* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Behat\Gherkin\Keywords; /** * Gherkin keywords dumper. * * @author Konstantin Kudryashov */ class KeywordsDumper { /** * @var callable(list, bool): string */ private $keywordsDumper; public function __construct( private readonly KeywordsInterface $keywords, ) { $this->keywordsDumper = [$this, 'dumpKeywords']; } /** * Sets keywords mapper function. * * Callable should accept 2 arguments (array $keywords and bool $isShort) * * @param callable(list, bool): string $mapper Mapper function * * @return void */ public function setKeywordsDumperFunction(callable $mapper) { $this->keywordsDumper = $mapper; } /** * Defaults keywords dumper. * * @param list $keywords Keywords list * @param bool $isShort Is short version * * @return string */ public function dumpKeywords(array $keywords, bool $isShort) { if ($isShort) { return count($keywords) > 1 ? '(' . implode('|', $keywords) . ')' : $keywords[0]; } return $keywords[0]; } /** * Dumps keyworded feature into string. * * @param string $language Keywords language * @param bool $short Dump short version * * @return string|array String for short version and array of features for extended * * @phpstan-return ($short is true ? string : list) */ public function dump(string $language, bool $short = true, bool $excludeAsterisk = false) { $this->keywords->setLanguage($language); $languageComment = ''; if ($language !== 'en') { $languageComment = "# language: $language\n"; } $keywords = explode('|', $this->keywords->getFeatureKeywords()); if ($short) { $keywords = call_user_func($this->keywordsDumper, $keywords, $short); return trim($languageComment . $this->dumpFeature($keywords, $short, $excludeAsterisk)); } $features = []; foreach ($keywords as $keyword) { $keyword = call_user_func($this->keywordsDumper, [$keyword], $short); $features[] = trim($languageComment . $this->dumpFeature($keyword, $short, $excludeAsterisk)); } return $features; } /** * Dumps feature example. * * @param string $keyword Item keyword * @param bool $short Dump short version? * * @return string */ protected function dumpFeature(string $keyword, bool $short = true, bool $excludeAsterisk = false) { $dump = <<keywords->getBackgroundKeywords()); if ($short) { $keywords = call_user_func($this->keywordsDumper, $keywords, $short); $dump .= $this->dumpBackground($keywords, $short, $excludeAsterisk); } else { $keyword = call_user_func($this->keywordsDumper, [$keywords[0]], $short); $dump .= $this->dumpBackground($keyword, $short, $excludeAsterisk); } // Scenario $keywords = explode('|', $this->keywords->getScenarioKeywords()); if ($short) { $keywords = call_user_func($this->keywordsDumper, $keywords, $short); $dump .= $this->dumpScenario($keywords, $short, $excludeAsterisk); } else { foreach ($keywords as $keyword) { $keyword = call_user_func($this->keywordsDumper, [$keyword], $short); $dump .= $this->dumpScenario($keyword, $short, $excludeAsterisk); } } // Outline $keywords = explode('|', $this->keywords->getOutlineKeywords()); if ($short) { $keywords = call_user_func($this->keywordsDumper, $keywords, $short); $dump .= $this->dumpOutline($keywords, $short, $excludeAsterisk); } else { foreach ($keywords as $keyword) { $keyword = call_user_func($this->keywordsDumper, [$keyword], $short); $dump .= $this->dumpOutline($keyword, $short, $excludeAsterisk); } } return $dump; } /** * Dumps background example. * * @param string $keyword Item keyword * @param bool $short Dump short version? * * @return string */ protected function dumpBackground(string $keyword, bool $short = true, bool $excludeAsterisk = false) { $dump = <<dumpStep( $this->keywords->getGivenKeywords(), 'there is agent A', $short, $excludeAsterisk ); // And $dump .= $this->dumpStep( $this->keywords->getAndKeywords(), 'there is agent B', $short, $excludeAsterisk ); return $dump . "\n"; } /** * Dumps scenario example. * * @param string $keyword Item keyword * @param bool $short Dump short version? * * @return string */ protected function dumpScenario(string $keyword, bool $short = true, bool $excludeAsterisk = false) { $dump = <<dumpStep( $this->keywords->getGivenKeywords(), 'there is agent J', $short, $excludeAsterisk ); // And $dump .= $this->dumpStep( $this->keywords->getAndKeywords(), 'there is agent K', $short, $excludeAsterisk ); // When $dump .= $this->dumpStep( $this->keywords->getWhenKeywords(), 'I erase agent K\'s memory', $short, $excludeAsterisk ); // Then $dump .= $this->dumpStep( $this->keywords->getThenKeywords(), 'there should be agent J', $short, $excludeAsterisk ); // But $dump .= $this->dumpStep( $this->keywords->getButKeywords(), 'there should not be agent K', $short, $excludeAsterisk ); return $dump . "\n"; } /** * Dumps outline example. * * @param string $keyword Item keyword * @param bool $short Dump short version? * * @return string */ protected function dumpOutline(string $keyword, bool $short = true, bool $excludeAsterisk = false) { $dump = <<dumpStep( $this->keywords->getGivenKeywords(), 'there is agent ', $short, $excludeAsterisk ); // And $dump .= $this->dumpStep( $this->keywords->getAndKeywords(), 'there is agent ', $short, $excludeAsterisk ); // When $dump .= $this->dumpStep( $this->keywords->getWhenKeywords(), 'I erase agent \'s memory', $short, $excludeAsterisk ); // Then $dump .= $this->dumpStep( $this->keywords->getThenKeywords(), 'there should be agent ', $short, $excludeAsterisk ); // But $dump .= $this->dumpStep( $this->keywords->getButKeywords(), 'there should not be agent ', $short, $excludeAsterisk ); $keywords = explode('|', $this->keywords->getExamplesKeywords()); if ($short) { $keyword = call_user_func($this->keywordsDumper, $keywords, $short); } else { $keyword = call_user_func($this->keywordsDumper, [$keywords[0]], $short); } $dump .= <<keywordsDumper, $keywords, $short); $dump .= <<keywordsDumper, [$keyword], $short); $dump .= <<