Add MissingCheckDigitException and common interface for all exceptions. Add tests for exceptions. (#23)

* create exceptions specific for this library

* lint

* add tests for argument is not numeric

* add test for missing check digit exception

* add clarification

* cleanup

* cleanup

Author: Ekman

composer.json

@@ -39,5 +39,9 @@
 		"phpunit/phpunit": "^6.0",
 		"friendsofphp/php-cs-fixer": "^2.15",
 		"php-coveralls/php-coveralls": "^2.1"
+	},
+	"scripts": {
+		"lint": "php-cs-fixer fix",
+		"test": "phpunit --configuration phpunit.xml"
 	}
 }

src/Contract/LuhnAlgorithmExceptionInterface.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 Niklas Ekman
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+declare(strict_types=1);
+
+namespace Nekman\LuhnAlgorithm\Contract;
+
+/**
+ * Base interface for all thrown exceptions in this library.
+ */
+interface LuhnAlgorithmExceptionInterface extends \Throwable
+{
+}

src/Contract/LuhnAlgorithmInterface.php

@@ -27,6 +27,8 @@
 
 namespace Nekman\LuhnAlgorithm\Contract;
 
+use Nekman\LuhnAlgorithm\Exceptions\MissingCheckDigitException;
+
 /**
  * Handles the Luhn Algorithm.
  *
@@ -40,6 +42,8 @@ interface LuhnAlgorithmInterface
      * @param NumberInterface $number The number to validate.
      *
      * @return bool true if number is valid, false otherwise.
+     *
+     * @throws MissingCheckDigitException If the check digit in the number is not set.
      */
     public function isValid(NumberInterface $number): bool;
 
@@ -49,7 +53,6 @@ public function isValid(NumberInterface $number): bool;
      * @param NumberInterface $number The number to calculate the check digit for.
      *
      * @return int The check digit.
-     *
      */
     public function calcCheckDigit(NumberInterface $number): int;
 
@@ -59,7 +62,6 @@ public function calcCheckDigit(NumberInterface $number): int;
      * @param NumberInterface $number The number to calculate the checksum for.
      *
      * @return int The checksum.
-     *
      */
     public function calcChecksum(NumberInterface $number): int;
 }

src/ArgumentIsNotNumericException.php renamed to src/Exceptions/ArgumentIsNotNumericException.php

@@ -25,16 +25,17 @@
 
 declare(strict_types=1);
 
-namespace Nekman\LuhnAlgorithm;
+namespace Nekman\LuhnAlgorithm\Exceptions;
 
-class ArgumentIsNotNumericException extends \InvalidArgumentException
+use Nekman\LuhnAlgorithm\Contract\LuhnAlgorithmExceptionInterface;
+
+/**
+ * Indicates that an argument should be numeric, but is in fact not.
+ */
+class ArgumentIsNotNumericException extends \InvalidArgumentException implements LuhnAlgorithmExceptionInterface
 {
-    /**
-     * ArgumentIsNotNumericException constructor.
-     * @param string $number
-     */
     public function __construct(string $number)
     {
-        parent::__construct("Expects \$number to be a number, \"{$number}\" given.", 0, null);
+        parent::__construct("Expects \$number to be a number, \"{$number}\" given.");
     }
 }

src/Exceptions/MissingCheckDigitException.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 Niklas Ekman
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+declare(strict_types=1);
+
+namespace Nekman\LuhnAlgorithm\Exceptions;
+
+use Nekman\LuhnAlgorithm\Contract\LuhnAlgorithmExceptionInterface;
+
+/**
+ * Indicates that the check digit should be present, but is in fact not.
+ */
+class MissingCheckDigitException extends \InvalidArgumentException implements LuhnAlgorithmExceptionInterface
+{
+}

src/LuhnAlgorithm.php

@@ -29,19 +29,29 @@
 
 use Nekman\LuhnAlgorithm\Contract\LuhnAlgorithmInterface;
 use Nekman\LuhnAlgorithm\Contract\NumberInterface;
+use Nekman\LuhnAlgorithm\Exceptions\MissingCheckDigitException;
 
 /**
  * {@inheritdoc}
  */
 class LuhnAlgorithm implements LuhnAlgorithmInterface
 {
+    /**
+     * @internal The intended way to instantiate this object is through the factory.
+     *
+     * @see LuhnAlgorithmFactory
+     */
+    public function __construct()
+    {
+    }
+
     /**
      * {@inheritDoc}
      */
     public function isValid(NumberInterface $number): bool
     {
         if ($number->getCheckDigit() === null) {
-            throw new \InvalidArgumentException("Check digit is null.");
+            throw new MissingCheckDigitException("Check digit is null.");
         }
 
         $checksum = $this->calcChecksum($number) + $number->getCheckDigit();

src/Number.php

@@ -28,6 +28,7 @@
 namespace Nekman\LuhnAlgorithm;
 
 use Nekman\LuhnAlgorithm\Contract\NumberInterface;
+use Nekman\LuhnAlgorithm\Exceptions\ArgumentIsNotNumericException;
 
 /**
  * Input for the Luhn Algorithm contains a number and a check digit.
@@ -45,9 +46,10 @@ class Number implements NumberInterface
     private $checkDigit;
 
     /**
-     * Input constructor.
      * @param string $number The number.
      * @param int|null $checkDigit [Optional] The check digit for the number.
+     *
+     * @throws ArgumentIsNotNumericException If the number input does not consist entirely of numbers.
      */
     public function __construct(string $number, int $checkDigit = null)
     {
@@ -66,6 +68,8 @@ public function __construct(string $number, int $checkDigit = null)
      * @param string $input The input that contains the check digit already.
      *
      * @return self
+     *
+     * @throws ArgumentIsNotNumericException If the input does not consist entirely of numbers.
      */
     public static function fromString(string $input): self
     {

tests/LuhnAlgorithmTest.php

@@ -25,6 +25,8 @@
 
 namespace Nekman\LuhnAlgorithm\Test;
 
+use Nekman\LuhnAlgorithm\Contract\LuhnAlgorithmExceptionInterface;
+use Nekman\LuhnAlgorithm\Exceptions\MissingCheckDigitException;
 use Nekman\LuhnAlgorithm\LuhnAlgorithm;
 use Nekman\LuhnAlgorithm\Number;
 use PHPUnit\Framework\TestCase;
@@ -46,65 +48,70 @@ protected function setUp()
     /**
      * @dataProvider provideIsValid_success
      */
-    public function testIsValid_success($number, $expected, $purpose)
+    public function testIsValid_success($number, $expected)
     {
-        $this->assertEquals($expected, $this->luhn->isValid($number), $purpose);
+        $this->assertEquals($expected, $this->luhn->isValid($number));
     }
 
     public function provideIsValid_success()
     {
         return [
-            [new Number('12345', 5), true, "Valid number"],
-            [new Number('0', 0), true, "Zero"],
-            [new Number('92233720368547758072', 8), true, "Larger than INT_MAX"],
-            [new Number('12345', 6), false, "Invalid number"],
+            "Valid number" => [new Number('12345', 5), true],
+            "Zero" => [new Number('0', 0), true],
+            "Larger than INT_MAX" => [new Number('92233720368547758072', 8), true],
+            "Invalid number" => [new Number('12345', 6), false],
+            "Swedish company organization ID" => [new Number(559114884, 5), true],
+            "Swedish organization number" => [new Number(640319261, 7), true],
         ];
     }
 
     /**
      * @dataProvider provideIsValid_failure
      */
-    public function testIsValid_failure($number, $exception, $purpose)
+    public function testIsValid_failure($number, $exception)
     {
-        $this->expectException($exception, $purpose);
+        $this->expectException($exception);
         $this->luhn->isValid($number);
     }
 
     public function provideIsValid_failure()
     {
         return [
-            [new Number(123, null), \InvalidArgumentException::class, "Invalid argument"],
+            "Invalid argument" => [new Number(123, null), \InvalidArgumentException::class],
+            "Should be MissingCheckDigitException" => [new Number(123, null), MissingCheckDigitException::class],
+            "Should be LuhnAlgorithmExceptionInterface" => [new Number(123, null), LuhnAlgorithmExceptionInterface::class],
         ];
     }
 
     /**
      * @dataProvider provideCalcChecksum_success
      */
-    public function testCalcChecksum_success($number, $expected, $purpose)
+    public function testCalcChecksum_success($number, $expected)
     {
-        $this->assertEquals($expected, $this->luhn->calcChecksum($number), $purpose);
+        $this->assertEquals($expected, $this->luhn->calcChecksum($number));
     }
 
     public function provideCalcChecksum_success()
     {
         return [
-            [new Number(3199723370002), 50, "Valid checksum"],
+            "Valid checksum" => [new Number(3199723370002), 50],
         ];
     }
 
     /**
      * @dataProvider provideCalcCheckDigit_success
      */
-    public function testCalcCheckDigit_success($number, $expected, $purpose)
+    public function testCalcCheckDigit_success($number, $expected)
     {
         $this->assertEquals($expected, $this->luhn->calcCheckDigit($number));
     }
 
     public function provideCalcCheckDigit_success()
     {
         return [
-            [new Number(12345), 5, "Valid number"],
-            [new Number(559114884), 5, "Swedish company organization ID"],
+            "Valid number" => [new Number(12345), 5],
+            "Swedish company organization ID" => [new Number(559114884), 5],
+            "Swedish organization number" => [new Number(640319261), 7],
         ];
     }
 }