@cepharum/contextual-gherkin 3.0.0-beta.5 → 3.0.0

package/steps/local-state.js

@@ -1,27 +1,16 @@
 import { Then } from "@cucumber/cucumber";
-import { Api } from "../index.js";
+import {
+	localStateByAttribute,
+	localStateByClass,
+	localStateByLabel,
+	localStateByProperty,
+	localStateByTextContent, localStateExists
+} from "../lib/step-helper.js";
 
 Then( "{contextual-word} has/have (the )ID/id {text-or-regexp}", ( context, text ) => localStateByAttribute( context, true, "id", text ) );
 Then( "{contextual-word} has/have (the )name {text-or-regexp}", ( context, text ) => localStateByAttribute( context, true, "name", text ) );
 Then( "{contextual-word} is/are named {text-or-regexp}", ( context, text ) => localStateByAttribute( context, true, "name", text ) );
 
-/**
- * Checks if some or all elements of an addressed match have a named attribute
- * matching some expected value.
- *
- * @param {ContextualWord} phrase description of previous match to check
- * @param {boolean} all if true, all matching elements have to match named attribute's expected value
- * @param {string} name name of attribute to check with either matching element
- * @param {string} value expected value of named attribute per matching element
- * @returns {Promise<void>} promises check passed
- */
-export async function localStateByAttribute( phrase, all, name, value ) {
-	const api = Api.access();
-	const context = api.getContextFor( phrase );
-	const filtered = context.withAttribute( name, value );
-
-	await context.checkFilteredInContext( filtered, phrase, all );
-}
 
 Then( "{contextual-word} has/have (the )value {text-or-regexp}", ( context, text ) => localStateByProperty( context, true, "value", text ) );
 Then( "{contextual-word} is/are enabled", context => localStateByProperty( context, true, "disabled", false ) );
@@ -33,67 +22,16 @@ Then( "{contextual-word} is/are selected", context => localStateByProperty( cont
 Then( "{contextual-word} is/are unselected", context => localStateByProperty( context, true, "selected", false ) );
 Then( "{contextual-word} is/are not selected", context => localStateByProperty( context, true, "selected", false ) );
 
-/**
- * Checks if all elements of an addressed match have a named property matching
- * some expected value.
- *
- * @param {ContextualWord} phrase description of previous match to check
- * @param {boolean} all if true, all matching elements have to match named attribute's expected value
- * @param {string} name name of DOM property to check on either matching element
- * @param {string|RegExp|boolean} value expected value of named property per matching element
- * @returns {Promise<void>} promises check passed
- */
-export async function localStateByProperty( phrase, all, name, value ) {
-	const api = Api.access();
-	const context = api.getContextFor( phrase );
-	const filtered = context.withProperty( name, value );
-
-	await context.checkFilteredInContext( filtered, phrase, all );
-}
 
 Then( "{contextual-word} is/are marked/tagged as {word}", ( context, className ) => localStateByClass( context, true, className, false ) );
 Then( "{contextual-word} is/are not marked/tagged as {word}", ( context, className ) => localStateByClass( context, true, className, true ) );
 
-/**
- * Asserts if selected element(s) has/have given class or not.
- *
- * @param {ContextualWord} phrase describes context of search
- * @param {boolean} all if true, all matching elements have to match named attribute's expected value
- * @param {string} className name of class to check
- * @param {boolean} negated inverts the assertion by means of requiring one or all elements of context not to have selected class
- * @return {Promise<void>} promises step passed
- */
-export async function localStateByClass( phrase, all, className, negated ) {
-	const api = Api.access();
-	const context = api.getContextFor( phrase );
-	const filtered = context.withListProperty( "classList", className, negated );
-
-	await context.checkFilteredInContext( filtered, phrase, all );
-}
 
 Then( "{contextual-word} is/are labelled with {text-or-regexp}", ( context, text ) => localStateByLabel( context, text, false ) );
 Then( "{contextual-word} has/have (the )label {text-or-regexp}", ( context, text ) => localStateByLabel( context, text, false ) );
 Then( "{contextual-word} is/are partially labelled with {text-or-regexp}", ( context, text ) => localStateByLabel( context, text, true ) );
 Then( "{contextual-word} has/have (the )partial label {text-or-regexp}", ( context, text ) => localStateByLabel( context, text, true ) );
 
-/**
- * Checks if an addressed match of a previously tracked search contains a given
- * text.
- *
- * @param {ContextualWord} phrase description of previous match to check
- * @param {string} text expected text found in elements of selected match
- * @param {boolean} partially if true, provided text does not have to match whole content of matching subs
- * @returns {Promise<void>} promises check passed
- */
-export async function localStateByLabel( phrase, text, partially ) {
-	const api = Api.access();
-	const context = api.getContextFor( phrase );
-	const cardinal = phrase.asCardinalWord( await context.matchCount() );
-
-	await context
-		.filterBySubsWithText( "$label", "label", text, partially )
-		.checkCardinalWord( cardinal, phrase.isRefining, `expected %amount labelled with "${text}"` );
-}
 
 Then( "{contextual-word} read/reads {text-or-regexp}", ( context, text ) => localStateByTextContent( context, text, false ) );
 Then( "{contextual-word} is reading {text-or-regexp}", ( context, text ) => localStateByTextContent( context, text, false ) );
@@ -102,49 +40,8 @@ Then( "{contextual-word} partially read/reads {text-or-regexp}", ( context, text
 Then( "{contextual-word} is partially reading {text-or-regexp}", ( context, text ) => localStateByTextContent( context, text, true ) );
 Then( "{contextual-word} has/have partial text {text-or-regexp}", ( context, text ) => localStateByTextContent( context, text, true ) );
 
-/**
- * Checks if an addressed match of a previously tracked search contains a given
- * text.
- *
- * @param {ContextualWord} phrase description of previous match to check
- * @param {string} text expected text found in elements of selected match
- * @param {boolean} partially if true searched elements may partially contain provided text to be considered a match
- * @returns {Promise<void>} promises check passed
- */
-export async function localStateByTextContent( phrase, text, partially ) {
-	const api = Api.access();
-	const context = api.getContextFor( phrase );
-	const cardinal = phrase.asCardinalWord( await context.matchCount() );
-
-	await context
-		.filterBySubsWithText( "$text", false, text, partially )
-		.checkCardinalWord( cardinal, phrase.isRefining, `expected %amount ${partially ? "partially " : ""}reading "${text}"` );
-}
 
 Then( "{contextual-word} (still )exists/exist", context => localStateExists( context, true ) );
 Then( "{contextual-word} doesn't/don't exist( anymore)", context => localStateExists( context, false ) );
 Then( "{contextual-word} does/do not exist( anymore)", context => localStateExists( context, false ) );
 Then( "{contextual-word} is/are missing/gone", context => localStateExists( context, false ) );
-
-/**
- * Checks if some contextual elements exist or are missing explicitly.
- *
- * @param {ContextualWord} phrase description of previous match to check
- * @param {boolean} mustExist if true, described contextual element has to exist to pass, otherwise it has to be missing
- * @returns {Promise<void>} promises check passed
- */
-export async function localStateExists( phrase, mustExist ) {
-	const api = Api.access();
-	const context = api.getContextFor( phrase );
-
-	if ( mustExist ) {
-		// FIXME might pass unintentionally if just one of several elements to be tested exists
-		await api.expect( context.locator ).not.toHaveCount( 0 );
-
-		if ( phrase.isRefining ) {
-			await context.track( phrase.word, phrase.targetCardinality );
-		}
-	} else {
-		await api.expect( context.locator ).toHaveCount( 0 );
-	}
-}