Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use transformRuleNode method of GherkinDocumentBuilder class

Best Cucumber Common Library code snippet using GherkinDocumentBuilder.transformRuleNode

GherkinDocumentBuilder.php

Source:GherkinDocumentBuilder.php

...92            RuleType::DataTable => $this->transformDataTableNode($node),93            Ruletype::Background => $this->transformBackgroundNode($node),94            RuleType::Description => $this->transformDescriptionNode($node),95            RuleType::Feature => $this->transformFeatureNode($node),96            RuleType::Rule => $this->transformRuleNode($node),97            RuleType::GherkinDocument => $this->transformGherkinDocumentNode($node),98            default => $node,99        };100    }101    private function getLocation(TokenMatch $token, int $column): MessageLocation102    {103        $column = ($column === 0) ? $token->location->column : $column;104        return new MessageLocation($token->location->line, $column);105    }106    private function getDescription(AstNode $node): string107    {108        return (string) $node->getSingleUntyped(RuleType::Description, "");109    }110    /** @return list<Step> */111    private function getSteps(AstNode $node): array112    {113        return $node->getitems(Step::class, RuleType::Step);114    }115    /** @return list<TableRow> */116    private function getTableRows(AstNode $node): array117    {118        $rows = array_map(119            fn ($token) => new TableRow($this->getLocation($token, 0), $this->getCells($token), $this->idGenerator->newId()),120            $node->getTokenMatches(TokenType::TableRow),121        );122        $this->ensureCellCount($rows);123        return $rows;124    }125    /** @param list<TableRow> $rows */126    private function ensureCellCount(array $rows): void127    {128        if (!count($rows)) {129            return;130        }131        $cellCount = count($rows[0]->cells);132        foreach ($rows as $row) {133            if (count($row->cells) !== $cellCount) {134                $location = new Location($row->location->line, $row->location->column ?? 0);135                throw new AstBuilderException('inconsistent cell count within the table', $location);136            }137        }138    }139    /**140     * @return list<TableCell>141     */142    private function getCells(TokenMatch $token): array143    {144        return array_map(145            fn ($cellItem) => new TableCell($this->getLocation($token, $cellItem->column), $cellItem->text),146            $token->items,147        );148    }149    /**150     * @return list<Tag>151     */152    private function getTags(AstNode $node): array153    {154        $tagsNode = $node->getSingle(AstNode::class, RuleType::Tags, new AstNode(RuleType::None));155        $tokens = $tagsNode->getTokenMatches(TokenType::TagLine);156        $tags = [];157        foreach ($tokens as $token) {158            foreach ($token->items as $tagItem) {159                $tags[] = new Tag(160                    location: $this->getLocation($token, $tagItem->column),161                    name: $tagItem->text,162                    id: $this->idGenerator->newId(),163                );164            }165        }166        return $tags;167    }168    /**169     * @param array<TokenMatch> $lineTokens170     */171    private function joinMatchedTextWithLinebreaks(array $lineTokens): string172    {173        return join("\n", array_map(fn ($t) => $t->text, $lineTokens));174    }175    private function transformStepNode(AstNode $node): Step176    {177        $stepLine = $node->getTokenMatch(TokenType::StepLine);178        return new Step(179            location: $this->getLocation($stepLine, 0),180            keyword: $stepLine->keyword,181            text: $stepLine->text,182            docString: $node->getSingle(DocString::class, RuleType::DocString),183            dataTable: $node->getSingle(DataTable::class, RuleType::DataTable),184            id: $this->idGenerator->newId(),185        );186    }187    private function transformDocStringNode(AstNode $node): DocString188    {189        $separatorToken = $node->getTokenMatches(TokenType::DocStringSeparator)[0];190        $mediaType = $separatorToken->text;191        $lineTokens = $node->getTokenMatches(TokenType::Other);192        $content = $this->joinMatchedTextWithLinebreaks($lineTokens);193        return new DocString(194            location: $this->getLocation($separatorToken, 0),195            mediaType: $mediaType ?: null, // special case turns '' into null196            content: $content,197            delimiter: $separatorToken->keyword,198        );199    }200    private function transformScenarioDefinitionNode(AstNode $node): ?Scenario201    {202        $scenarioNode = $node->getSingle(AstNode::class, RuleType::Scenario);203        if (null === $scenarioNode) {204            return null;205        }206        $scenarioLine = $scenarioNode->getTokenMatch(TokenType::ScenarioLine);207        return new Scenario(208            location: $this->getLocation($scenarioLine, 0),209            tags: $this->getTags($node),210            keyword: $scenarioLine->keyword,211            name: $scenarioLine->text,212            description: $this->getDescription($scenarioNode),213            steps: $this->getSteps($scenarioNode),214            examples: $scenarioNode->getItems(Examples::class, RuleType::ExamplesDefinition),215            id: $this->idGenerator->newId(),216        );217    }218    private function transformExamplesDefinitionNode(AstNode $node): ?Examples219    {220        $examplesNode = $node->getSingle(AstNode::class, RuleType::Examples);221        if (null === $examplesNode) {222            return null;223        }224        $examplesLine = $examplesNode->getTokenMatch(TokenType::ExamplesLine);225        /** @var list<TableRow>|null $rows */226        $rows = $examplesNode->getSingleUntyped(RuleType::ExamplesTable);227        $tableHeader = is_array($rows) && count($rows) ? $rows[0] : null;228        $tableBody = (is_array($rows) && count($rows) > 0) ? array_slice($rows, 1) : [];229        return new Examples(230            location: $this->getLocation($examplesLine, 0),231            tags: $this->getTags($node),232            keyword: $examplesLine->keyword,233            name: $examplesLine->text,234            description: $this->getDescription($examplesNode),235            tableHeader: $tableHeader,236            tableBody: $tableBody,237            id: $this->idGenerator->newId(),238        );239    }240    private function transformDataTableNode(AstNode $node): DataTable241    {242        $rows = $this->getTableRows($node);243        return new DataTable($rows[0]->location, $rows);244    }245    /** @return list<TableRow> */246    private function transformExamplesTableNode(AstNode $node): array247    {248        return $this->getTableRows($node);249    }250    private function transformBackgroundNode(AstNode $node): Background251    {252        $backgroundLine = $node->getTokenMatch(TokenType::BackgroundLine);253        return new Background(254            location: $this->getLocation($backgroundLine, 0),255            keyword: $backgroundLine->keyword,256            name: $backgroundLine->text,257            description: $this->getDescription($node),258            steps: $this->getSteps($node),259            id: $this->idGenerator->newId(),260        );261    }262    private function transformDescriptionNode(AstNode $node): string263    {264        $lineTokens = $node->getTokenMatches(TokenType::Other);265        $lineText = preg_replace(266            '/(\\n\\s*)*$/u',267            '',268            $this->joinMatchedTextWithLinebreaks($lineTokens),269        );270        return $lineText;271    }272    private function transformFeatureNode(AstNode $node): ?Feature273    {274        $header = $node->getSingle(AstNode::class, RuleType::FeatureHeader, new AstNode(RuleType::FeatureHeader));275        if (!$header instanceof AstNode) {276            return null;277        }278        $tags = $this->getTags($header);279        $featureLine = $header->getTokenMatch(TokenType::FeatureLine);280        $children = [];281        $background = $node->getSingle(Background::class, RuleType::Background);282        if ($background instanceof Background) {283            $children[] = new FeatureChild(background: $background);284        }285        foreach ($node->getItems(Scenario::class, RuleType::ScenarioDefinition) as $scenario) {286            $children[] = new FeatureChild(scenario: $scenario);287        }288        foreach ($node->getItems(Rule::class, RuleType::Rule) as $rule) {289            $children[] = new FeatureChild($rule, null, null);290        }291        $language = $featureLine->gherkinDialect->getLanguage();292        return new Feature(293            location: $this->getLocation($featureLine, 0),294            tags: $tags,295            language: $language,296            keyword: $featureLine->keyword,297            name: $featureLine->text,298            description: $this->getDescription($header),299            children: $children,300        );301    }302    private function transformRuleNode(AstNode $node): Rule303    {304        $header = $node->getSingle(AstNode::class, RuleType::RuleHeader, new AstNode(RuleType::RuleHeader));305        $ruleLine = $header->getTokenMatch(TokenType::RuleLine);306        $children = [];307        $tags = $this->getTags($header);308        $background = $node->getSingle(Background::class, RuleType::Background);309        if ($background) {310            $children[] = new RuleChild(background: $background);311        }312        $scenarios = $node->getItems(Scenario::class, RuleType::ScenarioDefinition);313        foreach ($scenarios as $scenario) {314            $children[] = new RuleChild(scenario: $scenario);315        }316        return new Rule(...

transformRuleNode

Using AI Code Generation

1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocumentBuilder->transformRuleNode($ruleNode);3$gherkinDocumentBuilder = new GherkinDocumentBuilder();4$gherkinDocumentBuilder->transformBackgroundNode($backgroundNode);5$gherkinDocumentBuilder = new GherkinDocumentBuilder();6$gherkinDocumentBuilder->transformScenarioNode($scenarioNode);7$gherkinDocumentBuilder = new GherkinDocumentBuilder();8$gherkinDocumentBuilder->transformScenarioOutlineNode($scenarioOutlineNode);9$gherkinDocumentBuilder = new GherkinDocumentBuilder();10$gherkinDocumentBuilder->transformExamplesNode($examplesNode);11$gherkinDocumentBuilder = new GherkinDocumentBuilder();12$gherkinDocumentBuilder->transformStepNode($stepNode);13$gherkinDocumentBuilder = new GherkinDocumentBuilder();14$gherkinDocumentBuilder->transformDataTableNode($dataTableNode);15$gherkinDocumentBuilder = new GherkinDocumentBuilder();16$gherkinDocumentBuilder->transformDocStringNode($docStringNode);17$gherkinDocumentBuilder = new GherkinDocumentBuilder();18$gherkinDocumentBuilder->transformTagsNode($tagsNode);19$gherkinDocumentBuilder = new GherkinDocumentBuilder();20$gherkinDocumentBuilder->transformLocation($location);

transformRuleNode

Using AI Code Generation

1require_once 'GherkinDocumentBuilder.php';2$builder = new GherkinDocumentBuilder();3$gherkinDocument = $builder->transformRuleNode($ruleNode);4$rule = $gherkinDocument->getFeature()->getChildren()[0]->getRule();5echo $rule->getName();6require_once 'GherkinDocumentBuilder.php';7$builder = new GherkinDocumentBuilder();8$gherkinDocument = $builder->transformScenarioDefinitionNode($scenarioDefinitionNode);9$scenario = $gherkinDocument->getFeature()->getChildren()[0]->getScenario();10echo $scenario->getName();11require_once 'GherkinDocumentBuilder.php';12$builder = new GherkinDocumentBuilder();13$gherkinDocument = $builder->transformScenarioNode($scenarioNode);14$scenario = $gherkinDocument->getFeature()->getChildren()[0]->getScenario();15echo $scenario->getName();16require_once 'GherkinDocumentBuilder.php';17$builder = new GherkinDocumentBuilder();18$gherkinDocument = $builder->transformBackgroundNode($backgroundNode);19$background = $gherkinDocument->getFeature()->getChildren()[0]->getBackground();20echo $background->getName();21require_once 'GherkinDocumentBuilder.php';22$builder = new GherkinDocumentBuilder();23$gherkinDocument = $builder->transformExamplesNode($examplesNode);24$examples = $gherkinDocument->getFeature()->getChildren()[0]->getRule()->getChildren()[0]->getExamples();25echo $examples->getName();26require_once 'GherkinDocumentBuilder.php';27$builder = new GherkinDocumentBuilder();28$gherkinDocument = $builder->transformExamplesTableNode($examplesTableNode);29$examplesTable = $gherkinDocument->getFeature()->getChildren()[0]->getRule()->getChildren

transformRuleNode

Using AI Code Generation

1$builder = new GherkinDocumentBuilder();2$builder->transformRuleNode($ruleNode, $rule);3$builder = new GherkinDocumentBuilder();4$builder->transformRuleNode($ruleNode, $rule);5$builder = new GherkinDocumentBuilder();6$builder->transformRuleNode($ruleNode, $rule);7$builder = new GherkinDocumentBuilder();8$builder->transformRuleNode($ruleNode, $rule);9$builder = new GherkinDocumentBuilder();10$builder->transformRuleNode($ruleNode, $rule);11$builder = new GherkinDocumentBuilder();12$builder->transformRuleNode($ruleNode, $rule);13$builder = new GherkinDocumentBuilder();14$builder->transformRuleNode($ruleNode, $rule);15$builder = new GherkinDocumentBuilder();16$builder->transformRuleNode($ruleNode, $rule);17$builder = new GherkinDocumentBuilder();18$builder->transformRuleNode($ruleNode, $rule);19$builder = new GherkinDocumentBuilder();20$builder->transformRuleNode($ruleNode, $rule);21$builder = new GherkinDocumentBuilder();22$builder->transformRuleNode($ruleNode, $rule);

transformRuleNode

Using AI Code Generation

1require_once 'GherkinDocumentBuilder.php';2$builder = new GherkinDocumentBuilder();3$builder->transformRuleNode($ruleNode);4require_once 'GherkinDocumentBuilder.php';5$builder = new GherkinDocumentBuilder();6$ruleNode = $builder->transformRuleNode($ruleNode);7echo "Rule Keyword: " . $ruleNode->keyword . PHP_EOL;8echo "Rule Name: " . $ruleNode->name . PHP_EOL;9echo "Rule Description: " . $ruleNode->description . PHP_EOL;10echo "Rule Line: " . $ruleNode->line . PHP_EOL;11echo "Rule Nodes: " . PHP_EOL;12foreach ($ruleNode->nodes as $node) {13    echo $node->keyword . PHP_EOL;14}

transformRuleNode

Using AI Code Generation

1$builder = new GherkinDocumentBuilder();2$gherkinDocument = $builder->build($parser->parse($feature));3$gherkinDocument->transformRuleNode(function (RuleNode $ruleNode) {4});5$ruleSteps = $gherkinDocument->getFeature()->getRule(0)->getSteps();6getKeyword() - returns the step keyword7getText() - returns the step text8getLocation() - returns the step location9getArgument() - returns the step argument10$ruleSteps = $gherkinDocument->getFeature()->getRule(0)->getSteps();11foreach ($ruleSteps as $ruleStep) {12    echo $ruleStep->getKeyword() . " " . $ruleStep->getText() . " " . $ruleStep->getLocation() . " " . $ruleStep->getArgument() . "13";14}15$ruleSteps = $gherkinDocument->getFeature()->getRule(0)->getSteps();16foreach ($ruleSteps as $ruleStep) {

transformRuleNode

Using AI Code Generation

1$rule = $builder->transformRuleNode($ruleNode);2print_r($rule);3        (4        (5                (6                        (7                        (8                                (9                                        (10                (11                        (12                        (13                                (14                                        (15                        (16                                (17                                        (

transformRuleNode

Using AI Code Generation

1$ruleNode = $builder->transformRuleNode($rule);2$ruleNode = $builder->transformRuleNode($rule);3$ruleNode = $builder->transformRuleNode($rule);4$ruleNode = $builder->transformRuleNode($rule);5$ruleNode = $builder->transformRuleNode($rule);6$ruleNode = $builder->transformRuleNode($rule);7$ruleNode = $builder->transformRuleNode($rule);8$ruleNode = $builder->transformRuleNode($rule);9$ruleNode = $builder->transformRuleNode($rule);10$ruleNode = $builder->transformRuleNode($rule);11$ruleNode = $builder->transformRuleNode($rule);12$ruleNode = $builder->transformRuleNode($rule);

transformRuleNode

Using AI Code Generation

1$rule = new RuleNode('Rule', 'Rule: Rule 1', 1, 1);2$rule->addStep(new StepNode('Given', 'Step 1', 1, 1));3$rule->addStep(new StepNode('When', 'Step 2', 2, 1));4$rule->addStep(new StepNode('Then', 'Step 3', 3, 1));5$rule->addStep(new StepNode('And', 'Step 4', 4, 1));6$rule->addStep(new StepNode('But', 'Step 5', 5, 1));7$builder = new GherkinDocumentBuilder();8$builder->transformRuleNode($rule);9$rule = new RuleNode('Rule', 'Rule: Rule 1', 1, 1);10$rule->addStep(new StepNode('Given', 'Step 1', 1, 1));11$rule->addStep(new StepNode('When', 'Step 2', 2, 1));12$rule->addStep(new StepNode('Then', 'Step 3', 3, 1));13$rule->addStep(new StepNode('And', 'Step 4', 4, 1));14$rule->addStep(new StepNode('But', 'Step 5', 5, 1));15$builder = new GherkinDocumentBuilder();16$builder->transformRuleNode($rule);17I am trying to use the GherkinDocumentBuilder class to parse a Rule node. I am using the following code to do this:When I run this code, I get the following error:Fatal error: Uncaught Error: Call to undefined method Gherkin\GherkinDocumentBuilder::transformRuleNode() in /var/www/html/2.php:17 Stack trace: #0 {main} thrown in /var/www/html/2.php on line 17I am using the latest version of the Gherkin library (5.0.0). I have also tried the same code with version 4.6.0 and the same error occurs. I have also tried the same code with the GherkinDocumentParser class and it works fine. Am I doing something wrong or is there a bug in the GherkinDocumentBuilder class?Thanks,John

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.

LambdaTest Learning Hubs:

YouTube

You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.

Run Cucumber Common Library automation tests on LambdaTest cloud grid

Perform automation testing on 3000+ real desktop and mobile devices online.

View sample repo

View Documentation Sign up Free

›

Trigger transformRuleNode code on LambdaTest Cloud Grid

Execute automation tests with transformRuleNode on a cloud-based Grid of 3000+ real browsers and operating systems for both web and mobile applications.

Test now for Free