feat: channel attribute extraction

Ferror · Feb 3, 2024 · 02268b6 · 02268b6
1 parent 9a828a9
commit 02268b6
Show file tree

Hide file tree

Showing 16 changed files with 198 additions and 93 deletions.
diff --git a/README.md b/README.md
@@ -55,8 +55,10 @@ ferror_asyncapi_doc_bundle_html:
 
 ```php
 use Ferror\AsyncapiDocBundle\Attribute\Message;
+use Ferror\AsyncapiDocBundle\Attribute\Channel;
 
-#[Message(name: 'ProductCreated', channel: 'product.created')]
+#[Message(name: 'ProductCreated')]
+#[Channel(name: 'product.created')] // optional
 final readonly class ProductCreated
 {
     public function __construct(
@@ -81,7 +83,8 @@ use Ferror\AsyncapiDocBundle\Attribute as AA;
 use Ferror\AsyncapiDocBundle\Schema\Format;
 use Ferror\AsyncapiDocBundle\Schema\PropertyType;
 
-#[AA\Message(name: 'ProductCreated', channel: 'product.created')]
+#[AA\Message(name: 'ProductCreated')]
+#[AA\Channel(name: 'product.created')] // optional
 final readonly class ProductCreated
 {
     public function __construct(

diff --git a/phpunit.xml b/phpunit.xml
@@ -16,6 +16,9 @@
         <testsuite name="all">
             <directory>tests</directory>
         </testsuite>
+        <testsuite name="unit">
+            <directory>tests/Unit</directory>
+        </testsuite>
     </testsuites>
 
     <php>

diff --git a/src/Attribute/Channel.php b/src/Attribute/Channel.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ferror\AsyncapiDocBundle\Attribute;
+
+use Attribute;
+use Ferror\AsyncapiDocBundle\Schema\V2\ChannelType;
+
+#[Attribute(Attribute::TARGET_CLASS)]
+readonly class Channel
+{
+    public function __construct(
+        public string $name,
+        public ChannelType $type = ChannelType::SUBSCRIBE,
+    ) {
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'name' => $this->name,
+            'type' => $this->type->value,
+        ];
+    }
+}
diff --git a/src/Attribute/Message.php b/src/Attribute/Message.php
@@ -5,29 +5,27 @@
 namespace Ferror\AsyncapiDocBundle\Attribute;
 
 use Attribute;
-use Ferror\AsyncapiDocBundle\Schema\V2\ChannelType;
 
 #[Attribute(Attribute::TARGET_CLASS)]
 class Message
 {
     /**
      * @param array<Property|PropertyArray|PropertyEnum|PropertyObject|PropertyArrayObject> $properties
+     * @param Channel[] $channels
      */
     public function __construct(
         public readonly string $name,
-        public readonly string $channel,
         public array $properties = [],
-        public readonly ChannelType $channelType = ChannelType::SUBSCRIBE,
+        public array $channels = [],
     ) {
     }
 
     public function toArray(): array
     {
         return [
             'name' => $this->name,
-            'channel' => $this->channel,
             'properties' => array_map(static fn(PropertyInterface $property) => $property->toArray(), $this->properties),
-            'channelType' => $this->channelType->value,
+            'channels' => array_map(static fn(Channel $channel) => $channel->toArray(), $this->channels),
         ];
     }
 
@@ -36,6 +34,11 @@ public function addProperty(Property|PropertyArray|PropertyEnum|PropertyObject|P
         $this->properties[] = $property;
     }
 
+    public function addChannel(Channel $channel): void
+    {
+        $this->channels[] = $channel;
+    }
+
     public function enrich(self $self): self
     {
         // UPDATE EXISTING

diff --git a/src/DocumentationStrategy/AttributeDocumentationStrategy.php b/src/DocumentationStrategy/AttributeDocumentationStrategy.php
@@ -4,6 +4,7 @@
 
 namespace Ferror\AsyncapiDocBundle\DocumentationStrategy;
 
+use Ferror\AsyncapiDocBundle\Attribute\Channel;
 use Ferror\AsyncapiDocBundle\Attribute\Message;
 use ReflectionAttribute;
 use ReflectionClass;
@@ -41,6 +42,14 @@ public function document(string $class): Message
             $message->addProperty($property);
         }
 
+        // Channels are optional as it's possible to document just Messages.
+        /** @var ReflectionAttribute<Channel>[] $messageAttributes */
+        $channelAttributes = $reflection->getAttributes(Channel::class);
+
+        foreach ($channelAttributes as $channelAttribute) {
+            $message->addChannel($channelAttribute->newInstance());
+        }
+
         return $message;
     }
 }
diff --git a/src/Schema/V2/ChannelRenderer.php b/src/Schema/V2/ChannelRenderer.php
@@ -8,14 +8,18 @@ class ChannelRenderer
 {
     public function render(array $document): array
     {
-        $channel[$document['channel']] = [
-            $document['channelType'] => [
-                'message' => [
-                    '$ref' => '#/components/messages/' . $document['name'],
+        $channels = [];
+
+        foreach ($document['channels'] as $channel) {
+            $channels[$channel['name']] = [
+                $channel['type'] => [
+                    'message' => [
+                        '$ref' => '#/components/messages/' . $document['name'],
+                    ],
                 ],
-            ],
-        ];
+            ];
+        }
 
-        return $channel;
+        return $channels;
     }
 }
diff --git a/tests/Examples/PaymentExecuted.php b/tests/Examples/PaymentExecuted.php
@@ -4,12 +4,14 @@
 
 namespace Ferror\AsyncapiDocBundle\Tests\Examples;
 
+use Ferror\AsyncapiDocBundle\Attribute\Channel;
 use Ferror\AsyncapiDocBundle\Attribute\Message;
 
 /**
  * This class represents an example of documenting by ReflectionStrategy
  */
-#[Message(name: 'PaymentExecuted', channel: 'payment_executed')]
+#[Message(name: 'PaymentExecuted')]
+#[Channel(name: 'payment_executed')]
 final readonly class PaymentExecuted
 {
     public function __construct(

diff --git a/tests/Examples/ProductCreated.php b/tests/Examples/ProductCreated.php
@@ -5,6 +5,7 @@
 namespace Ferror\AsyncapiDocBundle\Tests\Examples;
 
 use DateTime;
+use Ferror\AsyncapiDocBundle\Attribute\Channel;
 use Ferror\AsyncapiDocBundle\Attribute\Message;
 use Ferror\AsyncapiDocBundle\Attribute\Property;
 use Ferror\AsyncapiDocBundle\Attribute\PropertyArray;
@@ -17,7 +18,8 @@
 /**
  * This class represents an example of documenting by AttributeStrategy. It contains all types.
  */
-#[Message(name: 'ProductCreated', channel: 'product.created')]
+#[Message(name: 'ProductCreated')]
+#[Channel(name: 'product.created')]
 final readonly class ProductCreated
 {
     /**

diff --git a/tests/Examples/ProductUpdated.php b/tests/Examples/ProductUpdated.php
@@ -5,6 +5,7 @@
 namespace Ferror\AsyncapiDocBundle\Tests\Examples;
 
 use DateTime;
+use Ferror\AsyncapiDocBundle\Attribute\Channel;
 use Ferror\AsyncapiDocBundle\Attribute\Message;
 use Ferror\AsyncapiDocBundle\Attribute\Property;
 use Ferror\AsyncapiDocBundle\Attribute\PropertyArray;
@@ -19,7 +20,6 @@
  */
 #[Message(
     name: 'ProductUpdated',
-    channel: 'product.updated',
     properties: [
         new Property(name: 'id', type: PropertyType::INTEGER),
         new Property(name: 'amount', type: PropertyType::FLOAT),
@@ -32,6 +32,7 @@
         new PropertyArray(name: 'tags', itemsType: PropertyType::STRING),
     ],
 )]
+#[Channel(name: 'product.updated')]
 final readonly class ProductUpdated
 {
     /**

diff --git a/tests/Examples/UserSignedUp.php b/tests/Examples/UserSignedUp.php
@@ -4,6 +4,7 @@
 
 namespace Ferror\AsyncapiDocBundle\Tests\Examples;
 
+use Ferror\AsyncapiDocBundle\Attribute\Channel;
 use Ferror\AsyncapiDocBundle\Attribute\Message;
 use Ferror\AsyncapiDocBundle\Attribute\Property;
 use Ferror\AsyncapiDocBundle\Schema\Format;
@@ -12,7 +13,8 @@
 /**
  * This class represents a SIMPLE example of documenting by AttributeStrategy.
  */
-#[Message(name: 'UserSignedUp', channel: 'user_signed_up')]
+#[Message(name: 'UserSignedUp')]
+#[Channel(name: 'user_signed_up')]
 final readonly class UserSignedUp
 {
     public function __construct(

diff --git a/tests/Unit/Attribute/MessageTest.php b/tests/Unit/Attribute/MessageTest.php
@@ -12,18 +12,18 @@ final class MessageTest extends TestCase
 {
     public function testEnrichAddsProperty(): void
     {
-        $message = new Message('name', 'channel');
+        $message = new Message('name');
 
-        $message->enrich(new Message('name', 'channel', [new Property('name')]));
+        $message->enrich(new Message('name', [new Property('name')]));
 
         $this->assertCount(1, $message->properties);
     }
 
     public function testEnrichUpdatesProperty(): void
     {
-        $message = new Message('name', 'channel', [new Property('name')]);
+        $message = new Message('name', [new Property('name')]);
 
-        $message->enrich(new Message('name', 'channel', [new Property('name', 'Nice Description')]));
+        $message->enrich(new Message('name', [new Property('name', 'Nice Description')]));
 
         $this->assertEquals('Nice Description', $message->properties[0]->description);
     }

diff --git a/tests/Unit/DocumentationEditorTest.php b/tests/Unit/DocumentationEditorTest.php
@@ -24,8 +24,6 @@ public function testDocument(): void
 
         $expected = [
             'name' => 'PaymentExecuted',
-            'channel' => 'payment_executed',
-            'channelType' => 'subscribe',
             'properties' => [
                 [
                     'name' => 'amount',
@@ -44,6 +42,7 @@ public function testDocument(): void
                     'example' => null,
                 ],
             ],
+            'channels' => [],
         ];
 
         $this->assertEquals($expected, $actual);

diff --git a/tests/Unit/DocumentationStrategy/AttributeDocumentationStrategyTest.php b/tests/Unit/DocumentationStrategy/AttributeDocumentationStrategyTest.php
@@ -20,8 +20,6 @@ public function testUserSignedUp(): void
 
         $expected = [
             'name' => 'UserSignedUp',
-            'channel' => 'user_signed_up',
-            'channelType' => 'subscribe',
             'properties' => [
                 [
                     'name' => 'name',
@@ -56,6 +54,12 @@ public function testUserSignedUp(): void
                     'required' => true,
                 ],
             ],
+            'channels' => [
+                [
+                    'name' => 'user_signed_up',
+                    'type' => 'subscribe',
+                ],
+            ],
         ];
 
         $this->assertEquals($expected, $actual);
@@ -69,8 +73,6 @@ public function testProductCreated(): void
 
         $expected = [
             'name' => 'ProductCreated',
-            'channel' => 'product.created',
-            'channelType' => 'subscribe',
             'properties' => [
                 [
                     'name' => 'id',
@@ -146,6 +148,12 @@ public function testProductCreated(): void
                     'required' => true,
                 ],
             ],
+            'channels' => [
+                [
+                    'name' => 'product.created',
+                    'type' => 'subscribe',
+                ],
+            ],
         ];
 
         $this->assertEquals($expected, $actual);

diff --git a/tests/Unit/DocumentationStrategy/ReflectionDocumentationStrategyTest.php b/tests/Unit/DocumentationStrategy/ReflectionDocumentationStrategyTest.php
@@ -17,8 +17,6 @@ public function test(): void
 
         $expected = [
             'name' => 'UserSignedUp',
-            'channel' => 'user_signed_up',
-            'channelType' => 'subscribe',
             'properties' => [
                 [
                     'name' => 'name',
@@ -53,6 +51,7 @@ public function test(): void
                     'example' => null,
                 ],
             ],
+            'channels' => [],
         ];
 
         $this->assertEquals($expected, $documentation->document(UserSignedUp::class)->toArray());
@@ -64,8 +63,6 @@ public function testEnum(): void
 
         $expected = [
             'name' => 'ProductCreated',
-            'channel' => 'product.created',
-            'channelType' => 'subscribe',
             'properties' => [
                 [
                     'name' => 'id',
@@ -100,6 +97,7 @@ public function testEnum(): void
                     'example' => null
                 ],
             ],
+            'channels' => [],
         ];
 
 

diff --git a/tests/Unit/Schema/V2/ChannelRendererTest.php b/tests/Unit/Schema/V2/ChannelRendererTest.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ferror\AsyncapiDocBundle\Tests\Unit\Schema\V2;
+
+use Ferror\AsyncapiDocBundle\Schema\V2\ChannelRenderer;
+use PHPUnit\Framework\TestCase;
+
+class ChannelRendererTest extends TestCase
+{
+    public function testSingleChannel(): void
+    {
+        $document = [
+            'name' => 'UserSignedUp',
+            'channels' => [
+                [
+                    'name' => 'UserSignedUpChannel',
+                    'type' => 'subscribe',
+                ]
+            ]
+        ];
+
+        $schema = new ChannelRenderer();
+
+        $actual = $schema->render($document);
+
+        $expected = [
+            'UserSignedUpChannel' => [
+                'subscribe' => [
+                    'message' => [
+                        '$ref' => '#/components/messages/UserSignedUp',
+                    ]
+                ]
+            ]
+        ];
+
+        $this->assertEquals($expected, $actual);
+    }
+}