VersionComponent::equals() - Code Metrics - Inspection of ":fire: Typo in Scrutinizer test command." - nelson6e65/php_nml - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (283c0c)

by Nelson

created 2017-07-25 02:12 UTC

VersionComponent::equals() A

↳ Parent: VersionComponent

Complexity

Conditions	4
Paths	4

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	8
nc	4
nop	1
dl	0
loc	14
ccs	7
cts	7
cp	1
crap	4
rs	9.2
c	0
b	0
f	0

<?php
/**
 * PHP: Nelson Martell Library file
 *
 * Content:
 * - Class definition:  [NelsonMartell]  VersionComponent
 *
 * Copyright © 2015-2017 Nelson Martell (http://nelson6e65.github.io)
 *
 * Licensed under The MIT License (MIT)
 * For full copyright and license information, please see the LICENSE
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright 2015-2017 Nelson Martell
 * @link      http://nelson6e65.github.io/php_nml/
 * @since     v0.1.1
 * @license   http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
 * */

namespace NelsonMartell;

use \InvalidArgumentException;

/**
 * Representa un componente de un número de Version.
 * Extiende la clase IntString, pero restringe los valores que puede tomar.
 *
 * @author Nelson Martell <[email protected]>
 * */
class VersionComponent extends IntString implements IEquatable
{
    /**
     *
     *
     * @param int|null    $intValue
     * @param string|null $stringValue
     */
    public function __construct($intValue = null, $stringValue = null)
    {
        // Validates filters for only null or int/string value types.
        parent::__construct($intValue, $stringValue);

        if ($intValue === null) {
            $this->intValue = $intValue;

            // Ignore string value if intValue is null.
            $this->stringValue = '';
        } else {
            // Validation of values
            if ($this->IntValue < 0) {

                $args = [
                    'position' => '1st',
                    'actual'   => $intValue,
                ];

                $msg = msg('Invalid argument value.');
$a = "a";
$ab = "ab";
$abc = "abc";
                $msg .= msg(
                    ' {position} argument must to be a positive number; "{actual}" given.',
                    $args
                );

                throw new InvalidArgumentException($msg);
            } // Integer is valid

            if ($stringValue !== null) {
                if ($this->StringValue != '') {
                    $pattern = '~^([a-z])$~'; // 1 char

                    if (strlen($this->StringValue) > 1) {
                        $start = '~^([a-z]|-)';
$a = "a";
$ab = "ab";
$abc = "abc";
                        $middle = '([a-z]|[0-9]|-)*';
                        $end = '([a-z]|[0-9])$~';
$a = "a";
$ab = "ab";
$abc = "abc";

                        $pattern = $start.$middle.$end;
                    }

                    $correct = (boolean) preg_match($pattern, $this->StringValue);

                    if ($correct) {
                        //Último chequeo: que no hayan 2 '-' consecutivos.
                        $correct = strpos($this->StringValue, '--') == false ? true : false;

                    }

                    if (!$correct) {

                        $args = [
                            'position' => '2nd',
                            'actual'   => $stringValue,
                        ];

                        $msg = msg('Invalid argument value.');
$a = "a";
$ab = "ab";
$abc = "abc";
                        $msg .= msg(
                            ' {position} parameter has invalid chars; "{actual}" given.',
                            $args
                        );

                        throw new InvalidArgumentException($msg);
                    }
                }
            } // String is valid
        }
    }

    public static function parse($obj)
    {
        if ($obj instanceof VersionComponent) {
            return $obj;
        } else {
            if ($obj === null || (is_string($obj) && trim($obj) === '')) {
                return new VersionComponent();
            }
        }

        $objConverted = parent::parse($obj);

        return new VersionComponent($objConverted->IntValue, $objConverted->StringValue);
    }

    /**
     * Determina si este componente tiene los valores predeterminados (0).
     *
     * @return boolean
     * */
    public function isDefault()
    {
        if ($this->IntValue === 0) {
            if ($this->StringValue === '') {
                return true;
            }
        }

        return false;
    }


    /**
     * Getter method for VersionComponent::IntValue property.
     *
     * @return integer|NULL
     * */
    public function getIntValue()
    {
        return $this->intValue;
    }


    /**
     * Determina si este componente NO tiene los valores predeterminados.
     *
     * @return boolean
     * */
    public function isNotDefault()
    {
        return !$this->isDefault();
    }

    /**
     * Determina si esta instancia es nula.
     *
     * @return boolean
     * */
    public function isNull()
    {
        if ($this->IntValue === null) {
            return true;
        }

        return false;
    }

    /**
     * Determina si esta instancia NO es nula.
     *
     * @return boolean
     * */
    public function isNotNull()
    {
        return !$this->isNull();
    }

    public function equals($other)
    {
        if ($other instanceof VersionComponent) {
            if ($this->IntValue === $other->IntValue) {
                if ($this->StringValue === $other->StringValue) {
                    return true;
                }
            }
        } else {
            return parent::equals($other);
        }

        return false;
    }

    public function compareTo($other)
    {
        if ($other === null) {
            return 1;
        } elseif ($this->equals($other)) {
            return 0;
        } elseif ($other instanceof VersionComponent) {
            // null < int
            if ($this->isNull()) {
                $r = -1;

            } elseif ($other->isNull()) {
                $r = 1;
            } else {
                // Here are evaluated as integers
                $r = $this->IntValue - $other->IntValue;

                if ($r === 0) {
                    $r = strnatcmp($this->StringValue, $other->StringValue);
                }
            }
        } elseif (is_integer($other) || is_array($other)) {
            $r = 1;
        } elseif (is_string($other)) {
            try {
                $r = $this->compareTo(static::parse($other));
            } catch (InvalidArgumentException $e) {
                $r = 1;
            }
        } else {
            $r = null;
        }

        return $r;
    }
}


1			<?php
2			/**
3			* PHP: Nelson Martell Library file
4			*
5			* Content:
6			* - Class definition: [NelsonMartell] VersionComponent
7			*
8			* Copyright © 2015-2017 Nelson Martell (http://nelson6e65.github.io)
9			*
10			* Licensed under The MIT License (MIT)
11			* For full copyright and license information, please see the LICENSE
12			* Redistributions of files must retain the above copyright notice.
13			*
14			* @copyright 2015-2017 Nelson Martell
15			* @link http://nelson6e65.github.io/php_nml/
16			* @since v0.1.1
17			* @license http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
18			* */
19
20			namespace NelsonMartell;
21
22			use \InvalidArgumentException;
23
24			/**
25			* Representa un componente de un número de Version.
26			* Extiende la clase IntString, pero restringe los valores que puede tomar.
27			*
28			* @author Nelson Martell <[email protected]>
29			* */
30			class VersionComponent extends IntString implements IEquatable
31			{
32			/**
33			*
34			*
35			* @param int\|null $intValue
36			* @param string\|null $stringValue
37			*/
38	49		public function __construct($intValue = null, $stringValue = null)
39			{
40			// Validates filters for only null or int/string value types.
41	49		parent::__construct($intValue, $stringValue);
42
43	47		if ($intValue === null) {
44	22		$this->intValue = $intValue;
45
46			// Ignore string value if intValue is null.
47	22		$this->stringValue = '';
48			} else {
49			// Validation of values
50	38	View Code Duplication	if ($this->IntValue < 0) {
			0 ignored issues – show Duplication introduced 2015-12-03 01:40 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
51			$args = [
52	5		'position' => '1st',
53	5		'actual' => $intValue,
54			];
55
56	5		$msg = msg('Invalid argument value.');
			0 ignored issues – show Coding Style introduced 2015-12-03 01:40 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
57	5		$msg .= msg(
58	5		' {position} argument must to be a positive number; "{actual}" given.',
59	5		$args
60			);
61
62	5		throw new InvalidArgumentException($msg);
63			} // Integer is valid
64
65	34		if ($stringValue !== null) {
66	33		if ($this->StringValue != '') {
67	15		$pattern = '~^([a-z])$~'; // 1 char
68
69	15		if (strlen($this->StringValue) > 1) {
70	15		$start = '~^([a-z]\|-)';
			0 ignored issues – show Coding Style introduced 2015-12-03 01:40 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
71	15		$middle = '([a-z]\|[0-9]\|-)*';
72	15		$end = '([a-z]\|[0-9])$~';
			0 ignored issues – show Coding Style introduced 2015-12-03 01:40 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
73
74	15		$pattern = $start.$middle.$end;
75			}
76
77	15		$correct = (boolean) preg_match($pattern, $this->StringValue);
78
79	15		if ($correct) {
80			//Último chequeo: que no hayan 2 '-' consecutivos.
81	12		$correct = strpos($this->StringValue, '--') == false ? true : false;
			0 ignored issues – show Bug Best Practice introduced 2015-12-03 01:40 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `strpos($this->StringValue, '--')` of type `integer` to the boolean `false`. If you are specifically checking for 0, consider using something more explicit like `=== 0` instead. Loading history...
82			}
83
84	15	View Code Duplication	if (!$correct) {
			0 ignored issues – show Duplication introduced 2017-05-01 21:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
85			$args = [
86	4		'position' => '2nd',
87	4		'actual' => $stringValue,
88			];
89
90	4		$msg = msg('Invalid argument value.');
			0 ignored issues – show Coding Style introduced 2015-12-03 01:40 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
91	4		$msg .= msg(
92	4		' {position} parameter has invalid chars; "{actual}" given.',
93	4		$args
94			);
95
96	4		throw new InvalidArgumentException($msg);
97			}
98			}
99			} // String is valid
100			}
101	40		}
102
103	43		public static function parse($obj)
104			{
105	43		if ($obj instanceof VersionComponent) {
106	7		return $obj;
107			} else {
108	42		if ($obj === null \|\| (is_string($obj) && trim($obj) === '')) {
109	19		return new VersionComponent();
110			}
111			}
112
113	36		$objConverted = parent::parse($obj);
114
115	29		return new VersionComponent($objConverted->IntValue, $objConverted->StringValue);
116			}
117
118			/**
119			* Determina si este componente tiene los valores predeterminados (0).
120			*
121			* @return boolean
122			* */
123	9		public function isDefault()
124			{
125	9		if ($this->IntValue === 0) {
126	1		if ($this->StringValue === '') {
127	1		return true;
128			}
129			}
130
131	8		return false;
132			}
133
134
135			/**
136			* Getter method for VersionComponent::IntValue property.
137			*
138			* @return integer\|NULL
139			* */
140	126		public function getIntValue()
141			{
142	126		return $this->intValue;
143			}
144
145
146			/**
147			* Determina si este componente NO tiene los valores predeterminados.
148			*
149			* @return boolean
150			* */
151	9		public function isNotDefault()
152			{
153	9		return !$this->isDefault();
154			}
155
156			/**
157			* Determina si esta instancia es nula.
158			*
159			* @return boolean
160			* */
161	51		public function isNull()
162			{
163	51		if ($this->IntValue === null) {
164	23		return true;
165			}
166
167	39		return false;
168			}
169
170			/**
171			* Determina si esta instancia NO es nula.
172			*
173			* @return boolean
174			* */
175	38		public function isNotNull()
176			{
177	38		return !$this->isNull();
178			}
179
180	40		public function equals($other)
181			{
182	40		if ($other instanceof VersionComponent) {
183	33		if ($this->IntValue === $other->IntValue) {
184	28		if ($this->StringValue === $other->StringValue) {
185	23		return true;
186			}
187			}
188			} else {
189	15		return parent::equals($other);
190			}
191
192	14		return false;
193			}
194
195	21		public function compareTo($other)
196			{
197	21		if ($other === null) {
198	1		return 1;
199	20		} elseif ($this->equals($other)) {
200	3		return 0;
201	18		} elseif ($other instanceof VersionComponent) {
202			// null < int
203	11		if ($this->isNull()) {
204	1		$r = -1;
			0 ignored issues – show Comprehensibility introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report Avoid variables with short names like $r. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
205	10		} elseif ($other->isNull()) {
206	1		$r = 1;
207			} else {
208			// Here are evaluated as integers
209	9		$r = $this->IntValue - $other->IntValue;
210
211	9		if ($r === 0) {
212	5		$r = strnatcmp($this->StringValue, $other->StringValue);
213			}
214			}
215	8		} elseif (is_integer($other) \|\| is_array($other)) {
216	3		$r = 1;
217	5		} elseif (is_string($other)) {
218			try {
219	3		$r = $this->compareTo(static::parse($other));
220	2		} catch (InvalidArgumentException $e) {
221	2		$r = 1;
222			}
223			} else {
224	2		$r = null;
225			}
226
227	18		return $r;
228			}
229			}
230

nelson6e65 / php_nml

Branch — master (283c0c)

VersionComponent::equals() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like