Upgrade to cucumber-expressions 3.0.0, rename addParameter to defineParameterType

Author: aslakhellesoy

features/custom_parameter.feature

@@ -17,9 +17,9 @@ Feature: Custom Parameter
       """
       import assert from 'assert'
       import {defineSupportCode} from 'cucumber'
-      defineSupportCode(({Given, addParameter}) => {
-        addParameter({
-          captureGroupRegexps: /passing|failing|undefined|pending/,
+      defineSupportCode(({Given, defineParameterType}) => {
+        defineParameterType({
+          regexp: /passing|failing|undefined|pending/,
           transformer: s => s.toUpperCase(),
           typeName: 'status'
         })
@@ -31,6 +31,24 @@ Feature: Custom Parameter
     When I run cucumber.js
     Then the step "a passing step" has status "passed"
 
+  Scenario: custom parameter without transformer
+    Given a file named "features/step_definitions/passing_steps.js" with:
+      """
+      import assert from 'assert'
+      import {defineSupportCode} from 'cucumber'
+      defineSupportCode(({Given, defineParameterType}) => {
+        defineParameterType({
+          regexp: /passing|failing|undefined|pending/,
+          typeName: 'status'
+        })
+        Given('a {status} step', function(status) {
+          assert.equal(status, 'passing')
+        })
+      })
+      """
+    When I run cucumber.js
+    Then the step "a passing step" has status "passed"
+
   Scenario: custom parameter (legacy API)
     Given a file named "features/step_definitions/passing_steps.js" with:
       """

package.json

@@ -121,7 +121,7 @@
     "cli-table": "^0.3.1",
     "colors": "^1.1.2",
     "commander": "^2.9.0",
-    "cucumber-expressions": "^2.0.1",
+    "cucumber-expressions": "^3.0.0",
     "cucumber-tag-expressions": "^1.0.0",
     "duration": "^0.2.0",
     "figures": "2.0.0",

src/formatter/builder.js

@@ -47,7 +47,7 @@ export default class FormatterBuilder {
     }
     return new StepDefinitionSnippetBuilder({
       snippetSyntax: new Syntax(snippetInterface),
-      parameterRegistry: supportCodeLibrary.parameterRegistry
+      parameterTypeRegistry: supportCodeLibrary.parameterTypeRegistry
     })
   }
 

src/formatter/step_definition_snippet_builder/index.js

@@ -5,9 +5,9 @@ import DocString from '../../models/step_arguments/doc_string'
 import KeywordType from '../../keyword_type'
 
 export default class StepDefinitionSnippetBuilder {
-  constructor({snippetSyntax, parameterRegistry}) {
+  constructor({snippetSyntax, parameterTypeRegistry}) {
     this.snippetSyntax = snippetSyntax
-    this.cucumberExpressionGenerator = new CucumberExpressionGenerator(parameterRegistry)
+    this.cucumberExpressionGenerator = new CucumberExpressionGenerator(parameterTypeRegistry)
   }
 
   build(step) {

src/formatter/step_definition_snippet_builder/index_spec.js

@@ -2,15 +2,15 @@ import DataTable from '../../models/step_arguments/data_table'
 import DocString from '../../models/step_arguments/doc_string'
 import KeywordType from '../../keyword_type'
 import StepDefinitionSnippetBuilder from './'
-import TransformLookupBuilder from '../../support_code_library/transform_lookup_builder'
+import TransformLookupBuilder from '../../support_code_library/parameter_type_registry_builder'
 
 describe('StepDefinitionSnippetBuilder', function () {
   beforeEach(function () {
     this.snippetSyntax = createMock(['build'])
     this.transformsLookup = TransformLookupBuilder.build()
     this.snippetBuilder = new StepDefinitionSnippetBuilder({
       snippetSyntax: this.snippetSyntax,
-      parameterRegistry: this.transformsLookup
+      parameterTypeRegistry: this.transformsLookup
     })
   })
 

src/models/step_definition.js

@@ -22,8 +22,8 @@ export default class StepDefinition {
     return this.buildInvalidCodeLengthMessage(parameters.length, parameters.length + 1)
   }
 
-  getInvocationParameters({step, parameterRegistry}) {
-    const cucumberExpression = this.getCucumberExpression(parameterRegistry)
+  getInvocationParameters({step, parameterTypeRegistry}) {
+    const cucumberExpression = this.getCucumberExpression(parameterTypeRegistry)
     const stepNameParameters = _.map(cucumberExpression.match(step.name), 'transformedValue')
     const stepArgumentParameters = step.arguments.map(function(arg) {
       if (arg instanceof DataTable) {
@@ -37,20 +37,20 @@ export default class StepDefinition {
     return stepNameParameters.concat(stepArgumentParameters)
   }
 
-  getCucumberExpression(parameterRegistry) {
+  getCucumberExpression(parameterTypeRegistry) {
     if (typeof(this.pattern) === 'string') {
-      return new CucumberExpression(this.pattern, [], parameterRegistry)
+      return new CucumberExpression(this.pattern, [], parameterTypeRegistry)
     } else {
-      return new RegularExpression(this.pattern, [], parameterRegistry)
+      return new RegularExpression(this.pattern, [], parameterTypeRegistry)
     }
   }
 
   getValidCodeLengths(parameters) {
     return [parameters.length, parameters.length + 1]
   }
 
-  matchesStepName({stepName, parameterRegistry}) {
-    const cucumberExpression = this.getCucumberExpression(parameterRegistry)
+  matchesStepName({stepName, parameterTypeRegistry}) {
+    const cucumberExpression = this.getCucumberExpression(parameterTypeRegistry)
     return Boolean(cucumberExpression.match(stepName))
   }
 }

src/runtime/scenario_runner.js

@@ -39,7 +39,7 @@ export default class ScenarioRunner {
       scenarioResult: this.scenarioResult,
       step,
       stepDefinition,
-      parameterRegistry: this.supportCodeLibrary.parameterRegistry,
+      parameterTypeRegistry: this.supportCodeLibrary.parameterTypeRegistry,
       world: this.world
     })
   }
@@ -103,7 +103,7 @@ export default class ScenarioRunner {
     const stepDefinitions = this.supportCodeLibrary.stepDefinitions.filter((stepDefinition) => {
       return stepDefinition.matchesStepName({
         stepName: step.name,
-        parameterRegistry: this.supportCodeLibrary.parameterRegistry
+        parameterTypeRegistry: this.supportCodeLibrary.parameterTypeRegistry
       })
     })
     if (stepDefinitions.length === 0) {

src/runtime/scenario_runner_spec.js

@@ -26,7 +26,7 @@ describe('ScenarioRunner', function () {
       beforeHookDefinitions: [],
       defaultTimeout: 5000,
       stepDefinitions: [],
-      parameterRegistry: {},
+      parameterTypeRegistry: {},
       World() {}
     }
     this.options = {}

src/runtime/step_runner.js

@@ -6,9 +6,9 @@ import UserCodeRunner from '../user_code_runner'
 
 const {beginTiming, endTiming} = Time
 
-async function run({attachmentManager, defaultTimeout, scenarioResult, step, stepDefinition, parameterRegistry, world}) {
+async function run({attachmentManager, defaultTimeout, scenarioResult, step, stepDefinition, parameterTypeRegistry, world}) {
   beginTiming()
-  const parameters = stepDefinition.getInvocationParameters({scenarioResult, step, parameterRegistry})
+  const parameters = stepDefinition.getInvocationParameters({scenarioResult, step, parameterTypeRegistry})
   const timeoutInMilliseconds = stepDefinition.options.timeout || defaultTimeout
 
   let error, result

src/support_code_library/builder.js

@@ -1,9 +1,8 @@
-import util from 'util'
 import _ from 'lodash'
 import arity from 'util-arity'
 import isGenerator from 'is-generator'
 import path from 'path'
-import TransformLookupBuilder from './transform_lookup_builder'
+import TransformLookupBuilder from './parameter_type_registry_builder'
 import * as helpers from './helpers'
 function build({cwd, fns}) {
   const options = {
@@ -12,16 +11,16 @@ function build({cwd, fns}) {
     defaultTimeout: 5000,
     listeners: [],
     stepDefinitions: [],
-    parameterRegistry: TransformLookupBuilder.build(),
+    parameterTypeRegistry: TransformLookupBuilder.build(),
     World({attach, parameters}) {
       this.attach = attach
       this.parameters = parameters
     }
   }
   let definitionFunctionWrapper = null
   const fnArgument = {
-    addParameter: helpers.addParameter(options.parameterRegistry),
-    addTransform: util.deprecate(helpers.addParameter(options.parameterRegistry), 'addTransform is deprecated and will be removed in a future version. Please use addParameter instead.'),
+    addTransform: helpers.addTransform(options.parameterTypeRegistry),
+    defineParameterType: helpers.defineParameterType(options.parameterTypeRegistry),
     After: helpers.defineHook(cwd, options.afterHookDefinitions),
     Before: helpers.defineHook(cwd, options.beforeHookDefinitions),
     defineStep: helpers.defineStep(cwd, options.stepDefinitions),

src/support_code_library/builder_spec.js

@@ -1,4 +1,4 @@
-import {ParameterRegistry} from 'cucumber-expressions'
+import {ParameterTypeRegistry} from 'cucumber-expressions'
 import SupportCodeLibraryBuilder from './builder'
 
 describe('SupportCodeLibraryBuilder', function () {
@@ -14,7 +14,7 @@ describe('SupportCodeLibraryBuilder', function () {
       expect(this.options.defaultTimeout).to.eql(5000)
       expect(this.options.listeners).to.eql([])
       expect(this.options.stepDefinitions).to.eql([])
-      expect(this.options.parameterRegistry).to.be.instanceOf(ParameterRegistry)
+      expect(this.options.parameterTypeRegistry).to.be.instanceOf(ParameterTypeRegistry)
       const worldInstance = new this.options.World({
         attach: this.attachFn,
         parameters: {some: 'data'}

src/support_code_library/helpers.js

@@ -1,5 +1,6 @@
+import util from 'util'
 import _ from 'lodash'
-import {Parameter} from 'cucumber-expressions'
+import {ParameterType} from 'cucumber-expressions'
 import {formatLocation} from '../formatter/utils'
 import HookDefinition from '../models/hook_definition'
 import path from 'path'
@@ -72,14 +73,26 @@ export function registerHandler(cwd, collection) {
   }
 }
 
-export function addParameter(parameterRegistry) {
-  return ({captureGroupRegexps, transformer, typeName}) => {
-    const parameter = new Parameter(
+export function addTransform(parameterTypeRegistry) {
+  return util.deprecate(({captureGroupRegexps, transformer, typeName}) => {
+    const parameter = new ParameterType(
       typeName,
-      function() {},
+      null,
       captureGroupRegexps,
       transformer
     )
-    parameterRegistry.addParameter(parameter)
+    parameterTypeRegistry.defineParameterType(parameter)
+  }, 'addTransform is deprecated and will be removed in a future version. Please use defineParameterType instead.')
+}
+
+export function defineParameterType(parameterTypeRegistry) {
+  return ({regexp, transformer, typeName}) => {
+    const parameter = new ParameterType(
+      typeName,
+      null,
+      regexp,
+      transformer
+    )
+    parameterTypeRegistry.defineParameterType(parameter)
   }
 }

src/support_code_library/parameter_type_registry_builder.js

@@ -0,0 +1,15 @@
+import {ParameterType, ParameterTypeRegistry} from 'cucumber-expressions'
+
+function build() {
+  const parameterTypeRegistry = new ParameterTypeRegistry()
+  const stringInDoubleQuotesParameterType = new ParameterType(
+    'stringInDoubleQuotes',
+    function() {},
+    '"[^"]*"',
+    JSON.parse
+  )
+  parameterTypeRegistry.defineParameterType(stringInDoubleQuotesParameterType)
+  return parameterTypeRegistry
+}
+
+export default {build}

src/support_code_library/transform_lookup_builder.js

@@ -1097,15 +1097,7 @@ [email protected]:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
 
-concat-stream@^1.4.6:
-  version "1.6.0"
-  resolved "https://registry.yarnpkg.com/concat-stream/-/concat-stream-1.6.0.tgz#0aac662fd52be78964d5532f694784e70110acf7"
-  dependencies:
-    inherits "^2.0.3"
-    readable-stream "^2.2.2"
-    typedarray "^0.0.6"
-
-concat-stream@~1.5.0, concat-stream@~1.5.1:
+concat-stream@^1.4.6, concat-stream@~1.5.0, concat-stream@~1.5.1:
   version "1.5.2"
   resolved "https://registry.yarnpkg.com/concat-stream/-/concat-stream-1.5.2.tgz#708978624d856af41a5a741defdd261da752c266"
   dependencies:
@@ -1203,9 +1195,9 @@ crypto-browserify@^3.0.0:
     public-encrypt "^4.0.0"
     randombytes "^2.0.0"
 
-cucumber-expressions@^1.0.3:
-  version "1.0.3"
-  resolved "https://registry.yarnpkg.com/cucumber-expressions/-/cucumber-expressions-1.0.3.tgz#ea96ab5600f441f192f1c90540555baa1ae83580"
+cucumber-expressions@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/cucumber-expressions/-/cucumber-expressions-3.0.0.tgz#4cf424813dae396cc9dab714b8104b459befc32c"
 
 cucumber-tag-expressions@^1.0.0:
   version "1.0.0"
@@ -1231,18 +1223,12 @@ debug-log@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/debug-log/-/debug-log-1.0.1.tgz#2307632d4c04382b8df8a32f70b895046d52745f"
 
-[email protected], debug@~2.2.0:
+[email protected], debug@^2.1.1, debug@^2.2.0, debug@~2.2.0:
   version "2.2.0"
   resolved "https://registry.yarnpkg.com/debug/-/debug-2.2.0.tgz#f87057e995b1a1f6ae6a4960664137bc56f039da"
   dependencies:
     ms "0.7.1"
 
-debug@^2.1.1, debug@^2.2.0:
-  version "2.6.0"
-  resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.0.tgz#bc596bcabe7617f11d9fa15361eded5608b8499b"
-  dependencies:
-    ms "0.7.2"
-
 decamelize@^1.0.0, decamelize@^1.1.1:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290"
@@ -2009,7 +1995,7 @@ inflight@^1.0.4:
     once "^1.3.0"
     wrappy "1"
 
-inherits@2, [email protected], inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.0, inherits@~2.0.1:
+inherits@2, [email protected], inherits@^2.0.1, inherits@~2.0.0, inherits@~2.0.1:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de"
 
@@ -2606,10 +2592,6 @@ [email protected]:
   version "0.7.1"
   resolved "https://registry.yarnpkg.com/ms/-/ms-0.7.1.tgz#9cd13c03adbff25b65effde7ce864ee952017098"
 
-[email protected]:
-  version "0.7.2"
-  resolved "https://registry.yarnpkg.com/ms/-/ms-0.7.2.tgz#ae25cf2512b3885a1d95d7f037868d8431124765"
-
 [email protected]:
   version "0.0.5"
   resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-0.0.5.tgz#8fbfabb0a98a253d3184331f9e8deb7372fac6c0"
@@ -3007,7 +2989,7 @@ read-pkg@^1.0.0:
     normalize-package-data "^2.3.2"
     path-type "^1.0.0"
 
-"readable-stream@^2.0.0 || ^1.1.13", readable-stream@^2.0.2, readable-stream@^2.1.0, readable-stream@^2.1.5, readable-stream@^2.2.2:
+"readable-stream@^2.0.0 || ^1.1.13", readable-stream@^2.0.2, readable-stream@^2.1.0, readable-stream@^2.1.5:
   version "2.2.2"
   resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.2.2.tgz#a9e6fec3c7dda85f8bb1b3ba7028604556fc825e"
   dependencies:
@@ -3663,7 +3645,7 @@ type-detect@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/type-detect/-/type-detect-1.0.0.tgz#762217cc06db258ec48908a1298e8b95121e8ea2"
 
-typedarray@^0.0.6, typedarray@~0.0.5:
+typedarray@~0.0.5:
   version "0.0.6"
   resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"