Introduce JobParameterAccessor to help job components access the required execution parameters (#26)

* Introduce JobParameterAccessor to help job components access the required execution parameters

* Refactored FlatFileReader & FlatFileWriter to use a JobParameterAccessorInterface instead of fetching file path from JobParameters

* Introduce more job parameter accessors, mostly decorators able to move in JobExecution graph

* Added more tests to cover FlatFileReader & FlatFileWriter

* Add missing tests cases for job parameters accessors

* Allow extra variables from constructor in ReplaceWithVariablesParameterAccessor

* Fixed PHPStan issue with array type

Author: yann-eugone

src/ContainerParameterAccessor.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Bridge\Symfony\Framework;
+
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+use Yokai\Batch\Exception\CannotAccessParameterException;
+use Yokai\Batch\Job\Parameters\JobParameterAccessorInterface;
+use Yokai\Batch\JobExecution;
+
+/**
+ * This job parameter accessor implementation returns container parameter value.
+ */
+final class ContainerParameterAccessor implements JobParameterAccessorInterface
+{
+    private ContainerInterface $container;
+    private string $name;
+
+    public function __construct(ContainerInterface $container, string $name)
+    {
+        $this->container = $container;
+        $this->name = $name;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get(JobExecution $execution)
+    {
+        try {
+            return $this->container->getParameter($this->name);
+        } catch (InvalidArgumentException $exception) {
+            throw new CannotAccessParameterException(
+                \sprintf('Cannot access "%s" parameter from container parameters', $this->name),
+                $exception
+            );
+        }
+    }
+}

tests/ContainerParameterAccessorTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Tests\Bridge\Symfony\Framework;
+
+use Symfony\Component\DependencyInjection\Container;
+use Yokai\Batch\Bridge\Symfony\Framework\ContainerParameterAccessor;
+use PHPUnit\Framework\TestCase;
+use Yokai\Batch\Exception\CannotAccessParameterException;
+use Yokai\Batch\JobExecution;
+
+class ContainerParameterAccessorTest extends TestCase
+{
+    public function test(): void
+    {
+        $container = new Container();
+        $container->setParameter('some.parameter', 'foo');
+        $accessor = new ContainerParameterAccessor($container, 'some.parameter');
+
+        self::assertSame('foo', $accessor->get(JobExecution::createRoot('123', 'testing')));
+    }
+
+    public function testParameterNotFound(): void
+    {
+        $this->expectException(CannotAccessParameterException::class);
+        $container = new Container();
+        $container->setParameter('some.parameter', 'foo');
+        $accessor = new ContainerParameterAccessor($container, 'undefined.parameter');
+        $accessor->get(JobExecution::createRoot('123', 'testing'));
+    }
+}

tests/Job/Parameters/JobExecutionSummaryAccessorTest.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Tests\Bridge\Symfony\Framework\Job\Parameters;
+
+use Yokai\Batch\Exception\CannotAccessParameterException;
+use Yokai\Batch\Job\Parameters\JobExecutionSummaryAccessor;
+use PHPUnit\Framework\TestCase;
+use Yokai\Batch\JobExecution;
+
+class JobExecutionSummaryAccessorTest extends TestCase
+{
+    public function test(): void
+    {
+        $accessor = new JobExecutionSummaryAccessor('report');
+
+        $execution = JobExecution::createRoot('123', 'testing');
+        $execution->getSummary()->set('report', 42);
+        self::assertSame(42, $accessor->get($execution));
+
+        $execution = JobExecution::createRoot('123', 'testing');
+        $execution->getSummary()->set('anything.else', 0);
+        $execution->getSummary()->set('report', 1042);
+        self::assertSame(1042, $accessor->get($execution));
+    }
+
+    public function testNotFound(): void
+    {
+        $this->expectException(CannotAccessParameterException::class);
+
+        $accessor = new JobExecutionSummaryAccessor('an.undefined.summary.var');
+
+        $accessor->get(JobExecution::createRoot('123', 'testing'));
+    }
+}