Merge pull request #21 from brazanation/cns

CNS document implemented

fix #20

Author: tonicospinelli

README.md

@@ -176,6 +176,18 @@ echo $state; // prints P011004243002
 echo $state->format(); // prints P-01100424.3/002
 ```
 
+### Cartão Nacional de Saúde (SUS)
+
+National Health Card
+
+```php
+use Brazanation\Documents\Cns;
+
+$cns = new Cns('242912018460005')
+echo $state; // prints 242912018460005
+echo $state->format(); // prints 242 9120 1846 0005
+```
+
 ### License
 
 MIT, hell yeah!

src/AbstractDocument.php

@@ -4,7 +4,7 @@
 
 use Brazanation\Documents\Exception\InvalidDocument as InvalidDocumentException;
 
-abstract class AbstractDocument implements DocumentInterface
+abstract class AbstractDocument implements DigitCalculable, Formattable
 {
     /**
      * @var string

src/Cnh.php

@@ -2,7 +2,7 @@
 
 namespace Brazanation\Documents;
 
-final class Cnh extends AbstractDocument implements DocumentInterface
+final class Cnh extends AbstractDocument
 {
     const LENGTH = 11;
 

src/Cnpj.php

@@ -2,7 +2,7 @@
 
 namespace Brazanation\Documents;
 
-final class Cnpj extends AbstractDocument implements DocumentInterface
+final class Cnpj extends AbstractDocument
 {
     const LENGTH = 14;
 

src/Cns.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Brazanation\Documents;
+
+use Brazanation\Documents\Cns\CnsCalculator;
+use Brazanation\Documents\Cns\TemporaryCalculator;
+
+final class Cns extends AbstractDocument
+{
+    const LENGTH = 15;
+
+    const LABEL = 'CNS';
+
+    const REGEX = '/^([\d]{3})([\d]{4})([\d]{4})([\d]{4})$/';
+
+    const FORMAT = '$1 $2 $3 $4';
+
+    const DIGIT_COUNT = 1;
+
+    /**
+     * CNS constructor.
+     *
+     * @param string $number
+     */
+    public function __construct($number)
+    {
+        $number = preg_replace('/\D/', '', $number);
+        parent::__construct($number, self::LENGTH, self::DIGIT_COUNT, self::LABEL);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function format()
+    {
+        return preg_replace(self::REGEX, self::FORMAT, "{$this}");
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * Based on given number, it will decide what kind of calculator will use.
+     *
+     * For numbers starting with 7, 8 or 9 will use TemporaryCalculator,
+     * otherwise CnsCalculator.
+     */
+    public function calculateDigit($baseNumber)
+    {
+        $calculator = new CnsCalculator();
+
+        if (in_array(substr($baseNumber, 0, 1), [7, 8, 9])) {
+            $calculator = new TemporaryCalculator();
+        }
+
+        $digit = $calculator->calculateDigit($baseNumber);
+
+        return "{$digit}";
+    }
+}

src/Cns/CnsCalculator.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Brazanation\Documents\Cns;
+
+use Brazanation\Documents\DigitCalculable;
+use Brazanation\Documents\DigitCalculator;
+
+final class CnsCalculator implements DigitCalculable
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function calculateDigit($baseNumber)
+    {
+        $pis = substr($baseNumber, 0, 11);
+
+        $calculator = new DigitCalculator($pis);
+        $calculator->useComplementaryInsteadOfModule();
+        $calculator->replaceWhen('8', 10);
+        $calculator->replaceWhen('0', 11);
+        $calculator->withMultipliersInterval(5, 15);
+
+        $digit = $calculator->calculate();
+
+        return "{$digit}";
+    }
+}

src/Cns/TemporaryCalculator.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Brazanation\Documents\Cns;
+
+use Brazanation\Documents\DigitCalculable;
+use Brazanation\Documents\DigitCalculator;
+
+class TemporaryCalculator implements DigitCalculable
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function calculateDigit($baseNumber)
+    {
+        $calculator = new DigitCalculator($baseNumber);
+        $calculator->withMultipliersInterval(1, 15);
+
+        $digit = $calculator->calculate();
+
+        return "{$digit}";
+    }
+}

src/Cpf.php

@@ -2,7 +2,7 @@
 
 namespace Brazanation\Documents;
 
-final class Cpf extends AbstractDocument implements DocumentInterface
+final class Cpf extends AbstractDocument
 {
     const LENGTH = 11;
 

src/DocumentInterface.php renamed to src/DigitCalculable.php

@@ -2,7 +2,7 @@
 
 namespace Brazanation\Documents;
 
-interface DocumentInterface
+interface DigitCalculable
 {
     /**
      * Calculate check digit from base number.
@@ -12,11 +12,4 @@ interface DocumentInterface
      * @return string Returns the checker digit.
      */
     public function calculateDigit($baseNumber);
-
-    /**
-     * Formats current number.
-     *
-     * @return string Returns formatted number.
-     */
-    public function format();
 }

src/DigitCalculator.php

@@ -260,12 +260,12 @@ private function calculateAdditionalDigit($digit)
      *
      * @param int $total A total to be calculated.
      *
-     * @return float Returns a calculated total.
+     * @return int Returns a calculated total.
      */
     private function calculateSingleSum($total)
     {
         if ($this->singleSum) {
-            return ($total / 10) + ($total % 10);
+            return intval(($total / 10) + ($total % 10));
         }
 
         return $total;

src/Formattable.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Brazanation\Documents;
+
+interface Formattable
+{
+    /**
+     * Formats current number.
+     *
+     * @return string Returns formatted number.
+     */
+    public function format();
+}

src/NFeAccessKey.php

@@ -2,7 +2,7 @@
 
 namespace Brazanation\Documents;
 
-final class NFeAccessKey extends AbstractDocument implements DocumentInterface
+final class NFeAccessKey extends AbstractDocument
 {
     const LABEL = 'NFeAccessKey';
 

src/PisPasep.php

@@ -2,7 +2,7 @@
 
 namespace Brazanation\Documents;
 
-final class PisPasep extends AbstractDocument implements DocumentInterface
+final class PisPasep extends AbstractDocument
 {
     const LENGTH = 11;
 

src/StateRegistration.php

@@ -64,7 +64,7 @@
  * @method static StateRegistration SP($number)
  * @method static StateRegistration TO($number)
  */
-final class StateRegistration extends AbstractDocument implements DocumentInterface
+final class StateRegistration extends AbstractDocument
 {
     /**
      * @var StateInterface

src/StateRegistration/StateInterface.php

@@ -2,7 +2,9 @@
 
 namespace Brazanation\Documents\StateRegistration;
 
-interface StateInterface
+use Brazanation\Documents\DigitCalculable;
+
+interface StateInterface extends DigitCalculable
 {
     /**
      * @return string
@@ -29,13 +31,6 @@ public function getFormat();
      */
     public function getNumberOfDigits();
 
-    /**
-     * @param string $baseNumber
-     *
-     * @return string
-     */
-    public function calculateDigit($baseNumber);
-
     /**
      * Normalizes number removing non-digit chars.
      *

src/Voter.php

@@ -2,7 +2,7 @@
 
 namespace Brazanation\Documents;
 
-final class Voter extends AbstractDocument implements DocumentInterface
+final class Voter extends AbstractDocument
 {
     const LENGTH = 12;
 

tests/CnsTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Brazanation\Documents\Tests;
+
+use Brazanation\Documents\Cns;
+
+class CnsTest extends DocumentTestCase
+{
+    public function createDocument($number)
+    {
+        return new Cns($number);
+    }
+
+    public function provideValidNumbers()
+    {
+        return [
+            ['242912018460005'],
+            ['202652786480004'],
+            ['130660713310009'],
+            ['161406744690005'],
+            ['131638083510018'],
+            ['153146911870018'],
+            ['126556169380018'],
+            ['112737911470018'],
+        ];
+    }
+
+    public function provideValidNumbersAndExpectedFormat()
+    {
+        return [
+            ['242912018460005', '242 9120 1846 0005'],
+        ];
+    }
+
+    public function provideEmptyData()
+    {
+        return [
+            [Cns::LABEL, ''],
+            [Cns::LABEL, null],
+            [Cns::LABEL, 0],
+        ];
+    }
+
+    public function provideInvalidNumber()
+    {
+        return [
+            [Cns::LABEL, 1],
+            [Cns::LABEL, '123123232323'],
+            [Cns::LABEL, '861238979874'],
+        ];
+    }
+}

tests/DocumentTestCase.php

@@ -2,15 +2,15 @@
 
 namespace Brazanation\Documents\Tests;
 
-use Brazanation\Documents\DocumentInterface;
+use Brazanation\Documents\AbstractDocument;
 use Brazanation\Documents\Exception\InvalidDocument;
 
 abstract class DocumentTestCase extends \PHPUnit_Framework_TestCase
 {
     /**
      * @param string $number
      *
-     * @return DocumentInterface
+     * @return AbstractDocument
      */
     abstract public function createDocument($number);
 
@@ -50,7 +50,7 @@ abstract public function provideInvalidNumber();
     final public function testShouldCreateInstance($number)
     {
         $document = $this->createDocument($number);
-        $this->assertInstanceOf(DocumentInterface::class, $document);
+        $this->assertInstanceOf(AbstractDocument::class, $document);
         $this->assertEquals(preg_replace('/[^\dXP]/i', '', $number), (string) $document);
     }