Merge pull request #9 from Chemaclass/segment-tag-renaming

Segment tag renaming
Chemaclass · Jun 4, 2020 · 1d257e2 · 1d257e2
2 parents 1238f9c + 624b61e
commit 1d257e2
Show file tree

Hide file tree

Showing 25 changed files with 85 additions and 80 deletions.
diff --git a/docu/segments/README.md b/docu/segments/README.md
@@ -1,15 +1,15 @@
-# Segments
+# EDIFACT Segments
 
-## EDIFACT Segment Definition
+## Segment definition
 
 EDIFACT Segment is a collection of logically-related data elements in a fixed, defined sequence. 
 
-### EDIFACT provides a hierarchical structure for messages
+### Hierarchical structure for messages
 
 EDIFACT messages begin with the `Message Header Segment` (UNH) and end with the` Message Trailer Segment` (UNT). 
 These two segments are the first, and innermost, level of the three levels of “electronic envelopes” within EDIFACT.
 
-EDIFACT Segment contains:
+### A Segment contains
 
 * A **three-character alphanumeric** code that identifies the segment. This is called the segment tag.
 * Variable length data elements. These can be either simple or composite.

diff --git a/example.php b/example.php
@@ -9,6 +9,7 @@
 use EdifactParser\Segments\MEADimensions;
 use EdifactParser\Segments\NADNameAddress;
 use EdifactParser\Segments\PCIPackageId;
+use EdifactParser\Segments\SegmentInterface;
 use EdifactParser\Segments\UNHMessageHeader;
 use EdifactParser\Segments\UNTMessageFooter;
 use EdifactParser\TransactionMessage;
@@ -80,15 +81,16 @@ function printMessage(TransactionMessage $message): void
     printSegment($message->segmentByName(UNTMessageFooter::class));
 }
 
+/** @var SegmentInterface[] $segments */
 function printSegment(array $segments): void
 {
-    $first  = $segments[array_key_first($segments)];
-    print sprintf("> %s:\n", $first->name());
+    $first = $segments[array_key_first($segments)];
+    print sprintf("> %s:\n", $first->tag());
 
     foreach ($segments as $segment) {
         print sprintf(
             "    %s |> %s \n",
-            str_pad($segment->subSegmentKey(), 3),
+            str_pad($segment->subId(), 3),
             json_encode($segment->rawValues())
         );
     }

diff --git a/src/Exception/MissingSubId.php b/src/Exception/MissingSubId.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EdifactParser\Exception;
+
+final class MissingSubId extends \Exception
+{
+    public function __construct(string $missingId, array $rawValues)
+    {
+        parent::__construct("SubId '$missingId' not found in " . json_encode($rawValues));
+    }
+}
diff --git a/src/Exception/MissingSubSegmentKey.php b/src/Exception/MissingSubSegmentKey.php
diff --git a/src/Segments/BGMBeginningOfMessage.php b/src/Segments/BGMBeginningOfMessage.php
@@ -14,12 +14,12 @@ public function __construct(array $rawValues)
         $this->rawValues = $rawValues;
     }
 
-    public function name(): string
+    public function tag(): string
     {
         return self::class;
     }
 
-    public function subSegmentKey(): string
+    public function subId(): string
     {
         return (string) $this->rawValues[1];
     }

diff --git a/src/Segments/CNTControl.php b/src/Segments/CNTControl.php
@@ -6,7 +6,7 @@
 
 namespace EdifactParser\Segments;
 
-use EdifactParser\Exception\MissingSubSegmentKey;
+use EdifactParser\Exception\MissingSubId;
 
 /** @psalm-immutable */
 final class CNTControl implements SegmentInterface
@@ -18,15 +18,15 @@ public function __construct(array $rawValues)
         $this->rawValues = $rawValues;
     }
 
-    public function name(): string
+    public function tag(): string
     {
         return self::class;
     }
 
-    public function subSegmentKey(): string
+    public function subId(): string
     {
         if (!isset($this->rawValues[1][0])) {
-            throw new MissingSubSegmentKey('[1][0]', $this->rawValues);
+            throw new MissingSubId('[1][0]', $this->rawValues);
         }
 
         return (string) $this->rawValues[1][0];

diff --git a/src/Segments/DTMDateTimePeriod.php b/src/Segments/DTMDateTimePeriod.php
@@ -4,7 +4,7 @@
 
 namespace EdifactParser\Segments;
 
-use EdifactParser\Exception\MissingSubSegmentKey;
+use EdifactParser\Exception\MissingSubId;
 
 /** @psalm-immutable */
 final class DTMDateTimePeriod implements SegmentInterface
@@ -16,15 +16,15 @@ public function __construct(array $rawValues)
         $this->rawValues = $rawValues;
     }
 
-    public function name(): string
+    public function tag(): string
     {
         return self::class;
     }
 
-    public function subSegmentKey(): string
+    public function subId(): string
     {
         if (!isset($this->rawValues[1][0])) {
-            throw new MissingSubSegmentKey('[1][0]', $this->rawValues);
+            throw new MissingSubId('[1][0]', $this->rawValues);
         }
 
         return (string) $this->rawValues[1][0];

diff --git a/src/Segments/MEADimensions.php b/src/Segments/MEADimensions.php
@@ -16,12 +16,12 @@ public function __construct(array $rawValues)
         $this->rawValues = $rawValues;
     }
 
-    public function name(): string
+    public function tag(): string
     {
         return self::class;
     }
 
-    public function subSegmentKey(): string
+    public function subId(): string
     {
         return (string) $this->rawValues[1];
     }

diff --git a/src/Segments/NADNameAddress.php b/src/Segments/NADNameAddress.php
@@ -16,12 +16,12 @@ public function __construct(array $rawValues)
         $this->rawValues = $rawValues;
     }
 
-    public function name(): string
+    public function tag(): string
     {
         return self::class;
     }
 
-    public function subSegmentKey(): string
+    public function subId(): string
     {
         return (string) $this->rawValues[1];
     }

diff --git a/src/Segments/PCIPackageId.php b/src/Segments/PCIPackageId.php
@@ -14,12 +14,12 @@ public function __construct(array $rawValues)
         $this->rawValues = $rawValues;
     }
 
-    public function name(): string
+    public function tag(): string
     {
         return self::class;
     }
 
-    public function subSegmentKey(): string
+    public function subId(): string
     {
         return (string) $this->rawValues[1];
     }

diff --git a/src/Segments/SegmentInterface.php b/src/Segments/SegmentInterface.php
@@ -7,9 +7,12 @@
 /** @psalm-immutable */
 interface SegmentInterface
 {
-    public function name(): string;
+    /** A three-character alphanumeric code that identifies the segment. */
+    public function tag(): string;
 
-    public function subSegmentKey(): string;
+    /** The identifier for multiple segments with the same tag. */
+    public function subId(): string;
 
+    /** Variable length data elements. These can be either simple or composite. */
     public function rawValues(): array;
 }
diff --git a/src/Segments/UNHMessageHeader.php b/src/Segments/UNHMessageHeader.php
@@ -4,7 +4,7 @@
 
 namespace EdifactParser\Segments;
 
-use EdifactParser\Exception\MissingSubSegmentKey;
+use EdifactParser\Exception\MissingSubId;
 
 /** @psalm-immutable */
 final class UNHMessageHeader implements SegmentInterface
@@ -16,15 +16,15 @@ public function __construct(array $rawValues)
         $this->rawValues = $rawValues;
     }
 
-    public function name(): string
+    public function tag(): string
     {
         return self::class;
     }
 
-    public function subSegmentKey(): string
+    public function subId(): string
     {
         if (!isset($this->rawValues[1][0])) {
-            throw new MissingSubSegmentKey('[1][0]', $this->rawValues);
+            throw new MissingSubId('[1][0]', $this->rawValues);
         }
 
         return (string) $this->rawValues[1][0];

diff --git a/src/Segments/UNTMessageFooter.php b/src/Segments/UNTMessageFooter.php
@@ -14,12 +14,12 @@ public function __construct(array $rawValues)
         $this->rawValues = $rawValues;
     }
 
-    public function name(): string
+    public function tag(): string
     {
         return self::class;
     }
 
-    public function subSegmentKey(): string
+    public function subId(): string
     {
         return (string) $this->rawValues[1];
     }

diff --git a/src/Segments/UnknownSegment.php b/src/Segments/UnknownSegment.php
@@ -14,12 +14,12 @@ public function __construct(array $rawValues)
         $this->rawValues = $rawValues;
     }
 
-    public function name(): string
+    public function tag(): string
     {
         return self::class;
     }
 
-    public function subSegmentKey(): string
+    public function subId(): string
     {
         $encodedValues = json_encode($this->rawValues);
 

diff --git a/src/TransactionMessage.php b/src/TransactionMessage.php
@@ -59,8 +59,8 @@ private static function groupSegmentsByName(SegmentInterface...$segments): self
         $return = [];
 
         foreach ($segments as $s) {
-            $return[$s->name()] ??= [];
-            $return[$s->name()][$s->subSegmentKey()] = $s;
+            $return[$s->tag()] ??= [];
+            $return[$s->tag()][$s->subId()] = $s;
         }
 
         return new self($return);

diff --git a/tests/Functional/TestingSegmentFactory.php b/tests/Functional/TestingSegmentFactory.php
@@ -35,12 +35,12 @@ public function __construct(array $rawArray)
                 $this->rawArray = $rawArray;
             }
 
-            public function name(): string
+            public function tag(): string
             {
                 return (string) $this->rawArray[0];
             }
 
-            public function subSegmentKey(): string
+            public function subId(): string
             {
                 return (string) $this->rawArray[1];
             }

diff --git a/tests/Unit/Segments/BGMBeginningOfMessageTest.php b/tests/Unit/Segments/BGMBeginningOfMessageTest.php
@@ -15,8 +15,8 @@ public function segmentValues(): void
         $rawValues = ['BGM', '340', '00250559268149700889', '9'];
         $segment = new BGMBeginningOfMessage($rawValues);
 
-        self::assertEquals(BGMBeginningOfMessage::class, $segment->name());
-        self::assertEquals('340', $segment->subSegmentKey());
+        self::assertEquals(BGMBeginningOfMessage::class, $segment->tag());
+        self::assertEquals('340', $segment->subId());
         self::assertEquals($rawValues, $segment->rawValues());
     }
 }
diff --git a/tests/Unit/Segments/CNTControlTest.php b/tests/Unit/Segments/CNTControlTest.php
@@ -4,7 +4,7 @@
 
 namespace EdifactParser\Tests\Unit\Segments;
 
-use EdifactParser\Exception\MissingSubSegmentKey;
+use EdifactParser\Exception\MissingSubId;
 use EdifactParser\Segments\CNTControl;
 use PHPUnit\Framework\TestCase;
 
@@ -16,16 +16,16 @@ public function segmentValues(): void
         $rawValues = ['CNT', ['7', '0.1', 'KGM']];
         $segment = new CNTControl($rawValues);
 
-        self::assertEquals(CNTControl::class, $segment->name());
-        self::assertEquals('7', $segment->subSegmentKey());
+        self::assertEquals(CNTControl::class, $segment->tag());
+        self::assertEquals('7', $segment->subId());
         self::assertEquals($rawValues, $segment->rawValues());
     }
 
     /** @test */
-    public function missingSubSegmentKey(): void
+    public function missingSubId(): void
     {
         $segment = new CNTControl(['CNT']);
-        $this->expectException(MissingSubSegmentKey::class);
-        $segment->subSegmentKey();
+        $this->expectException(MissingSubId::class);
+        $segment->subId();
     }
 }
diff --git a/tests/Unit/Segments/DTMDateTimePeriodTest.php b/tests/Unit/Segments/DTMDateTimePeriodTest.php
@@ -4,7 +4,7 @@
 
 namespace EdifactParser\Tests\Unit\Segments;
 
-use EdifactParser\Exception\MissingSubSegmentKey;
+use EdifactParser\Exception\MissingSubId;
 use EdifactParser\Segments\DTMDateTimePeriod;
 use PHPUnit\Framework\TestCase;
 
@@ -16,16 +16,16 @@ public function segmentValues(): void
         $rawValues = ['DTM', ['10', '20191002', '102']];
         $segment = new DTMDateTimePeriod($rawValues);
 
-        self::assertEquals(DTMDateTimePeriod::class, $segment->name());
-        self::assertEquals('10', $segment->subSegmentKey());
+        self::assertEquals(DTMDateTimePeriod::class, $segment->tag());
+        self::assertEquals('10', $segment->subId());
         self::assertEquals($rawValues, $segment->rawValues());
     }
 
     /** @test */
-    public function missingSubSegmentKey(): void
+    public function missingSubId(): void
     {
         $segment = new DTMDateTimePeriod(['DTM']);
-        $this->expectException(MissingSubSegmentKey::class);
-        $segment->subSegmentKey();
+        $this->expectException(MissingSubId::class);
+        $segment->subId();
     }
 }
diff --git a/tests/Unit/Segments/MEADimensionsTest.php b/tests/Unit/Segments/MEADimensionsTest.php
@@ -15,8 +15,8 @@ public function segmentValues(): void
         $rawValues = ['MEA', 'WT', 'G', ['KGM', '0.1']];
         $segment = new MEADimensions($rawValues);
 
-        self::assertEquals(MEADimensions::class, $segment->name());
-        self::assertEquals('WT', $segment->subSegmentKey());
+        self::assertEquals(MEADimensions::class, $segment->tag());
+        self::assertEquals('WT', $segment->subId());
         self::assertEquals($rawValues, $segment->rawValues());
     }
 }
diff --git a/tests/Unit/Segments/NADNameAddressTest.php b/tests/Unit/Segments/NADNameAddressTest.php
@@ -26,8 +26,8 @@ public function segmentValues(): void
         ];
         $segment = new NADNameAddress($rawValues);
 
-        self::assertEquals(NADNameAddress::class, $segment->name());
-        self::assertEquals('CZ', $segment->subSegmentKey());
+        self::assertEquals(NADNameAddress::class, $segment->tag());
+        self::assertEquals('CZ', $segment->subId());
         self::assertEquals($rawValues, $segment->rawValues());
     }
 }
diff --git a/tests/Unit/Segments/PCIPackageIdTest.php b/tests/Unit/Segments/PCIPackageIdTest.php
@@ -15,8 +15,8 @@ public function segmentValues(): void
         $rawValues = ['PCI', '18', '00250559268149700889'];
         $segment = new PCIPackageId($rawValues);
 
-        self::assertEquals(PCIPackageId::class, $segment->name());
-        self::assertEquals('18', $segment->subSegmentKey());
+        self::assertEquals(PCIPackageId::class, $segment->tag());
+        self::assertEquals('18', $segment->subId());
         self::assertEquals($rawValues, $segment->rawValues());
     }
 }