Card::name() - Code Metrics - Inspection of "Added brand property and created getters for brand..." - laravel-validation-rules/credit-card - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

unknown

created 2018-08-14 06:01 UTC

Card::name() A

↳ Parent: Card

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace LVR\CreditCard\Cards;

use LVR\CreditCard\Exceptions\CreditCardException;
use LVR\CreditCard\Exceptions\CreditCardCvcException;
use LVR\CreditCard\Exceptions\CreditCardNameException;
use LVR\CreditCard\Exceptions\CreditCardTypeException;
use LVR\CreditCard\Exceptions\CreditCardLengthException;
use LVR\CreditCard\Exceptions\CreditCardPatternException;
use LVR\CreditCard\Exceptions\CreditCardChecksumException;

abstract class Card
{
    /**
     * Regular expression for card number recognition.
     *
     * @var string
     */
    public static $pattern;

    /**
     * Credit card type: "debit", "credit".
     *
     * @var string
     */
    protected $type;

    /**
     * Credit card name.
     *
     * @var string
     */
    protected $name;

    /**
     * Brand name.
     *
     * @var string
     */
    protected $brand;

    /**
     * Card number length's.
     *
     * @var array
     */
    protected $number_length;

    /**
     * CVC code length's.
     *
     * @var array
     */
    protected $cvc_length;

    /**
     * Test cvc code checksum against Luhn algorithm.
     *
     * @var bool
     */
    protected $checksum_test;

    /**
     * @var string
     */
    private $card_number;

    /**
     * Card constructor.
     *
     * @param string $card_number
     *
     * @throws \LVR\CreditCard\Exceptions\CreditCardException
     */
    public function __construct(string $card_number = '')
    {
        $this->checkImplementation();

        if ($card_number) {
            $this->setCardNumber($card_number);
        }
    }

    /**
     * @param string $card_number
     *
     * @return $this
     * @throws \LVR\CreditCard\Exceptions\CreditCardPatternException
     */
    public function setCardNumber(string $card_number)
    {
        $card_number = preg_replace('/[^0-9]/', '', $card_number);

        $this->card_number = $card_number;

        if (! $this->validPattern()) {
            throw new CreditCardPatternException(
                sprintf('Wrong "%s" card pattern', $this->card_number)
            );
        }

        return $this;
    }

    /**
     * @return bool
     * @throws \LVR\CreditCard\Exceptions\CreditCardChecksumException
     * @throws \LVR\CreditCard\Exceptions\CreditCardException
     * @throws \LVR\CreditCard\Exceptions\CreditCardLengthException
     */
    public function isValidCardNumber()
    {
        if (! $this->card_number) {
            throw new CreditCardException('Card number is not set');
        }

        if (! $this->validLength()) {
            throw new CreditCardLengthException(
                sprintf('Incorrect "%s" card length', $this->card_number)
            );
        }

        if (! $this->validChecksum()) {
            throw new CreditCardChecksumException(
                sprintf('Invalid card number: "%s". Checksum is wrong', $this->card_number)
            );
        }

        return true;
    }

    /**
     * @return string
     */
    public function type()
    {
        return $this->type;
    }

    /**
     * @return string
     */
    public function name()
    {
        return $this->name;
    }

    /**
     * @return string
     */
    public function brand()
    {
        return $this->brand;
    }

    /**
     * @param $cvc
     *
     * @return bool
     */
    public function isValidCvc($cvc)
    {
        return is_numeric($cvc)
            && self::isValidCvcLength($cvc, $this->cvc_length);
    }

    /**
     * Check CVS length against possible lengths.
     *
     * @param string|int $cvc
     *
     * @param array $available_lengths
     *
     * @return bool
     */
    public static function isValidCvcLength($cvc, array $available_lengths = [3, 4])
    {
        return
            is_numeric($cvc)
            && in_array(strlen($cvc), $available_lengths, true);
    }

    /**
     * @throws \LVR\CreditCard\Exceptions\CreditCardException
     */
    protected function checkImplementation()
    {
        if (! $this->type || ! is_string($this->type) || ! in_array($this->type, ['debit', 'credit'])) {
            throw new CreditCardTypeException('Credit card type is missing');
        }

        if (! $this->name || ! is_string($this->name)) {
            throw new CreditCardNameException('Credit card name is missing or is not a string');
        }

        if (! static::$pattern || ! is_string(static::$pattern)) {
            throw new CreditCardPatternException(
                'Credit card number recognition pattern is missing or is not a string'
            );
        }

        if (empty($this->number_length) || ! is_array($this->number_length)) {
            throw new CreditCardLengthException(
                'Credit card number length is missing or is not an array'
            );
        }

        if (empty($this->cvc_length) || ! is_array($this->cvc_length)) {
            throw new CreditCardCvcException(
                'Credit card cvc code length is missing or is not an array'
            );
        }

        if ($this->checksum_test === null || ! is_bool($this->checksum_test)) {
            throw new CreditCardChecksumException(
                'Credit card checksum test is missing or is not a boolean'
            );
        }
    }

    /**
     * @return bool
     */
    protected function validPattern()
    {
        return (bool) preg_match(static::$pattern, $this->card_number);
    }

    /**
     * @return bool
     */
    protected function validLength()
    {
        return in_array(strlen($this->card_number), $this->number_length, true);
    }

    /**
     * @return bool
     */
    protected function validChecksum()
    {
        return ! $this->checksum_test || $this->checksumTest();
    }

    /**
     * @return bool
     */
    protected function checksumTest()
    {
        $checksum = 0;
        $len = strlen($this->card_number);
        for ($i = 2 - ($len % 2); $i <= $len; $i += 2) {
            $checksum += $this->card_number[$i - 1];
        }
        // Analyze odd digits in even length strings or even digits in odd length strings.
        for ($i = $len % 2 + 1; $i < $len; $i += 2) {
            $digit = $this->card_number[$i - 1] * 2;
            if ($digit < 10) {
                $checksum += $digit;
            } else {
                $checksum += $digit - 9;
            }
        }

        return ($checksum % 10) === 0;
    }
}


1		<?php
2
3		namespace LVR\CreditCard\Cards;
4
5		use LVR\CreditCard\Exceptions\CreditCardException;
6		use LVR\CreditCard\Exceptions\CreditCardCvcException;
7		use LVR\CreditCard\Exceptions\CreditCardNameException;
8		use LVR\CreditCard\Exceptions\CreditCardTypeException;
9		use LVR\CreditCard\Exceptions\CreditCardLengthException;
10		use LVR\CreditCard\Exceptions\CreditCardPatternException;
11		use LVR\CreditCard\Exceptions\CreditCardChecksumException;
12
13		abstract class Card
14		{
15		/**
16		* Regular expression for card number recognition.
17		*
18		* @var string
19		*/
20		public static $pattern;
21
22		/**
23		* Credit card type: "debit", "credit".
24		*
25		* @var string
26		*/
27		protected $type;
28
29		/**
30		* Credit card name.
31		*
32		* @var string
33		*/
34		protected $name;
35
36		/**
37		* Brand name.
38		*
39		* @var string
40		*/
41		protected $brand;
42
43		/**
44		* Card number length's.
45		*
46		* @var array
47		*/
48		protected $number_length;
49
50		/**
51		* CVC code length's.
52		*
53		* @var array
54		*/
55		protected $cvc_length;
56
57		/**
58		* Test cvc code checksum against Luhn algorithm.
59		*
60		* @var bool
61		*/
62		protected $checksum_test;
63
64		/**
65		* @var string
66		*/
67		private $card_number;
68
69		/**
70		* Card constructor.
71		*
72		* @param string $card_number
73		*
74		* @throws \LVR\CreditCard\Exceptions\CreditCardException
75		*/
76	95	public function __construct(string $card_number = '')
77		{
78	95	$this->checkImplementation();
79
80	90	if ($card_number) {
81	34	$this->setCardNumber($card_number);
82		}
83	90	}
84
85		/**
86		* @param string $card_number
87		*
88		* @return $this
89		* @throws \LVR\CreditCard\Exceptions\CreditCardPatternException
90		*/
91	67	public function setCardNumber(string $card_number)
92		{
93	67	$card_number = preg_replace('/[^0-9]/', '', $card_number);
94
95	67	$this->card_number = $card_number;
96
97	67	if (! $this->validPattern()) {
98	22	throw new CreditCardPatternException(
99	22	sprintf('Wrong "%s" card pattern', $this->card_number)
100		);
101		}
102
103	45	return $this;
104		}
105
106		/**
107		* @return bool
108		* @throws \LVR\CreditCard\Exceptions\CreditCardChecksumException
109		* @throws \LVR\CreditCard\Exceptions\CreditCardException
110		* @throws \LVR\CreditCard\Exceptions\CreditCardLengthException
111		*/
112	55	public function isValidCardNumber()
113		{
114	55	if (! $this->card_number) {
115	11	throw new CreditCardException('Card number is not set');
116		}
117
118	44	if (! $this->validLength()) {
119	11	throw new CreditCardLengthException(
120	11	sprintf('Incorrect "%s" card length', $this->card_number)
121		);
122		}
123
124	33	if (! $this->validChecksum()) {
125	11	throw new CreditCardChecksumException(
126	11	sprintf('Invalid card number: "%s". Checksum is wrong', $this->card_number)
127		);
128		}
129
130	22	return true;
131		}
132
133		/**
134		* @return string
135		*/
136	11	public function type()
137		{
138	11	return $this->type;
139		}
140
141		/**
142		* @return string
143		*/
144		public function name()
145		{
146		return $this->name;
147		}
148
149		/**
150		* @return string
151		*/
152		public function brand()
153		{
154		return $this->brand;
155		}
156
157		/**
158		* @param $cvc
159		*
160		* @return bool
161		*/
162	1	public function isValidCvc($cvc)
163		{
164	1	return is_numeric($cvc)
165	1	&& self::isValidCvcLength($cvc, $this->cvc_length);
166		}
167
168		/**
169		* Check CVS length against possible lengths.
170		*
171		* @param string\|int $cvc
172		*
173		* @param array $available_lengths
174		*
175		* @return bool
176		*/
177	2	public static function isValidCvcLength($cvc, array $available_lengths = [3, 4])
178		{
179		return
180	2	is_numeric($cvc)
181	2	&& in_array(strlen($cvc), $available_lengths, true);
182		}
183
184		/**
185		* @throws \LVR\CreditCard\Exceptions\CreditCardException
186		*/
187	95	protected function checkImplementation()
188		{
189	95	if (! $this->type \|\| ! is_string($this->type) \|\| ! in_array($this->type, ['debit', 'credit'])) {
190	1	throw new CreditCardTypeException('Credit card type is missing');
191		}
192
193	95	if (! $this->name \|\| ! is_string($this->name)) {
194	2	throw new CreditCardNameException('Credit card name is missing or is not a string');
195		}
196
197	94	if (! static::$pattern \|\| ! is_string(static::$pattern)) {
198	2	throw new CreditCardPatternException(
199	2	'Credit card number recognition pattern is missing or is not a string'
200		);
201		}
202
203	93	if (empty($this->number_length) \|\| ! is_array($this->number_length)) {
204	2	throw new CreditCardLengthException(
205	2	'Credit card number length is missing or is not an array'
206		);
207		}
208
209	92	if (empty($this->cvc_length) \|\| ! is_array($this->cvc_length)) {
210	2	throw new CreditCardCvcException(
211	2	'Credit card cvc code length is missing or is not an array'
212		);
213		}
214
215	91	if ($this->checksum_test === null \|\| ! is_bool($this->checksum_test)) {
216	2	throw new CreditCardChecksumException(
217	2	'Credit card checksum test is missing or is not a boolean'
218		);
219		}
220	90	}
221
222		/**
223		* @return bool
224		*/
225	67	protected function validPattern()
226		{
227	67	return (bool) preg_match(static::$pattern, $this->card_number);
228		}
229
230		/**
231		* @return bool
232		*/
233	44	protected function validLength()
234		{
235	44	return in_array(strlen($this->card_number), $this->number_length, true);
236		}
237
238		/**
239		* @return bool
240		*/
241	33	protected function validChecksum()
242		{
243	33	return ! $this->checksum_test \|\| $this->checksumTest();
244		}
245
246		/**
247		* @return bool
248		*/
249	31	protected function checksumTest()
250		{
251	31	$checksum = 0;
252	31	$len = strlen($this->card_number);
253	31	for ($i = 2 - ($len % 2); $i <= $len; $i += 2) {
254	31	$checksum += $this->card_number[$i - 1];
255		}
256		// Analyze odd digits in even length strings or even digits in odd length strings.
257	31	for ($i = $len % 2 + 1; $i < $len; $i += 2) {
258	31	$digit = $this->card_number[$i - 1] * 2;
259	31	if ($digit < 10) {
260	31	$checksum += $digit;
261		} else {
262	28	$checksum += $digit - 9;
263		}
264		}
265
266	31	return ($checksum % 10) === 0;
267		}
268		}
269

laravel-validation-rules / credit-card

Pull Request — master (#10)

Card::name() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like