Merge pull request #17 from Setono/add-consentable-tag

Add consentable script tag

composer.json

@@ -18,9 +18,9 @@
     },
     "require-dev": {
         "infection/infection": "^0.26",
-        "phpunit/phpunit": "^9.5",
-        "psalm/plugin-phpunit": "^0.17",
-        "setono/code-quality-pack": "^2.2"
+        "phpunit/phpunit": "^9.6",
+        "psalm/plugin-phpunit": "^0.18",
+        "setono/code-quality-pack": "^2.4"
     },
     "prefer-stable": true,
     "autoload": {

src/Tag/AttributesAwareTrait.php

@@ -4,11 +4,27 @@
 
 namespace Setono\TagBag\Tag;
 
+use InvalidArgumentException;
+
 trait AttributesAwareTrait
 {
     /** @var array<string, string|null> */
     protected array $attributes = [];
 
+    public function hasAttribute(string $attribute): bool
+    {
+        return array_key_exists($attribute, $this->attributes);
+    }
+
+    public function getAttribute(string $attribute): ?string
+    {
+        if (!$this->hasAttribute($attribute)) {
+            throw new InvalidArgumentException(sprintf('The attribute "%s" does not exist', $attribute));
+        }
+
+        return $this->attributes[$attribute];
+    }
+
     /**
      * @return array<string, string|null>
      */

src/Tag/ConsentableScriptTag.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\TagBag\Tag;
+
+/**
+ * The script tag represents script tags in the form of <script type="text/plain" src="..."></script>
+ */
+final class ConsentableScriptTag extends ElementTag
+{
+    /**
+     * @return static
+     */
+    public static function create(string $src, string $consentType = null): self
+    {
+        $obj = parent::createWithoutContent('script')
+            ->withSrc($src)
+            ->withType('text/plain')
+        ;
+
+        if (null !== $consentType) {
+            $obj = $obj->withAttribute('data-consent', $consentType);
+        }
+
+        return $obj;
+    }
+
+    /**
+     * Returns the src attribute value for the <script src="..."> tag
+     */
+    public function getSrc(): ?string
+    {
+        return $this->attributes['src'] ?? null;
+    }
+
+    /**
+     * @return static
+     */
+    public function withSrc(string $src): self
+    {
+        return $this->withAttribute('src', $src);
+    }
+
+    /**
+     * Returns the type attribute for the <script type="..."> tag
+     */
+    public function getType(): ?string
+    {
+        return $this->attributes['type'] ?? null;
+    }
+
+    /**
+     * @return static
+     */
+    public function withType(string $type): self
+    {
+        return $this->withAttribute('type', $type);
+    }
+}

tests/Tag/ConsentableScriptTagTest.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\TagBag\Tag;
+
+use PHPUnit\Framework\TestCase;
+
+final class ConsentableScriptTagTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_creates(): void
+    {
+        $tag = ConsentableScriptTag::create('https://example.com/script.js');
+
+        self::assertInstanceOf(TagInterface::class, $tag);
+        self::assertInstanceOf(ContentAwareInterface::class, $tag);
+        self::assertInstanceOf(AttributesAwareInterface::class, $tag);
+    }
+
+    /**
+     * @test
+     */
+    public function it_has_default_values(): void
+    {
+        $tag = ConsentableScriptTag::create('https://example.com/script.js', 'marketing');
+
+        self::assertSame('https://example.com/script.js', $tag->getSrc());
+        self::assertSame('text/plain', $tag->getType());
+        self::assertSame('marketing', $tag->getAttribute('data-consent'));
+    }
+
+    /**
+     * @test
+     */
+    public function it_has_immutable_setters(): void
+    {
+        $tag = ConsentableScriptTag::create('https://example.com/script.js')->withType('type');
+        $newTag = $tag->withSrc('https://example.com/script2.js')->withType('new_type');
+
+        self::assertNotSame($tag, $newTag);
+
+        self::assertSame('type', $tag->getType());
+        self::assertSame('new_type', $newTag->getType());
+
+        self::assertSame('https://example.com/script.js', $tag->getSrc());
+        self::assertSame('https://example.com/script2.js', $newTag->getSrc());
+    }
+}