Cnp::isResident() - Code Metrics - Inspection of "added Cnp" - vimishor/cnp-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( b270a8...088d24 )

by Alexandru

created 2017-08-14 09:27 UTC

Cnp::isResident() A

↳ Parent: Cnp

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * Copyright 2017 Alexandru Guzinschi <[email protected]>
 *
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */
namespace Vimishor\Cnp;

use Gentle\Embeddable\Embeddable;
use Gentle\Embeddable\Date;
use Vimishor\Cnp\Exception\InvalidCnpException;

/**
 * @author Alexandru Guzinschi <[email protected]>
 */
final class Cnp extends Embeddable
{
    /** @var Gender */
    private $gender;

    /** @var Date */
    private $birthday;

    /** @var County */
    private $county;

    /** @var Serial */
    private $serial;

    /** @var Checksum */
    private $checksum;

    /**
     * Build a {@link CNP} instance from a CNP number.
     *
     * @static
     * @access public
     * @param  string $number A CNP number.
     * @return self
     *
     * @throws InvalidCnpException
     */
    public static function fromString($number)
    {
        if (13 !== mb_strlen($number)) {
            throw new InvalidCnpException(
                'Invalid CNP length.',
                0,
                new \LengthException('Expected a string number of 13 characters.')
            );
        }

        try {
            return new self(
                new Gender(self::getValue($number, 0)),
                new Date(
                    new Date\Year('19'.self::getValue($number, 1).self::getValue($number, 2)),
                    new Date\Month(self::getValue($number, 3).self::getValue($number, 4)),
                    new Date\Day(self::getValue($number, 5).self::getValue($number, 6))
                ),
                new County(self::getValue($number, 7).self::getValue($number, 8)),
                new Serial(self::getValue($number, 9).self::getValue($number, 10).self::getValue($number, 11)),
                new Checksum(self::getValue($number, 12))
            );
        } catch (\Exception $e) {
            throw new InvalidCnpException($e->getMessage(), $e->getCode(), $e);
        }
    }

    /**
     * @param Gender   $gender
     * @param Date     $birthday
     * @param County   $county
     * @param Serial   $serial
     * @param Checksum $checksum
     *
     * @throws InvalidCnpException
     */
    public function __construct(Gender $gender, Date $birthday, County $county, Serial $serial, Checksum $checksum)
    {
        $this->gender = $gender;
        $this->serial = $serial;
        $this->checksum = $checksum;

        try {
            $this->setBirthday($birthday);
            $this->setCounty($county);
        } catch (\DomainException $e) {
            throw new InvalidCnpException('Provided number is not a valid CNP.', $e->getCode(), $e);
        }

        $this->validate((string)$this);
    }

    /**
     * @access public
     * @return Gender
     */
    public function getGender()
    {
        return $this->gender;
    }

    /**
     * @access public
     * @return Date
     */
    public function getBirthday()
    {
        return $this->birthday;
    }

    /**
     * @access public
     * @return County
     */
    public function getCounty()
    {
        return $this->county;
    }

    /**
     * @access public
     * @return Serial
     */
    public function getSerial()
    {
        return $this->serial;
    }

    /**
     * @access public
     * @return Checksum
     */
    public function getChecksum()
    {
        return $this->checksum;
    }

    /**
     * @access public
     * @return bool
     */
    public function isResident()
    {
        return in_array(sprintf('%s', $this->getGender()), ['7', '8'], false);
    }

    /**
     * {@inheritDoc}
     */
    public function equals(Embeddable $object)
    {
        return get_class($object) === 'Vimishor\Cnp\Cnp' && (string)$this === (string)$object;
    }

    /**
     * {@inheritDoc}
     */
    public function __toString()
    {
        return (string)$this->getGender().
            (string)$this->getBirthday()->asDateTime()->format('ymd').
            (string)$this->getCounty().
            (string)$this->getSerial().
            (string)$this->getChecksum();
    }

    /**
     * Rebuild a date object with the year changed.
     *
     * Year prefix is changed according to gender.
     *
     * @access private
     * @param  Date $birthday
     * @return $this
     */
    private function setBirthday(Date $birthday)
    {
        $year   = (string)$birthday->getYear();
        $prefix = $this->getYearPrefix($this->getGender());

        /** @noinspection ExceptionsAnnotatingAndHandlingInspection */
        $date = new Date(
            new Date\Year($prefix . self::getValue($year, 2) . self::getValue($year, 3)),
            new Date\Month((string)$birthday->getMonth()),
            new Date\Day((string)$birthday->getDay())
        );

        $this->birthday = $date;

        return $this;
    }

    /**
     * @access private
     * @param  County $county
     * @return $this
     *
     * @throws \DomainException
     */
    private function setCounty(County $county)
    {
        // Allow usage of Bucharest's district 7 and 8 only for dates prior to December 19, 1979.
        if (in_array((string)$county, ['47', '48'], false) &&
            strtotime($this->getBirthday()) > strtotime(Date::fromString('1979-12-19T23:59:23+00:00'))
        ) {
            $district = (string)$county;
            throw new \DomainException(
                sprintf("Bucharest's district %d doesn't exist anymore since 1979.", $district[1])
            );
        }

        $this->county = $county;

        return $this;
    }

    /**
     * Extract element from string at given position.
     *
     * @access private
     * @param  string $from
     * @param  int    $position
     * @return string
     */
    private static function getValue($from, $position)
    {
        $arr = str_split($from);

        return (string)$arr[$position];
    }

    /**
     * @access private
     * @param  Gender $gender
     * @return int
     */
    private function getYearPrefix(Gender $gender)
    {
        $prefix = 0;

        switch ((int)sprintf('%s', $gender)) {
            case 1:
            case 2:
            case 7:
            case 8:
                $prefix = 19;
                break;
            case 3:
            case 4:
                $prefix = 18;
                break;
            case 5:
            case 6:
                $prefix = 20;
                break;
        } // @codeCoverageIgnore

        return $prefix;
    }

    /**
     * Calculate checksum and compare with the one provided in order to validate
     *
     * @access private
     * @param  string $cnp
     * @return void
     *
     * @throws \Vimishor\Cnp\Exception\InvalidCnpException
     */
    private function validate($cnp)
    {
        // calculate control number and compare in order to validate
        if ((int)sprintf('%s', $this->getChecksum()) !== (int)$this->calculateChecksum($cnp)) {
            throw new InvalidCnpException('Provided number is not a valid CNP.');
        }
    }

    /**
     * @access private
     * @param  string $cnp
     * @return int
     */
    private function calculateChecksum($cnp)
    {
        $sum    = 0;

        for ($i = 0; $i <= 11; ++$i) {
            $sum += (int) self::getValue((string) $cnp, $i) * (int) self::getValue('279146358279', $i);
        }

        $sum %= 11;

        // Rule says that 10 should be interpreted as 1
        return (10 === $sum) ? 1 : $sum;
    }
}


1		<?php
2		/**
3		* Copyright 2017 Alexandru Guzinschi <[email protected]>
4		*
5		* This software may be modified and distributed under the terms
6		* of the MIT license. See the LICENSE file for details.
7		*/
8		namespace Vimishor\Cnp;
9
10		use Gentle\Embeddable\Embeddable;
11		use Gentle\Embeddable\Date;
12		use Vimishor\Cnp\Exception\InvalidCnpException;
13
14		/**
15		* @author Alexandru Guzinschi <[email protected]>
16		*/
17		final class Cnp extends Embeddable
18		{
19		/** @var Gender */
20		private $gender;
21
22		/** @var Date */
23		private $birthday;
24
25		/** @var County */
26		private $county;
27
28		/** @var Serial */
29		private $serial;
30
31		/** @var Checksum */
32		private $checksum;
33
34		/**
35		* Build a {@link CNP} instance from a CNP number.
36		*
37		* @static
38		* @access public
39		* @param string $number A CNP number.
40		* @return self
41		*
42		* @throws InvalidCnpException
43		*/
44	20	public static function fromString($number)
45		{
46	20	if (13 !== mb_strlen($number)) {
47	4	throw new InvalidCnpException(
48	4	'Invalid CNP length.',
49	4	0,
50	4	new \LengthException('Expected a string number of 13 characters.')
51	2	);
52		}
53
54		try {
55	16	return new self(
56	16	new Gender(self::getValue($number, 0)),
57	14	new Date(
58	14	new Date\Year('19'.self::getValue($number, 1).self::getValue($number, 2)),
59	14	new Date\Month(self::getValue($number, 3).self::getValue($number, 4)),
60	14	new Date\Day(self::getValue($number, 5).self::getValue($number, 6))
61	6	),
62	10	new County(self::getValue($number, 7).self::getValue($number, 8)),
63	8	new Serial(self::getValue($number, 9).self::getValue($number, 10).self::getValue($number, 11)),
64	6	new Checksum(self::getValue($number, 12))
65	3	);
66	16	} catch (\Exception $e) {
67	16	throw new InvalidCnpException($e->getMessage(), $e->getCode(), $e);
68		}
69		}
70
71		/**
72		* @param Gender $gender
73		* @param Date $birthday
74		* @param County $county
75		* @param Serial $serial
76		* @param Checksum $checksum
77		*
78		* @throws InvalidCnpException
79		*/
80	38	public function __construct(Gender $gender, Date $birthday, County $county, Serial $serial, Checksum $checksum)
81		{
82	38	$this->gender = $gender;
83	38	$this->serial = $serial;
84	38	$this->checksum = $checksum;
85
86		try {
87	38	$this->setBirthday($birthday);
88	38	$this->setCounty($county);
89	21	} catch (\DomainException $e) {
90	4	throw new InvalidCnpException('Provided number is not a valid CNP.', $e->getCode(), $e);
91		}
92
93	34	$this->validate((string)$this);
94	32	}
95
96		/**
97		* @access public
98		* @return Gender
99		*/
100	38	public function getGender()
101		{
102	38	return $this->gender;
103		}
104
105		/**
106		* @access public
107		* @return Date
108		*/
109	38	public function getBirthday()
110		{
111	38	return $this->birthday;
112		}
113
114		/**
115		* @access public
116		* @return County
117		*/
118	34	public function getCounty()
119		{
120	34	return $this->county;
121		}
122
123		/**
124		* @access public
125		* @return Serial
126		*/
127	34	public function getSerial()
128		{
129	34	return $this->serial;
130		}
131
132		/**
133		* @access public
134		* @return Checksum
135		*/
136	34	public function getChecksum()
137		{
138	34	return $this->checksum;
139		}
140
141		/**
142		* @access public
143		* @return bool
144		*/
145	4	public function isResident()
146		{
147	4	return in_array(sprintf('%s', $this->getGender()), ['7', '8'], false);
148		}
149
150		/**
151		* {@inheritDoc}
152		*/
153	16	public function equals(Embeddable $object)
154		{
155	16	return get_class($object) === 'Vimishor\Cnp\Cnp' && (string)$this === (string)$object;
156		}
157
158		/**
159		* {@inheritDoc}
160		*/
161	34	public function __toString()
162		{
163	34	return (string)$this->getGender().
164	34	(string)$this->getBirthday()->asDateTime()->format('ymd').
165	34	(string)$this->getCounty().
166	34	(string)$this->getSerial().
167	34	(string)$this->getChecksum();
168		}
169
170		/**
171		* Rebuild a date object with the year changed.
172		*
173		* Year prefix is changed according to gender.
174		*
175		* @access private
176		* @param Date $birthday
177		* @return $this
178		*/
179	38	private function setBirthday(Date $birthday)
180		{
181	38	$year = (string)$birthday->getYear();
182	38	$prefix = $this->getYearPrefix($this->getGender());
183
184		/** @noinspection ExceptionsAnnotatingAndHandlingInspection */
185	38	$date = new Date(
186	38	new Date\Year($prefix . self::getValue($year, 2) . self::getValue($year, 3)),
187	38	new Date\Month((string)$birthday->getMonth()),
188	38	new Date\Day((string)$birthday->getDay())
189	19	);
190
191	38	$this->birthday = $date;
192
193	38	return $this;
194		}
195
196		/**
197		* @access private
198		* @param County $county
199		* @return $this
200		*
201		* @throws \DomainException
202		*/
203	38	private function setCounty(County $county)
204		{
205		// Allow usage of Bucharest's district 7 and 8 only for dates prior to December 19, 1979.
206	38	if (in_array((string)$county, ['47', '48'], false) &&
207	27	strtotime($this->getBirthday()) > strtotime(Date::fromString('1979-12-19T23:59:23+00:00'))
208	19	) {
209	4	$district = (string)$county;
210	4	throw new \DomainException(
211	4	sprintf("Bucharest's district %d doesn't exist anymore since 1979.", $district[1])
212	2	);
213		}
214
215	34	$this->county = $county;
216
217	34	return $this;
218		}
219
220		/**
221		* Extract element from string at given position.
222		*
223		* @access private
224		* @param string $from
225		* @param int $position
226		* @return string
227		*/
228	48	private static function getValue($from, $position)
229		{
230	48	$arr = str_split($from);
231
232	48	return (string)$arr[$position];
233		}
234
235		/**
236		* @access private
237		* @param Gender $gender
238		* @return int
239		*/
240	38	private function getYearPrefix(Gender $gender)
241		{
242	38	$prefix = 0;
243
244	38	switch ((int)sprintf('%s', $gender)) {
245	38	case 1:
246	34	case 2:
247	31	case 7:
248	28	case 8:
249	24	$prefix = 19;
250	24	break;
251	14	case 3:
252	14	case 4:
253	4	$prefix = 18;
254	4	break;
255	10	case 5:
256	5	case 6:
257	10	$prefix = 20;
258	10	break;
259		} // @codeCoverageIgnore
260
261	38	return $prefix;
262		}
263
264		/**
265		* Calculate checksum and compare with the one provided in order to validate
266		*
267		* @access private
268		* @param string $cnp
269		* @return void
270		*
271		* @throws \Vimishor\Cnp\Exception\InvalidCnpException
272		*/
273	34	private function validate($cnp)
274		{
275		// calculate control number and compare in order to validate
276	34	if ((int)sprintf('%s', $this->getChecksum()) !== (int)$this->calculateChecksum($cnp)) {
277	2	throw new InvalidCnpException('Provided number is not a valid CNP.');
278		}
279	32	}
280
281		/**
282		* @access private
283		* @param string $cnp
284		* @return int
285		*/
286	34	private function calculateChecksum($cnp)
287		{
288	34	$sum = 0;
289
290	34	for ($i = 0; $i <= 11; ++$i) {
291	34	$sum += (int) self::getValue((string) $cnp, $i) * (int) self::getValue('279146358279', $i);
292	17	}
293
294	34	$sum %= 11;
295
296		// Rule says that 10 should be interpreted as 1
297	34	return (10 === $sum) ? 1 : $sum;
298		}
299		}
300

vimishor / cnp-php

Push — develop ( b270a8...088d24 )

Cnp::isResident() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like