Improve tag handling; update test

Author: uuf6429

src/Node/ExampleNode.php

@@ -17,6 +17,8 @@
  */
 class ExampleNode implements ScenarioInterface, NamedScenarioInterface
 {
+    use TaggedNodeTrait;
+
     /**
      * @var string
      */
@@ -105,33 +107,6 @@ public function getTitle()
         return $this->text;
     }
 
-    /**
-     * Checks if outline is tagged with tag.
-     *
-     * @param string $tag
-     *
-     * @return bool
-     */
-    public function hasTag($tag)
-    {
-        return in_array($tag, $this->getTags());
-    }
-
-    /**
-     * Checks if outline has tags (both inherited from feature and own).
-     *
-     * @return bool
-     */
-    public function hasTags()
-    {
-        return count($this->getTags()) > 0;
-    }
-
-    /**
-     * Returns outline tags (including inherited from feature).
-     *
-     * @return string[]
-     */
     public function getTags()
     {
         return $this->tags;

src/Node/ExampleTableNode.php

@@ -15,8 +15,10 @@
  *
  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  */
-class ExampleTableNode extends TableNode
+class ExampleTableNode extends TableNode implements TaggedNodeInterface
 {
+    use TaggedNodeTrait;
+
     /**
      * @var string[]
      */
@@ -52,11 +54,6 @@ public function getNodeType()
         return 'ExampleTable';
     }
 
-    /**
-     * Returns attached tags.
-     *
-     * @return string[]
-     */
     public function getTags()
     {
         return $this->tags;

src/Node/FeatureNode.php

@@ -21,6 +21,8 @@
  */
 class FeatureNode implements KeywordNodeInterface, TaggedNodeInterface
 {
+    use TaggedNodeTrait;
+
     /**
      * @var string|null
      */
@@ -136,33 +138,6 @@ public function getDescription()
         return $this->description;
     }
 
-    /**
-     * Checks if feature is tagged with tag.
-     *
-     * @param string $tag
-     *
-     * @return bool
-     */
-    public function hasTag($tag)
-    {
-        return in_array($tag, $this->tags);
-    }
-
-    /**
-     * Checks if feature has tags.
-     *
-     * @return bool
-     */
-    public function hasTags()
-    {
-        return count($this->tags) > 0;
-    }
-
-    /**
-     * Returns feature tags.
-     *
-     * @return string[]
-     */
     public function getTags()
     {
         return $this->tags;

src/Node/OutlineNode.php

@@ -17,6 +17,8 @@
  */
 class OutlineNode implements ScenarioInterface
 {
+    use TaggedNodeTrait;
+
     /**
      * @var string
      */
@@ -92,33 +94,6 @@ public function getTitle()
         return $this->title;
     }
 
-    /**
-     * Checks if outline is tagged with tag.
-     *
-     * @param string $tag
-     *
-     * @return bool
-     */
-    public function hasTag($tag)
-    {
-        return in_array($tag, $this->getTags());
-    }
-
-    /**
-     * Checks if outline has tags (both inherited from feature and own).
-     *
-     * @return bool
-     */
-    public function hasTags()
-    {
-        return count($this->getTags()) > 0;
-    }
-
-    /**
-     * Returns outline tags (including inherited from feature).
-     *
-     * @return string[]
-     */
     public function getTags()
     {
         return $this->tags;

src/Node/ScenarioNode.php

@@ -17,6 +17,8 @@
  */
 class ScenarioNode implements ScenarioInterface, NamedScenarioInterface
 {
+    use TaggedNodeTrait;
+
     /**
      * @var string
      */
@@ -83,33 +85,6 @@ public function getName(): ?string
         return $this->title;
     }
 
-    /**
-     * Checks if scenario is tagged with tag.
-     *
-     * @param string $tag
-     *
-     * @return bool
-     */
-    public function hasTag($tag)
-    {
-        return in_array($tag, $this->getTags());
-    }
-
-    /**
-     * Checks if scenario has tags (both inherited from feature and own).
-     *
-     * @return bool
-     */
-    public function hasTags()
-    {
-        return count($this->getTags()) > 0;
-    }
-
-    /**
-     * Returns scenario tags (including inherited from feature).
-     *
-     * @return array
-     */
     public function getTags()
     {
         return $this->tags;

src/Node/TaggedNodeInterface.php

@@ -27,14 +27,14 @@ interface TaggedNodeInterface extends NodeInterface
     public function hasTag($tag);
 
     /**
-     * Checks if node has tags (both inherited from feature and own).
+     * Checks if node has tags (including any inherited tags e.g. from feature).
      *
      * @return bool
      */
     public function hasTags();
 
     /**
-     * Returns node tags (including inherited from feature).
+     * Returns node tags (including any inherited tags e.g. from feature).
      *
      * @return list<string>
      */

src/Node/TaggedNodeTrait.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Behat Gherkin Parser.
+ * (c) Konstantin Kudryashov <ever.zet@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Behat\Gherkin\Node;
+
+/**
+ * This trait partially implements {@see TaggedNodeInterface}.
+ */
+trait TaggedNodeTrait
+{
+    /**
+     * @return list<string>
+     */
+    abstract public function getTags();
+
+    /**
+     * @param string $tag
+     *
+     * @return bool
+     */
+    public function hasTag($tag)
+    {
+        return in_array($tag, $this->getTags(), true);
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasTags()
+    {
+        return $this->getTags() !== [];
+    }
+}

tests/Node/OutlineNodeTest.php

@@ -128,11 +128,15 @@ public function testPopulatesExampleWithOutlineTitle(): void
             new StepNode('', 'I am <name>', [], 1, 'Given'),
         ];
 
-        $table = new ExampleTableNode([
-            10 => ['name', 'email'],
-            11 => ['Ciaran', 'ciaran@example.com'],
-            12 => ['John', 'john@example.com'],
-        ], 'Examples');
+        $table = new ExampleTableNode(
+            [
+                10 => ['name', 'email'],
+                11 => ['Ciaran', 'ciaran@example.com'],
+                12 => ['John', 'john@example.com'],
+            ],
+            'Examples',
+            ['tagA', 'tagB'],
+        );
 
         $outline = new OutlineNode('An outline title for <name>', [], $steps, $table, '', 1);
 
@@ -143,12 +147,14 @@ public function testPopulatesExampleWithOutlineTitle(): void
                     'getTitle' => '| Ciaran | ciaran@example.com |',
                     'getOutlineTitle' => 'An outline title for <name>',
                     'getExampleText' => '| Ciaran | ciaran@example.com |',
+                    'getTags' => ['tagA', 'tagB'],
                 ],
                 [
                     'getName' => 'An outline title for John #2',
                     'getTitle' => '| John   | john@example.com   |',
                     'getOutlineTitle' => 'An outline title for <name>',
                     'getExampleText' => '| John   | john@example.com   |',
+                    'getTags' => ['tagA', 'tagB'],
                 ],
             ],
             array_map(
@@ -158,6 +164,7 @@ static function (ExampleNode $node) {
                         'getTitle' => $node->getTitle(),
                         'getOutlineTitle' => $node->getOutlineTitle(),
                         'getExampleText' => $node->getExampleText(),
+                        'getTags' => $node->getTags(),
                     ];
                 },
                 $outline->getExamples()