Represent inline config as object to hide responsibility for array-ac…

…cess to properties inside it + add access to raw data to wide compatibility (permit access to not described fields).
Aeliot-Tm · Jul 1, 2024 · 3e22215 · 3e22215
1 parent 7b2ffcc
commit 3e22215
Show file tree

Hide file tree

Showing 9 changed files with 134 additions and 22 deletions.
diff --git a/src/ApplicationFactory.php b/src/ApplicationFactory.php
@@ -12,6 +12,7 @@
 use Aeliot\TodoRegistrar\Service\FileProcessor;
 use Aeliot\TodoRegistrar\Service\InlineConfig\ArrayFromJsonLexerBuilder;
 use Aeliot\TodoRegistrar\Service\InlineConfig\ExtrasReader;
+use Aeliot\TodoRegistrar\Service\InlineConfig\InlineConfigFactory;
 use Aeliot\TodoRegistrar\Service\Registrar\RegistrarFactoryInterface;
 use Aeliot\TodoRegistrar\Service\Registrar\RegistrarFactoryRegistry;
 use Aeliot\TodoRegistrar\Service\Registrar\RegistrarInterface;
@@ -35,12 +36,13 @@ public function create(Config $config): Application
     private function createCommentRegistrar(RegistrarInterface $registrar, Config $config): CommentRegistrar
     {
         $inlineConfigReader = $config->getInlineConfigReader() ?? new ExtrasReader(new ArrayFromJsonLexerBuilder());
+        $inlineConfigFactory = $config->getInlineConfigFactory() ?? new InlineConfigFactory();
 
         return new CommentRegistrar(
             new Detector(),
             new Extractor(new TagDetector($config->getTags())),
             $registrar,
-            new TodoFactory($inlineConfigReader),
+            new TodoFactory($inlineConfigFactory, $inlineConfigReader),
         );
     }
 

diff --git a/src/Config.php b/src/Config.php
@@ -11,6 +11,7 @@
 class Config
 {
     private Finder $finder;
+    private ?InlineConfigFactoryInterface $InlineConfigFactory = null;
     private ?InlineConfigReaderInterface $inlineConfigReader = null;
     /**
      * @var array<string,mixed>
@@ -34,6 +35,26 @@ public function setFinder(Finder $finder): self
         return $this;
     }
 
+    public function getInlineConfigFactory(): ?InlineConfigFactoryInterface
+    {
+        return $this->InlineConfigFactory;
+    }
+
+    public function setInlineConfigFactory(?InlineConfigFactoryInterface $InlineConfigFactory): void
+    {
+        $this->InlineConfigFactory = $InlineConfigFactory;
+    }
+
+    public function getInlineConfigReader(): ?InlineConfigReaderInterface
+    {
+        return $this->inlineConfigReader;
+    }
+
+    public function setInlineConfigReader(?InlineConfigReaderInterface $inlineConfigReader): void
+    {
+        $this->inlineConfigReader = $inlineConfigReader;
+    }
+
     /**
      * @return array<string,mixed>
      */
@@ -75,14 +96,4 @@ public function setTags(array $tags): self
 
         return $this;
     }
-
-    public function getInlineConfigReader(): ?InlineConfigReaderInterface
-    {
-        return $this->inlineConfigReader;
-    }
-
-    public function setInlineConfigReader(?InlineConfigReaderInterface $inlineConfigReader): void
-    {
-        $this->inlineConfigReader = $inlineConfigReader;
-    }
 }
diff --git a/src/Dto/InlineConfig/InlineConfig.php b/src/Dto/InlineConfig/InlineConfig.php
@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Aeliot\TodoRegistrar\Dto\InlineConfig;
+
+use Aeliot\TodoRegistrar\InlineConfigInterface;
+
+class InlineConfig implements InlineConfigInterface
+{
+    /**
+     * @param array<array-key,mixed> $data
+     */
+    public function __construct(
+        private array $data,
+    ) {
+    }
+
+    /**
+     * @param int|string $offset
+     */
+    public function offsetExists(mixed $offset): bool
+    {
+        return array_key_exists($offset, $this->data);
+    }
+
+    /**
+     * @param int|string $offset
+     */
+    public function offsetGet(mixed $offset): mixed
+    {
+        return $this->data[$offset];
+    }
+
+    /**
+     * @param int|string $offset
+     */
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        throw new \BadMethodCallException('Setting value is not allowed.');
+    }
+
+    /**
+     * @param int|string $offset
+     */
+    public function offsetUnset(mixed $offset): void
+    {
+        throw new \BadMethodCallException('Unsetting value is not allowed.');
+    }
+}
diff --git a/src/Dto/Registrar/Todo.php b/src/Dto/Registrar/Todo.php
@@ -4,17 +4,16 @@
 
 namespace Aeliot\TodoRegistrar\Dto\Registrar;
 
+use Aeliot\TodoRegistrar\InlineConfigInterface;
+
 class Todo
 {
-    /**
-     * @param array<array-key,mixed> $inlineConfig
-     */
     public function __construct(
         private string $tag,
         private string $summary,
         private string $description,
         private ?string $assignee,
-        private array $inlineConfig,
+        private InlineConfigInterface $inlineConfig,
     ) {
     }
 
@@ -28,7 +27,7 @@ public function getDescription(): string
         return $this->description;
     }
 
-    public function getInlineConfig(): array
+    public function getInlineConfig(): InlineConfigInterface
     {
         return $this->inlineConfig;
     }

diff --git a/src/InlineConfigFactoryInterface.php b/src/InlineConfigFactoryInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Aeliot\TodoRegistrar;
+
+interface InlineConfigFactoryInterface
+{
+    /**
+     * @param array<array-key,mixed> $input
+     */
+    public function getInlineConfig(array $input): InlineConfigInterface;
+}
diff --git a/src/InlineConfigInterface.php b/src/InlineConfigInterface.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Aeliot\TodoRegistrar;
+
+interface InlineConfigInterface extends \ArrayAccess
+{
+}
diff --git a/src/Service/InlineConfig/InlineConfigFactory.php b/src/Service/InlineConfig/InlineConfigFactory.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Aeliot\TodoRegistrar\Service\InlineConfig;
+
+use Aeliot\TodoRegistrar\Dto\InlineConfig\InlineConfig;
+use Aeliot\TodoRegistrar\InlineConfigFactoryInterface;
+use Aeliot\TodoRegistrar\InlineConfigInterface;
+
+final class InlineConfigFactory implements InlineConfigFactoryInterface
+{
+    public function getInlineConfig(array $input): InlineConfigInterface
+    {
+        return new InlineConfig($input);
+    }
+}
diff --git a/src/Service/TodoFactory.php b/src/Service/TodoFactory.php
@@ -6,11 +6,16 @@
 
 use Aeliot\TodoRegistrar\Dto\Comment\CommentPart;
 use Aeliot\TodoRegistrar\Dto\Registrar\Todo;
+use Aeliot\TodoRegistrar\InlineConfigFactoryInterface;
+use Aeliot\TodoRegistrar\InlineConfigInterface;
 use Aeliot\TodoRegistrar\InlineConfigReaderInterface;
 
 class TodoFactory
 {
-    public function __construct(private InlineConfigReaderInterface $inlineConfigReader)
+    public function __construct(
+        private InlineConfigFactoryInterface $inlineConfigFactory,
+        private InlineConfigReaderInterface $inlineConfigReader,
+    )
     {
     }
 
@@ -23,7 +28,12 @@ public function create(CommentPart $commentPart): Todo
             $commentPart->getFirstLine(),
             $commentPart->getContent(),
             $commentPart->getTagMetadata()?->getAssignee(),
-            $this->inlineConfigReader->getInlineConfig($description),
+            $this->getInlineConfig($description),
         );
     }
+
+    private function getInlineConfig(string $description): InlineConfigInterface
+    {
+        return $this->inlineConfigFactory->getInlineConfig($this->inlineConfigReader->getInlineConfig($description));
+    }
 }
diff --git a/tests/Unit/Service/CommentRegistrarTest.php b/tests/Unit/Service/CommentRegistrarTest.php
@@ -13,6 +13,7 @@
 use Aeliot\TodoRegistrar\Service\CommentRegistrar;
 use Aeliot\TodoRegistrar\Service\InlineConfig\ArrayFromJsonLexerBuilder;
 use Aeliot\TodoRegistrar\Service\InlineConfig\ExtrasReader;
+use Aeliot\TodoRegistrar\Service\InlineConfig\InlineConfigFactory;
 use Aeliot\TodoRegistrar\Service\Registrar\RegistrarInterface;
 use Aeliot\TodoRegistrar\Service\TodoFactory;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -35,7 +36,7 @@ public function testDontRegisterTwice(): void
         $commentParts = $this->createCommentParts($tokens[2]->text);
         $commentExtractor = $this->mockCommentExtractor($commentParts);
 
-        $todoFactory = new TodoFactory(new ExtrasReader(new ArrayFromJsonLexerBuilder()));
+        $todoFactory = new TodoFactory(new InlineConfigFactory(), new ExtrasReader(new ArrayFromJsonLexerBuilder()));
         $todo = $todoFactory->create($commentParts->getTodos()[0]);
 
         $registrar = $this->mockRegistrar($todo, true);
@@ -59,7 +60,7 @@ public function testDontRegisterTwiceWithIssueKey(): void
         $commentParts = $this->createCommentParts($tokens[2]->text, 'X-001');
         $commentExtractor = $this->mockCommentExtractor($commentParts);
 
-        $todoFactory = new TodoFactory(new ExtrasReader(new ArrayFromJsonLexerBuilder()));
+        $todoFactory = new TodoFactory(new InlineConfigFactory(), new ExtrasReader(new ArrayFromJsonLexerBuilder()));
 
         $registrar = $this->createMock(RegistrarInterface::class);
         $registrar
@@ -81,7 +82,7 @@ public function testRegisterNewTodos(): void
         $commentExtractor = $this->mockCommentExtractor($commentParts);
 
         $token = $commentParts->getTodos()[0];
-        $todoFactory = new TodoFactory(new ExtrasReader(new ArrayFromJsonLexerBuilder()));
+        $todoFactory = new TodoFactory(new InlineConfigFactory(), new ExtrasReader(new ArrayFromJsonLexerBuilder()));
         $todo = $todoFactory->create($token);
 
         $registrar = $this->mockRegistrar($todo, false);
@@ -160,4 +161,4 @@ private function mockRegistrar(Todo $todo, bool $isRegistered): RegistrarInterfa
 
         return $registrar;
     }
-}
+}