Implement analyzer for wizards-and-warriors-2 (#262)

Author: chiarazarrella

src/main/java/analyzer/AnalyzerRoot.java

@@ -13,6 +13,7 @@
 import analyzer.exercises.timfrommarketing.TimFromMarketingAnalyzer;
 import analyzer.exercises.twofer.TwoferAnalyzer;
 import analyzer.exercises.wizardsandwarriors.WizardsAndWarriorsAnalyzer;
+import analyzer.exercises.wizardsandwarriors2.WizardsAndWarriors2Analyzer;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -34,7 +35,6 @@ private AnalyzerRoot() {
      */
     public static Output analyze(Solution solution) {
         var outputBuilder = new OutputBuilder();
-
         for (Analyzer analyzer : createAnalyzers(solution.getSlug())) {
             analyzer.analyze(solution, outputBuilder);
         }
@@ -50,7 +50,6 @@ private static List<Analyzer> createAnalyzers(String slug) {
         var analyzers = new ArrayList<Analyzer>();
 
         analyzers.add(new GlobalAnalyzer());
-
         switch (slug) {
             case "annalyns-infiltration" -> analyzers.add(new AnnalynsInfiltrationAnalyzer());
             case "hamming" -> analyzers.add(new HammingAnalyzer());
@@ -63,6 +62,7 @@ private static List<Analyzer> createAnalyzers(String slug) {
             case "tim-from-marketing" -> analyzers.add(new TimFromMarketingAnalyzer());
             case "two-fer" -> analyzers.add(new TwoferAnalyzer());
             case "wizards-and-warriors" -> analyzers.add(new WizardsAndWarriorsAnalyzer());
+            case "wizards-and-warriors-2" -> analyzers.add(new WizardsAndWarriors2Analyzer());
         }
 
         return List.copyOf(analyzers);

src/main/java/analyzer/exercises/wizardsandwarriors2/ReuseCodeFromDescribeThreeParams.java

@@ -0,0 +1,16 @@
+package analyzer.exercises.wizardsandwarriors2;
+
+import analyzer.Comment;
+
+public class ReuseCodeFromDescribeThreeParams extends Comment {
+
+    @Override
+    public String getKey() {
+        return "java.wizards-and-warriors-2.reuse_code_from_describe_three_params";
+    }
+
+    @Override
+    public Type getType() {
+        return Type.ACTIONABLE;
+    }
+}

src/main/java/analyzer/exercises/wizardsandwarriors2/ReuseCodeFromDescribeTwoParams.java

@@ -0,0 +1,16 @@
+package analyzer.exercises.wizardsandwarriors2;
+
+import analyzer.Comment;
+
+public class ReuseCodeFromDescribeTwoParams extends Comment {
+
+    @Override
+    public String getKey() {
+        return "java.wizards-and-warriors-2.reuse_code_from_describe_two_params";
+    }
+
+    @Override
+    public Type getType() {
+        return Type.ACTIONABLE;
+    }
+}

src/main/java/analyzer/exercises/wizardsandwarriors2/WizardsAndWarriors2Analyzer.java

@@ -0,0 +1,87 @@
+package analyzer.exercises.wizardsandwarriors2;
+
+import analyzer.Analyzer;
+import analyzer.OutputCollector;
+import analyzer.Solution;
+import analyzer.comments.ExemplarSolution;
+import analyzer.comments.PreferStringConcatenation;
+import com.github.javaparser.ast.body.MethodDeclaration;
+import com.github.javaparser.ast.body.Parameter;
+import com.github.javaparser.ast.expr.MethodCallExpr;
+import com.github.javaparser.ast.visitor.VoidVisitorAdapter;
+
+import java.util.List;
+
+/**
+ * The {@link WizardsAndWarriors2Analyzer} is the analyzer implementation for the {@code wizards-and-warriors-2} concept exercise.
+ *
+ * @see <a href="https://github.com/exercism/java/tree/main/exercises/concept/wizards-and-warriors-2">The wizards-and-warriors exercise on the Java track</a>
+ */
+public class WizardsAndWarriors2Analyzer extends VoidVisitorAdapter<OutputCollector> implements Analyzer {
+
+    private static final String EXERCISE_NAME = "Wizards and Warriors 2";
+    private static final String GAME_MASTER = "GameMaster";
+    private static final String DESCRIBE = "describe";
+    private static final String FORMAT = "format";
+    private static final String DESTINATION_TYPE = "Destination";
+    private static final String TRAVEL_METHOD_TYPE = "TravelMethod";
+    private static final String CHARACTER_TYPE = "Character";
+
+    @Override
+    public void analyze(Solution solution, OutputCollector output) {
+
+        for (var compilationUnit : solution.getCompilationUnits()) {
+            compilationUnit.getClassByName(GAME_MASTER).ifPresent(c -> c.accept(this, output));
+        }
+
+        if (output.getComments().isEmpty()) {
+            output.addComment(new ExemplarSolution(EXERCISE_NAME));
+        }
+    }
+
+    @Override
+    public void visit(MethodDeclaration node, OutputCollector output) {
+
+        if(!node.getNameAsString().equals(DESCRIBE)) {
+            return;
+        }
+
+        if(node.getParameters().size() == 2 && !reuseMethod(node, 2)) {
+            output.addComment(new ReuseCodeFromDescribeTwoParams());
+        }
+
+        if(node.getParameters().size() == 3 && !reuseMethod(node, 3)) {
+            output.addComment(new ReuseCodeFromDescribeThreeParams());
+        }
+
+        if(useStringFormat(node)) {
+            output.addComment(new PreferStringConcatenation());
+        }
+
+        super.visit(node, output);
+    }
+
+    private static boolean reuseMethod(MethodDeclaration node, int paramCount) {
+
+        List<String> paramsType = node.getParameters().stream().map(Parameter::getTypeAsString).toList();
+        List<MethodCallExpr> describeCalls = node.findAll(MethodCallExpr.class).stream()
+                .filter(m -> m.getNameAsString().equals(DESCRIBE))
+                .toList();
+
+        if (paramCount == 2 && paramsType.contains(DESTINATION_TYPE) && paramsType.contains(CHARACTER_TYPE)) {
+            return describeCalls.size() == 1 || describeCalls.size() == 3;
+        }
+
+        if (paramCount == 3 && paramsType.contains(DESTINATION_TYPE) && paramsType.contains(TRAVEL_METHOD_TYPE) && paramsType.contains(CHARACTER_TYPE)) {
+            return describeCalls.size() == 3;
+        }
+
+        return false;
+    }
+
+    private static boolean useStringFormat(MethodDeclaration node) {
+        return node.findAll(MethodCallExpr.class).stream()
+                .anyMatch(m -> m.getNameAsString().contains(FORMAT));
+    }
+
+}

src/test/java/analyzer/AnalyzerIntegrationTest.java

@@ -221,4 +221,20 @@ void salarycalculator(String scenario) throws IOException {
 
         Approvals.verify(serialize(output.analysis()), Approvals.NAMES.withParameters(scenario));
     }
+
+    @ParameterizedTest
+    @ValueSource(strings = {
+            "ExemplarSolution",
+            "NotReuseMethod",
+            "PartialReuseOfMethod",
+            "UseStringFormat",
+            "UseStringFormatAndNotReuseMethod",
+    })
+    void wizardsandwarriors2(String scenario) throws IOException {
+        var path = Path.of("wizards-and-warriors-2", scenario + ".java");
+        var solution = new SolutionFromFiles("wizards-and-warriors-2", SCENARIOS.resolve(path));
+        var output = AnalyzerRoot.analyze(solution);
+
+        Approvals.verify(serialize(output.analysis()), Approvals.NAMES.withParameters(scenario));
+    }
 }

src/test/resources/analyzer/AnalyzerIntegrationTest.wizardsandwarriors2.ExemplarSolution.approved.txt

@@ -0,0 +1,11 @@
+{
+  "comments": [
+    {
+      "comment": "java.general.exemplar",
+      "params": {
+        "exerciseName": "Wizards and Warriors 2"
+      },
+      "type": "celebratory"
+    }
+  ]
+}

src/test/resources/analyzer/AnalyzerIntegrationTest.wizardsandwarriors2.NotReuseMethod.approved.txt

@@ -0,0 +1,19 @@
+{
+  "comments": [
+    {
+      "comment": "java.wizards-and-warriors-2.reuse_code_from_describe_three_params",
+      "params": {},
+      "type": "actionable"
+    },
+    {
+      "comment": "java.wizards-and-warriors-2.reuse_code_from_describe_two_params",
+      "params": {},
+      "type": "actionable"
+    },
+    {
+      "comment": "java.general.feedback_request",
+      "params": {},
+      "type": "informative"
+    }
+  ]
+}

src/test/resources/analyzer/AnalyzerIntegrationTest.wizardsandwarriors2.PartialReuseOfMethod.approved.txt

@@ -0,0 +1,14 @@
+{
+  "comments": [
+    {
+      "comment": "java.wizards-and-warriors-2.reuse_code_from_describe_two_params",
+      "params": {},
+      "type": "actionable"
+    },
+    {
+      "comment": "java.general.feedback_request",
+      "params": {},
+      "type": "informative"
+    }
+  ]
+}

src/test/resources/analyzer/AnalyzerIntegrationTest.wizardsandwarriors2.UseStringFormat.approved.txt

@@ -0,0 +1,14 @@
+{
+  "comments": [
+    {
+      "comment": "java.general.prefer_string_concatenation",
+      "params": {},
+      "type": "informative"
+    },
+    {
+      "comment": "java.general.feedback_request",
+      "params": {},
+      "type": "informative"
+    }
+  ]
+}

src/test/resources/analyzer/AnalyzerIntegrationTest.wizardsandwarriors2.UseStringFormatAndNotReuseMethod.approved.txt

@@ -0,0 +1,24 @@
+{
+  "comments": [
+    {
+      "comment": "java.wizards-and-warriors-2.reuse_code_from_describe_three_params",
+      "params": {},
+      "type": "actionable"
+    },
+    {
+      "comment": "java.wizards-and-warriors-2.reuse_code_from_describe_two_params",
+      "params": {},
+      "type": "actionable"
+    },
+    {
+      "comment": "java.general.prefer_string_concatenation",
+      "params": {},
+      "type": "informative"
+    },
+    {
+      "comment": "java.general.feedback_request",
+      "params": {},
+      "type": "informative"
+    }
+  ]
+}