Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate ApiImplicitParam defaultValue #27

Merged
merged 5 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
/*
* Copyright 2024 the original author or authors.
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.openapi.swagger;

import org.openrewrite.*;
import org.openrewrite.java.*;
timtebeek marked this conversation as resolved.
Show resolved Hide resolved
timtebeek marked this conversation as resolved.
Show resolved Hide resolved
timtebeek marked this conversation as resolved.
Show resolved Hide resolved
import org.openrewrite.java.search.UsesMethod;
import org.openrewrite.java.tree.Expression;
import org.openrewrite.java.tree.J;

import java.util.ArrayList;
import java.util.List;

public class MigrateApiImplicitParam extends Recipe {
private static final String FQN_SCHEMA = "io.swagger.v3.oas.annotations.media.Schema";

@Override
public String getDisplayName() {
return "Migrate `@ApiImplicitParam` to `@Parameter)`";
}

@Override
public String getDescription() {
return "Migrate `@ApiImplicitParam` to `@Parameter`.";
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
// This recipe is after ChangeType recipe
return Preconditions.check(
Preconditions.or(
new UsesMethod<>("io.swagger.annotations.ApiImplicitParam dataTypeClass()", false),
new UsesMethod<>("io.swagger.annotations.ApiImplicitParam defaultValue()", false)
),
new JavaIsoVisitor<ExecutionContext>() {
@Override
public J.Annotation visitAnnotation(J.Annotation annotation, ExecutionContext ctx) {
J.Annotation anno = super.visitAnnotation(annotation, ctx);

if (!new AnnotationMatcher("io.swagger.v3.oas.annotations.Parameter").matches(anno)) {
return anno;
}

StringBuilder tpl = new StringBuilder();
StringBuilder schemaTpl = new StringBuilder();
List<Expression> args = new ArrayList<>();
for (Expression exp : anno.getArguments()) {
if (isDataTypeClass(exp)) {
Expression expression = ((J.Assignment) exp).getAssignment();
addSchema(schemaTpl, "implementation");
args.add(expression);
} else if (isDefaultValue(exp)) {
Expression expression = ((J.Assignment) exp).getAssignment();
addSchema(schemaTpl, "defaultValue");
args.add(expression);
} else {
tpl.append("#{any()}, ");
args.add(exp);
}
}
if (tpl.toString().endsWith(", ")) {
tpl.delete(tpl.length() - 2, tpl.length());
}
if (schemaTpl.length() > 0) {
if (schemaTpl.toString().endsWith(", ")) {
schemaTpl.delete(schemaTpl.length() - 2, schemaTpl.length());
}
schemaTpl.append(")");
tpl.append(", ").append(schemaTpl);
}
anno = JavaTemplate.builder(tpl.toString())
.imports(FQN_SCHEMA)
.javaParser(JavaParser.fromJavaVersion().classpath("swagger-annotations"))
.build()
.apply(updateCursor(anno), annotation.getCoordinates().replaceArguments(), args.toArray());
maybeAddImport(FQN_SCHEMA, false);
return maybeAutoFormat(annotation, anno, ctx, getCursor().getParentTreeCursor());
}

private void addSchema(StringBuilder tpl, String key) {
if (tpl.length() == 0) {
tpl.append("schema = @Schema(");
}
tpl.append(key).append(" = #{any()}, ");
}

private boolean isDataTypeClass(Expression exp) {
return exp instanceof J.Assignment && ((J.Identifier) ((J.Assignment) exp).getVariable()).getSimpleName().equals("dataTypeClass");
}

private boolean isDefaultValue(Expression exp) {
return exp instanceof J.Assignment && ((J.Identifier) ((J.Assignment) exp).getVariable()).getSimpleName().equals("defaultValue");
}
}
);
}
}

This file was deleted.

2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/swagger-2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ recipeList:
- org.openrewrite.java.RemoveAnnotationAttribute:
annotationType: io.swagger.v3.oas.annotations.Parameter
attributeName: allowMultiple
- org.openrewrite.openapi.swagger.MigrateApiImplicitParamDataTypeClass
- org.openrewrite.openapi.swagger.MigrateApiImplicitParam

---
type: specs.openrewrite.org/v1beta/recipe
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,15 +128,15 @@ class Example {
}

@Test
void migrateApiImplicitParamDataTypeClass() {
void migrateApiImplicitParam() {
rewriteRun(
//language=java
java(
"""
import io.swagger.annotations.ApiImplicitParam;

class Example {
@ApiImplicitParam(name = "foo", value = "Foo object", required = true, dataTypeClass = Example.class)
@ApiImplicitParam(name = "foo", value = "Foo object", required = true, dataTypeClass = Example.class, defaultValue = "example")
public void create(Example foo) {
}
}
Expand All @@ -146,7 +146,7 @@ public void create(Example foo) {
import io.swagger.v3.oas.annotations.media.Schema;

class Example {
@Parameter(name = "foo", description = "Foo object", required = true, schema = @Schema(implementation = Example.class))
@Parameter(name = "foo", description = "Foo object", required = true, schema = @Schema(implementation = Example.class, defaultValue = "example"))
public void create(Example foo) {
}
}
Expand Down
Loading