Merge pull request #18 from Jeroen-G/tagged

allow tagged classes in configuration

Author: Jeroen-G

changelog.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [2.0.0]
+
+### Added
+- Configurations can now include tags
+
 ## [1.9.0]
 
 ### Added

readme.md

@@ -146,6 +146,9 @@ The notations of config and service definitions is the same as used in Symfony.
 // Will inject an instance of the Message class
 #[Configure(['$message' => '@App\Domain\Message'])]
 
+// When you want tagged classes
+#[Configure(['$messages' => '#messages'])]
+
 // When you have multiple constructor arguments
 #[Configure(['$message' => '%app.message%', '$logger' => '@Psr\Log\LoggerInterface'])]
 ```

src/Attribute/Configure.php

@@ -15,6 +15,8 @@ final class Configure implements ConfigureInterface
 
     private array $definitions = [];
 
+    private array $tags = [];
+
     public function __construct(array $cables)
     {
         foreach ($cables as $variable => $value) {
@@ -37,6 +39,11 @@ public function getDefinitions(): array
         return $this->definitions;
     }
 
+    public function getTags(): array
+    {
+        return $this->tags;
+    }
+
     private function parse(string $variable, string $value): void
     {
         $hasConfig = preg_match("/%(.*)%/", $value, $config);
@@ -53,6 +60,13 @@ private function parse(string $variable, string $value): void
             return;
         }
 
+        $hasTag = preg_match("/#(.*)/", $value, $service);
+
+        if ($hasTag === 1) {
+            $this->tags[$variable] = $service[1];
+            return;
+        }
+
         $this->definitions[$variable] = $value;
     }
 }

src/Attribute/ConfigureInterface.php

@@ -20,4 +20,9 @@ public function getServices(): array;
      * @return array<non-empty-string, scalar>
      */
     public function getDefinitions(): array;
+
+    /**
+     * @return array<non-empty-string, scalar>
+     */
+    public function getTags(): array;
 }

src/AutowireServiceProvider.php

@@ -4,6 +4,8 @@
 
 namespace JeroenG\Autowire;
 
+use App\Console\Commands\Bot\SendEndOfWeekUpdate;
+use App\Domain\Bot\AlarmBellInterface;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\File;
@@ -131,6 +133,9 @@ private function define(string $implementation, ConfigurationValue $definition):
                 $give = $this->app->make($definition->give);
                 $this->app->when($implementation)->needs($definition->need)->give($give);
                 break;
+            case ConfigurationType::TAGGED:
+                $this->app->when($implementation)->needs($definition->need)->giveTagged($definition->give);
+                break;
             case ConfigurationType::UNKNOWN:
             default:
                 $this->app->when($implementation)->needs($definition->need)->give($definition->give);

src/ConfigurationType.php

@@ -10,5 +10,7 @@ final class ConfigurationType
 
     public const SERVICE = 'service';
 
+    public const TAGGED = 'tagged';
+
     public const UNKNOWN = 'unknown';
 }

src/Electrician.php

@@ -70,6 +70,10 @@ public function configure(string $implementation): Configuration
                 $configurations[] = new ConfigurationValue($need, $give, ConfigurationType::SERVICE);
             }
 
+            foreach ($instance->getTags() as $need => $give) {
+                $configurations[] = new ConfigurationValue($need, $give, ConfigurationType::TAGGED);
+            }
+
             foreach ($instance->getDefinitions() as $need => $give) {
                 $configurations[] = new ConfigurationValue($need, $give, ConfigurationType::UNKNOWN);
             }

tests/Support/Attributes/CustomConfigure.php

@@ -16,6 +16,8 @@ class CustomConfigure implements ConfigureInterface
 
     private array $definitions = [];
 
+    private array $tags = [];
+
     public function __construct(array $cables)
     {
         foreach ($cables as $variable => $value) {
@@ -38,6 +40,11 @@ public function getDefinitions(): array
         return $this->definitions;
     }
 
+    public function getTags(): array
+    {
+        return $this->tags;
+    }
+
     private function parse(string $variable, string $value): void
     {
         $hasConfig = preg_match("/%(.*)%/", $value, $config);
@@ -54,6 +61,13 @@ private function parse(string $variable, string $value): void
             return;
         }
 
+        $hasTag = preg_match("/#(.*)/", $value, $service);
+
+        if ($hasTag === 1) {
+            $this->tags[$variable] = $service[1];
+            return;
+        }
+
         $this->definitions[$variable] = $value;
     }
 }

tests/Support/Subject/Contracts/GoodeveningInterface.php

@@ -6,7 +6,7 @@
 
 use JeroenG\Autowire\Attribute\Tag;
 
-#[Tag('evening')]
+#[Tag('#evening')]
 interface GoodeveningInterface
 {
     public function goodevening(): string;

tests/Support/Subject/Domain/Greeting/TagGreeting.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JeroenG\Autowire\Tests\Support\Subject\Domain\Greeting;
+
+use JeroenG\Autowire\Attribute\Configure;
+
+#[Configure(['$greeting' => '#evening'])]
+class TagGreeting
+{
+    private $greeting;
+
+    public function __construct($greeting)
+    {
+        $this->greeting = $greeting;
+    }
+
+    public function getGreeting()
+    {
+        return $this->greeting;
+    }
+}