@serenity-js/core 3.1.3 → 3.1.5

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.1.5](https://github.com/serenity-js/serenity-js/compare/v3.1.4...v3.1.5) (2023-04-18)
+
+
+### Bug Fixes
+
+* **serenity-bdd:** improved support for nested requirement hierarchies with Cucumber.js ([749fb0f](https://github.com/serenity-js/serenity-js/commit/749fb0f9501575ac8152b01a980e4959a823471f)), closes [/github.com/serenity-bdd/serenity-core/blob/8f7d14c6dad47bb58a1585fef5f9d9a44bb963fd/serenity-model/src/main/java/net/thucydides/core/requirements/AbstractRequirementsTagProvider.java#L36](https://github.com//github.com/serenity-bdd/serenity-core/blob/8f7d14c6dad47bb58a1585fef5f9d9a44bb963fd/serenity-model/src/main/java/net/thucydides/core/requirements/AbstractRequirementsTagProvider.java/issues/L36) [#1649](https://github.com/serenity-js/serenity-js/issues/1649)
+
+
+
+
+
 ## [3.1.3](https://github.com/serenity-js/serenity-js/compare/v3.1.2...v3.1.3) (2023-04-14)
 
 **Note:** Version bump only for package @serenity-js/core

package/lib/model/tags/Tag.d.ts

@@ -5,6 +5,7 @@ import { JSONObject, TinyType } from 'tiny-types';
 export declare abstract class Tag extends TinyType {
     readonly name: string;
     readonly type: string;
+    static humanReadable(tagConstructor: new (name: string) => Tag, tagName: string): Tag;
     static fromJSON(o: JSONObject): Tag;
     protected constructor(name: string, type: string);
     toJSON(): {

package/lib/model/tags/Tag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Tag.d.ts","sourceRoot":"","sources":["../../../src/model/tags/Tag.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8C,UAAU,EAAY,QAAQ,EAAE,MAAM,YAAY,CAAC;AAIxG;;GAEG;AACH,8BAAsB,GAAI,SAAQ,QAAQ;aAaA,IAAI,EAAE,MAAM;aAAkB,IAAI,EAAE,MAAM;IAZhF,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,UAAU,GAAG,GAAG;IAYnC,SAAS,aAA6B,IAAI,EAAE,MAAM,EAAkB,IAAI,EAAE,MAAM;IAOhF,MAAM,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAG3C"}
+{"version":3,"file":"Tag.d.ts","sourceRoot":"","sources":["../../../src/model/tags/Tag.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8C,UAAU,EAAY,QAAQ,EAAE,MAAM,YAAY,CAAC;AAIxG;;GAEG;AACH,8BAAsB,GAAI,SAAQ,QAAQ;aA0BA,IAAI,EAAE,MAAM;aAAkB,IAAI,EAAE,MAAM;IAzBhF,MAAM,CAAC,aAAa,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,GAAG;IAarF,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,UAAU,GAAG,GAAG;IAYnC,SAAS,aAA6B,IAAI,EAAE,MAAM,EAAkB,IAAI,EAAE,MAAM;IAOhF,MAAM,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAG3C"}

package/lib/model/tags/Tag.js

@@ -30,6 +30,16 @@ const TagTypes = __importStar(require("./index"));
  * @access public
  */
 class Tag extends tiny_types_1.TinyType {
+    static humanReadable(tagConstructor, tagName) {
+        // based on https://github.com/serenity-bdd/serenity-core/blob/8f7d14c6dad47bb58a1585fef5f9d9a44bb963fd/serenity-model/src/main/java/net/thucydides/core/requirements/AbstractRequirementsTagProvider.java#L36
+        const name = String(tagName)
+            .trim()
+            .match(/[\dA-Z]{2,}(?=[A-Z][a-z]+\d*|\b)|[A-Z]?[a-z]+\d*|[A-Z]|\d+/g)
+            .map(chunk => /^[A-Z]+$/.test(chunk) ? chunk : chunk.toLowerCase())
+            .join('_')
+            .replace(/[\s_]+/g, ' ');
+        return new tagConstructor(name.charAt(0).toUpperCase() + name.slice(1));
+    }
     static fromJSON(o) {
         const type = (0, tiny_types_1.ensure)('serialised tag type', o.type, (0, tiny_types_1.isDefined)(), (0, tiny_types_1.isString)());
         const found = Object.keys(TagTypes).find(t => TagTypes[t].Type === type) || TagTypes.ArbitraryTag.name;

package/lib/model/tags/Tag.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tag.js","sourceRoot":"","sources":["../../../src/model/tags/Tag.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAwG;AAExG,kDAAoC;AAEpC;;GAEG;AACH,MAAsB,GAAI,SAAQ,qBAAQ;IACtC,MAAM,CAAC,QAAQ,CAAC,CAAa;QACzB,MAAM,IAAI,GAAW,IAAA,mBAAM,EAAC,qBAAqB,EAAE,CAAC,CAAC,IAAI,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,GAAE,CAAW,CAAC;QAE9F,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC;QAEvG,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,EAAE;YACnE,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SACtC;QAED,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,YAAsC,IAAY,EAAkB,IAAY;QAC5E,KAAK,EAAE,CAAC;QAD0B,SAAI,GAAJ,IAAI,CAAQ;QAAkB,SAAI,GAAJ,IAAI,CAAQ;QAG5E,IAAA,mBAAM,EAAC,UAAU,EAAE,IAAI,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,EAAC,QAAQ,EAAE,IAAA,0BAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5E,IAAA,mBAAM,EAAC,UAAU,EAAE,IAAI,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,EAAC,QAAQ,EAAE,IAAA,0BAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,MAAM;QACF,OAAO,KAAK,CAAC,MAAM,EAAoC,CAAC;IAC5D,CAAC;CACJ;AAvBD,kBAuBC"}
+{"version":3,"file":"Tag.js","sourceRoot":"","sources":["../../../src/model/tags/Tag.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAwG;AAExG,kDAAoC;AAEpC;;GAEG;AACH,MAAsB,GAAI,SAAQ,qBAAQ;IACtC,MAAM,CAAC,aAAa,CAAC,cAAyC,EAAE,OAAe;QAC3E,8MAA8M;QAC9M,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC;aACvB,IAAI,EAAE;aACN,KAAK,CAAC,6DAA6D,CAAC;aACpE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;aAClE,IAAI,CAAC,GAAG,CAAC;aACT,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAC3B;QAED,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,CAAa;QACzB,MAAM,IAAI,GAAW,IAAA,mBAAM,EAAC,qBAAqB,EAAE,CAAC,CAAC,IAAI,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,GAAE,CAAW,CAAC;QAE9F,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC;QAEvG,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,EAAE;YACnE,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SACtC;QAED,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,YAAsC,IAAY,EAAkB,IAAY;QAC5E,KAAK,EAAE,CAAC;QAD0B,SAAI,GAAJ,IAAI,CAAQ;QAAkB,SAAI,GAAJ,IAAI,CAAQ;QAG5E,IAAA,mBAAM,EAAC,UAAU,EAAE,IAAI,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,EAAC,QAAQ,EAAE,IAAA,0BAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5E,IAAA,mBAAM,EAAC,UAAU,EAAE,IAAI,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,EAAC,QAAQ,EAAE,IAAA,0BAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,MAAM;QACF,OAAO,KAAK,CAAC,MAAM,EAAoC,CAAC;IAC5D,CAAC;CACJ;AApCD,kBAoCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/core",
-  "version": "3.1.3",
+  "version": "3.1.5",
   "description": "Serenity/JS Screenplay, reporting engine and core interfaces.",
   "author": {
     "name": "Jan Molak",
@@ -71,5 +71,5 @@
     "node": "^14 || ^16 || ^18",
     "npm": "^6 || ^7 || ^8 || ^9"
   },
-  "gitHead": "6cabc4cb6e6f25411862c7375738b931012b6361"
+  "gitHead": "31f621a7c827e20ba07a86a2f7c77d941784bb0a"
 }

package/src/model/tags/Tag.ts

@@ -6,6 +6,19 @@ import * as TagTypes from './index';
  * @access public
  */
 export abstract class Tag extends TinyType {
+    static humanReadable(tagConstructor: new (name: string) => Tag, tagName: string): Tag {
+        // based on https://github.com/serenity-bdd/serenity-core/blob/8f7d14c6dad47bb58a1585fef5f9d9a44bb963fd/serenity-model/src/main/java/net/thucydides/core/requirements/AbstractRequirementsTagProvider.java#L36
+        const name = String(tagName)
+            .trim()
+            .match(/[\dA-Z]{2,}(?=[A-Z][a-z]+\d*|\b)|[A-Z]?[a-z]+\d*|[A-Z]|\d+/g)
+            .map(chunk => /^[A-Z]+$/.test(chunk) ? chunk : chunk.toLowerCase())
+            .join('_')
+            .replace(/[\s_]+/g, ' ')
+        ;
+
+        return new tagConstructor(name.charAt(0).toUpperCase() + name.slice(1));
+    }
+
     static fromJSON(o: JSONObject): Tag {
         const type: string = ensure('serialised tag type', o.type, isDefined(), isString()) as string;