@cepharum/contextual-gherkin 1.2.1 → 1.2.2

package/cli.js

@@ -6,6 +6,7 @@ const Path = require( "node:path" );
 const os = require( "node:os" );
 
 const semver = require( "semver" );
+const { getShellConfigurationSync, quote } = require( "@cepharum/quoting-db" );
 
 const cgFolder = "./node_modules/@cepharum/contextual-gherkin";
 const isWindows = os.platform() === "win32";
@@ -148,8 +149,7 @@ const isWindows = os.platform() === "win32";
 	}
 
 	if ( spawnOptions.shell ) {
-		const { getShellConfiguration, quote } = await import( "@cepharum/quoting-db" );
-		const configuration = await getShellConfiguration();
+		const configuration = getShellConfigurationSync( spawnOptions.shell );
 
 		sanitizer = argument => quote( argument, configuration );
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cepharum/contextual-gherkin",
-	"version": "1.2.1",
+	"version": "1.2.2",
 	"description": "flexible step definitions for Gherkin",
 	"author": "cepharum GmbH <thomas.urban@cepharum.de>",
 	"homepage": "https://cepharum-foss.gitlab.io/contextual-gherkin/",
@@ -12,7 +12,7 @@
 	},
 	"keywords": [],
 	"dependencies": {
-		"@cepharum/quoting-db": "^1.0.0",
+		"@cepharum/quoting-db": "^1.2.0",
 		"pluralize": "^8.0.0",
 		"semver": "^7.5.0"
 	},

package/steps/global-action.js

@@ -5,8 +5,8 @@ const actAndTrack = async( testController, cardinal, refined, action, input ) =>
 	const target = await refined.find( "$" + action, false );
 	const targetCount = await target.matches.count;
 
-	await testController.expect( targetCount ).gt( 0, `there is no $${action} target for selected ${cardinal.word} to ${input == null ? action : "enter text into"}` ); // eslint-disable-line max-len
-	await testController.expect( targetCount ).eql( 1, `there is no single $${action} target for selected ${cardinal.word} to ${input == null ? action : "enter text into"}` ); // eslint-disable-line max-len
+	await testController.expect( targetCount ).gt( 0, `there is no $${action} target for selected ${cardinal.word} to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
+	await testController.expect( targetCount ).eql( 1, `there is no single $${action} target for selected ${cardinal.word} to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
 
 	await refined.detach();
 
@@ -44,7 +44,7 @@ When( "I enter {string-or-word} into {cardinal-word} named {text-or-regexp}", (
  * @param {NumberAndWord} cardinal describes what to search
  * @param {string|RegExp} name name of attribute to match
  * @param {string|RegExp} value value of named attribute to match
- * @param {'click'|'hover'} action action to perform on found element
+ * @param {'click'|'hover'|'enter'} action action to perform on found element
  * @param {string} input text to enter into selected field (instead of clicking or hovering)
  * @return {Promise<void>} promises step passed
  */
@@ -54,11 +54,16 @@ async function globalActionByAttribute( testController, cardinal, name, value, a
 	}
 
 	const matches = await Api.access( testController ).find( cardinal.word );
+
+	if ( cardinal.cardinality !== "singular" ) {
+		await testController.expect( false ).eql( true, `selector is not addressing a single ${cardinal.word} to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
+	}
+
 	const refined = await matches.withAttribute( name, value );
 	const matchCount = await refined.matches.count;
 
-	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} with attribute ${name} == "${value}" to ${input == null ? action : "enter text into"}` );
-	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} with attribute ${name} == "${value}" to ${input == null ? action : "enter text into"}` ); // eslint-disable-line max-len
+	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} with attribute ${name} == "${value}" to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
+	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} with attribute ${name} == "${value}" to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
 
 	await actAndTrack( testController, cardinal, refined, action, input );
 }
@@ -79,7 +84,7 @@ When( "I enter {string-or-word} into {cardinal-word} not marked/tagged as {word}
  * @param {TestController} testController exposes test controller
  * @param {NumberAndWord} cardinal describes what to search
  * @param {string|RegExp} className class required for match
- * @param {'click'|'hover'} action action to perform on found element
+ * @param {'click'|'hover'|'enter'} action action to perform on found element
  * @param {boolean} negated inverts the assertion by means of requiring one or all elements of context not to have selected class
  * @param {string} input text to enter into selected field (instead of clicking or hovering)
  * @return {Promise<void>} promises step passed
@@ -90,12 +95,17 @@ async function globalActionByClass( testController, cardinal, className, action,
 	}
 
 	const matches = await Api.access( testController ).find( cardinal.word );
+
+	if ( cardinal.cardinality !== "singular" ) {
+		await testController.expect( false ).eql( true, `selector is not addressing a single ${cardinal.word} ${negated ? "not " : ""}marked as ${className} to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
+	}
+
 	const { query: property } = matches.getSelector( "#classList", "classList" );
 	const refined = await matches.filterFn( node => node?.[property]?.contains( className ) ^ negated, { property, className, negated } );
 	const matchCount = await refined.matches.count;
 
-	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} ${negated ? "not " : ""}marked as ${className} to ${input == null ? action : "enter text into"}` );
-	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} ${negated ? "not " : ""}marked as ${className} to ${input == null ? action : "enter text into"}` );
+	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} ${negated ? "not " : ""}marked as ${className} to ${input == null ? action : `enter '${input}' into`}` );
+	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} ${negated ? "not " : ""}marked as ${className} to ${input == null ? action : `enter '${input}' into`}` );
 
 	await actAndTrack( testController, cardinal, refined, action, input );
 }
@@ -114,7 +124,7 @@ When( "I enter {string-or-word} into {cardinal-word} with value {text-or-regexp}
  * @param {NumberAndWord} cardinal describes what to search
  * @param {string|RegExp} name name of attribute to match
  * @param {string|RegExp} value value of named attribute to match
- * @param {'click'|'hover'} action action to perform on found element
+ * @param {'click'|'hover'|'enter'} action action to perform on found element
  * @param {string} input text to enter into selected field (instead of clicking or hovering)
  * @return {Promise<void>} promises step passed
  */
@@ -124,11 +134,16 @@ async function globalActionByProperty( testController, cardinal, name, value, ac
 	}
 
 	const matches = await Api.access( testController ).find( cardinal.word );
+
+	if ( cardinal.cardinality !== "singular" ) {
+		await testController.expect( false ).eql( true, `selector is not addressing a single ${cardinal.word} with property ${name} == "${value}" to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
+	}
+
 	const refined = await matches.withProperty( name, value );
 	const matchCount = await refined.matches.count;
 
-	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} with property ${name} == "${value}" to ${input == null ? action : "enter text into"}` );
-	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} with property ${name} == "${value}" to ${input == null ? action : "enter text into"}` ); // eslint-disable-line max-len
+	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} with property ${name} == "${value}" to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
+	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} with property ${name} == "${value}" to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
 
 	await actAndTrack( testController, cardinal, refined, action, input );
 }
@@ -156,7 +171,7 @@ When( "I enter {string-or-word} into {cardinal-word} partially labelled with {te
  * @param {NumberAndWord} cardinal provides cardinal number and word
  * @param {string} label provides required label of matching element(s)
  * @param {boolean} partially if true, provided text does not have to match whole content of matching subs
- * @param {'click'|'hover'} action action to perform on found element
+ * @param {'click'|'hover'|'enter'} action action to perform on found element
  * @param {string} input text to enter into selected field (instead of clicking or hovering)
  * @returns {Promise<void>} promises step passed
  */
@@ -166,11 +181,16 @@ async function globalActionByLabel( testController, cardinal, label, partially,
 	}
 
 	const matches = await Api.access( testController ).find( cardinal.word );
+
+	if ( cardinal.cardinality !== "singular" ) {
+		await testController.expect( false ).eql( true, `selector is not addressing a single ${cardinal.word} with ${partially ? "partial " : ""}label "${label}" to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
+	}
+
 	const refined = await matches.filterBySubsWithText( "$label", "label", label, partially );
 	const matchCount = await refined.matches.count;
 
-	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} with ${partially ? "partial " : ""}label "${label}" to ${input == null ? action : "enter text into"}` );
-	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} with ${partially ? "partial " : ""}label "${label}" to ${input == null ? action : "enter text into"}` );
+	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} with ${partially ? "partial " : ""}label "${label}" to ${input == null ? action : `enter '${input}' into`}` );
+	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} with ${partially ? "partial " : ""}label "${label}" to ${input == null ? action : `enter '${input}' into`}` );
 
 	await actAndTrack( testController, cardinal, refined, action, input );
 }
@@ -198,7 +218,7 @@ When( "I enter {string-or-word} into {cardinal-word} with partial text {text-or-
  * @param {NumberAndWord} cardinal provides cardinal number and word
  * @param {string} text provides text to be found in eventually matching element(s)
  * @param {boolean} partially if true, provided text does not have to match whole content of matching subs
- * @param {'click'|'hover'} action action to perform on found element
+ * @param {'click'|'hover'|'enter'} action action to perform on found element
  * @param {string} input text to enter into selected field (instead of clicking or hovering)
  * @returns {Promise<void>} promises step passed
  */
@@ -208,11 +228,16 @@ async function globalActionByTextContent( testController, cardinal, text, partia
 	}
 
 	const matches = await Api.access( testController ).find( cardinal.word );
+
+	if ( cardinal.cardinality !== "singular" ) {
+		await testController.expect( false ).eql( true, `selector is not addressing a single ${cardinal.word} ${partially ? "partially " : ""}reading "${text}" to ${input == null ? action : `enter '${input}' into`}` ); // eslint-disable-line max-len
+	}
+
 	const refined = await matches.filterBySubsWithText( "$text", false, text, partially );
 	const matchCount = await refined.matches.count;
 
-	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} ${partially ? "partially " : ""}reading "${text}" to ${input == null ? action : "enter text into"}` );
-	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} ${partially ? "partially " : ""}reading "${text}" to ${input == null ? action : "enter text into"}` );
+	await testController.expect( matchCount ).gt( 0, `there is no matching ${cardinal.word} ${partially ? "partially " : ""}reading "${text}" to ${input == null ? action : `enter '${input}' into`}` );
+	await testController.expect( matchCount ).eql( 1, `there is no single matching ${cardinal.word} ${partially ? "partially " : ""}reading "${text}" to ${input == null ? action : `enter '${input}' into`}` );
 
 	await actAndTrack( testController, cardinal, refined, action, input );
 }