Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use GherkinDialect class

Best Cucumber Common Library code snippet using GherkinDialect

GherkinDialectTest.php

Source:GherkinDialectTest.php

1<?php2declare(strict_types=1);3namespace Cucumber\Gherkin;4use PHPUnit\Framework\TestCase;5final class GherkinDialectTest extends TestCase6{7    private GherkinDialect $dialect;8    public function setUp(): void9    {10        $data = [11            'feature' => ['F1', 'F2', 'F3'],12            'background' => ['B1', 'B2', 'B3'],13            'scenario' => ['S1', 'S2', 'S3'],14            'scenarioOutline' => ['SO1', 'SO2', 'SO3'],15            'rule' => ['R1', 'R2', 'R3'],16            'examples' => ['E1', 'E2', 'E3'],17            'given' => ['G1', 'G2', 'G3'],18            'when' => ['W1', 'W2', 'W3'],19            'then' => ['T1', 'T2', 'T3'],20            'and' => ['A1', 'A2', 'A3'],21            'but' => ['B1', 'B2', 'B3'],22        ];23        $this->dialect = new GherkinDialect('en', $data);24    }25    public function testItReturnsItsLanguage(): void26    {27        self::assertSame('en', $this->dialect->getLanguage());28    }29    public function testItReturnsTheFeatureKeywords(): void30    {31        self::assertSame(['F1', 'F2', 'F3'], $this->dialect->getFeatureKeywords());32    }33    public function testItReturnsTheScenarioKeywords(): void34    {35        self::assertSame(['S1', 'S2', 'S3'], $this->dialect->getScenarioKeywords());36    }37    public function testItReturnsTheScenarioOutlineKeywords(): void...

GherkinDialect.php

Source:GherkinDialect.php

...15 *     and: non-empty-list<non-empty-string>,16 *     but: non-empty-list<non-empty-string>,17 * } $data18 */19final class GherkinDialect20{21    /**22     * @param Dialect $dialect23     */24    public function __construct(25        private readonly string $language,26        private readonly array $dialect,27    ) {28    }29    public function getLanguage(): string30    {31        return $this->language;32    }33    /** @return non-empty-list<non-empty-string> */...

TokenTest.php

Source:TokenTest.php

...40        $token1 = new Token($line, new Location(1, 2));41        $token = $token1;42        $token->match(43            TokenType::Other,44            (new GherkinDialectProvider())->getDefaultDialect(),45            1,46            'keyword',47            'text',48            [new GherkinLineSpan(1, 'foo')],49        );50        self::assertSame(TokenType::Other, $token->match?->tokenType);51        self::assertEquals((new GherkinDialectProvider())->getDefaultDialect(), $token->match?->gherkinDialect);52        self::assertSame(1, $token->match?->indent);53        self::assertSame('keyword', $token->match?->keyword);54        self::assertSame('text', $token->match?->text);55        self::assertEquals([new GherkinLineSpan(1, 'foo')], $token->match?->items);56    }57    public function testItPopulatesMatchedLocationWithIndentColumnWhenMatched(): void58    {59        $line = $this->createMock(GherkinLine::class);60        $line->method('getLineText')->with(-1)->willReturn('TOKENVALUE');61        $token1 = new Token($line, new Location(1, 100));62        $token = $token1;63        $token->match(64            TokenType::Other,65            (new GherkinDialectProvider())->getDefaultDialect(),66            1,67            'keyword',68            'text',69            [new GherkinLineSpan(1, 'foo')],70        );71        self::assertEquals(new Location(1, 2), $token->match?->location);72    }73}...

GherkinDialectProvider.php

Source:GherkinDialectProvider.php

...4use Cucumber\Gherkin\ParserException\NoSuchLanguageException;5use JsonException;6use RuntimeException;7/**8 * @psalm-import-type Dialect from GherkinDialect9 */10final class GherkinDialectProvider11{12    /**13     * @var non-empty-array<non-empty-string, Dialect>14     */15    private readonly array $DIALECTS;16    public const JSON_PATH = __DIR__ . '/../resources/gherkin-languages.json';17    /** @param non-empty-string $defaultDialectName */18    public function __construct(19        private readonly string $defaultDialectName = 'en',20    ) {21        try {22            /**23             * Here we force the type checker to assume the decoded JSON has the correct24             * structure, rather than validating it. This is safe because it's not dynamic25             *26             * @var non-empty-array<non-empty-string, Dialect> $data27             */28            $data = json_decode(file_get_contents(self::JSON_PATH), true, flags: JSON_THROW_ON_ERROR);29            $this->DIALECTS = $data;30        } catch (JsonException $e) {31            throw new RuntimeException("Unable to parse " . self::JSON_PATH, previous: $e);32        }33    }34    /**35     * @return non-empty-list<non-empty-string>36     */37    public function getLanguages(): array38    {39        return array_keys($this->DIALECTS);40    }41    /**42     * @param non-empty-string $language43     */44    public function getDialect(string $language, ?Location $location): GherkinDialect45    {46        if (!isset($this->DIALECTS[$language])) {47            throw new NoSuchLanguageException($language, $location);48        }49        return new GherkinDialect($language, $this->DIALECTS[$language]);50    }51    public function getDefaultDialect(): GherkinDialect52    {53        return $this->getDialect($this->defaultDialectName, null);54    }55}...

GherkinDialectProviderTest.php

Source:GherkinDialectProviderTest.php

1<?php2declare(strict_types=1);3namespace Cucumber\Gherkin;4use PHPUnit\Framework\TestCase;5final class GherkinDialectProviderTest extends TestCase6{7    private GherkinDialectProvider $dialectProvider;8    public function setUp(): void9    {10        $this->dialectProvider = new GherkinDialectProvider();11    }12    public function testItCanListLanguages(): void13    {14        $languages = $this->dialectProvider->getLanguages();15        self::assertTrue(count($languages) > 1);16        self::assertContains('en', $languages);17    }18    public function testItCanProvideADialectForKnownLanguage(): void19    {20        $dialect = $this->dialectProvider->getDialect('de', new Location(1, 1));21        self::assertInstanceOf(GherkinDialect::class, $dialect);22    }23    public function testItThrowsAnExceptionWithLocationIfLanguageIsNotFound(): void24    {25        $location = new Location(1, 1);26        $this->expectExceptionObject(new ParserException\NoSuchLanguageException('xx', $location));27        $this->dialectProvider->getDialect('xx', $location);28    }29    public function testItGetsADefaultDialectFromConstructorLanguage(): void30    {31        $this->dialectProvider = new GherkinDialectProvider('fr');32        $dialect = $this->dialectProvider->getDefaultDialect();33        self::assertInstanceOf(GherkinDialect::class, $dialect);34        self::assertSame('fr', $dialect->getLanguage());35    }36}...

Token.php

Source:Token.php

...30     * @param list<GherkinLineSpan> $items31     */32    public function match(33        TokenType $matchedType,34        GherkinDialect $gherkinDialect,35        int $indent,36        string $keyword,37        string $text,38        array $items,39    ): void {40        $this->match = new TokenMatch(41            $matchedType,42            $gherkinDialect,43            $indent,44            $keyword,45            $text,46            $items,47            new Location($this->location->line, $indent + 1),48        );...

TokenMatchTest.php

Source:TokenMatchTest.php

...8    public function testItContainsFields(): void9    {10        $match = new TokenMatch(11            TokenType::Other,12            (new GherkinDialectProvider())->getDefaultDialect(),13            1,14            'keyword',15            'text',16            [new GherkinLineSpan(1, 'foo')],17            new Location(100, 200),18        );19        self::assertSame(TokenType::Other, $match->tokenType);20        self::assertEquals((new GherkinDialectProvider())->getDefaultDialect(), $match->gherkinDialect);21        self::assertSame(1, $match->indent);22        self::assertSame('keyword', $match->keyword);23        self::assertSame('text', $match->text);24        self::assertEquals([new GherkinLineSpan(1, 'foo')], $match->items);25        self::assertEquals(new Location(100, 200), $match->location);26    }27}...

TokenMatch.php

Source:TokenMatch.php

...8     * @param list<GherkinLineSpan> $items9     */10    public function __construct(11        public readonly TokenType $tokenType,12        public readonly GherkinDialect $gherkinDialect,13        public readonly int $indent,14        public readonly string $keyword,15        public readonly string $text,16        public readonly array $items,17        public readonly Location $location,18    ) {19    }20}...

GherkinDialect

Using AI Code Generation

1$dialect = new GherkinDialect();2$dialect->getStepKeywords();3$dialect->getGivenStepKeywords();4$dialect->getWhenStepKeywords();5$dialect->getThenStepKeywords();6$dialect->getAndStepKeywords();7$dialect->getButStepKeywords();8$dialect->getBackgroundKeywords();9$dialect->getExamplesKeywords();10$dialect->getFeatureKeywords();11$dialect->getScenarioKeywords();12$dialect->getScenarioOutlineKeywords();13$dialect->getGivenStepRegexp();14$dialect->getWhenStepRegexp();15$dialect->getThenStepRegexp();16$dialect->getAndStepRegexp();17$dialect->getButStepRegexp();18$dialect->getStepRegexp();19$dialect->getBackgroundRegexp();20$dialect->getExamplesRegexp();21$dialect->getFeatureRegexp();22$dialect->getScenarioRegexp();23$dialect->getScenarioOutlineRegexp();24$dialect = new GherkinDialect();25$dialect->getStepKeywords();26$dialect->getGivenStepKeywords();27$dialect->getWhenStepKeywords();28$dialect->getThenStepKeywords();29$dialect->getAndStepKeywords();30$dialect->getButStepKeywords();31$dialect->getBackgroundKeywords();32$dialect->getExamplesKeywords();33$dialect->getFeatureKeywords();34$dialect->getScenarioKeywords();35$dialect->getScenarioOutlineKeywords();36$dialect->getGivenStepRegexp();37$dialect->getWhenStepRegexp();38$dialect->getThenStepRegexp();39$dialect->getAndStepRegexp();40$dialect->getButStepRegexp();41$dialect->getStepRegexp();42$dialect->getBackgroundRegexp();43$dialect->getExamplesRegexp();44$dialect->getFeatureRegexp();45$dialect->getScenarioRegexp();46$dialect->getScenarioOutlineRegexp();47$dialect = new GherkinDialect();48$dialect->getStepKeywords();49$dialect->getGivenStepKeywords();

GherkinDialect

Using AI Code Generation

1require_once 'vendor/autoload.php';2use Behat\Gherkin\Keywords\KeywordsDialectProvider;3use Behat\Gherkin\Keywords\KeywordsDialect;4use Behat\Gherkin\Keywords\KeywordsTable;5$provider = new KeywordsDialectProvider();6$dialect = $provider->get('en');7$keywords = $dialect->getKeywords();8echo $keywords->getScenario();9echo $keywords->getExamples();10echo $keywords->getScenarioOutline();11echo $keywords->getBackground();12echo $keywords->getGiven();13echo $keywords->getWhen();14echo $keywords->getThen();15echo $keywords->getAnd();16echo $keywords->getBut();17echo $keywords->getGivenAliases();18echo $keywords->getWhenAliases();19echo $keywords->getThenAliases();20echo $keywords->getAndAliases();21echo $keywords->getButAliases();22echo $keywords->getGivenPattern();23echo $keywords->getWhenPattern();24echo $keywords->getThenPattern();25echo $keywords->getAndPattern();26echo $keywords->getButPattern();27echo $keywords->getScenarioOutlinePattern();28echo $keywords->getScenarioPattern();29echo $keywords->getExamplesPattern();30echo $keywords->getBackgroundPattern();31echo $keywords->getFeaturePattern();32$dialect = $provider->get('fr');33$dialect = $provider->getAll();

GherkinDialect

Using AI Code Generation

1require_once 'GherkinDialect.php';2$gherkinDialect = new GherkinDialect();3$dialect = $gherkinDialect->getGherkinDialect('en');4print_r($dialect);5public function getGherkinDialect($language)6require_once 'GherkinDialect.php';7$gherkinDialect = new GherkinDialect();8$dialect = $gherkinDialect->getGherkinDialect('en');9print_r($dialect);

GherkinDialect

Using AI Code Generation

1require_once('gherkin/gherkin.php');2$dialect = new GherkinDialect();3$dialect->setLanguage('en');4$dialect->setKeyword('Feature','Feature');5$dialect->setKeyword('Background','Background');6$dialect->setKeyword('Scenario','Scenario');7$dialect->setKeyword('ScenarioOutline','Scenario Outline');8$dialect->setKeyword('Examples','Examples');9$dialect->setKeyword('Given','Given');10$dialect->setKeyword('When','When');11$dialect->setKeyword('Then','Then');12$dialect->setKeyword('And','And');13$dialect->setKeyword('But','But');14$dialect->setKeyword('given','given');15$dialect->setKeyword('when','when');16$dialect->setKeyword('then','then');17$dialect->setKeyword('and','and');18$dialect->setKeyword('but','but');19$dialect->setKeyword('example','example');20$dialect->setKeyword('examples','examples');21$dialect->setKeyword('background','background');22$dialect->setKeyword('scenario','scenario');23$dialect->setKeyword('scenarioOutline','scenario outline');24$dialect->setKeyword('feature','feature');25$dialect->setKeyword('given','given');26$dialect->setKeyword('when','when');27$dialect->setKeyword('then','then');28$dialect->setKeyword('and','and');29$dialect->setKeyword('but','but');30$dialect->setKeyword('example','example');31$dialect->setKeyword('examples','examples');32$dialect->setKeyword('background','background');33$dialect->setKeyword('scenario','scenario');34$dialect->setKeyword('scenarioOutline','scenario outline');35$dialect->setKeyword('feature','feature');36$dialect->setKeyword('given','given');37$dialect->setKeyword('when','when');38$dialect->setKeyword('then','then');39$dialect->setKeyword('and','and');40$dialect->setKeyword('but','but');41$dialect->setKeyword('example','example');42$dialect->setKeyword('examples','examples');43$dialect->setKeyword('background','background');44$dialect->setKeyword('scenario','scenario');45$dialect->setKeyword('scenarioOutline','

GherkinDialect

Using AI Code Generation

1$dialect = new GherkinDialect();2$dialect->loadDialect("en");3echo $dialect->getKeyword("examples");4$dialect = new GherkinDialect();5$dialect->loadDialect("en");6echo $dialect->getKeyword("given");7$dialect = new GherkinDialect();8$dialect->loadDialect("en");9echo $dialect->getKeyword("when");10$dialect = new GherkinDialect();11$dialect->loadDialect("en");12echo $dialect->getKeyword("then");13$dialect = new GherkinDialect();14$dialect->loadDialect("en");15echo $dialect->getKeyword("and");16$dialect = new GherkinDialect();17$dialect->loadDialect("en");18echo $dialect->getKeyword("but");19$dialect = new GherkinDialect();20$dialect->loadDialect("en");21echo $dialect->getKeyword("background");22$dialect = new GherkinDialect();23$dialect->loadDialect("en");

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.