added memory to world (#202)

* added memory to world
* made getValue as any

Author: AlexGalichenko

.github/workflows/npm-publish.yml

@@ -6,6 +6,8 @@ name: Node.js Package
 on:
   release:
     types: [created]
+    tags:
+      - '1*'
 
 jobs:
   publish-npm:

.github/workflows/pull-request.yml

@@ -4,6 +4,8 @@ on:
   pull_request:
     branches:
       - main
+      - v1
+      - v2
 
 jobs:
   unix:

CHANGELOG.MD

@@ -9,6 +9,10 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :x: - deprecation
 :pencil: - chore
 
+## 2.1.0
+- :rocket: added memory to world
+- :rocket: updated `world.getValue` and `world.setValue` to use bound memory
+
 ## 2.0.2
 - :beetle: fixed d.ts for new _MemoryValue_ and _Validation_ types
 

index.d.ts

@@ -63,7 +63,7 @@ export interface IQavajsWorld extends IWorld {
      * Get value from memory
      * @param {any} expression - expression to parse
      */
-    getValue(expression: any): Promise<any>;
+    getValue(expression: any): any;
 
     /**
      * Save value to memory

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/core",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "qavajs framework core",
   "scripts": {
     "build": "tsc",
@@ -26,22 +26,22 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@qavajs/memory": "^1.9.0",
+    "@qavajs/memory": "^1.10.0",
     "@qavajs/validation": "^0.10.0",
-    "@swc/core": "^1.7.36",
+    "@swc/core": "^1.7.40",
     "chalk": "^5.3.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@cucumber/cucumber": "^11.0.1",
-    "@types/node": "^22.7.6",
+    "@types/node": "^22.8.1",
     "@types/yargs": "^17.0.33",
-    "@vitest/coverage-v8": "^2.1.3",
-    "@vitest/ui": "^2.1.3",
-    "@types/chai": "^4.3.19",
+    "@vitest/coverage-v8": "^2.1.4",
+    "@vitest/ui": "^2.1.4",
+    "@types/chai": "^4.3.20",
     "chai": "^4.5.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.3"
+    "vitest": "^2.1.4"
   }
 }

package.json

@@ -1,4 +1,5 @@
 import { DataTable, IWorld } from '@cucumber/cucumber';
+import { Memory } from '@qavajs/memory';
 
 export interface Validation {
     (AR: any, ER: any): void;
@@ -7,9 +8,10 @@ export interface Validation {
 }
 
 export interface IQavajsWorld extends IWorld {
-    getValue(expression: string): Promise<any>;
+    getValue(expression: string): any;
     setValue(key: string, value: any): void;
     executeStep(step: string, extraParam?: DataTable | string): Promise<void>;
     validation(type: string): Validation;
+    memory: Memory;
     config: any;
 }

src/IQavajsWorld.ts

@@ -30,32 +30,32 @@ export async function executeStep(this: any, text: string, extraParam?: DataTabl
   }
 }
 
-function setValue(key: string, value: any): void {
-  memory.setValue(key, value);
+function setValue(this: IQavajsWorld, key: string, value: any): void {
+  this.memory.setValue(key, value);
 }
 
-async function getValue(expression: string): Promise<any> {
-  return memory.getValue(expression);
+function getValue(this: IQavajsWorld, expression: string): any {
+  return this.memory.getValue(expression);
 }
 
 export class MemoryValue {
-  constructor(public expression: string) {}
+  constructor(public world: IQavajsWorld, public expression: string) {}
 
   /**
    * Return resolved value
    * @example
    * url.value()
-   * @return Promise<any>
+   * @return any
    */
-  value() { return memory.getValue(this.expression) }
+  value() { return this.world.getValue(this.expression) }
 
   /**
    * Set value to memory with provided key
    * @param value any - value to set
    * @example
    * url.set('https://qavajs.github.io/')
    */
-  set(value: any): void { memory.setValue(this.expression, value); }
+  set(value: any): void { this.world.setValue(this.expression, value); }
 }
 
 function transformString(fn: (value: string) => any) {
@@ -68,7 +68,12 @@ function transformString(fn: (value: string) => any) {
 defineParameterType({
   name: 'value',
   regexp: /"([^"\\]*(\\.[^"\\]*)*)"|'([^'\\]*(\\.[^'\\]*)*)'/,
-  transformer: transformString(expression => new MemoryValue(expression)),
+  transformer: function(this: IQavajsWorld, s1, s2) {
+    const world = this;
+    return transformString(expression => {
+      return new MemoryValue(world, expression);
+    })(s1, s2)
+  }
 });
 
 defineParameterType({
@@ -96,6 +101,7 @@ Before({name: 'qavajs init'}, async function (this: IQavajsWorld, scenario) {
     memory.setLogger(this);
   }
   memory.register(Object.assign({}, ...memoryInstances, memoryValues));
+  this.memory = memory;
   this.executeStep = executeStep;
   this.getValue = getValue;
   this.setValue = setValue;

src/load.ts

@@ -1,7 +1,6 @@
 const { When, DataTable } = require('@cucumber/cucumber');
 const { Override } = require('../../../utils');
 const { expect } = require('chai');
-const memory = require('@qavajs/memory');
 
 When('I do test', async function() {});
 Override('I do test', async function() {
@@ -19,8 +18,8 @@ When('I verify that config loaded', async function() {
 });
 
 When('I verify that memory loaded', async function() {
-    expect(memory.getValue('$customValue')).to.equal('cjs');
-    expect(memory.getValue('$additionalValue')).to.equal(12);
+    expect(this.memory.getValue('$customValue')).to.equal('cjs');
+    expect(this.memory.getValue('$additionalValue')).to.equal(12);
 });
 
 When('I verify that memory is connected to qavajs world', async function() {
@@ -51,16 +50,16 @@ When('I execute composite step', async function () {
     await this.executeStep('Nested step "42"');
     const customDataTable = new DataTable([['1', '2', '3']])
     await this.executeStep('Data table step:', customDataTable);
-    expect(memory.getValue('$nestedValue')).to.equal('42');
-    expect(memory.getValue('$dataTable')).to.deep.equal({ rawTable: [['1', '2', '3']]});
+    expect(this.memory.getValue('$nestedValue')).to.equal('42');
+    expect(this.memory.getValue('$dataTable')).to.deep.equal({ rawTable: [['1', '2', '3']]});
 });
 
 When('Nested step {string}', async function(val) {
-    memory.setValue('nestedValue', val);
+    this.memory.setValue('nestedValue', val);
 });
 
 When('Data table step:', function (dataTable) {
-    memory.setValue('dataTable', dataTable);
+    this.memory.setValue('dataTable', dataTable);
 });
 
 When('Read memory {value} from cucumber type', async function(memoryValue) {
@@ -69,7 +68,7 @@ When('Read memory {value} from cucumber type', async function(memoryValue) {
 
 When('write {string} to {value} value', async function(value, key) {
     key.set(value);
-    expect(memory.getValue('$'+key.expression)).to.equal(value);
+    expect(this.memory.getValue('$'+key.expression)).to.equal(value);
 });
 
 When('I expect {string} {validation} {string}', async function(value1, validate, value2) {

test-e2e/cjs/step_definitions/custom.js

@@ -1,6 +1,5 @@
 import {DataTable, When} from '@cucumber/cucumber';
 import { expect } from 'chai';
-import memory from '@qavajs/memory';
 import {Override} from '../../../utils.js';
 import moduleESM from '../../modules/module.mjs';
 import moduleCJS from '../../modules/module.cjs';
@@ -22,8 +21,8 @@ When('I verify that config loaded', async function() {
 });
 
 When('I verify that memory loaded', async function() {
-    expect(memory.getValue('$customValue')).to.equal('esm');
-    expect(memory.getValue('$additionalValue')).to.equal(12);
+    expect(this.memory.getValue('$customValue')).to.equal('esm');
+    expect(this.memory.getValue('$additionalValue')).to.equal(12);
 });
 
 When('I verify that process env loaded', async function() {
@@ -47,16 +46,16 @@ When('I execute composite step', async function () {
     await this.executeStep('Nested step "42"');
     const customDataTable = new DataTable([['1', '2', '3']])
     await this.executeStep('Data table step:', customDataTable);
-    expect(memory.getValue('$nestedValue')).to.equal('42');
-    expect(memory.getValue('$dataTable')).to.deep.equal({ rawTable: [['1', '2', '3']]});
+    expect(this.memory.getValue('$nestedValue')).to.equal('42');
+    expect(this.memory.getValue('$dataTable')).to.deep.equal({ rawTable: [['1', '2', '3']]});
 });
 
 When('Nested step {string}', async function(val) {
-    memory.setValue('nestedValue', val);
+    this.memory.setValue('nestedValue', val);
 });
 
 When('Data table step:', function (dataTable) {
-    memory.setValue('dataTable', dataTable);
+    this.memory.setValue('dataTable', dataTable);
 });
 
 When('Read memory {value} from cucumber type', async function(memoryValue) {
@@ -65,7 +64,7 @@ When('Read memory {value} from cucumber type', async function(memoryValue) {
 
 When('write {string} to {value} value', async function(value, key) {
     key.set(value);
-    expect(memory.getValue('$'+key.expression)).to.equal(value);
+    expect(this.memory.getValue('$'+key.expression)).to.equal(value);
 });
 
 When('I expect {string} {validation} {string}', async function(value1, validate, value2) {