Merge pull request #56 from php-etl/feature/reference-entities-extractor

Added a way to extract data from reference entities and its attribute…
php-etl · Oct 10, 2023 · 1750546 · 1750546
2 parents 93e913e + 3048076
commit 1750546
Show file tree

Hide file tree

Showing 28 changed files with 123 additions and 108 deletions.
diff --git a/src/Builder/AlternativeLookup.php b/src/Builder/AlternativeLookup.php
@@ -14,8 +14,7 @@ final class AlternativeLookup implements Builder
 
     public function __construct(
         private readonly Builder $capacity,
-    ) {
-    }
+    ) {}
 
     public function withMerge(Builder $merge): self
     {

diff --git a/src/Builder/Capacity/Extractor/All.php b/src/Builder/Capacity/Extractor/All.php
@@ -13,11 +13,8 @@ final class All implements Builder
     private null|Node\Expr|Node\Identifier $endpoint = null;
     private null|Node\Expr $search = null;
     private null|Node\Expr $code = null;
-    private null|string $type = null;
-
-    public function __construct()
-    {
-    }
+    private null|Node\Expr $referenceEntity = null;
+    private null|Node\Expr $referenceEntityAttributeCode = null;
 
     public function withEndpoint(Node\Expr|Node\Identifier $endpoint): self
     {
@@ -40,9 +37,16 @@ public function withCode(?Node\Expr $code): self
         return $this;
     }
 
-    public function withType(string $type): self
+    public function withReferenceEntityCode(?Node\Expr $referenceEntity): self
+    {
+        $this->referenceEntity = $referenceEntity;
+
+        return $this;
+    }
+
+    public function withReferenceEntityAttributeOption(?Node\Expr $referenceEntityAttrbuteCode): self
     {
-        $this->type = $type;
+        $this->referenceEntityAttributeCode = $referenceEntityAttrbuteCode;
 
         return $this;
     }
@@ -64,23 +68,7 @@ public function getNode(): Node
                          name: $this->endpoint
                      ),
                      name: new Node\Identifier('all'),
-                     args: array_filter(
-                         [
-                             new Node\Arg(
-                                 value: new Node\Expr\Array_(
-                                     items: $this->compileSearch(),
-                                     attributes: [
-                                         'kind' => Node\Expr\Array_::KIND_SHORT,
-                                     ]
-                                 ),
-                                 name: new Node\Identifier('queryParameters'),
-                             ),
-                             null !== $this->code ? new Node\Arg(
-                                 value: $this->code,
-                                 name: $this->compileCodeNamedArgument($this->type),
-                             ) : null,
-                         ],
-                     ),
+                     args: $this->compileArguments(),
                  ),
                  valueVar: new Node\Expr\Variable('item'),
                  subNodes: [
@@ -116,12 +104,43 @@ private function compileSearch(): array
         ];
     }
 
-    private function compileCodeNamedArgument(string $type): Node\Identifier
+    private function compileArguments(): array
     {
-        return match ($type) {
-            'assetManager' => new Node\Identifier('assetFamilyCode'),
-            'referenceEntityRecord' => new Node\Identifier('referenceEntityCode'),
-            default => new Node\Identifier('attributeCode')
-        };
+        $args = [];
+
+        if (null !== $this->search) {
+            $args[] = new Node\Arg(
+                value: new Node\Expr\Array_(
+                    items: $this->compileSearch(),
+                    attributes: [
+                        'kind' => Node\Expr\Array_::KIND_SHORT,
+                    ]
+                ),
+                name: new Node\Identifier('queryParameters'),
+            );
+        }
+
+        if (null !== $this->code) {
+            $args[] = new Node\Arg(
+                value: $this->code,
+                name: new Node\Identifier('attributeCode'),
+            );
+        }
+
+        if (null !== $this->referenceEntity) {
+            $args[] = new Node\Arg(
+                value: $this->referenceEntity,
+                name: new Node\Identifier('referenceEntityCode'),
+            );
+        }
+
+        if (null !== $this->referenceEntity) {
+            $args[] = new Node\Arg(
+                value: $this->referenceEntityAttributeCode,
+                name: new Node\Identifier('attributeCode'),
+            );
+        }
+
+        return $args;
     }
 }
diff --git a/src/Builder/Capacity/Extractor/Get.php b/src/Builder/Capacity/Extractor/Get.php
@@ -13,9 +13,7 @@ final class Get implements Builder
     private null|Node\Expr|Node\Identifier $endpoint = null;
     private null|Node\Expr $identifier = null;
 
-    public function __construct()
-    {
-    }
+    public function __construct() {}
 
     public function withEndpoint(Node\Expr|Node\Identifier $endpoint): self
     {

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

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

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

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

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

diff --git a/src/Builder/Client.php b/src/Builder/Client.php
@@ -19,9 +19,7 @@ final class Client implements Builder
     private ?Node\Expr $httpStreamFactory = null;
     private ?Node\Expr $fileSystem = null;
 
-    public function __construct(private readonly Node\Expr $baseUrl, private readonly Node\Expr $clientId, private readonly Node\Expr $secret)
-    {
-    }
+    public function __construct(private readonly Node\Expr $baseUrl, private readonly Node\Expr $clientId, private readonly Node\Expr $secret) {}
 
     public function withToken(Node\Expr $token, Node\Expr $refreshToken): self
     {

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

diff --git a/src/Builder/Extractor.php b/src/Builder/Extractor.php
@@ -15,8 +15,7 @@ final class Extractor implements StepBuilderInterface
 
     public function __construct(
         private readonly Builder $capacity,
-    ) {
-    }
+    ) {}
 
     public function withClient(Node\Expr $client): self
     {

diff --git a/src/Builder/Inline.php b/src/Builder/Inline.php
@@ -13,9 +13,7 @@
 
 final readonly class Inline implements Builder
 {
-    public function __construct(private ArrayBuilderInterface|ObjectBuilderInterface $mapper)
-    {
-    }
+    public function __construct(private ArrayBuilderInterface|ObjectBuilderInterface $mapper) {}
 
     public function getNode(): Node
     {

diff --git a/src/Builder/Loader.php b/src/Builder/Loader.php
@@ -15,8 +15,7 @@ final class Loader implements StepBuilderInterface
 
     public function __construct(
         private readonly Builder $capacity,
-    ) {
-    }
+    ) {}
 
     public function withClient(Node\Expr $client): self
     {

diff --git a/src/Builder/Lookup.php b/src/Builder/Lookup.php
@@ -12,9 +12,7 @@ final class Lookup implements StepBuilderInterface
     private ?Node\Expr $logger = null;
     private ?Node\Expr $client = null;
 
-    public function __construct(private readonly AlternativeLookup $alternative)
-    {
-    }
+    public function __construct(private readonly AlternativeLookup $alternative) {}
 
     public function withClient(Node\Expr $client): self
     {

diff --git a/src/Builder/Search.php b/src/Builder/Search.php
@@ -11,8 +11,7 @@ final class Search implements Builder
 {
     public function __construct(
         private array $filters = []
-    ) {
-    }
+    ) {}
 
     public function addFilter(
         Node\Expr $field,

diff --git a/src/Capacity/Extractor/All.php b/src/Capacity/Extractor/All.php
@@ -55,9 +55,7 @@ final class All implements Akeneo\Capacity\CapacityInterface
         'UNCLASSIFIED',
     ];
 
-    public function __construct(private readonly ExpressionLanguage $interpreter)
-    {
-    }
+    public function __construct(private readonly ExpressionLanguage $interpreter) {}
 
     public function applies(array $config): bool
     {
@@ -94,17 +92,25 @@ public function getBuilder(array $config): Builder
     {
         $builder = (new Akeneo\Builder\Capacity\Extractor\All())
             ->withEndpoint(new Node\Identifier(sprintf('get%sApi', ucfirst((string) $config['type']))))
-            ->withType($config['type'])
         ;
 
-        if (isset($config['search']) && \is_array($config['search'])) {
+        if (isset($config['search']) && \is_array($config['search']) && \count($config['search']) > 0) {
             $builder->withSearch($this->compileFilters(...$config['search']));
         }
 
-        if (\in_array($config['type'], ['attributeOption', 'assetManager', 'referenceEntityRecord']) && \array_key_exists('code', $config)) {
+        if (\in_array($config['type'], ['attributeOption', 'assetManager']) && \array_key_exists('code', $config)) {
             $builder->withCode(compileValueWhenExpression($this->interpreter, $config['code']));
         }
 
+        if ('referenceEntityRecord' == $config['type']) {
+            $builder->withReferenceEntityCode(compileValueWhenExpression($this->interpreter, $config['reference_entity']));
+        }
+
+        if ('referenceEntityAttributeOption' == $config['type']) {
+            $builder->withReferenceEntityCode(compileValueWhenExpression($this->interpreter, $config['reference_entity']));
+            $builder->withReferenceEntityAttributeOption(compileValueWhenExpression($this->interpreter, $config['reference_entity_option']));
+        }
+
         return $builder;
     }
 }
diff --git a/src/Capacity/Extractor/Get.php b/src/Capacity/Extractor/Get.php
@@ -43,9 +43,7 @@ final class Get implements Akeneo\Capacity\CapacityInterface
         'assetManager',
     ];
 
-    public function __construct(private readonly ExpressionLanguage $interpreter)
-    {
-    }
+    public function __construct(private readonly ExpressionLanguage $interpreter) {}
 
     public function applies(array $config): bool
     {

diff --git a/src/Capacity/Extractor/ListPerPage.php b/src/Capacity/Extractor/ListPerPage.php
@@ -53,9 +53,7 @@ final class ListPerPage implements Akeneo\Capacity\CapacityInterface
         'UNCLASSIFIED',
     ];
 
-    public function __construct(private readonly ExpressionLanguage $interpreter)
-    {
-    }
+    public function __construct(private readonly ExpressionLanguage $interpreter) {}
 
     public function applies(array $config): bool
     {

diff --git a/src/Capacity/Loader/Upsert.php b/src/Capacity/Loader/Upsert.php
@@ -45,9 +45,7 @@ final class Upsert implements Akeneo\Capacity\CapacityInterface
         'referenceEntity',
     ];
 
-    public function __construct(private readonly ExpressionLanguage $interpreter)
-    {
-    }
+    public function __construct(private readonly ExpressionLanguage $interpreter) {}
 
     public function applies(array $config): bool
     {

diff --git a/src/Capacity/Lookup/All.php b/src/Capacity/Lookup/All.php
@@ -54,9 +54,7 @@ final class All implements Akeneo\Capacity\CapacityInterface
         'UNCLASSIFIED',
     ];
 
-    public function __construct(private readonly ExpressionLanguage $interpreter)
-    {
-    }
+    public function __construct(private readonly ExpressionLanguage $interpreter) {}
 
     public function applies(array $config): bool
     {

diff --git a/src/Capacity/Lookup/Download.php b/src/Capacity/Lookup/Download.php
@@ -22,9 +22,7 @@ final class Download implements Akeneo\Capacity\CapacityInterface
         'assetMediaFile',
     ];
 
-    public function __construct(private readonly ExpressionLanguage $interpreter)
-    {
-    }
+    public function __construct(private readonly ExpressionLanguage $interpreter) {}
 
     public function applies(array $config): bool
     {

diff --git a/src/Capacity/Lookup/Get.php b/src/Capacity/Lookup/Get.php
@@ -43,9 +43,7 @@ final class Get implements Akeneo\Capacity\CapacityInterface
         'assetManager',
     ];
 
-    public function __construct(private readonly ExpressionLanguage $interpreter)
-    {
-    }
+    public function __construct(private readonly ExpressionLanguage $interpreter) {}
 
     public function applies(array $config): bool
     {

diff --git a/src/Capacity/Lookup/ListPerPage.php b/src/Capacity/Lookup/ListPerPage.php
@@ -53,9 +53,7 @@ final class ListPerPage implements Akeneo\Capacity\CapacityInterface
         'UNCLASSIFIED',
     ];
 
-    public function __construct(private readonly ExpressionLanguage $interpreter)
-    {
-    }
+    public function __construct(private readonly ExpressionLanguage $interpreter) {}
 
     public function applies(array $config): bool
     {