feat: Apply recipes by number (#819)

- Downgrade spring-shell to 2.x
- Recipes can be applied by name or number of recipe

Author: fabapp2

applications/spring-shell/src/main/java/org/springframework/sbm/shell/ApplyShellCommand.java

@@ -21,6 +21,7 @@
 import org.jline.utils.AttributedString;
 import org.jline.utils.AttributedStringBuilder;
 import org.jline.utils.AttributedStyle;
+import org.jline.utils.Colors;
 import org.springframework.sbm.engine.commands.ApplicableRecipeListCommand;
 import org.springframework.sbm.engine.commands.ApplyCommand;
 import org.springframework.sbm.engine.context.ProjectContext;
@@ -30,15 +31,13 @@
 import org.springframework.shell.Availability;
 import org.springframework.shell.CompletionContext;
 import org.springframework.shell.CompletionProposal;
-import org.springframework.shell.standard.ShellComponent;
-import org.springframework.shell.standard.ShellMethod;
-import org.springframework.shell.standard.ShellMethodAvailability;
-import org.springframework.shell.standard.ShellOption;
-import org.springframework.shell.standard.ValueProvider;
+import org.springframework.shell.standard.*;
 import org.springframework.stereotype.Component;
 
 import java.util.List;
 
+import static java.lang.Integer.parseUnsignedInt;
+
 @ShellComponent
 @RequiredArgsConstructor
 public class ApplyShellCommand {
@@ -53,10 +52,17 @@ public class ApplyShellCommand {
     @ShellMethod(key = {"apply", "a"}, value = "Apply a given recipe to the target application.")
     @ShellMethodAvailability("availabilityCheck")
     public AttributedString apply(@ShellOption(arity = 1, valueProvider = ApplyRecipeValueProvider.class,
-            help = "The number of the recipe to apply.") String recipeIndex) {
-        int realIndex = Integer.parseInt(recipeIndex) - 1;
-        Recipe recipe = applicableRecipeListHolder.getRecipeByIndex(realIndex);
-        String recipeName = recipe.getName();
+            help = "The number of the recipe to apply.") String recipe) {
+        // allow passing in number of position or name of recipe (meh)
+        String recipeName = recipe;
+        try {
+            int recipeIndex = parseUnsignedInt(recipe);
+            int realIndex = recipeIndex - 1;
+            Recipe matchingRecipe = applicableRecipeListHolder.getRecipeByIndex(realIndex);
+            recipeName = matchingRecipe.getName();
+        } catch (NumberFormatException nfe) {
+
+        }
         AttributedStringBuilder header = buildHeader(recipeName);
         System.out.println(header.toAnsi());
 

applications/spring-shell/src/main/java/org/springframework/sbm/shell/RecipeRenderer.java

@@ -18,7 +18,6 @@
 import org.jline.utils.AttributedString;
 import org.jline.utils.AttributedStringBuilder;
 import org.jline.utils.AttributedStyle;
-import org.jline.utils.Colors;
 import org.springframework.sbm.engine.recipe.Recipe;
 import org.springframework.stereotype.Component;
 
@@ -49,7 +48,7 @@ public AttributedString renderRecipesList(String noRecipesTitle, String title, L
     }
 
     public AttributedStringBuilder buildRecipePresentation(int index, AttributedStringBuilder builder, Recipe recipe) {
-        builder.style(AttributedStyle.BOLD);//.foreground(Colors.rgbColor("yellow")));
+        builder.style(AttributedStyle.BOLD);
         builder.append("  ").append(Integer.toString(index + 1)).append(") ");
         builder.append(recipe.getName());
         builder.style(AttributedStyle.DEFAULT);

applications/spring-shell/src/test/java/org/springframework/sbm/shell/RecipeRendererTest.java

@@ -19,7 +19,6 @@
 import org.jline.utils.AttributedString;
 import org.jline.utils.AttributedStringBuilder;
 import org.jline.utils.AttributedStyle;
-import org.jline.utils.Colors;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.junit.jupiter.MockitoExtension;
@@ -47,16 +46,15 @@ void shouldRenderRecipe() {
         when(recipe.getDescription()).thenReturn(recipeDescription);
 
         AttributedStringBuilder builder = new AttributedStringBuilder();
-        builder.style(AttributedStyle.DEFAULT);
-        builder.append("  - ");
-        builder.style(AttributedStyle.DEFAULT.boldDefault().foreground(Colors.rgbColor("yellow")));
+        builder.style(AttributedStyle.BOLD);
+        builder.append("  2) ");
         builder.append(recipe.getName());
         builder.style(AttributedStyle.DEFAULT);
         builder.append("\n     -> " + recipe.getDescription());
         builder.append("\n");
 
-                AttributedStringBuilder builder2 = new AttributedStringBuilder();
-        AttributedString attributedString = sut.buildRecipePresentation(builder2, recipe).toAttributedString();
+        AttributedString attributedString = sut.buildRecipePresentation(1, new AttributedStringBuilder(), recipe).toAttributedString();
+
         AttributedString expectedAttributedString = builder.toAttributedString();
         assertThat(attributedString)
                 .as(attributedString + "  " + expectedAttributedString)

applications/spring-shell/src/test/java/org/springframework/sbm/shell/ScanShellCommandTest.java

@@ -61,6 +61,9 @@ class ScanShellCommandTest {
     @Mock
     private ConsolePrinter consolePrinter;
 
+    @Mock
+    ApplicableRecipesListHolder applicableRecipesListHolder;
+
     @InjectMocks
     ScanShellCommand sut;
 
@@ -86,7 +89,11 @@ void testScanWithFailingPreconditionChecksShouldPrintResult() {
 
         String result = sut.scan(projectRoot);
 
+        verify(applicableRecipesListHolder).clear();
+        verify(applicableRecipesListHolder, never()).setRecipes(any());
+
         ArgumentCaptor<String> capturedOutput = ArgumentCaptor.forClass(String.class);
+
         verify(consolePrinter).println(capturedOutput.capture());
 
         // header and validation result rendered
@@ -126,6 +133,8 @@ void testScanWithSucceedingPreconditionChecksShouldPrintResultAndRenderApplicabl
 
         String result = sut.scan(projectRoot);
 
+        verify(applicableRecipesListHolder).clear();
+        verify(applicableRecipesListHolder).setRecipes(recipes);
         // list of recipes returned
         assertThat(result).isEqualTo("\u001B[91mThe applicable recipe\u001B[0m");
         // header and validation result rendered

applications/spring-shell/src/test/java/org/springframework/sbm/shell/ScanShellCommandWithWindowsPathTest.java

@@ -59,7 +59,7 @@ void beforeEach() {
         recipes = List.of();
         projectContext = mock(ProjectContext.class);
 
-        sut = new ScanShellCommand(scanCommand, applicationRecipeListRenderer, applicableRecipeListCommand, contextHolder, preconditionVerificationRenderer, scanCommandHeaderRenderer, consolePrinter);
+        sut = new ScanShellCommand(scanCommand, applicationRecipeListRenderer, applicableRecipeListCommand, contextHolder, preconditionVerificationRenderer, scanCommandHeaderRenderer, consolePrinter, new ApplicableRecipesListHolder());
     }
 
     private void recordMocks(String projectRoot, ScanCommand scanCommand, ApplicableRecipeListRenderer applicationRecipeListRenderer, ApplicableRecipeListCommand applicableRecipeListCommand, List<Resource> resources, List<Recipe> recipes, ProjectContext projectContext) {

pom.xml

@@ -16,7 +16,7 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven-compiler-plugin.version>3.10.1</maven-compiler-plugin.version>
         <java.version>17</java.version>
-        <spring-shell.version>3.1.1</spring-shell.version>
+        <spring-shell.version>2.1.10</spring-shell.version>
         <openrewrite.version>7.35.0</openrewrite.version>
         <openrewrite.spring.version>4.32.0</openrewrite.spring.version>
         <rewrite-migrate-java.version>1.17.0</rewrite-migrate-java.version>