added capability to define Template (#247)

Author: AlexGalichenko

CHANGELOG.MD

@@ -10,6 +10,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :pencil: - chore  
 :microscope: - experimental
 
+## [Unreleased]
+- :microscope: added capability to define `Template`
+
 ## 2.3.0
 - :microscope: added capability to define `Fixture`
 ```typescript

README.MD

@@ -154,4 +154,16 @@ Feature: feature with fixture
     When I click 'qavajs T-shirt'
     And I click 'cart icon'
     Then I expect 'qavajs T-shirt cart item' to be visible
+```
+
+### Template
+`Template` provides a way to define step definition using Gherkin language
+
+```typescript
+import { When, Template } from '@qavajs/core';
+
+When('I click {string} and verify {string}', Template((locator, expected) => `
+    I click '${locator}'
+    I expect '${locator} > Value' to equal '${expected}'
+`));
 ```

index.d.ts

@@ -3,6 +3,7 @@ import { DataTable, IWorld, When } from '@cucumber/cucumber';
 import { IConfiguration, IRunResult } from '@cucumber/cucumber/api';
 export const Override: typeof When;
 export { Fixture } from 'src/Fixture';
+export { Template } from 'src/Template';
 
 /**
  * Validation function

index.js

@@ -1,9 +1,11 @@
 const cucumber = require('@cucumber/cucumber');
 const { Override } = require('./lib/Override');
 const { Fixture } = require('./lib/Fixture');
+const { Template } = require('./lib/Template');
 
 module.exports = {
     ...cucumber,
     Override,
-    Fixture
+    Fixture,
+    Template
 }

index.mjs

@@ -1,3 +1,4 @@
 export { Override } from './lib/Override.js';
 export { Fixture } from './lib/Fixture.js';
+export { Template } from './lib/Template.js';
 export * from '@cucumber/cucumber';

src/Template.ts

@@ -0,0 +1,14 @@
+export function Template(scenario: (...args: any[]) => string) {
+    return new Proxy(scenario, {
+        apply: async function (template, world, args) {
+            const scenario = template(...args) as string;
+            const steps = scenario
+                .split('\n')
+                .map(step => step.trim())
+                .filter(step => step);
+            for (const step of steps) {
+                await world.executeStep(step);
+            }
+        },
+    })
+}

test-e2e/cjs/step_definitions/custom.js

@@ -1,4 +1,4 @@
-const { Override, Fixture, When, DataTable } = require('../../../index');
+const { Template, Override, Fixture, When, DataTable } = require('../../../index');
 const { expect } = require('chai');
 
 Fixture('testFixture', async function() {
@@ -79,4 +79,9 @@ When('write {string} to {value} value', async function(value, key) {
 
 When('I expect {value} {validation} {value}', async function(value1, validate, value2) {
     validate(value1.value(), value2.value());
-});
+});
+
+When('I click {string} and verify {string}', Template((locator, expected) => `
+    I expect '${expected}' to equal '42'
+    I expect '42' to equal '${expected}'
+`));

test-e2e/esm/step_definitions/custom.js

@@ -1,4 +1,4 @@
-import { DataTable, When, Override, Fixture } from '../../../index.mjs';
+import { DataTable, When, Override, Fixture, Template } from '../../../index.mjs';
 import { expect } from 'chai';
 import moduleESM from '../../modules/module.mjs';
 import moduleCJS from '../../modules/module.cjs';
@@ -75,4 +75,9 @@ When('write {string} to {value} value', async function(value, key) {
 
 When('I expect {value} {validation} {value}', async function(value1, validate, value2) {
     validate(value1.value(), value2.value());
-});
+});
+
+When('I click {string} and verify {string}', Template((locator, expected) => `
+    I expect '${expected}' to equal '42'
+    I expect '42' to equal '${expected}'
+`));

test-e2e/ts/step_definitions/custom.ts

@@ -1,4 +1,13 @@
-import { DataTable, When, Override, Fixture, IQavajsWorld, Validation, MemoryValue } from '../../../index';
+import {
+    DataTable,
+    When,
+    Override,
+    Fixture,
+    IQavajsWorld,
+    Validation,
+    MemoryValue,
+    Template
+} from '../../../index';
 import { expect } from 'chai';
 //@ts-ignore
 import moduleCJS from '../../modules/module.cjs';
@@ -77,4 +86,9 @@ When('write {string} to {value} value', async function(value: string, key: Memor
 
 When('I expect {value} {validation} {value}', async function(value1: MemoryValue, validate: Validation, value2: MemoryValue) {
     validate(value1.value(), value2.value());
-});
+});
+
+When('I click {string} and verify {string}', Template((locator: string, expected: string) => `
+    I expect '${expected}' to equal '42'
+    I expect '42' to equal '${expected}'
+`));