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.

Sign up for GitHub

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

fix: Add DelegatingRecipe to find underlying recipe for loading options #4286

Merged
merged 5 commits into from
Jun 28, 2024
Merged

fix: Add DelegatingRecipe to find underlying recipe for loading options #4286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6eea37e
fix: Add method to determine recipe class that can be overwritten in …
pstreef Jun 25, 2024
514e283
Add test and use (sort of) interface
pstreef Jun 25, 2024
34c25bd
convert to interface
pstreef Jun 26, 2024
96eca22
Update DeclarativeRecipeTest.java
pstreef Jun 26, 2024
f95fc0c
Also use for ScanningRecipe
pstreef Jun 27, 2024
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
20 changes: 14 additions & 6 deletions rewrite-core/src/main/java/org/openrewrite/Recipe.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import lombok.Setter;
import org.intellij.lang.annotations.Language;
import org.jetbrains.annotations.Nls;
import org.openrewrite.config.DataTableDescriptor;
import org.openrewrite.config.OptionDescriptor;
import org.openrewrite.config.RecipeDescriptor;
Expand Down Expand Up @@ -131,7 +130,7 @@ public String getInstanceName() {
return getDisplayName() + " " + suffix;
}

List<OptionDescriptor> options = new ArrayList<>(getOptionDescriptors(getClass()));
List<OptionDescriptor> options = new ArrayList<>(getOptionDescriptors());
options.removeIf(opt -> !opt.isRequired());
if (options.isEmpty()) {
return getDisplayName();
Expand Down Expand Up @@ -209,7 +208,7 @@ public final RecipeDescriptor getDescriptor() {
}

protected RecipeDescriptor createRecipeDescriptor() {
List<OptionDescriptor> options = getOptionDescriptors(this.getClass());
List<OptionDescriptor> options = getOptionDescriptors();
List<RecipeDescriptor> recipeList1 = new ArrayList<>();
for (Recipe next : getRecipeList()) {
recipeList1.add(next.getDescriptor());
Expand All @@ -226,14 +225,19 @@ protected RecipeDescriptor createRecipeDescriptor() {
getMaintainers(), getContributors(), getExamples(), recipeSource);
}

private List<OptionDescriptor> getOptionDescriptors(Class<?> recipeClass) {
private List<OptionDescriptor> getOptionDescriptors() {
Recipe recipe = this;
if (this instanceof DelegatingRecipe) {
recipe = ((DelegatingRecipe) this).getDelegate();
}

List<OptionDescriptor> options = new ArrayList<>();

for (Field field : recipeClass.getDeclaredFields()) {
for (Field field : recipe.getClass().getDeclaredFields()) {
Object value;
try {
field.setAccessible(true);
value = field.get(this);
value = field.get(recipe);
} catch (IllegalAccessException e) {
value = null;
}
Expand Down Expand Up @@ -416,4 +420,8 @@ public Object clone() {
throw new RuntimeException(e);
}
}

public interface DelegatingRecipe {
Recipe getDelegate();
}
}
4 changes: 2 additions & 2 deletions rewrite-core/src/main/java/org/openrewrite/config/DeclarativeRecipe.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ public boolean isAcceptable(SourceFile sourceFile, ExecutionContext ctx) {

@EqualsAndHashCode(callSuper = false)
@Value
static class BellwetherDecoratedRecipe extends Recipe {
static class BellwetherDecoratedRecipe extends Recipe implements DelegatingRecipe {
Copy link
Contributor

@timtebeek timtebeek Jun 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should BellwetherDecoratedScanningRecipe below implement the same interface? Or a DelegatingScanningRecipe for that part?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, good catch!


DeclarativeRecipe.PreconditionBellwether bellwether;
Recipe delegate;
Expand Down Expand Up @@ -206,7 +206,7 @@ public boolean causesAnotherCycle() {

@Value
@EqualsAndHashCode(callSuper = false)
static class BellwetherDecoratedScanningRecipe<T> extends ScanningRecipe<T> {
static class BellwetherDecoratedScanningRecipe<T> extends ScanningRecipe<T> implements DelegatingRecipe {

DeclarativeRecipe.PreconditionBellwether bellwether;
ScanningRecipe<T> delegate;
Expand Down
30 changes: 30 additions & 0 deletions rewrite-core/src/test/java/org/openrewrite/config/DeclarativeRecipeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,36 @@ public PlainText visitText(PlainText text, ExecutionContext ctx) {
);
}

@Test
void addingPreconditionsWithOptions() {
DeclarativeRecipe dr = new DeclarativeRecipe("test", "test", "test", null,
null, null, true, null);
dr.addPrecondition(
toRecipe(() -> new PlainTextVisitor<>() {
@Override
public PlainText visitText(PlainText text, ExecutionContext ctx) {
if ("1".equals(text.getText())) {
return SearchResult.found(text);
}
return text;
}
})
);
dr.addUninitialized(
new ChangeText("2")
);
dr.addUninitialized(
new ChangeText("3")
);
dr.initialize(List.of(), Map.of());
assertThat(dr.getDescriptor().getRecipeList())
.hasSize(3) // precondition + 2 recipes with options
.flatExtracting(RecipeDescriptor::getOptions)
.hasSize(2)
.extracting(OptionDescriptor::getName)
.containsOnly("toText");
}

@Test
void uninitializedFailsValidation() {
DeclarativeRecipe dr = new DeclarativeRecipe("test", "test", "test", null,
Expand Down
Loading