Feature: Custom parameter type registry

gclient/README.md

@@ -75,6 +75,31 @@ For ex. to get step from the py expression `@given(u'I do something')` we could
 ```
 After this, the current expression will be handled as `@given('I do something')`, so the extension would be able to get `'I do something'` step. 
 
+**`cucumberautocomplete.parameterTypeRegistryPath`** - Set a path to an exported parameterTypeRegistry from cucumber-expressions.
+Example registry 
+```
+const { ParameterTypeRegistry, ParameterType } = require('cucumber-expressions');
+
+class Color {
+  constructor(name) {
+    this.name = `${name} color`;
+  }
+}
+
+const registry = new ParameterTypeRegistry();
+
+registry.defineParameterType(
+  new ParameterType(
+    'color', // name
+    /red|blue|yellow/, // regexp
+    Color, // type
+    name => new Color(name) // transformer function
+  )
+);
+
+module.exports = registry;
+```
+
 **`cucumberautocomplete.pages`** - Object, which consists of 'page name' => 'page object file path' pairs
 It is allowing to handle some very specific case of page objects usage in the gherkin steps.
 
@@ -150,6 +175,7 @@ By default, all the `' ' "` symbols will be used do define start and the end of
             "value":"a"
         },
     ],
+    "cucumberautocomplete.parameterTypeRegistryPath": "test/features/support/parameterTypeRegistry.js"
     "cucumberautocomplete.pages": {
         "users": "test/features/page_objects/users.storage.js",
         "pathes": "test/features/page_objects/pathes.storage.js",

gclient/package.json

@@ -128,6 +128,12 @@
                     "required": false,
                     "default": []
                 },
+                "cucumberautocomplete.parameterTypeRegistryPath": {
+                    "description": "Path to a ParameterTypeRegistry of custom parameters created from the cucumber-expressions library",
+                    "type": "string",
+                    "required": false,
+                    "default": null
+                },
                 "cucumberautocomplete.skipDocStringsFormat": {
                     "description": "Skip format of strings, that placed between ''' or \"\"\" strings",
                     "type": "boolean",

gserver/package.json

@@ -7,17 +7,18 @@
     "node": "*"
   },
   "dependencies": {
+    "doctrine": "^2.1.0",
     "glob": "^7.1.1",
     "md5": "^2.2.1",
     "strip-comments": "^0.4.4",
-    "vscode-languageserver": "^3.5.0",
-    "doctrine": "^2.1.0"
+    "vscode-languageserver": "^3.5.0"
   },
   "devDependencies": {
     "@types/chai": "^3.4.34",
     "@types/mocha": "^2.2.39",
     "@types/node": "^6.0.52",
     "chai": "^3.5.0",
+    "cucumber-expressions": "^8.3.0",
     "mocha": "^3.2.0",
     "ts-node": "^2.0.0",
     "tslint": "^4.2.0",

gserver/src/steps.handler.ts

@@ -5,7 +5,8 @@ import {
     getMD5Id,
     escapeRegExp,
     getTextRange,
-    getSortPrefix
+    getSortPrefix,
+    getUncachedFileModule
 } from './util';
 
 import {
@@ -49,6 +50,19 @@ interface JSDocComments {
     [key: number]: string
 }
 
+interface ParameterType<T> {
+    name: string,
+    regexpStrings: RegExp[] | string[],
+    transform: (...match: string[]) => T,
+    useForSnippets: boolean,
+    preferForRegexpMatch: boolean
+}
+
+
+interface ParameterTypeRegistry {
+    parameterTypeByName: Map<string, ParameterType<any>>,
+}
+
 const commentParser = require('doctrine');
 
 export default class StepsHandler {
@@ -61,6 +75,8 @@ export default class StepsHandler {
 
     settings: Settings;
 
+    parameterTypeRegistry: ParameterTypeRegistry;
+
     constructor(root: string, settings: Settings) {
         const { steps, syncfeatures } = settings.cucumberautocomplete;
         this.settings = settings;
@@ -72,6 +88,12 @@ export default class StepsHandler {
         }
     }
 
+    setParameterTypeRegistry() {
+        if (this.settings.cucumberautocomplete.parameterTypeRegistryPath) {
+            this.parameterTypeRegistry = getUncachedFileModule(this.settings.cucumberautocomplete.parameterTypeRegistryPath)
+        }
+    }
+
     getGherkinRegEx() {
         return new RegExp(`^(\\s*)(${allGherkinWords})(\\s+)(.*)`);
     }
@@ -188,10 +210,18 @@ export default class StepsHandler {
 
     handleCustomParameters(step: string): string {
         if (!step) return '';
+
+        if (this.parameterTypeRegistry && this.parameterTypeRegistry.parameterTypeByName) {
+            // Remove default cucumber-expression types
+            Array.from(this.parameterTypeRegistry.parameterTypeByName).slice(4).forEach(([key, _]) => {
+                step = step.split(`{${key}}`).join(`(${this.parameterTypeRegistry.parameterTypeByName.get(key).regexpStrings.join('|')})`);
+            })     
+        }
         this.settings.cucumberautocomplete.customParameters.forEach((p: CustomParameter) => {
             const { parameter, value } = p;
             step = step.split(parameter).join(value);
         });
+
         return step;
     }
 
@@ -474,6 +504,7 @@ export default class StepsHandler {
 
     populate(root: string, stepsPathes: StepSettings): void {
         this.elementsHash = {};
+        this.setParameterTypeRegistry();
         this.elements = stepsPathes
             .reduce((files, path) => files.concat(glob.sync(root + '/' + path, { ignore: '.gitignore' })), [])
             .reduce((elements, f) => elements.concat(

gserver/src/typings.d.ts

@@ -23,10 +23,11 @@ interface Settings {
         smartSnippets?: boolean,
         stepsInvariants?: boolean,
         customParameters?: CustomParameter[],
+        parameterTypeRegistryPath?: string,
         skipDocStringsFormat?: boolean,
         formatConfOverride?: FormatConf[],
         onTypeFormat?: boolean,
         gherkinDefinitionPart?: string,
-        stepRegExSymbol?: string
+        stepRegExSymbol?: string,
     }
 }

gserver/src/util.ts

@@ -13,6 +13,18 @@ export function getOSPath(path: string): string {
     }
 }
 
+function requireUncached(module) {
+    delete require.cache[require.resolve(module)];
+    return require(module);
+}
+
+export function getUncachedFileModule(filePath: string) {
+    try {
+      return requireUncached(filePath).default;
+    } catch (err) {
+    }
+}
+
 export function getFileContent(filePath: string): string {
     try {
         return fs.readFileSync(filePath, 'utf8');

gserver/test/data/parameterRegistry/parameterRegistry.js

@@ -0,0 +1,40 @@
+const { ParameterTypeRegistry, ParameterType } = require('cucumber-expressions');
+
+const DictionaryParam = {
+  EntryOne: '[a-zA-Z0-9_-]+ dictionary',
+  EntryTwo: '"[^"]*"',
+}
+
+const registry = new ParameterTypeRegistry()
+
+registry.defineParameterType(
+  new ParameterType(
+    'dictionaryObject',
+    new RegExp(Object.values(DictionaryParam).join('|')),
+    null,
+    (arg) => arg,
+    true,
+    false
+  )
+)
+
+
+registry.defineParameterType(
+  new ParameterType(
+    '/\{a.*\}/',
+    'aa',
+    null,
+    (arg) => arg,
+    true,
+    false
+  )
+)
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = registry;
+exports.default = _default;

gserver/test/steps.handler.spec.ts

@@ -19,7 +19,8 @@ const settings = {
                 parameter: /\{a.*\}/,
                 value: 'aa'
             }
-        ]
+        ],
+        parameterTypeRegistryPath: ''
     }
 };
 
@@ -131,8 +132,21 @@ describe('handleCustomParameters', () => {
             ['I use ${dictionaryObject} and ${dictionaryObject}',
             'I use ([a-zA-Z0-9_-]+ dictionary|"[^"]*") and ([a-zA-Z0-9_-]+ dictionary|"[^"]*")'],
             ['I use {aTest} parameter', 'I use aa parameter'],
-            ['I use {bTest} parameter', 'I use {bTest} parameter'],
-        ];
+            ['I use {bTest} parameter', 'I use {bTest} parameter'],        ];
+        data.forEach(d => {
+            expect(s.handleCustomParameters(d[0])).to.be.equal(d[1]);
+        });
+    });
+});
+
+describe('handleCustomParametersFromRegistry', () => {
+    it('should correctly change cucumber parameters from a provided registry', () => {
+        settings.cucumberautocomplete.parameterTypeRegistryPath = `${__dirname}/data/parameterRegistry/parameterRegistry`
+        const data = [
+            ['I use ${dictionaryObject} and ${dictionaryObject}',
+            'I use ([a-zA-Z0-9_-]+ dictionary|"[^"]*") and ([a-zA-Z0-9_-]+ dictionary|"[^"]*")'],
+            ['I use {aTest} parameter', 'I use aa parameter'],
+            ['I use {bTest} parameter', 'I use {bTest} parameter'],        ];
         data.forEach(d => {
             expect(s.handleCustomParameters(d[0])).to.be.equal(d[1]);
         });
@@ -438,3 +452,4 @@ describe('gherkin regex step start', () => {
         expect(elements[0].text).to.be.eq('I test quotes step');
     });
 });
+

gserver/yarn.lock

@@ -2,6 +2,14 @@
 # yarn lockfile v1
 
 
+"@babel/runtime-corejs3@^7.12.1":
+  version "7.12.5"
+  resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.12.5.tgz#ffee91da0eb4c6dae080774e94ba606368e414f4"
+  integrity sha512-roGr54CsTmNPPzZoCP1AmDXuBoNao7tnSA83TXTwt+UK5QVyh1DIJnrgYRPWKCF2flqZQXwa7Yr8v7VmLzF0YQ==
+  dependencies:
+    core-js-pure "^3.0.0"
+    regenerator-runtime "^0.13.4"
+
 "@types/chai@^3.4.34":
   version "3.5.2"
   resolved "https://registry.yarnpkg.com/@types/chai/-/chai-3.5.2.tgz#c11cd2817d3a401b7ba0f5a420f35c56139b1c1e"
@@ -116,6 +124,11 @@ bcrypt-pbkdf@^1.0.0:
   dependencies:
     tweetnacl "^0.14.3"
 
+becke-ch--regex--s0-0-v1--base--pl--lib@^1.4.0:
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/becke-ch--regex--s0-0-v1--base--pl--lib/-/becke-ch--regex--s0-0-v1--base--pl--lib-1.4.0.tgz#429ceebbfa5f7e936e78d73fbdc7da7162b20e20"
+  integrity sha1-Qpzuu/pffpNueNc/vcfacWKyDiA=
+
 beeper@^1.0.0:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/beeper/-/beeper-1.1.1.tgz#e6d5ea8c5dad001304a70b22638447f69cb2f809"
@@ -290,6 +303,11 @@ convert-source-map@^1.5.0:
   dependencies:
     safe-buffer "~5.1.1"
 
+core-js-pure@^3.0.0:
+  version "3.7.0"
+  resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.7.0.tgz#28a57c861d5698e053f0ff36905f7a3301b4191e"
+  integrity sha512-EZD2ckZysv8MMt4J6HSvS9K2GdtlZtdBncKAmF9lr2n0c9dJUaUN88PSTjvgwCgQPWKTkERXITgS6JJRAnljtg==
+
 core-util-is@1.0.2, core-util-is@~1.0.0:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.2.tgz#b5fd54220aa2bc5ab57aab7140c940754503c1a7"
@@ -316,6 +334,14 @@ crypto-random-string@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/crypto-random-string/-/crypto-random-string-1.0.0.tgz#a230f64f568310e1498009940790ec99545bca7e"
 
+cucumber-expressions@^8.3.0:
+  version "8.3.0"
+  resolved "https://registry.yarnpkg.com/cucumber-expressions/-/cucumber-expressions-8.3.0.tgz#67f48307dc8f53540c7f3530ad7b744aa918dd5c"
+  integrity sha512-cP2ya0EiorwXBC7Ll7Cj7NELYbasNv9Ty42L4u7sso9KruWemWG1ZiTq4PMqir3SNDSrbykoqI5wZgMbLEDjLQ==
+  dependencies:
+    becke-ch--regex--s0-0-v1--base--pl--lib "^1.4.0"
+    xregexp "^4.2.4"
+
 dashdash@^1.12.0:
   version "1.14.1"
   resolved "https://registry.yarnpkg.com/dashdash/-/dashdash-1.14.1.tgz#853cfa0f7cbe2fed5de20326b8dd581035f6e2f0"
@@ -1560,6 +1586,11 @@ readable-stream@~1.1.9:
     isarray "0.0.1"
     string_decoder "~0.10.x"
 
+regenerator-runtime@^0.13.4:
+  version "0.13.7"
+  resolved "https://registry.yarnpkg.com/regenerator-runtime/-/regenerator-runtime-0.13.7.tgz#cac2dacc8a1ea675feaabaeb8ae833898ae46f55"
+  integrity sha512-a54FxoJDIr27pgf7IgeQGxmqUNYrcV338lf/6gH456HZ/PhX+5BcwHXG9ajESmwe6WRO0tAzRUrRmNONWgkrew==
+
 registry-auth-token@^3.0.1:
   version "3.3.1"
   resolved "https://registry.yarnpkg.com/registry-auth-token/-/registry-auth-token-3.3.1.tgz#fb0d3289ee0d9ada2cbb52af5dfe66cb070d3006"
@@ -2216,6 +2247,13 @@ xdg-basedir@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/xdg-basedir/-/xdg-basedir-3.0.0.tgz#496b2cc109eca8dbacfe2dc72b603c17c5870ad4"
 
+xregexp@^4.2.4:
+  version "4.4.0"
+  resolved "https://registry.yarnpkg.com/xregexp/-/xregexp-4.4.0.tgz#29660f5d6567cd2ef981dd4a50cb05d22c10719d"
+  integrity sha512-83y4aa8o8o4NZe+L+46wpa+F1cWR/wCGOWI3tzqUso0w3/KAvXy0+Di7Oe/cbNMixDR4Jmi7NEybWU6ps25Wkg==
+  dependencies:
+    "@babel/runtime-corejs3" "^7.12.1"
+
 "xtend@>=4.0.0 <4.1.0-0", xtend@^4.0.0, xtend@~4.0.0, xtend@~4.0.1:
   version "4.0.1"
   resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.1.tgz#a5c6d532be656e23db820efb943a1f04998d63af"