Pass expression object to expression evaluator.

a-ast · a-ast · commit d3f44f50b9a0 · 2021-09-07T17:29:36.000+02:00
diff --git a/src/Application/Action/Add.php b/src/Application/Action/Add.php
@@ -5,7 +5,7 @@
 namespace AkeneoE3\Application\Action;
 
 use AkeneoE3\Application\Expression\ActionState;
-use AkeneoE3\Application\Expression\ExpressionLanguage;
+use AkeneoE3\Application\Expression\ExpressionEvaluator;
 use AkeneoE3\Domain\Action;
 use AkeneoE3\Domain\Exception\TransformException;
 use AkeneoE3\Domain\Resource\Field;
@@ -18,9 +18,9 @@ final class Add implements Action
 
     private AddRemoveOptions $options;
 
-    private ExpressionLanguage $expressionLanguage;
+    private ExpressionEvaluator $expressionLanguage;
 
-    public function __construct(ExpressionLanguage $expressionLanguage, array $options)
+    public function __construct(ExpressionEvaluator $expressionLanguage, array $options)
     {
         $this->expressionLanguage = $expressionLanguage;
         $this->field = FieldFactory::fromOptions($options);
diff --git a/src/Application/Action/Remove.php b/src/Application/Action/Remove.php
@@ -5,7 +5,7 @@
 namespace AkeneoE3\Application\Action;
 
 use AkeneoE3\Application\Expression\ActionState;
-use AkeneoE3\Application\Expression\ExpressionLanguage;
+use AkeneoE3\Application\Expression\ExpressionEvaluator;
 use AkeneoE3\Domain\Action;
 use AkeneoE3\Domain\Exception\TransformException;
 use AkeneoE3\Domain\Resource\Field;
@@ -18,9 +18,9 @@ final class Remove implements Action
 
     private AddRemoveOptions $options;
 
-    private ExpressionLanguage $expressionLanguage;
+    private ExpressionEvaluator $expressionLanguage;
 
-    public function __construct(ExpressionLanguage $expressionLanguage, array $options)
+    public function __construct(ExpressionEvaluator $expressionLanguage, array $options)
     {
         $this->expressionLanguage = $expressionLanguage;
         $this->field = FieldFactory::fromOptions($options);
diff --git a/src/Application/Action/Set.php b/src/Application/Action/Set.php
@@ -5,7 +5,7 @@
 namespace AkeneoE3\Application\Action;
 
 use AkeneoE3\Application\Expression\ActionState;
-use AkeneoE3\Application\Expression\ExpressionLanguage;
+use AkeneoE3\Application\Expression\ExpressionEvaluator;
 use AkeneoE3\Domain\Action;
 use AkeneoE3\Domain\Resource\Field;
 use AkeneoE3\Domain\Resource\FieldFactory;
@@ -17,9 +17,9 @@ final class Set implements Action
 
     private SetOptions $options;
 
-    private ExpressionLanguage $expressionLanguage;
+    private ExpressionEvaluator $expressionLanguage;
 
-    public function __construct(ExpressionLanguage $expressionLanguage, array $options)
+    public function __construct(ExpressionEvaluator $expressionLanguage, array $options)
     {
         $this->expressionLanguage = $expressionLanguage;
         $this->field = FieldFactory::fromOptions($options);
diff --git a/src/Application/ActionFactory.php b/src/Application/ActionFactory.php
@@ -4,25 +4,32 @@
 
 namespace AkeneoE3\Application;
 
+use AkeneoE3\Application\Expression\ExpressionEvaluator;
 use AkeneoE3\Domain\Action;
 use AkeneoE3\Application\Action as Actions;
 use AkeneoE3\Domain\Profile\TransformProfile;
 use LogicException;
-use AkeneoE3\Application\Expression\ExpressionLanguage;
 
 final class ActionFactory
 {
+    private ExpressionEvaluator $expressionLanguage;
+
+    public function __construct(ExpressionEvaluator $expressionLanguage)
+    {
+        $this->expressionLanguage = $expressionLanguage;
+    }
+
     public function create(string $type, array $options): Action
     {
         switch ($type) {
             case 'set':
-                $action = new Actions\Set(new ExpressionLanguage(), $options);
+                $action = new Actions\Set($this->expressionLanguage, $options);
                 break;
             case 'add':
-                $action = new Actions\Add(new ExpressionLanguage(), $options);
+                $action = new Actions\Add($this->expressionLanguage, $options);
                 break;
             case 'remove':
-                $action = new Actions\Remove(new ExpressionLanguage(), $options);
+                $action = new Actions\Remove($this->expressionLanguage, $options);
                 break;
             case 'duplicate':
                 $action = new Actions\Duplicate($options);
diff --git a/src/Application/Expression/E3ExpressionEvaluator.php b/src/Application/Expression/E3ExpressionEvaluator.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AkeneoE3\Application\Expression;
+
+use Symfony\Component\ExpressionLanguage\ExpressionLanguage as BaseExpressionLanguage;
+
+final class E3ExpressionEvaluator implements ExpressionEvaluator
+{
+    private BaseExpressionLanguage $expressionLanguage;
+
+    private ExpressionObject $expressionObject;
+
+    public function __construct(ExpressionObject $expressionObject)
+    {
+        $this->expressionLanguage = new BaseExpressionLanguage(
+            null,
+            [new FunctionProvider()]
+        );
+
+        $this->expressionObject = $expressionObject;
+    }
+
+    /**
+     * @return mixed|null
+     */
+    public function evaluate(string $expression, array $values = [])
+    {
+        return $this->expressionLanguage->evaluate($expression, $values);
+    }
+}
diff --git a/src/Application/Expression/ExpressionEvaluator.php b/src/Application/Expression/ExpressionEvaluator.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace AkeneoE3\Application\Expression;
+
+interface ExpressionEvaluator
+{
+    /**
+     * @return mixed|null
+     */
+    public function evaluate(string $expression, array $values = []);
+}
diff --git a/src/Application/Expression/ExpressionLanguage.php b/src/Application/Expression/ExpressionLanguage.php
diff --git a/src/Application/Expression/ExpressionObject.php b/src/Application/Expression/ExpressionObject.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace AkeneoE3\Application\Expression;
+
+interface ExpressionObject
+{
+    public function getName(): string;
+}
diff --git a/src/Application/Expression/ExpressionObjectProvider.php b/src/Application/Expression/ExpressionObjectProvider.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace AkeneoE3\Application\Expression;
+
+interface ExpressionObjectProvider
+{
+    public function get(): ExpressionObject;
+}
diff --git a/src/Domain/Resource/ResourceType.php b/src/Domain/Resource/ResourceType.php
@@ -27,6 +27,11 @@ public static function create(string $code): self
         return new self($code);
     }
 
+    public static function referenceEntityAttribute(): self
+    {
+        return new self('reference-entity-attribute');
+    }
+
     public function __toString(): string
     {
         return $this->code;
diff --git a/src/Infrastructure/Api/ExpressionObject/AkeneoObject.php b/src/Infrastructure/Api/ExpressionObject/AkeneoObject.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace AkeneoE3\Infrastructure\Api\ExpressionObject;
+
+use Akeneo\PimEnterprise\ApiClient\AkeneoPimEnterpriseClientInterface;
+use AkeneoE3\Application\Expression\ExpressionObject;
+use AkeneoE3\Domain\Resource\Property;
+use AkeneoE3\Domain\Resource\ResourceType;
+use AkeneoE3\Infrastructure\Api\Query\ApiQuery;
+use AkeneoE3\Infrastructure\Api\RepositoryFactory;
+
+class AkeneoObject implements ExpressionObject
+{
+    private RepositoryFactory $repositoryFactory;
+
+    private AkeneoPimEnterpriseClientInterface $client;
+
+    public function __construct(
+        RepositoryFactory $repositoryFactory,
+        AkeneoPimEnterpriseClientInterface $client
+    ) {
+        $this->repositoryFactory = $repositoryFactory;
+        $this->client = $client;
+    }
+
+    public function getName(): string
+    {
+        return 'akeneo';
+    }
+
+    public function getReferenceEntityAttributeCodesByTypes(string $entityCode, array $types): array
+    {
+        $repository = $this->repositoryFactory->createReadRepository(
+            ResourceType::referenceEntityAttribute(),
+            $this->client
+        );
+
+        $query = new ApiQuery();
+        $query->addFilter(ResourceType::REFERENCE_ENTITY_CODE_FIELD, '=', $entityCode);
+        $attributes = $repository->read($query);
+
+        $codes = [];
+
+        foreach ($attributes as $attribute) {
+            $type = $attribute->get(Property::create('type'));
+            if (in_array($type, $types)) {
+                $codes[] = $attribute->getCode();
+            }
+        }
+
+        return $codes;
+    }
+}
diff --git a/src/Infrastructure/Api/RepositoryFactory.php b/src/Infrastructure/Api/RepositoryFactory.php
@@ -26,7 +26,6 @@ final class RepositoryFactory
 {
     public function createReadRepository(
         ResourceType $resourceType,
-        ExtractProfile $profile,
         AkeneoPimEnterpriseClientInterface $client
     ): BaseReadRepository {
         $api = $this->createRepository($resourceType, $client);
diff --git a/src/Infrastructure/EtlFactory.php b/src/Infrastructure/EtlFactory.php
@@ -7,6 +7,8 @@
 use Akeneo\PimEnterprise\ApiClient\AkeneoPimEnterpriseClientBuilder;
 use Akeneo\PimEnterprise\ApiClient\AkeneoPimEnterpriseClientInterface;
 use AkeneoE3\Application\ActionFactory;
+use AkeneoE3\Application\Expression\E3ExpressionEvaluator;
+use AkeneoE3\Application\Expression\ExpressionObject;
 use AkeneoE3\Domain\Extractor;
 use AkeneoE3\Domain\Loader;
 use AkeneoE3\Domain\Transformer;
@@ -17,22 +19,19 @@
 use AkeneoE3\Domain\Profile\EtlProfile;
 use AkeneoE3\Domain\Profile\TransformProfile;
 use AkeneoE3\Domain\Resource\ResourceType;
+use AkeneoE3\Infrastructure\Api\ExpressionObject\AkeneoObject;
 use AkeneoE3\Infrastructure\Api\Query\ApiQueryFactory;
 use AkeneoE3\Infrastructure\Api\RepositoryFactory;
 
 final class EtlFactory
 {
     private array $clients = [];
 
-    private ActionFactory $actionFactory;
-
     private RepositoryFactory $repositoryFactory;
 
     public function __construct(
-        ActionFactory $actionFactory = null,
         RepositoryFactory $repositoryFactory = null
     ) {
-        $this->actionFactory = $actionFactory ?? new ActionFactory();
         $this->repositoryFactory = $repositoryFactory ?? new RepositoryFactory();
     }
 
@@ -48,8 +47,11 @@ public function createEtlProcess(
             $etlProfile
         );
 
+        $expressionObject = new AkeneoObject($this->repositoryFactory, $this->getClient($sourceConnectionProfile));
+
         $transformer = $this->createTransformer(
-            $etlProfile
+            $etlProfile,
+            $expressionObject
         );
 
         $loader = $this->createLoader(
@@ -72,17 +74,26 @@ public function createExtractor(
     ): Extractor {
         $client = $this->getClient($profile);
 
-        $repository = $this->repositoryFactory->createReadRepository($resourceType, $extractProfile, $client);
+        $repository = $this->repositoryFactory->createReadRepository($resourceType, $client);
 
         $queryFactory = new ApiQueryFactory();
         $query = $queryFactory->fromProfile($extractProfile, $resourceType);
 
         return new Extractor($repository, $query);
     }
 
-    public function createTransformer(TransformProfile $transformProfile): Transformer
+    public function createActionFactory(ExpressionObject $expressionObject): ActionFactory
+    {
+        $expressionLanguage = new E3ExpressionEvaluator($expressionObject);
+
+        return new ActionFactory($expressionLanguage);
+    }
+
+    public function createTransformer(TransformProfile $transformProfile, ExpressionObject $expressionObject): Transformer
     {
-        $actions = $this->actionFactory->createActions($transformProfile);
+        $actionFactory = $this->createActionFactory($expressionObject);
+
+        $actions = $actionFactory->createActions($transformProfile);
 
         return new Transformer($actions);
     }
diff --git a/tests/Acceptance/bootstrap/EmptyExpressionObject.php b/tests/Acceptance/bootstrap/EmptyExpressionObject.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace AkeneoE3\Tests\Acceptance\bootstrap;
+
+use AkeneoE3\Application\Expression\ExpressionObject;
+
+class EmptyExpressionObject implements ExpressionObject
+{
+    public function getName(): string
+    {
+        return 'empty';
+    }
+}
diff --git a/tests/Acceptance/bootstrap/TransformContext.php b/tests/Acceptance/bootstrap/TransformContext.php
@@ -86,7 +86,7 @@ public function initialiseEtlProfile(PyStringNode $string): void
         $factory = new EtlFactory();
         $this->profile = EtlProfile::fromArray($config);
 
-        $this->transformer = $factory->createTransformer($this->profile);
+        $this->transformer = $factory->createTransformer($this->profile, new EmptyExpressionObject());
     }
 
     /**
diff --git a/tests/Unit/Application/ActionFactoryTest.php b/tests/Unit/Application/ActionFactoryTest.php
@@ -3,6 +3,7 @@
 namespace AkeneoE3\Tests\Unit\Application;
 
 use AkeneoE3\Application\ActionFactory;
+use AkeneoE3\Application\Expression\ExpressionEvaluator;
 use AkeneoE3\Domain\Action;
 use LogicException;
 use PHPUnit\Framework\Assert;
@@ -12,7 +13,7 @@ class ActionFactoryTest extends TestCase
 {
     public function test_it_creates_a_action()
     {
-        $factory = new ActionFactory();
+        $factory = new ActionFactory(new FakeExpressionEvaluator());
         $action = $factory->create('set', [
             'field' => 'name',
             'value' => 'nemo',
@@ -25,7 +26,15 @@ public function test_it_throws_an_exception_if_action_not_registered()
     {
         $this->expectException(LogicException::class);
 
-        $factory = new ActionFactory();
+        $factory = new ActionFactory(new FakeExpressionEvaluator());
         $factory->create('??? unknown ???', []);
     }
 }
+
+class FakeExpressionEvaluator implements ExpressionEvaluator
+{
+    public function evaluate(string $expression, array $values = [])
+    {
+        return null;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,11 @@ public static function create(string $code): self`
`27`	`27`	`return new self($code);`
`28`	`28`	`}`
`29`	`29`
	`30`	`+ public static function referenceEntityAttribute(): self`
	`31`	`+ {`
	`32`	`+ return new self('reference-entity-attribute');`
	`33`	`+ }`
	`34`	`+`
`30`	`35`	`public function __toString(): string`
`31`	`36`	`{`
`32`	`37`	`return $this->code;`