Merge remote-tracking branch 'origin' into v3

picqer · Sep 20, 2024 · f2abc13 · f2abc13
2 parents 55c82bd + e9d3968
commit f2abc13
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 5 deletions.
diff --git a/src/Types/TypeCode128.php b/src/Types/TypeCode128.php
@@ -214,7 +214,7 @@ public function getBarcode(string $code): Barcode
                 // get numeric sequences (if any)
                 $numseq = [];
                 preg_match_all('/([0-9]{4,})/', $code, $numseq, PREG_OFFSET_CAPTURE);
-                if (isset($numseq[1]) AND ! empty($numseq[1])) {
+                if (! empty($numseq[1])) {
                     $end_offset = 0;
                     foreach ($numseq[1] as $val) {
                         $offset = $val[1];
@@ -390,7 +390,7 @@ protected function get128ABsequence($code): array
         // get A sequences (if any)
         $numseq = [];
         preg_match_all('/([\x00-\x1f])/', $code, $numseq, PREG_OFFSET_CAPTURE);
-        if (isset($numseq[1]) AND ! empty($numseq[1])) {
+        if (empty($numseq[1])) {
             $end_offset = 0;
             foreach ($numseq[1] as $val) {
                 $offset = $val[1];

diff --git a/src/Types/TypeITF14.php b/src/Types/TypeITF14.php
@@ -5,13 +5,15 @@
 use Picqer\Barcode\Barcode;
 use Picqer\Barcode\BarcodeBar;
 use Picqer\Barcode\Exceptions\InvalidCharacterException;
+use Picqer\Barcode\Exceptions\InvalidCheckDigitException;
 use Picqer\Barcode\Exceptions\InvalidLengthException;
 
 class TypeITF14 implements TypeInterface
 {
     /**
      * @throws InvalidLengthException
      * @throws InvalidCharacterException
+     * @throws InvalidCheckDigitException
      */
     public function getBarcode(string $code): Barcode
     {
@@ -35,6 +37,10 @@ public function getBarcode(string $code): Barcode
 
         if (strlen($code) === 13) {
             $code .= $this->getChecksum($code);
+        } elseif (substr($code, -1) !== $this->getChecksum(substr($code, 0, -1))) {
+            // If length of given barcode is same as final length, barcode is including checksum
+            // Make sure that checksum is the same as we calculated
+            throw new InvalidCheckDigitException();
         }
 
         $barcode = new Barcode($code);
@@ -73,8 +79,8 @@ private function getChecksum(string $code): string
         $total = 0;
 
         for ($charIndex = 0; $charIndex <= (strlen($code) - 1); $charIndex++) {
-            $integerOfChar = intval($code . substr(strval($charIndex), 1));
-            $total += $integerOfChar * (($charIndex === 0 || $charIndex % 2 === 0) ? 3 : 1);
+            $integerOfChar = intval($code[$charIndex]);
+            $total += $integerOfChar * ($charIndex % 2 === 0 ? 3 : 1);
         }
 
         $checksum = 10 - ($total % 10);

diff --git a/src/Types/TypeUpcExtension2.php b/src/Types/TypeUpcExtension2.php
@@ -25,7 +25,7 @@ public function getBarcode(string $code): Barcode
 
         // Calculate check digit
         if ($len == 2) {
-            $r = $code % 4;
+            $r = (int)$code % 4;
         } elseif ($len == 5) {
             $r = (3 * intval($code[0] . $code[2] . $code[4])) + (9 * intval($code[1] . $code[3]));
             $r %= 10;

diff --git a/tests/ChecksumBarcodeTest.php b/tests/ChecksumBarcodeTest.php
@@ -0,0 +1,61 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+use Picqer\Barcode\Exceptions\BarcodeException;
+use Picqer\Barcode\Exceptions\InvalidCheckDigitException;
+use Picqer\Barcode\Types\TypeEan13;
+use Picqer\Barcode\Types\TypeInterface;
+use Picqer\Barcode\Types\TypeITF14;
+
+class ChecksumBarcodeTest extends TestCase
+{
+    private const VALID_BARCODES = [
+        ['type' => TypeEan13::class, 'barcodes' => [
+            '081231723897' => '0812317238973',
+            '004900000463' => '0049000004632',
+        ]],
+        ['type' => TypeITF14::class, 'barcodes' => [
+            '0001234560001' => '00012345600012',
+            '0540014128876' => '05400141288766',
+        ]],
+    ];
+    private const INVALID_BARCODES = [
+        ['type' => TypeEan13::class, 'barcodes' => ['0812317238972', '0049000004633']],
+        ['type' => TypeITF14::class, 'barcodes' => ['00012345600016', '05400141288762']],
+    ];
+
+    public function testAllValidBarcodeTypes()
+    {
+        foreach (self::VALID_BARCODES as $barcodeTestSet) {
+            $barcodeType = $this->getBarcodeType($barcodeTestSet['type']);
+
+            foreach ($barcodeTestSet['barcodes'] as $testBarcode => $validBarcode) {
+                $this->assertEquals($validBarcode, $barcodeType->getBarcodeData($testBarcode)->getBarcode());
+            }
+        }
+    }
+
+    public function testAllInvalidBarcodeTypes()
+    {
+        foreach (self::INVALID_BARCODES as $barcodeTestSet) {
+            $barcodeType = $this->getBarcodeType($barcodeTestSet['type']);
+
+            foreach ($barcodeTestSet['barcodes'] as $invalidBarcode) {
+                try {
+                    $barcodeType->getBarcodeData($invalidBarcode)->getBarcode();
+                } catch (BarcodeException $exception) {
+                    $this->assertInstanceOf(InvalidCheckDigitException::class, $exception);
+                    continue;
+                }
+
+                $this->assertTrue(false, sprintf('Exception was not thrown for barcode "%s".', $invalidBarcode));
+            }
+        }
+    }
+
+
+    private function getBarcodeType(string $typeClass): TypeInterface
+    {
+        return new $typeClass;
+    }
+}