SKUTest::getInvalidSKUs() - Code Metrics - Inspection of "Feature/base" - wambo-co/module-catalog - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#1)

by Andreas

created 2016-07-12 18:54 UTC

SKUTest::getInvalidSKUs() A

↳ Parent: SKUTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	53
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	53
rs	9.5797
cc	1
eloc	32
nc	1
nop	0

How to fix Long Method

<?php
use Wambo\Catalog\Model\SKU;

/**
 * Class SKUTest contains tests for the Wambo\Catalog\Model\SKU class.
 */
class SKUTest extends PHPUnit_Framework_TestCase
namespace YourVendor;

class YourClass { }
{
    /**
     * If the given SKU is valid validateSKU should not throw an exception
     *
     * @test
     * @dataProvider getValidSKUs
     *
     * @param string $sku A SKU
     */
    public function validateSKU_validSKUs_NoExceptionIsThrown($sku)

    {
        // act
        $exceptionThrown = false;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        try {

            new SKU($sku);
            $exceptionThrown = false;

        } catch (Exception $validationException) {
            $exceptionThrown = true;
        }

        // assert
        $this->assertFalse($exceptionThrown, "validateSKU('$sku') should not have thrown an exception");
    }

    /**
     * If the given SKU is invalid validateSKU should throw an exception
     *
     * @test
     * @dataProvider getInvalidSKUs
     *
     * @param string $sku                      A SKU
     * @param string $expectedExceptionMessage The expected exception message
     */
    public function validateSKU_invalidSKUs_ExceptionIsThrown($sku, $expectedExceptionMessage)

    {
        // act
        $exceptionThrown = false;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        try {

            new SKU($sku);
            $exceptionThrown = false;

        } catch (Exception $validationException) {

            // assert
            $exceptionThrown = true;
            $this->assertContains($expectedExceptionMessage, $validationException->getMessage(),
                "validateSKU('$sku') should have thrown an exception with the message: $expectedExceptionMessage");

        }

        // assert
        $this->assertTrue($exceptionThrown, "validateSKU('$sku') should have thrown an exception");
    }

    /**
     * Get a list of valid SKUs
     *
     * @return array
     */
    public static function getValidSKUs()
    {
        return [
            ["abcdefghijklmnopqrstuvwxyz012345"], // max length <= 32
            ["abcdefghijklmnopqrstuvwxyz"], // the whole alphabet
            ["123456789"], // only digits
            ["00000111111111"], // leading zeros
            ["a-product"], // dashes
            ["product1"], // characters and digits
            ["product112345678"], // characters and digits
            ["product-1"],
            ["product-112345678"],
            ["ab"], // min length >= 2
            ["12"], // min length >= 2
        ];
    }

    /**
     * Get a list of invalid SKUs
     *
     * @return array
     */
    public static function getInvalidSKUs()
    {
        // format: [ "sku", "expected exception messages" ]

        return [
            // empty
            ["", "empty"],

            // white space
            [" product", "white space"],
            ["product ", "white space"],
            [" product ", "white space"],
            ["pro duct", "white space"],

            // invalid characters
            ['7$tshirt', "invalid characters"], // Dollar sign
            ['gâteau', "invalid characters"], // French umlaut
            ['käse', "invalid characters"], // German umlaut
            ['product/1', "invalid characters"],
            ['product:1', "invalid characters"],
            ['product.1', "invalid characters"],
            ['product(1)', "invalid characters"],
            ['product§1', "invalid characters"],
            ['👃-spray', "invalid characters"], // nose emoji
            ['Åre', "invalid characters"], // Swedish umlaut
            ['Öresund', "invalid characters"], // German umlaut
            ['наушник', "invalid characters"], // Russian
            ['이어폰', "invalid characters"], // Korean

            // invalid prefix
            ['-product', "cannot start"],


            // invalid postfix
            ['product-', "cannot end"],

            // uppercase characters
            ["Product-123", "uppercase"],
            ["pro-Duct-123", "uppercase"],
            ["AAA", "uppercase"],
            ["aBc", "uppercase"],
            ["abC", "uppercase"],
            ["abC", "uppercase"],

            // minimum length
            ["a", "too short"],
            ["1", "too short"],
            ["0", "too short"],

            // maximum length
            ["abcdefghijklmnopqrstuvwxyz0123456789", "too long"],

        ];
    }
}


1		<?php
2		use Wambo\Catalog\Model\SKU;
3
4		/**
5		* Class SKUTest contains tests for the Wambo\Catalog\Model\SKU class.
6		*/
7		class SKUTest extends PHPUnit_Framework_TestCase
		0 ignored issues – show Coding Style Compatibility introduced 2016-07-12 17:29 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
8		{
9		/**
10		* If the given SKU is valid validateSKU should not throw an exception
11		*
12		* @test
13		* @dataProvider getValidSKUs
14		*
15		* @param string $sku A SKU
16		*/
17	View Code Duplication	public function validateSKU_validSKUs_NoExceptionIsThrown($sku)
		0 ignored issues – show Duplication introduced 2016-07-12 17:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
18		{
19		// act
20		$exceptionThrown = false;
		0 ignored issues – show Unused Code introduced 2016-07-12 17:29 UTC by Report Bug Copy Issue Report `$exceptionThrown` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
21		try {
22
23		new SKU($sku);
24		$exceptionThrown = false;
25
26		} catch (Exception $validationException) {
27		$exceptionThrown = true;
28		}
29
30		// assert
31		$this->assertFalse($exceptionThrown, "validateSKU('$sku') should not have thrown an exception");
32		}
33
34		/**
35		* If the given SKU is invalid validateSKU should throw an exception
36		*
37		* @test
38		* @dataProvider getInvalidSKUs
39		*
40		* @param string $sku A SKU
41		* @param string $expectedExceptionMessage The expected exception message
42		*/
43	View Code Duplication	public function validateSKU_invalidSKUs_ExceptionIsThrown($sku, $expectedExceptionMessage)
		0 ignored issues – show Duplication introduced 2016-07-12 17:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
44		{
45		// act
46		$exceptionThrown = false;
		0 ignored issues – show Unused Code introduced 2016-07-12 17:29 UTC by Report Bug Copy Issue Report `$exceptionThrown` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
47		try {
48
49		new SKU($sku);
50		$exceptionThrown = false;
51
52		} catch (Exception $validationException) {
53
54		// assert
55		$exceptionThrown = true;
56		$this->assertContains($expectedExceptionMessage, $validationException->getMessage(),
57		"validateSKU('$sku') should have thrown an exception with the message: $expectedExceptionMessage");
58
59		}
60
61		// assert
62		$this->assertTrue($exceptionThrown, "validateSKU('$sku') should have thrown an exception");
63		}
64
65		/**
66		* Get a list of valid SKUs
67		*
68		* @return array
69		*/
70		public static function getValidSKUs()
71		{
72		return [
73		["abcdefghijklmnopqrstuvwxyz012345"], // max length <= 32
74		["abcdefghijklmnopqrstuvwxyz"], // the whole alphabet
75		["123456789"], // only digits
76		["00000111111111"], // leading zeros
77		["a-product"], // dashes
78		["product1"], // characters and digits
79		["product112345678"], // characters and digits
80		["product-1"],
81		["product-112345678"],
82		["ab"], // min length >= 2
83		["12"], // min length >= 2
84		];
85		}
86
87		/**
88		* Get a list of invalid SKUs
89		*
90		* @return array
91		*/
92		public static function getInvalidSKUs()
93		{
94		// format: [ "sku", "expected exception messages" ]
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-12 17:29 UTC by Report Bug Copy Issue Report `46%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
95		return [
96		// empty
97		["", "empty"],
98
99		// white space
100		[" product", "white space"],
101		["product ", "white space"],
102		[" product ", "white space"],
103		["pro duct", "white space"],
104
105		// invalid characters
106		['7$tshirt', "invalid characters"], // Dollar sign
107		['gâteau', "invalid characters"], // French umlaut
108		['käse', "invalid characters"], // German umlaut
109		['product/1', "invalid characters"],
110		['product:1', "invalid characters"],
111		['product.1', "invalid characters"],
112		['product(1)', "invalid characters"],
113		['product§1', "invalid characters"],
114		['👃-spray', "invalid characters"], // nose emoji
115		['Åre', "invalid characters"], // Swedish umlaut
116		['Öresund', "invalid characters"], // German umlaut
117		['наушник', "invalid characters"], // Russian
118		['이어폰', "invalid characters"], // Korean
119
120		// invalid prefix
121		['-product', "cannot start"],
122
123
124		// invalid postfix
125		['product-', "cannot end"],
126
127		// uppercase characters
128		["Product-123", "uppercase"],
129		["pro-Duct-123", "uppercase"],
130		["AAA", "uppercase"],
131		["aBc", "uppercase"],
132		["abC", "uppercase"],
133		["abC", "uppercase"],
134
135		// minimum length
136		["a", "too short"],
137		["1", "too short"],
138		["0", "too short"],
139
140		// maximum length
141		["abcdefghijklmnopqrstuvwxyz0123456789", "too long"],
142
143		];
144		}
145		}
146

wambo-co / module-catalog

Pull Request — develop (#1)

SKUTest::getInvalidSKUs() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like