Merge pull request #77 from chimeraphp/implement-input-extractors

Provide interfaces for input extraction

src/MessageCreator/InputExtractor.php

@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+namespace Chimera\MessageCreator;
+
+use Chimera\Input;
+
+interface InputExtractor
+{
+    /** @return array<string, mixed> */
+    public function extractData(Input $input): array;
+}

src/MessageCreator/InputExtractor/AppendGeneratedIdentifier.php

@@ -0,0 +1,35 @@
+<?php
+declare(strict_types=1);
+
+namespace Chimera\MessageCreator\InputExtractor;
+
+use Chimera\IdentifierGenerator;
+use Chimera\Input;
+use Chimera\MessageCreator\InputExtractor;
+
+final class AppendGeneratedIdentifier implements InputExtractor
+{
+    private const DEFAULT_NAME = 'id';
+
+    private InputExtractor $decorated;
+    private string $attributeName;
+
+    public function __construct(InputExtractor $decorated, string $attributeName = self::DEFAULT_NAME)
+    {
+        $this->decorated     = $decorated;
+        $this->attributeName = $attributeName;
+    }
+
+    /** @inheritdoc */
+    public function extractData(Input $input): array
+    {
+        $id   = $input->getAttribute(IdentifierGenerator::class);
+        $data = $this->decorated->extractData($input);
+
+        if ($id === null) {
+            return $data;
+        }
+
+        return [$this->attributeName => $id] + $data;
+    }
+}

src/MessageCreator/InputExtractor/UseInputData.php

@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace Chimera\MessageCreator\InputExtractor;
+
+use Chimera\Input;
+use Chimera\MessageCreator\InputExtractor;
+
+final class UseInputData implements InputExtractor
+{
+    /** @inheritdoc */
+    public function extractData(Input $input): array
+    {
+        return $input->getData();
+    }
+}

tests/MessageCreator/InputExtractor/AppendGeneratedIdentifierTest.php

@@ -0,0 +1,73 @@
+<?php
+declare(strict_types=1);
+
+namespace Chimera\MessageCreator\Tests\Unit\InputExtractor;
+
+use Chimera\Input;
+use Chimera\MessageCreator\InputExtractor\AppendGeneratedIdentifier;
+use Chimera\MessageCreator\InputExtractor\UseInputData;
+use PHPUnit\Framework\TestCase;
+use Ramsey\Uuid\Uuid;
+
+/**
+ * @coversDefaultClass \Chimera\MessageCreator\InputExtractor\AppendGeneratedIdentifier
+ *
+ * @uses \Chimera\MessageCreator\InputExtractor\UseInputData
+ */
+final class AppendGeneratedIdentifierTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @covers ::__construct
+     * @covers ::extractData
+     */
+    public function extractDataShouldAddTheIdentifierAttributeWhenItExists(): void
+    {
+        $id = Uuid::uuid4();
+
+        $input = $this->createMock(Input::class);
+        $input->method('getData')->willReturn(['testing' => 1]);
+        $input->method('getAttribute')->willReturn($id);
+
+        $extractor = new AppendGeneratedIdentifier(new UseInputData());
+
+        self::assertSame(['id' => $id, 'testing' => 1], $extractor->extractData($input));
+    }
+
+    /**
+     * @test
+     *
+     * @covers ::__construct
+     * @covers ::extractData
+     */
+    public function extractDataShouldOverrideInputData(): void
+    {
+        $id = Uuid::uuid4();
+
+        $input = $this->createMock(Input::class);
+        $input->method('getData')->willReturn(['testing' => 1, 'id' => '123']);
+        $input->method('getAttribute')->willReturn($id);
+
+        $extractor = new AppendGeneratedIdentifier(new UseInputData());
+
+        self::assertSame(['id' => $id, 'testing' => 1], $extractor->extractData($input));
+    }
+
+    /**
+     * @test
+     *
+     * @covers ::__construct
+     * @covers ::extractData
+     */
+    public function extractDataShouldReturnTheInputDataWhenIdentifierAttributeDoesNotExist(): void
+    {
+        $input = $this->createMock(Input::class);
+        $input->method('getData')->willReturn(['testing' => 1, 'id' => '123']);
+        $input->method('getAttribute')->willReturn(null);
+
+        $extractor = new AppendGeneratedIdentifier(new UseInputData());
+
+        self::assertSame(['testing' => 1, 'id' => '123'], $extractor->extractData($input));
+    }
+}

tests/MessageCreator/InputExtractor/UseInputDataTest.php

@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+namespace Chimera\MessageCreator\Tests\Unit\InputExtractor;
+
+use Chimera\Input;
+use Chimera\MessageCreator\InputExtractor\UseInputData;
+use PHPUnit\Framework\TestCase;
+
+/** @coversDefaultClass \Chimera\MessageCreator\InputExtractor\UseInputData */
+final class UseInputDataTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @covers ::extractData
+     */
+    public function extractDataShouldReturnTheInputData(): void
+    {
+        $input = $this->createMock(Input::class);
+        $input->method('getData')->willReturn(['testing' => 1]);
+
+        $extractor = new UseInputData();
+
+        self::assertSame(['testing' => 1], $extractor->extractData($input));
+    }
+}