Refactored --snippet option. Closes #561, #302

Author: aslakhellesoy

History.md

@@ -1,5 +1,6 @@
 ## [Git master](https://github.com/cucumber/cucumber-jvm/compare/v1.1.4...master)
 
+* [Java, Jython] New `--snippet [underscore|camelcase]` option for more control over snippet style. ([#561](https://github.com/cucumber/cucumber-jvm/pull/561), [302](https://github.com/cucumber/cucumber-jvm/pull/302) Márton Mészáros, Aslak Hellesøy)
 * [Windows] Use uri instead of path in CucumberFeature ([#562](https://github.com/cucumber/cucumber-jvm/pull/562) Björn Rasmusson)
 
 ## [1.1.4](https://github.com/cucumber/cucumber-jvm/compare/v1.1.3...v1.1.4) (2013-08-11)

clojure/src/test/java/cucumber/runtime/clojure/ClojureSnippetTest.java

@@ -18,7 +18,7 @@ public class ClojureSnippetTest {
     @Test
     public void generatesPlainSnippet() {
         Step step = new Step(NO_COMMENTS, "Given ", "I have 4 cukes in my \"big\" belly", 0, null, null);
-        String snippet = new SnippetGenerator(new ClojureSnippet()).getSnippet(step);
+        String snippet = new SnippetGenerator(new ClojureSnippet()).getSnippet(step, null);
         String expected = "" +
                 "(Given #\"^I have (\\d+) cukes in my \\\"([^\\\"]*)\\\" belly$\" [arg1 arg2]\n" +
                 "  (comment  Express the Regexp above with the code you wish you had  )\n" +
@@ -30,7 +30,7 @@ public void generatesPlainSnippet() {
     public void generatesSnippetWithDataTable() {
         List<DataTableRow> dataTable = asList(new DataTableRow(NO_COMMENTS, asList("col1"), 1));
         Step step = new Step(NO_COMMENTS, "Given ", "I have:", 0, dataTable, null);
-        String snippet = new SnippetGenerator(new ClojureSnippet()).getSnippet(step);
+        String snippet = new SnippetGenerator(new ClojureSnippet()).getSnippet(step, null);
         String expected = "" +
                 "(Given #\"^I have:$\" [arg1]\n" +
                 "  (comment  Express the Regexp above with the code you wish you had  )\n" +

core/src/main/java/cucumber/api/SnippetType.java

@@ -0,0 +1,32 @@
+package cucumber.api;
+
+import cucumber.runtime.CucumberException;
+import cucumber.runtime.snippets.CamelCaseFunctionNameSanitizer;
+import cucumber.runtime.snippets.FunctionNameSanitizer;
+import cucumber.runtime.snippets.UnderscoreFunctionNameSanitizer;
+
+public enum SnippetType {
+    UNDERSCORE("underscore", new UnderscoreFunctionNameSanitizer()),
+    CAMELCASE("camelcase", new CamelCaseFunctionNameSanitizer());
+
+    private final String name;
+    private final FunctionNameSanitizer functionNameSanitizer;
+
+    SnippetType(String name, FunctionNameSanitizer functionNameSanitizer) {
+        this.name = name;
+        this.functionNameSanitizer = functionNameSanitizer;
+    }
+
+    public static SnippetType fromString(String name) {
+        for (SnippetType snippetType : SnippetType.values()) {
+            if (name.equalsIgnoreCase(snippetType.name)) {
+                return snippetType;
+            }
+        }
+        throw new CucumberException(String.format("Unrecognized SnippetType %s", name));
+    }
+
+    public FunctionNameSanitizer getFunctionNameSanitizer() {
+        return functionNameSanitizer;
+    }
+}

core/src/main/java/cucumber/runtime/Backend.java

@@ -1,5 +1,6 @@
 package cucumber.runtime;
 
+import cucumber.runtime.snippets.FunctionNameSanitizer;
 import gherkin.formatter.model.Step;
 
 import java.util.List;
@@ -27,5 +28,5 @@ public interface Backend {
      */
     void disposeWorld();
 
-    String getSnippet(Step step);
+    String getSnippet(Step step, FunctionNameSanitizer functionNameSanitizer);
 }

core/src/main/java/cucumber/runtime/Runtime.java

@@ -10,11 +10,22 @@
 import gherkin.formatter.Argument;
 import gherkin.formatter.Formatter;
 import gherkin.formatter.Reporter;
-import gherkin.formatter.model.*;
+import gherkin.formatter.model.Comment;
+import gherkin.formatter.model.DataTableRow;
+import gherkin.formatter.model.DocString;
+import gherkin.formatter.model.Match;
+import gherkin.formatter.model.Result;
+import gherkin.formatter.model.Step;
+import gherkin.formatter.model.Tag;
 
 import java.io.IOException;
 import java.io.PrintStream;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
 
 /**
  * This is the main entry point for running Cucumber features.
@@ -57,7 +68,7 @@ public Runtime(ResourceLoader resourceLoader, ClassLoader classLoader, Collectio
     }
 
     public Runtime(ResourceLoader resourceLoader, ClassLoader classLoader, Collection<? extends Backend> backends,
-            RuntimeOptions runtimeOptions, RuntimeGlue optionalGlue) {
+                   RuntimeOptions runtimeOptions, RuntimeGlue optionalGlue) {
         if (backends.isEmpty()) {
             throw new CucumberException("No backends were found. Please make sure you have a backend module on your CLASSPATH.");
         }
@@ -162,7 +173,7 @@ private boolean hasErrors() {
     }
 
     public List<String> getSnippets() {
-        return undefinedStepsTracker.getSnippets(backends, runtimeOptions.getSnippetType());
+        return undefinedStepsTracker.getSnippets(backends, runtimeOptions.getSnippetType().getFunctionNameSanitizer());
     }
 
     public Glue getGlue() {

core/src/main/java/cucumber/runtime/RuntimeOptions.java

@@ -1,10 +1,12 @@
 package cucumber.runtime;
 
+import cucumber.api.SnippetType;
 import cucumber.runtime.formatter.ColorAware;
 import cucumber.runtime.formatter.FormatterFactory;
 import cucumber.runtime.formatter.StrictAware;
 import cucumber.runtime.io.ResourceLoader;
 import cucumber.runtime.model.CucumberFeature;
+import cucumber.runtime.snippets.FunctionNameSanitizer;
 import gherkin.formatter.Formatter;
 import gherkin.formatter.Reporter;
 import gherkin.util.FixJava;
@@ -37,7 +39,7 @@ public class RuntimeOptions {
     private boolean dryRun;
     private boolean strict = false;
     private boolean monochrome = false;
-    private SnippetType snippet = SnippetType.getDefault();
+    private SnippetType snippetType = SnippetType.UNDERSCORE;
 
     public RuntimeOptions(Properties properties, String... argv) {
         /* IMPORTANT! Make sure USAGE.txt is always uptodate if this class changes */
@@ -100,7 +102,7 @@ private void parse(List<String> args) {
                 monochrome = !arg.startsWith("--no-");
             } else if (arg.equals("--snippets")) {
                 String nextArg = args.remove(0);
-                snippet = SnippetType.fromString(nextArg);
+                snippetType = SnippetType.fromString(nextArg);
             } else if (arg.equals("--name") || arg.equals("-n")) {
                 String nextArg = args.remove(0);
                 Pattern patternFilter = Pattern.compile(nextArg);
@@ -208,6 +210,6 @@ public boolean isMonochrome() {
     }
 
     public SnippetType getSnippetType() {
-        return snippet;
+        return snippetType;
     }
 }

core/src/main/java/cucumber/runtime/SnippetType.java

@@ -1,5 +1,6 @@
 package cucumber.runtime;
 
+import cucumber.runtime.snippets.FunctionNameSanitizer;
 import gherkin.I18n;
 import gherkin.formatter.model.Step;
 
@@ -18,19 +19,17 @@ public void reset() {
     }
 
     /**
-     * @param backends what backends we want snippets for
+     * @param backends              what backends we want snippets for
+     * @param functionNameSanitizer responsible for generating method name
      * @return a list of code snippets that the developer can use to implement undefined steps.
      *         This should be displayed after a run.
      */
-    public List<String> getSnippets(Iterable<? extends Backend> backends, SnippetType type) {
+    public List<String> getSnippets(Iterable<? extends Backend> backends, FunctionNameSanitizer functionNameSanitizer) {
         // TODO: Convert "And" and "But" to the Given/When/Then keyword above in the Gherkin source.
         List<String> snippets = new ArrayList<String>();
         for (Step step : undefinedSteps) {
             for (Backend backend : backends) {
-                if(backend instanceof SnippetTypeAwareBackend) {
-                    ((SnippetTypeAwareBackend) backend).setSnippetType(type);
-                }
-                String snippet = backend.getSnippet(step);
+                String snippet = backend.getSnippet(step, functionNameSanitizer);
                 if (snippet == null) {
                     throw new NullPointerException("null snippet");
                 }
@@ -42,15 +41,6 @@ public List<String> getSnippets(Iterable<? extends Backend> backends, SnippetTyp
         return snippets;
     }
 
-    /**
-     * @param backends what backends we want snippets for
-     * @return a list of code snippets that the developer can use to implement undefined steps.
-     *         This should be displayed after a run.
-     */
-    public List<String> getSnippets(Iterable<? extends Backend> backends) {
-        return getSnippets(backends, SnippetType.getDefault());
-    }
-
     public void storeStepKeyword(Step step, I18n i18n) {
         String keyword = step.getKeyword();
         if (isGivenWhenThenKeyword(keyword, i18n)) {

core/src/main/java/cucumber/runtime/SnippetTypeAwareBackend.java

@@ -1,6 +1,4 @@
-package cucumber.runtime.java;
-
-import cucumber.runtime.snippets.FunctionNameSanitizer;
+package cucumber.runtime.snippets;
 
 public class CamelCaseFunctionNameSanitizer implements FunctionNameSanitizer {
 

core/src/main/java/cucumber/runtime/UndefinedStepsTracker.java

@@ -1,7 +1,6 @@
 package cucumber.runtime.snippets;
 
 import cucumber.api.DataTable;
-import cucumber.runtime.SnippetType;
 import gherkin.I18n;
 import gherkin.formatter.model.Step;
 
@@ -32,23 +31,16 @@ public class SnippetGenerator {
 
     private final Snippet snippet;
 
-    private FunctionNameSanitizer sanitizer;
-
     public SnippetGenerator(Snippet snippet) {
-        this(snippet, new UnderscoreFunctionNameSanitizer());
-    }
-
-    public SnippetGenerator(Snippet snippet, FunctionNameSanitizer sanitizer) {
         this.snippet = snippet;
-        this.sanitizer = sanitizer;
     }
 
-    public String getSnippet(Step step) {
+    public String getSnippet(Step step, FunctionNameSanitizer functionNameSanitizer) {
         return MessageFormat.format(
                 snippet.template(),
                 I18n.codeKeywordFor(step.getKeyword()),
                 snippet.escapePattern(patternFor(step.getName())),
-                functionName(step.getName()),
+                functionName(step.getName(), functionNameSanitizer),
                 snippet.arguments(argumentTypes(step)),
                 REGEXP_HINT,
                 step.getRows() == null ? "" : snippet.tableHint()
@@ -72,12 +64,15 @@ String patternFor(String stepName) {
         return "^" + pattern + "$";
     }
 
-    private String functionName(String name) {
+    private String functionName(String name, FunctionNameSanitizer functionNameSanitizer) {
+        if(functionNameSanitizer == null) {
+            return null;
+        }
         String functionName = name;
         for (ArgumentPattern argumentPattern : argumentPatterns()) {
             functionName = argumentPattern.replaceMatchesWithSpace(functionName);
         }
-        functionName = sanitizer.sanitizeFunctionName(functionName);
+        functionName = functionNameSanitizer.sanitizeFunctionName(functionName);
         return functionName;
     }
 

java/src/main/java/cucumber/runtime/java/CamelCaseFunctionNameSanitizer.java renamed to core/src/main/java/cucumber/runtime/snippets/CamelCaseFunctionNameSanitizer.java

@@ -11,7 +11,7 @@ Options:
     -d, --[no-]-dry-run                Skip execution of glue code.
     -m, --[no-]-monochrome             Don't colour terminal output.
     -s, --[no-]-strict                 Treat undefined and pending steps as errors.
-        --snippets                     Snippet type: underscore, camelcase
+        --snippets                     Snippet name: underscore, camelcase
         --dotcucumber PATH_OR_URL      Where to write out runtime information. PATH_OR_URL can be a file system
                                        path or a URL.
     -v, --version                      Print version.

core/src/main/java/cucumber/runtime/snippets/SnippetGenerator.java

@@ -1,5 +1,6 @@
 package cucumber.runtime;
 
+import cucumber.api.SnippetType;
 import org.junit.Test;
 
 import cucumber.runtime.formatter.ColorAware;