vitest-cucumber-plugin 0.1.7 → 0.1.8

package/README.md

@@ -111,5 +111,4 @@ work, but this configuration isn't tested.
 ### Not yet implemented
 
 This plugin is not yet feature complete.  Here is the list of features from Cucumber which aren't yet implemented:
-* Rule keyword
 * Doc strings

package/RELEASE_NOTES.md

@@ -1,3 +1,4 @@
+* v0.1.8 : Implemented Rule keyword
 * v0.1.7 : Implemented Hooks API
 * v0.1.6 : Implemented tags boolean expression support
 * v0.1.5 : Implemented escape characters for Data Tables

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vitest-cucumber-plugin",
-    "version": "0.1.7",
+    "version": "0.1.8",
     "description": "Plugin for Vitest which allows for tests to be written in Cucumber format.",
     "keywords": [
         "vite",

package/src/generate/feature.js

@@ -1,6 +1,6 @@
 import _ from 'lodash/fp.js';
 import { log } from '../logger.js';
-import { generateExample, generateScenarioOutline } from './index.js';
+import { generateExample, generateScenarioOutline, generateRule } from './index.js';
 import { escape, shouldSkip } from './util.js';
 
 export const generateFeature = (config,feature) => {
@@ -18,6 +18,8 @@ export const generateFeature = (config,feature) => {
             return testStatements + generateExample(config,statement);
         } else if (statement.type.type === 'scenarioOutline') {
             return testStatements + generateScenarioOutline(config,statement);
+        } else if (statement.type.type === 'rule') {
+            return testStatements + generateRule(config,statement);
         }
     },'')(statements);
 

package/src/generate/index.js

@@ -3,11 +3,13 @@ import { generateExample } from './example.js';
 import { generateExamples } from './examples.js';
 import { generateScenarioOutline } from './scenario-outline.js';
 import { generateFeature } from './feature.js';
+import { generateRule } from './rule.js';
 
 export {
     generateTests,
     generateExample,
     generateExamples,
     generateScenarioOutline,
-    generateFeature
+    generateFeature,
+    generateRule,
 };

package/src/generate/rule.js

@@ -0,0 +1,22 @@
+import _ from 'lodash/fp.js';
+import { generateExample } from './index.js';
+import { escape, shouldSkip } from './util.js';
+import { log } from '../logger.js';
+
+export const generateRule = (config,rule) => {
+    log.debug('generateRule config: '+JSON.stringify(config)+' rule: '+JSON.stringify(rule));
+    
+    const examplesCode = _.reduce((examplesCode,example) => {
+        return examplesCode + generateExample(config,example);
+    },'')(rule.examples);
+
+    const skip = shouldSkip(config,rule.tags) ? '.skip' : '';
+    const tagsStr = JSON.stringify(rule.tags);
+
+    const code = `  // tags : ${tagsStr}
+  describe${skip}('${escape(rule.type.name)}: ${escape(rule.name)}', () => {
+${examplesCode}});
+`;
+
+    return code;
+}

package/src/gherkin.js

@@ -34,6 +34,7 @@ var gherkin_umd$1 = {exports: {}};
 	      step : ['Given','When','Then','And','But'],
 	      example : ['Example','Scenario'],
 	      background : 'Background',
+	      rule : 'Rule',
 	    }),
 	  },
 	});
@@ -61,6 +62,7 @@ var gherkin_umd$1 = {exports: {}};
 	        },
 	    {"name": "statement", "symbols": ["example"], "postprocess": data => data[0]},
 	    {"name": "statement", "symbols": ["scenarioOutline"], "postprocess": data => data[0]},
+	    {"name": "statement", "symbols": ["rule"], "postprocess": data => data[0]},
 	    {"name": "statements", "symbols": [], "postprocess": data => []},
 	    {"name": "statements", "symbols": ["statements", "statement"], "postprocess": data => fp.concat(data[0],data[1])},
 	    {"name": "example", "symbols": ["tags", "exampleStatement", "steps"], "postprocess": (data) => fp.assign(data[1],{ tags : data[0], steps : data[2] })},
@@ -68,6 +70,8 @@ var gherkin_umd$1 = {exports: {}};
 	        (data) => { return { type : { type : 'example', name : data[1] }, name : data[4].trim() } }
 	        },
 	    {"name": "exampleKeyword", "symbols": [(lexer.has("example") ? {type: "example"} : example)], "postprocess": data => data[0].value},
+	    {"name": "exampleList", "symbols": [], "postprocess": data => []},
+	    {"name": "exampleList", "symbols": ["exampleList", "example"], "postprocess": data => fp.concat(data[0],data[1])},
 	    {"name": "scenarioOutline", "symbols": ["tags", "scenarioOutlineStatement", "steps", "examplesList"], "postprocess": 
 	        data => fp.assign(data[1],{ tags : data[0], steps : data[2], examples : data[3] })
 	        },
@@ -75,6 +79,13 @@ var gherkin_umd$1 = {exports: {}};
 	        (data) => { return { type : { type : 'scenarioOutline', name : data[1] }, name : data[4].trim() } }
 	        },
 	    {"name": "scenarioOutlineKeyword", "symbols": [(lexer.has("scenarioOutline") ? {type: "scenarioOutline"} : scenarioOutline)], "postprocess": data => data[0].value},
+	    {"name": "rule", "symbols": ["tags", "ruleStatement", "example", "exampleList"], "postprocess": 
+	        data => fp.assign(data[1],{ tags : data[0], examples : fp.concat(data[2],data[3]) })
+	        },
+	    {"name": "ruleStatement", "symbols": ["_", "ruleKeyword", "_", (lexer.has("colon") ? {type: "colon"} : colon), "text", (lexer.has("newline") ? {type: "newline"} : newline)], "postprocess": 
+	        (data) => { return { type : { type : 'rule', name : data[1] }, name : data[4].trim() } }
+	        },
+	    {"name": "ruleKeyword", "symbols": [(lexer.has("rule") ? {type: "rule"} : rule)], "postprocess": data => data[0].value},
 	    {"name": "examplesList", "symbols": [], "postprocess": data => []},
 	    {"name": "examplesList", "symbols": ["examplesList", "examples"], "postprocess": data => fp.concat(data[0],data[1])},
 	    {"name": "examples", "symbols": ["tags", "examplesStatement", "dataTable", "emptyLines"], "postprocess": 

package/src/gherkin.ne

@@ -21,6 +21,7 @@ const lexer = moo.compile({
       step : ['Given','When','Then','And','But'],
       example : ['Example','Scenario'],
       background : 'Background',
+      rule : 'Rule',
     }),
   },
 });
@@ -56,6 +57,7 @@ backgroundStatement -> _ %background _ %colon text %newline {%
 
 statement -> example {% data => data[0] %}
   | scenarioOutline {% data => data[0] %}
+  | rule {% data => data[0] %}
 
 statements -> null {% data => [] %}
   | statements statement {% data => fp.concat(data[0],data[1]) %}
@@ -66,6 +68,9 @@ exampleStatement -> _ exampleKeyword _ %colon text %newline {%
 %}
 exampleKeyword -> %example {% data => data[0].value %}
 
+exampleList -> null {% data => [] %}
+  | exampleList example {% data => fp.concat(data[0],data[1]) %}
+
 scenarioOutline -> tags scenarioOutlineStatement steps examplesList {%
   data => fp.assign(data[1],{ tags : data[0], steps : data[2], examples : data[3] })
 %}
@@ -74,6 +79,14 @@ scenarioOutlineStatement -> _ scenarioOutlineKeyword _ %colon text %newline {%
 %}
 scenarioOutlineKeyword -> %scenarioOutline {% data => data[0].value %}
 
+rule -> tags ruleStatement example exampleList {%
+  data => fp.assign(data[1],{ tags : data[0], examples : fp.concat(data[2],data[3]) })
+%}
+ruleStatement -> _ ruleKeyword  _ %colon text %newline {%
+  (data) => { return { type : { type : 'rule', name : data[1] }, name : data[4].trim() } }
+%}
+ruleKeyword -> %rule {% data => data[0].value %}
+
 examplesList -> null {% data => [] %}
   | examplesList examples {% data => fp.concat(data[0],data[1]) %}
 

package/src/gherkin.umd.js

@@ -25,6 +25,7 @@ const lexer = moo.compile({
       step : ['Given','When','Then','And','But'],
       example : ['Example','Scenario'],
       background : 'Background',
+      rule : 'Rule',
     }),
   },
 });
@@ -52,6 +53,7 @@ var grammar = {
         },
     {"name": "statement", "symbols": ["example"], "postprocess": data => data[0]},
     {"name": "statement", "symbols": ["scenarioOutline"], "postprocess": data => data[0]},
+    {"name": "statement", "symbols": ["rule"], "postprocess": data => data[0]},
     {"name": "statements", "symbols": [], "postprocess": data => []},
     {"name": "statements", "symbols": ["statements", "statement"], "postprocess": data => fp.concat(data[0],data[1])},
     {"name": "example", "symbols": ["tags", "exampleStatement", "steps"], "postprocess": (data) => fp.assign(data[1],{ tags : data[0], steps : data[2] })},
@@ -59,6 +61,8 @@ var grammar = {
         (data) => { return { type : { type : 'example', name : data[1] }, name : data[4].trim() } }
         },
     {"name": "exampleKeyword", "symbols": [(lexer.has("example") ? {type: "example"} : example)], "postprocess": data => data[0].value},
+    {"name": "exampleList", "symbols": [], "postprocess": data => []},
+    {"name": "exampleList", "symbols": ["exampleList", "example"], "postprocess": data => fp.concat(data[0],data[1])},
     {"name": "scenarioOutline", "symbols": ["tags", "scenarioOutlineStatement", "steps", "examplesList"], "postprocess": 
         data => fp.assign(data[1],{ tags : data[0], steps : data[2], examples : data[3] })
         },
@@ -66,6 +70,13 @@ var grammar = {
         (data) => { return { type : { type : 'scenarioOutline', name : data[1] }, name : data[4].trim() } }
         },
     {"name": "scenarioOutlineKeyword", "symbols": [(lexer.has("scenarioOutline") ? {type: "scenarioOutline"} : scenarioOutline)], "postprocess": data => data[0].value},
+    {"name": "rule", "symbols": ["tags", "ruleStatement", "example", "exampleList"], "postprocess": 
+        data => fp.assign(data[1],{ tags : data[0], examples : fp.concat(data[2],data[3]) })
+        },
+    {"name": "ruleStatement", "symbols": ["_", "ruleKeyword", "_", (lexer.has("colon") ? {type: "colon"} : colon), "text", (lexer.has("newline") ? {type: "newline"} : newline)], "postprocess": 
+        (data) => { return { type : { type : 'rule', name : data[1] }, name : data[4].trim() } }
+        },
+    {"name": "ruleKeyword", "symbols": [(lexer.has("rule") ? {type: "rule"} : rule)], "postprocess": data => data[0].value},
     {"name": "examplesList", "symbols": [], "postprocess": data => []},
     {"name": "examplesList", "symbols": ["examplesList", "examples"], "postprocess": data => fp.concat(data[0],data[1])},
     {"name": "examples", "symbols": ["tags", "examplesStatement", "dataTable", "emptyLines"], "postprocess": 

package/tests/rule/features/rule.feature

@@ -0,0 +1,14 @@
+Feature: Is it Friday yet?
+  Everybody wants to know when it's Friday
+
+  Rule: The Sunday case
+    Scenario: Sunday isn't Friday
+      Given today is Sunday
+      When I ask whether it's Friday yet
+      Then I should be told "Nope"
+
+  Rule: The Friday case
+    Scenario: Friday is Friday
+      Given today is Friday
+      When I ask whether it's Friday yet
+      Then I should be told "TGIF"

package/tests/rule/features/step_definitions/stepdefs.js

@@ -0,0 +1,19 @@
+import { Given, When, Then } from 'vitest-cucumber-plugin';
+import _ from 'lodash/fp.js';
+import { expect } from 'vitest'
+
+Given('today is Sunday', function () {
+    return { today : 'Sunday' };
+});
+
+Given('today is Friday', function () {
+    return { today : 'Friday' };
+});
+
+When('I ask whether it\'s Friday yet', function (state) {
+    return _.set('answer',(state.today === 'Friday') ? 'TGIF' : 'Nope',state);
+});
+
+Then('I should be told {string}', function (state,[ answer ]) {
+    expect(state.answer).toBe(answer);
+});