Merge pull request #60 from php-etl/feature/add-category-enriched-att…

…ributes-parameter Add new parameter for endpoint category
php-etl · May 28, 2024 · 8bd9897 · 8bd9897
2 parents 1c5ef48 + b85c8b0
commit 8bd9897
Show file tree

Hide file tree

Showing 11 changed files with 70 additions and 29 deletions.
diff --git a/src/Builder/Capacity/Extractor/All.php b/src/Builder/Capacity/Extractor/All.php
@@ -15,6 +15,7 @@ final class All implements Builder
     private ?Node\Expr $code = null;
     private ?Node\Expr $referenceEntity = null;
     private ?Node\Expr $referenceEntityAttributeCode = null;
+    private ?Node\Expr $withEnrichedAttributes = null;
 
     public function withEndpoint(Node\Expr|Node\Identifier $endpoint): self
     {
@@ -51,6 +52,13 @@ public function withReferenceEntityAttributeOption(?Node\Expr $referenceEntityAt
         return $this;
     }
 
+    public function withEnrichedAttributes(?Node\Expr $withEnrichedAttributes): self
+    {
+        $this->withEnrichedAttributes = $withEnrichedAttributes;
+
+        return $this;
+    }
+
     public function getNode(): Node
     {
         if (null === $this->endpoint) {
@@ -109,9 +117,21 @@ private function compileArguments(): array
         $args = [];
 
         if (null !== $this->search) {
+            $items = $this->compileSearch();
+            if (null !== $this->withEnrichedAttributes) {
+                $items = array_merge(
+                    $this->compileSearch(),
+                    [
+                        new Node\Expr\ArrayItem(
+                            $this->withEnrichedAttributes,
+                            new Node\Scalar\String_('with_enriched_attributes'),
+                        ),
+                    ]
+                );
+            }
             $args[] = new Node\Arg(
                 value: new Node\Expr\Array_(
-                    items: $this->compileSearch(),
+                    items: $items,
                     attributes: [
                         'kind' => Node\Expr\Array_::KIND_SHORT,
                     ]
@@ -141,6 +161,23 @@ private function compileArguments(): array
             );
         }
 
+        if (null !== $this->withEnrichedAttributes && null === $this->search) {
+            $args[] = new Node\Arg(
+                value: new Node\Expr\Array_(
+                    items: [
+                        new Node\Expr\ArrayItem(
+                            $this->withEnrichedAttributes,
+                            new Node\Scalar\String_('with_enriched_attributes'),
+                        ),
+                    ],
+                    attributes: [
+                        'kind' => Node\Expr\Array_::KIND_SHORT,
+                    ]
+                ),
+                name: new Node\Identifier('queryParameters'),
+            );
+        }
+
         return $args;
     }
 }
diff --git a/src/Builder/Capacity/Extractor/Get.php b/src/Builder/Capacity/Extractor/Get.php
@@ -13,10 +13,6 @@ final class Get implements Builder
     private Node\Expr|Node\Identifier|null $endpoint = null;
     private ?Node\Expr $identifier = null;
 
-    public function __construct()
-    {
-    }
-
     public function withEndpoint(Node\Expr|Node\Identifier $endpoint): self
     {
         $this->endpoint = $endpoint;

diff --git a/src/Builder/Capacity/Extractor/ListPerPage.php b/src/Builder/Capacity/Extractor/ListPerPage.php
@@ -14,10 +14,6 @@ final class ListPerPage implements Builder
     private ?Node\Expr $search = null;
     private ?Node\Expr $code = null;
 
-    public function __construct()
-    {
-    }
-
     public function withEndpoint(Node\Expr|Node\Identifier $endpoint): self
     {
         $this->endpoint = $endpoint;

diff --git a/src/Builder/Capacity/Lookup/All.php b/src/Builder/Capacity/Lookup/All.php
@@ -15,10 +15,6 @@ final class All implements Builder
     private ?Node\Expr $code = null;
     private string $type = '';
 
-    public function __construct()
-    {
-    }
-
     public function withEndpoint(Node\Expr|Node\Identifier $endpoint): self
     {
         $this->endpoint = $endpoint;

diff --git a/src/Builder/Capacity/Lookup/Download.php b/src/Builder/Capacity/Lookup/Download.php
@@ -14,10 +14,6 @@ final class Download implements Builder
     private Node\Expr|Node\Identifier|null $endpoint = null;
     private ?Node\Expr $file = null;
 
-    public function __construct()
-    {
-    }
-
     public function withEndpoint(Node\Expr|Node\Identifier $endpoint): self
     {
         $this->endpoint = $endpoint;

diff --git a/src/Builder/Capacity/Lookup/Get.php b/src/Builder/Capacity/Lookup/Get.php
@@ -15,10 +15,6 @@ final class Get implements Builder
     private ?Node\Expr $code = null;
     private ?string $type = '';
 
-    public function __construct()
-    {
-    }
-
     public function withEndpoint(Node\Expr|Node\Identifier $endpoint): self
     {
         $this->endpoint = $endpoint;

diff --git a/src/Builder/Capacity/Lookup/ListPerPage.php b/src/Builder/Capacity/Lookup/ListPerPage.php
@@ -14,10 +14,6 @@ final class ListPerPage implements Builder
     private ?Node\Expr $search = null;
     private ?Node\Expr $code = null;
 
-    public function __construct()
-    {
-    }
-
     public function withEndpoint(Node\Expr|Node\Identifier $endpoint): self
     {
         $this->endpoint = $endpoint;

diff --git a/src/Builder/ConditionalLookup.php b/src/Builder/ConditionalLookup.php
@@ -14,10 +14,6 @@ final class ConditionalLookup implements StepBuilderInterface
     private iterable $alternatives = [];
     private ?Node\Expr $client = null;
 
-    public function __construct()
-    {
-    }
-
     public function withClient(Node\Expr $client): self
     {
         $this->client = $client;

diff --git a/src/Capacity/Extractor/All.php b/src/Capacity/Extractor/All.php
@@ -100,6 +100,10 @@ public function getBuilder(array $config): Builder
             $builder->withSearch($this->compileFilters(...$config['search']));
         }
 
+        if (isset($config['with_enriched_attributes']) && 'category' === $config['type']) {
+            $builder->withEnrichedAttributes(compileValueWhenExpression($this->interpreter, $config['with_enriched_attributes']));
+        }
+
         if (\in_array($config['type'], ['attributeOption', 'assetManager']) && \array_key_exists('code', $config)) {
             $builder->withCode(compileValueWhenExpression($this->interpreter, $config['code']));
         }

diff --git a/src/Configuration/Extractor.php b/src/Configuration/Extractor.php
@@ -197,6 +197,14 @@ public function getConfigTreeBuilder(): Config\Definition\Builder\TreeBuilder
                     && \in_array($data['type'], ['referenceEntityAttributeOption'], true))
                 ->thenInvalid('The reference_entity option should be used with the "referenceEntityAttributeOption" endpoint.')
             ->end()
+            ->validate()
+                ->ifTrue(fn ($data) => \array_key_exists('with_enriched_attributes', $data) && \array_key_exists('type', $data) && !\in_array($data['type'], ['category'], true))
+                ->thenInvalid('The with_enriched_attributes option should only be used with the "category" endpoint.')
+            ->end()
+            ->validate()
+                ->ifTrue(fn ($data) => \array_key_exists('with_enriched_attributes', $data) && \array_key_exists('method', $data) && 'all' !== $data['method'])
+                ->thenInvalid('The with_enriched_attributes option should only be used with the "all" method.')
+            ->end()
             ->children()
                 ->scalarNode('type')
                     ->isRequired()
@@ -238,6 +246,12 @@ public function getConfigTreeBuilder(): Config\Definition\Builder\TreeBuilder
                         ->then(asExpression())
                     ->end()
                 ->end()
+                ->booleanNode('with_enriched_attributes')
+                    ->validate()
+                        ->ifTrue(isExpression())
+                        ->then(asExpression())
+                    ->end()
+                ->end()
                 ->append((new Search())->getConfigTreeBuilder()->getRootNode())
             ->end()
         ;

diff --git a/tests/functional/Configuration/ExtractorTest.php b/tests/functional/Configuration/ExtractorTest.php
@@ -82,6 +82,20 @@ public static function validDataProvider(): iterable
                 'search' => [],
             ],
         ];
+        yield [
+            'config' => [
+                'method' => 'all',
+                'type' => 'category',
+                'search' => [],
+                'with_enriched_attributes' => true,
+            ],
+            'expected' => [
+                'method' => 'all',
+                'type' => 'category',
+                'search' => [],
+                'with_enriched_attributes' => true,
+            ],
+        ];
     }
 
     #[\PHPUnit\Framework\Attributes\DataProvider('validDataProvider')]