Implement analyzer for tim-from-marketing concept exercise

src/main/java/analyzer/AnalyzerRoot.java

@@ -10,6 +10,7 @@
 import analyzer.exercises.needforspeed.NeedForSpeedAnalyzer;
 import analyzer.exercises.salarycalculator.SalaryCalculatorAnalyzer;
 import analyzer.exercises.secrets.SecretsAnalyzer;
+import analyzer.exercises.timfrommarketing.TimFromMarketingAnalyzer;
 import analyzer.exercises.twofer.TwoferAnalyzer;
 import analyzer.exercises.wizardsandwarriors.WizardsAndWarriorsAnalyzer;
 
@@ -59,6 +60,7 @@ private static List<Analyzer> createAnalyzers(String slug) {
             case "need-for-speed" -> analyzers.add(new NeedForSpeedAnalyzer());
             case "salary-calculator" -> analyzers.add(new SalaryCalculatorAnalyzer());
             case "secrets" -> analyzers.add(new SecretsAnalyzer());
+            case "tim-from-marketing" -> analyzers.add(new TimFromMarketingAnalyzer());
             case "two-fer" -> analyzers.add(new TwoferAnalyzer());
             case "wizards-and-warriors" -> analyzers.add(new WizardsAndWarriorsAnalyzer());
         }

src/main/java/analyzer/exercises/timfrommarketing/TimFromMarketingAnalyzer.java

@@ -0,0 +1,54 @@
+package analyzer.exercises.timfrommarketing;
+
+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.expr.MethodCallExpr;
+import com.github.javaparser.ast.visitor.VoidVisitorAdapter;
+
+public class TimFromMarketingAnalyzer extends VoidVisitorAdapter<OutputCollector> implements Analyzer {
+
+    private static final String EXERCISE_NAME = "Tim from Marketing";
+    private static final String FORMAT = "format";
+    private static final String OPTIONAL = "Optional";
+
+    @Override
+    public void analyze(Solution solution, OutputCollector output) {
+
+        for (var compilationUnit : solution.getCompilationUnits()) {
+            compilationUnit.accept(this, output);
+        }
+
+        if (output.getComments().isEmpty()) {
+            output.addComment(new ExemplarSolution(EXERCISE_NAME));
+        }
+    }
+
+    @Override
+    public void visit(MethodDeclaration node, OutputCollector output) {
+
+        if(useOptionals(node)){
+            output.addComment(new UseNullLiteral());
+        }
+
+        if(useStringFormat(node)) {
+            output.addComment(new PreferStringConcatenation());
+        }
+
+        super.visit(node, output);
+    }
+
+    private static boolean useStringFormat(MethodDeclaration node) {
+        return node.findAll(MethodCallExpr.class).stream()
+                .anyMatch(m -> m.getNameAsString().contains(FORMAT));
+    }
+
+
+    private static boolean useOptionals(MethodDeclaration node) {
+        return node.findAll(MethodCallExpr.class).stream()
+                .anyMatch(m -> m.toString().contains(OPTIONAL));
+    }
+}

src/main/java/analyzer/exercises/timfrommarketing/UseNullLiteral.java

@@ -0,0 +1,17 @@
+package analyzer.exercises.timfrommarketing;
+
+import analyzer.Comment;
+
+
+public class UseNullLiteral extends Comment {
+
+    @Override
+    public String getKey() {
+        return "java.tim-from-marketing.use_null_literal";
+    }
+
+    @Override
+    public Type getType() {
+        return Type.ACTIONABLE;
+    }
+}

src/test/java/analyzer/AnalyzerIntegrationTest.java

@@ -83,6 +83,21 @@ void leap(String scenario) throws IOException {
         Approvals.verify(serialize(output.analysis()), Approvals.NAMES.withParameters(scenario));
     }
 
+    @ParameterizedTest
+    @ValueSource(strings = {
+            "ExemplarSolution",
+            "UseOptionals",
+            "UseStringFormat",
+            "UseOptionalsAndStringFormat",
+    })
+    void timfrommarketing(String scenario) throws IOException {
+        var path = Path.of("tim-from-marketing", scenario + ".java");
+        var solution = new SolutionFromFiles("tim-from-marketing", SCENARIOS.resolve(path));
+        var output = AnalyzerRoot.analyze(solution);
+
+        Approvals.verify(serialize(output.analysis()), Approvals.NAMES.withParameters(scenario));
+    }
+
     @ParameterizedTest
     @ValueSource(strings = {
             "HardCodedTestCases",

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

@@ -0,0 +1,11 @@
+{
+  "comments": [
+    {
+      "comment": "java.general.exemplar",
+      "params": {
+        "exerciseName": "Tim from Marketing"
+      },
+      "type": "celebratory"
+    }
+  ]
+}

src/test/resources/analyzer/AnalyzerIntegrationTest.timfrommarketing.UseOptionals.approved.txt

@@ -0,0 +1,14 @@
+{
+  "comments": [
+    {
+      "comment": "java.tim-from-marketing.use_null_literal",
+      "params": {},
+      "type": "actionable"
+    },
+    {
+      "comment": "java.general.feedback_request",
+      "params": {},
+      "type": "informative"
+    }
+  ]
+}

src/test/resources/analyzer/AnalyzerIntegrationTest.timfrommarketing.UseOptionalsAndStringFormat.approved.txt

@@ -0,0 +1,19 @@
+{
+  "comments": [
+    {
+      "comment": "java.tim-from-marketing.use_null_literal",
+      "params": {},
+      "type": "actionable"
+    },
+    {
+      "comment": "java.general.prefer_string_concatenation",
+      "params": {},
+      "type": "informative"
+    },
+    {
+      "comment": "java.general.feedback_request",
+      "params": {},
+      "type": "informative"
+    }
+  ]
+}

src/test/resources/analyzer/AnalyzerIntegrationTest.timfrommarketing.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/scenarios/tim-from-marketing/ExemplarSolution.java

@@ -0,0 +1,20 @@
+public class Badge {
+
+    public String print(Integer id, String name, String department) {
+
+        String worksAt;
+
+        if (department == null) {
+            worksAt = "OWNER";
+        } else {
+            worksAt = department.toUpperCase();
+        }
+
+        if (id == null) {
+            return name + " - " + worksAt;
+        }
+
+        return "[" + id + "] - " + name + " - " + worksAt;
+    }
+
+}

src/test/resources/scenarios/tim-from-marketing/UseOptionals.java

@@ -0,0 +1,11 @@
+public class Badge {
+    public String print(Integer id, String name, String department) {
+        Optional<Integer> optionalId = Optional.ofNullable(id);
+        Optional<String> optionalDepartment = Optional.ofNullable(department);
+
+        String idPart = optionalId.map(i -> "[" + i + "] - ").orElse("");
+        String departmentPart = optionalDepartment.orElse("OWNER").toUpperCase();
+
+        return idPart + name + " - " + departmentPart;
+    }
+}

src/test/resources/scenarios/tim-from-marketing/UseOptionalsAndStringFormat.java

@@ -0,0 +1,11 @@
+public class Badge {
+    public String print(Integer id, String name, String department) {
+        Optional<Integer> optionalId = Optional.ofNullable(id);
+        Optional<String> optionalDepartment = Optional.ofNullable(department);
+
+        String idPart = optionalId.map(i -> String.format("[%d] - ", i)).orElse("");
+        String departmentPart = optionalDepartment.orElse("OWNER").toUpperCase();
+
+        return String.format("%s%s - %s", idPart, name, departmentPart);
+    }
+}

src/test/resources/scenarios/tim-from-marketing/UseStringFormat.java

@@ -0,0 +1,15 @@
+public class Badge {
+    public String print(Integer id, String name, String department) {
+        if (department == null) {
+            department = "OWNER";
+        } else {
+            department = department.toUpperCase();
+        }
+
+        if (id == null) {
+            return String.format("%s - %s", name, department);
+        } else {
+            return String.format("[%d] - %s - %s", id, name, department);
+        }
+    }
+}

tests/tim-from-marketing/exemplar-solution/.meta/config.json

@@ -0,0 +1,23 @@
+{
+  "authors": [
+    "smcg468"
+  ],
+  "files": {
+    "solution": [
+      "src/main/java/Badge.java"
+    ],
+    "test": [
+      "src/test/java/BadgeTest.java"
+    ],
+    "exemplar": [
+      ".meta/src/reference/java/Badge.java"
+    ],
+    "invalidator": [
+      "build.gradle"
+    ]
+  },
+  "forked_from": [
+    "csharp/tim-from-marketing"
+  ],
+  "blurb": "Learn about the null literal and nullable variables in java by printing name badges."
+}

tests/tim-from-marketing/exemplar-solution/expected_analysis.json

@@ -0,0 +1,11 @@
+{
+  "comments": [
+    {
+      "comment": "java.general.exemplar",
+      "params": {
+        "exerciseName": "Tim from Marketing"
+      },
+      "type": "celebratory"
+    }
+  ]
+}

tests/tim-from-marketing/exemplar-solution/expected_tags.json

@@ -0,0 +1,3 @@
+{
+  "tags": []
+}

tests/tim-from-marketing/exemplar-solution/src/main/java/Badge.java

@@ -0,0 +1,20 @@
+public class Badge {
+
+    public String print(Integer id, String name, String department) {
+
+        String worksAt;
+
+        if (department == null) {
+            worksAt = "OWNER";
+        } else {
+            worksAt = department.toUpperCase();
+        }
+
+        if (id == null) {
+            return name + " - " + worksAt;
+        }
+
+        return "[" + id + "] - " + name + " - " + worksAt;
+    }
+
+}

tests/tim-from-marketing/use-optionals/.meta/config.json

@@ -0,0 +1,23 @@
+{
+  "authors": [
+    "smcg468"
+  ],
+  "files": {
+    "solution": [
+      "src/main/java/Badge.java"
+    ],
+    "test": [
+      "src/test/java/BadgeTest.java"
+    ],
+    "exemplar": [
+      ".meta/src/reference/java/Badge.java"
+    ],
+    "invalidator": [
+      "build.gradle"
+    ]
+  },
+  "forked_from": [
+    "csharp/tim-from-marketing"
+  ],
+  "blurb": "Learn about the null literal and nullable variables in java by printing name badges."
+}

tests/tim-from-marketing/use-optionals/expected_analysis.json

@@ -0,0 +1,14 @@
+{
+  "comments": [
+    {
+      "comment": "java.tim-from-marketing.use_null_literal",
+      "params": {},
+      "type": "actionable"
+    },
+    {
+      "comment": "java.general.feedback_request",
+      "params": {},
+      "type": "informative"
+    }
+  ]
+}

tests/tim-from-marketing/use-optionals/expected_tags.json

@@ -0,0 +1,3 @@
+{
+  "tags": []
+}

tests/tim-from-marketing/use-optionals/src/main/java/Badge.java

@@ -0,0 +1,11 @@
+public class Badge {
+    public String print(Integer id, String name, String department) {
+        Optional<Integer> optionalId = Optional.ofNullable(id);
+        Optional<String> optionalDepartment = Optional.ofNullable(department);
+
+        String idPart = optionalId.map(i -> "[" + i + "] - ").orElse("");
+        String departmentPart = optionalDepartment.orElse("OWNER").toUpperCase();
+
+        return idPart + name + " - " + departmentPart;
+    }
+}

tests/tim-from-marketing/use-string-format/.meta/config.json

@@ -0,0 +1,23 @@
+{
+  "authors": [
+    "smcg468"
+  ],
+  "files": {
+    "solution": [
+      "src/main/java/Badge.java"
+    ],
+    "test": [
+      "src/test/java/BadgeTest.java"
+    ],
+    "exemplar": [
+      ".meta/src/reference/java/Badge.java"
+    ],
+    "invalidator": [
+      "build.gradle"
+    ]
+  },
+  "forked_from": [
+    "csharp/tim-from-marketing"
+  ],
+  "blurb": "Learn about the null literal and nullable variables in java by printing name badges."
+}

tests/tim-from-marketing/use-string-format/expected_analysis.json

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