Apply recipes by number (#818)

Author: fabapp2

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

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2021 - 2022 the original author or authors.
+ *
+ * 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
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.springframework.sbm.shell;
+
+import org.springframework.sbm.engine.recipe.Recipe;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * @author Fabian Krüger
+ */
+@Component
+public class ApplicableRecipesListHolder {
+    private List<Recipe> recipes = new ArrayList<>();
+
+    public void clear() {
+        recipes.clear();
+    }
+
+    public void setRecipes(List<Recipe> recipes) {
+        this.recipes = recipes;
+    }
+
+    public Recipe getRecipeByIndex(int index) {
+        return recipes.get(index);
+    }
+}

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

@@ -16,18 +16,17 @@
  */
 package org.springframework.sbm.shell;
 
+import lombok.RequiredArgsConstructor;
+import org.jetbrains.annotations.NotNull;
+import org.jline.utils.AttributedString;
+import org.jline.utils.AttributedStringBuilder;
+import org.jline.utils.AttributedStyle;
 import org.springframework.sbm.engine.commands.ApplicableRecipeListCommand;
 import org.springframework.sbm.engine.commands.ApplyCommand;
 import org.springframework.sbm.engine.context.ProjectContext;
 import org.springframework.sbm.engine.context.ProjectContextHolder;
 import org.springframework.sbm.engine.recipe.Action;
 import org.springframework.sbm.engine.recipe.Recipe;
-import lombok.RequiredArgsConstructor;
-import org.jetbrains.annotations.NotNull;
-import org.jline.utils.AttributedString;
-import org.jline.utils.AttributedStringBuilder;
-import org.jline.utils.AttributedStyle;
-import org.jline.utils.Colors;
 import org.springframework.shell.Availability;
 import org.springframework.shell.CompletionContext;
 import org.springframework.shell.CompletionProposal;
@@ -49,11 +48,15 @@ public class ApplyShellCommand {
     private final ApplicableRecipeListRenderer applicableRecipeListRenderer;
     private final ProjectContextHolder projectContextHolder;
     private final ApplyCommandRenderer applyCommandRenderer;
+    private final ApplicableRecipesListHolder applicableRecipeListHolder;
 
     @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 name of the recipe to apply.") String recipeName) {
+            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();
         AttributedStringBuilder header = buildHeader(recipeName);
         System.out.println(header.toAnsi());
 

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

@@ -39,19 +39,18 @@ public AttributedString renderRecipesList(String noRecipesTitle, String title, L
             AttributedString titleString = renderTitle(title);
             builder.append(titleString);
 
-            foundRecipes.forEach(recipe -> this.buildRecipePresentation(builder, recipe));
+            foundRecipes.forEach(recipe -> this.buildRecipePresentation(foundRecipes.indexOf(recipe), builder, recipe));
 
             builder.append("\n");
-            builder.append("Run command '> apply recipe-name' to apply a recipe.");
+            builder.append("Run command '> apply <recipe-number>' to apply a recipe.");
             builder.append("\n");
         }
         return builder.toAttributedString();
     }
 
-    public AttributedStringBuilder buildRecipePresentation(AttributedStringBuilder builder, Recipe recipe) {
-        builder.style(AttributedStyle.DEFAULT);
-        builder.append("  - ");
-        builder.style(AttributedStyle.DEFAULT.italicDefault().boldDefault().foreground(Colors.rgbColor("yellow")));
+    public AttributedStringBuilder buildRecipePresentation(int index, AttributedStringBuilder builder, Recipe recipe) {
+        builder.style(AttributedStyle.BOLD);//.foreground(Colors.rgbColor("yellow")));
+        builder.append("  ").append(Integer.toString(index + 1)).append(") ");
         builder.append(recipe.getName());
         builder.style(AttributedStyle.DEFAULT);
         builder.append("\n     -> ").append(recipe.getDescription());

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

@@ -42,6 +42,7 @@ public class ScanShellCommand {
     private final PreconditionVerificationRenderer preconditionVerificationRenderer;
     private final ScanCommandHeaderRenderer scanCommandHeaderRenderer;
     private final ConsolePrinter consolePrinter;
+    private final ApplicableRecipesListHolder applicableRecipesListHolder;
 
     @ShellMethod(key = {"scan", "s"},
             value = "Scans the target project directory and get the list of applicable recipes.")
@@ -50,6 +51,8 @@ public String scan(
                     help = "The root directory of the target application.")
                     String projectRoot) {
 
+        applicableRecipesListHolder.clear();
+
         List<Resource> resources = scanCommand.scanProjectRoot(projectRoot);
         String scanCommandHeader = scanCommandHeaderRenderer.renderHeader(projectRoot);
         PreconditionVerificationResult result = scanCommand.checkPreconditions(projectRoot, resources);
@@ -67,6 +70,7 @@ public String scan(
             ProjectContext projectContext = scanCommand.execute(projectRoot);
             contextHolder.setProjectContext(projectContext);
             List<Recipe> recipes = applicableRecipeListCommand.execute(projectContext);
+            applicableRecipesListHolder.setRecipes(recipes);
             AttributedString recipeList = applicableRecipeListRenderer.render(recipes);
             stringBuilder.append(recipeList);
         }

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

@@ -15,6 +15,7 @@
  */
 package org.springframework.sbm.shell;
 
+import org.springframework.sbm.engine.recipe.Recipe;
 import org.jline.utils.AttributedString;
 import org.jline.utils.AttributedStringBuilder;
 import org.jline.utils.AttributedStyle;
@@ -75,8 +76,8 @@ void shouldRenderListOfRecipesWhenNotEmpty() {
 
         AttributedStringBuilder builder = new AttributedStringBuilder();
 
-        sut.buildRecipePresentation(builder, recipe1);
-        sut.buildRecipePresentation(builder, recipe2);
+        sut.buildRecipePresentation(1, builder, recipe1);
+        sut.buildRecipePresentation(2, builder, recipe2);
 
 
         AttributedString attributedString = sut.renderRecipesList("", title, List.of(recipe1, recipe2));

components/sbm-core/src/main/java/org/springframework/sbm/engine/commands/ApplyCommand.java

@@ -15,10 +15,7 @@
  */
 package org.springframework.sbm.engine.commands;
 
-import org.openrewrite.ExecutionContext;
-import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
-import org.springframework.context.annotation.Scope;
 import org.springframework.sbm.common.filter.DeletedResourcePathStringFilter;
 import org.springframework.sbm.common.filter.ModifiedResourcePathStringFilter;
 import org.springframework.sbm.engine.context.ProjectContext;