Merge pull request #3 from Chemaclass/refactor-inversion-dependency

Refactor: apply dependency inversion
Chemaclass · May 29, 2020 · 13ac766 · 13ac766
2 parents ac93306 + e85b204
commit 13ac766
Show file tree

Hide file tree

Showing 23 changed files with 117 additions and 78 deletions.
diff --git a/example.php b/example.php
@@ -61,7 +61,7 @@
 UNZ+2+8'
 EDI;
 
-$transactionResult = (new EdifactParser())->parse($fileContent);
+$transactionResult = EdifactParser::create()->parse($fileContent);
 
 foreach ($transactionResult->messages() as $i => $message) {
     print "Message number: {$i}" . PHP_EOL;

diff --git a/src/EdifactParser.php b/src/EdifactParser.php
@@ -6,16 +6,27 @@
 
 use EDI\Parser;
 use EdifactParser\Exception\InvalidFile;
-use EdifactParser\Segments\CustomSegmentFactoryInterface;
+use EdifactParser\Segments\SegmentFactory;
+use EdifactParser\Segments\SegmentFactoryInterface;
 
+/** @psalmphp-immutable */
 final class EdifactParser
 {
-    /** @var null|CustomSegmentFactoryInterface */
-    private ?CustomSegmentFactoryInterface $customSegmentsFactory;
+    private SegmentFactoryInterface $segmentFactory;
 
-    public function __construct(?CustomSegmentFactoryInterface $customSegmentsFactory = null)
+    public static function create(?SegmentFactoryInterface $segmentFactory = null): self
     {
-        $this->customSegmentsFactory = $customSegmentsFactory;
+        return new self($segmentFactory ?? new SegmentFactory());
+    }
+
+    private function __construct(SegmentFactoryInterface $segmentFactory)
+    {
+        $this->segmentFactory = $segmentFactory;
+    }
+
+    public function __invoke(string $fileContent): TransactionResult
+    {
+        return $this->parse($fileContent);
     }
 
     public function parse(string $fileContent): TransactionResult
@@ -27,7 +38,7 @@ public function parse(string $fileContent): TransactionResult
             throw InvalidFile::withErrors($errors);
         }
 
-        $segmentedValues = SegmentedValues::fromRaw($parser->get(), $this->customSegmentsFactory);
+        $segmentedValues = SegmentedValues::factory($this->segmentFactory)->fromRaw($parser->get());
 
         return TransactionResult::fromSegmentedValues($segmentedValues);
     }

diff --git a/src/Exception/InvalidFile.php b/src/Exception/InvalidFile.php
@@ -7,6 +7,7 @@
 use Exception;
 use function json_encode;
 
+/** @psalmphp-immutable */
 final class InvalidFile extends Exception
 {
     public static function withErrors(array $errors): self

diff --git a/src/SegmentedValues.php b/src/SegmentedValues.php
@@ -4,43 +4,40 @@
 
 namespace EdifactParser;
 
-use EdifactParser\Segments\CustomSegmentFactoryInterface;
 use EdifactParser\Segments\SegmentFactory;
+use EdifactParser\Segments\SegmentFactoryInterface;
 use EdifactParser\Segments\SegmentInterface;
 
+/** @psalmphp-immutable */
 final class SegmentedValues
 {
     /** @psalm-var list<SegmentInterface> */
-    private array $list;
+    private array $list = [];
 
-    public static function fromRaw(
-        array $rawArrays,
-        ?CustomSegmentFactoryInterface $customSegmentsFactory = null
-    ): self {
-        $factory = new SegmentFactory($customSegmentsFactory);
+    private SegmentFactoryInterface $segmentFactory;
 
-        $self = new self();
-        $segments = [];
+    public static function factory(?SegmentFactoryInterface $segmentFactory = null): self
+    {
+        return new self($segmentFactory ?? new SegmentFactory());
+    }
 
-        foreach ($rawArrays as $rawArray) {
-            $segments[] = $factory->segmentFromArray($rawArray);
-        }
+    public function __construct(SegmentFactoryInterface $segmentFactory)
+    {
+        $this->segmentFactory = $segmentFactory;
+    }
 
-        foreach ($segments as $segment) {
-            $self->addSegment($segment);
+    public function fromRaw(array $rawArrays): self
+    {
+        foreach ($rawArrays as $rawArray) {
+            $this->list[] = $this->segmentFactory->segmentFromArray($rawArray);
         }
 
-        return $self;
+        return $this;
     }
 
     /** @return SegmentInterface[] */
     public function list(): array
     {
         return $this->list;
     }
-
-    private function addSegment(SegmentInterface $segment): void
-    {
-        $this->list[] = $segment;
-    }
 }
diff --git a/src/Segments/BGMBeginningOfMessage.php b/src/Segments/BGMBeginningOfMessage.php
@@ -4,6 +4,7 @@
 
 namespace EdifactParser\Segments;
 
+/** @psalmphp-immutable */
 final class BGMBeginningOfMessage implements SegmentInterface
 {
     private array $rawValues;

diff --git a/src/Segments/CNTControl.php b/src/Segments/CNTControl.php
@@ -6,6 +6,7 @@
 
 namespace EdifactParser\Segments;
 
+/** @psalmphp-immutable */
 final class CNTControl implements SegmentInterface
 {
     private array $rawValues;

diff --git a/src/Segments/CustomSegmentFactoryInterface.php b/src/Segments/CustomSegmentFactoryInterface.php
diff --git a/src/Segments/DTMDateTimePeriod.php b/src/Segments/DTMDateTimePeriod.php
@@ -4,6 +4,7 @@
 
 namespace EdifactParser\Segments;
 
+/** @psalmphp-immutable */
 final class DTMDateTimePeriod implements SegmentInterface
 {
     private array $rawValues;

diff --git a/src/Segments/MEADimensions.php b/src/Segments/MEADimensions.php
@@ -6,6 +6,7 @@
 
 namespace EdifactParser\Segments;
 
+/** @psalmphp-immutable */
 final class MEADimensions implements SegmentInterface
 {
     private array $rawValues;

diff --git a/src/Segments/NADNameAddress.php b/src/Segments/NADNameAddress.php
@@ -6,6 +6,7 @@
 
 namespace EdifactParser\Segments;
 
+/** @psalmphp-immutable */
 final class NADNameAddress implements SegmentInterface
 {
     private array $rawValues;

diff --git a/src/Segments/PCIPackageId.php b/src/Segments/PCIPackageId.php
@@ -4,6 +4,7 @@
 
 namespace EdifactParser\Segments;
 
+/** @psalmphp-immutable */
 final class PCIPackageId implements SegmentInterface
 {
     private array $rawValues;

diff --git a/src/Segments/SegmentFactory.php b/src/Segments/SegmentFactory.php
@@ -4,23 +4,11 @@
 
 namespace EdifactParser\Segments;
 
-final class SegmentFactory
+/** @psalmphp-immutable */
+final class SegmentFactory implements SegmentFactoryInterface
 {
-    private ?CustomSegmentFactoryInterface $customSegmentsFactory;
-
-    public function __construct(?CustomSegmentFactoryInterface $customSegmentsFactory)
-    {
-        $this->customSegmentsFactory = $customSegmentsFactory;
-    }
-
     public function segmentFromArray(array $rawArray): SegmentInterface
     {
-        $customSegment = $this->customSegment($rawArray);
-
-        if ($customSegment) {
-            return $customSegment;
-        }
-
         $name = $rawArray[0];
 
         switch ($name) {
@@ -44,17 +32,4 @@ public function segmentFromArray(array $rawArray): SegmentInterface
 
         return new UnknownSegment($rawArray);
     }
-
-    private function customSegment(array $rawArray): ?SegmentInterface
-    {
-        if ($this->customSegmentsFactory) {
-            $segment = $this->customSegmentsFactory->segmentFromArray($rawArray);
-
-            if ($segment) {
-                return $segment;
-            }
-        }
-
-        return null;
-    }
 }
diff --git a/src/Segments/SegmentFactoryInterface.php b/src/Segments/SegmentFactoryInterface.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EdifactParser\Segments;
+
+interface SegmentFactoryInterface
+{
+    public function segmentFromArray(array $rawArray): SegmentInterface;
+}
diff --git a/src/Segments/UNHMessageHeader.php b/src/Segments/UNHMessageHeader.php
@@ -4,6 +4,7 @@
 
 namespace EdifactParser\Segments;
 
+/** @psalmphp-immutable */
 final class UNHMessageHeader implements SegmentInterface
 {
     private array $rawValues;

diff --git a/src/Segments/UNTMessageFooter.php b/src/Segments/UNTMessageFooter.php
@@ -4,6 +4,7 @@
 
 namespace EdifactParser\Segments;
 
+/** @psalmphp-immutable */
 final class UNTMessageFooter implements SegmentInterface
 {
     private array $rawValues;

diff --git a/src/Segments/UnknownSegment.php b/src/Segments/UnknownSegment.php
@@ -4,6 +4,7 @@
 
 namespace EdifactParser\Segments;
 
+/** @psalmphp-immutable */
 final class UnknownSegment implements SegmentInterface
 {
     private array $rawValues;

diff --git a/src/TransactionMessage.php b/src/TransactionMessage.php
@@ -6,6 +6,7 @@
 
 use EdifactParser\Segments\SegmentInterface;
 
+/** @psalmphp-immutable */
 final class TransactionMessage
 {
     /**

diff --git a/src/TransactionResult.php b/src/TransactionResult.php
@@ -8,6 +8,8 @@
 
 /**
  * A transactionResult is a list of transactionMessages.
+ *
+ * @psalmphp-immutable
  */
 final class TransactionResult
 {

diff --git a/tests/Functional/EdifactParserTest.php b/tests/Functional/EdifactParserTest.php
@@ -21,7 +21,7 @@ public function invalidFileDueToANonPrintableChar(): void
 \xE2\x80\xAF
 EDI;
         $this->expectException(InvalidFile::class);
-        (new EdifactParser())->parse($fileContent);
+        EdifactParser::create()->parse($fileContent);
     }
 
     /** @test */
@@ -37,7 +37,7 @@ public function parseMoreThanOneMessage(): void
 UNT+19+3'
 UNZ+3+4'
 EDI;
-        $transactionResult = (new EdifactParser())->parse($fileContent);
+        $transactionResult = EdifactParser::create()->parse($fileContent);
         self::assertCount(3, $transactionResult->messages());
     }
 
@@ -53,8 +53,7 @@ public function extractValuesFromMessage(): void
 UNZ+1+3'
 EDI;
 
-        $parser = new EdifactParser();
-        $transactionResult = $parser->parse($fileContent);
+        $transactionResult = EdifactParser::create()->parse($fileContent);
 
         self::assertCount(1, $transactionResult->messages());
         $firstMessage = $transactionResult->messages()[0];
@@ -88,8 +87,8 @@ public function useACustomSegmentFactory(): void
 UNT+19+1'
 UNZ+1+3'
 EDI;
-        $parser = new EdifactParser(new TestingCustomSegmentFactory('CUSTOM'));
-        $transactionResult = $parser->parse($fileContent);
+        $parser = EdifactParser::create(new TestingSegmentFactory('CUSTOM'));
+        $transactionResult = $parser($fileContent);
 
         self::assertCount(1, $transactionResult->messages());
         $firstMessage = $transactionResult->messages()[0];
@@ -98,5 +97,9 @@ public function useACustomSegmentFactory(): void
         /** @var SegmentInterface $custom */
         $custom = $segments['CUSTOM']['anyKey'];
         self::assertEquals(['CUSTOM', 'anyKey', ['whatever', 'value', '9']], $custom->rawValues());
+
+        /** @var CNTControl $cnt11 */
+        $cnt11 = $segments[CNTControl::class]['11'];
+        self::assertEquals(['CNT', ['11', '1', 'PCE']], $cnt11->rawValues());
     }
 }
diff --git a/...unctional/TestingCustomSegmentFactory.php → tests/Functional/TestingSegmentFactory.php b/...unctional/TestingCustomSegmentFactory.php → tests/Functional/TestingSegmentFactory.php
@@ -4,22 +4,26 @@
 
 namespace EdifactParser\Tests\Functional;
 
-use EdifactParser\Segments\CustomSegmentFactoryInterface;
+use EdifactParser\Segments\SegmentFactory;
+use EdifactParser\Segments\SegmentFactoryInterface;
 use EdifactParser\Segments\SegmentInterface;
 
-final class TestingCustomSegmentFactory implements CustomSegmentFactoryInterface
+final class TestingSegmentFactory implements SegmentFactoryInterface
 {
     private string $customKey;
 
+    private SegmentFactory $defaultFactory;
+
     public function __construct(string $customKey)
     {
         $this->customKey = $customKey;
+        $this->defaultFactory = new SegmentFactory();
     }
 
-    public function segmentFromArray(array $rawArray): ?SegmentInterface
+    public function segmentFromArray(array $rawArray): SegmentInterface
     {
         if ($this->customKey !== $rawArray[0]) {
-            return null;
+            return $this->defaultFactory->segmentFromArray($rawArray);
         }
 
         return new class($rawArray) implements SegmentInterface {

diff --git a/tests/Unit/SegmentedValuesTest.php b/tests/Unit/SegmentedValuesTest.php
@@ -6,6 +6,7 @@
 
 use EDI\Parser;
 use EdifactParser\SegmentedValues;
+use EdifactParser\Segments\SegmentFactory;
 use EdifactParser\Segments\UNHMessageHeader;
 use PHPUnit\Framework\TestCase;
 
@@ -16,7 +17,7 @@ public function getListOfSegments(): void
     {
         $fileContent = "UNH+1+IFTMIN:S:93A:UN:PN001'\nUNH+2+IFTMIN:S:93A:UN:PN001'";
         $parser = new Parser($fileContent);
-        $values = SegmentedValues::fromRaw($parser->get());
+        $values = (new SegmentedValues(new SegmentFactory()))->fromRaw($parser->get());
 
         self::assertEquals([
             new UNHMessageHeader(['UNH', '1', ['IFTMIN', 'S', '93A', 'UN', 'PN001']]),