SlugTest::getInvalidSlugs() - 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

SlugTest::getInvalidSlugs() B

↳ Parent: SlugTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	29
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	29
rs	8.8571
cc	1
eloc	15
nc	1
nop	0

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

/**
 * Class SlugTest tests the Wambo\Catalog\Model\Slug class.
 */
class SlugTest extends PHPUnit_Framework_TestCase
namespace YourVendor;

class YourClass { }
{
    /**
     * If the given Slug is valid validateSlug should not throw an exception
     *
     * @test
     * @dataProvider getValidSlugs
     *
     * @param string $sku A Slug
     */
    public function validateSlug_validSlugs_NoExceptionIsThrown($sku)

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

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

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

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

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

    /**
     * If the given Slug is invalid validateSlug should throw an exception
     *
     * @test
     * @dataProvider getInvalidSlugs
     *
     * @param string $sku                      A Slug
     * @param string $expectedExceptionMessage The expected exception message
     */
    public function validateSlug_invalidSlugs_ExceptionIsThrown($sku, $expectedExceptionMessage)

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

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

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

        } catch (Exception $validationException) {

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

        }

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

    /**
     * Get a list of valid Slugs
     *
     * @return array
     */
    public static function getValidSlugs()
    {
        return [
            ["abcdefghijklmnopqrstuvwxyz012345abcdefghijklmnopqrstuvwxyz012345"], // 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
            ["abc-dfg"],
            ["abc_dfg"],
            ["abc:dfg"],
            ["abc.dfg"],
            ["abc,dfg"],
            ["abc+dfg"],
            ["ABC_xyz"],
            ['Åre'], // Swedish umlaut
            ['Öresund'], // German umlaut
            ['наушник'], // Russian
            ['이어폰'], // Korean
        ];
    }

    /**
     * Get a list of invalid Slugs
     *
     * @return array
     */
    public static function getInvalidSlugs()
    {
        // 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
            ['product(1)', "invalid characters"],
            ['product§1', "invalid characters"],
            ['👃-spray', "invalid characters"], // nose emoji

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

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

        ];
    }
}


1		<?php
2		use Wambo\Catalog\Model\Slug;
3
4		/**
5		* Class SlugTest tests the Wambo\Catalog\Model\Slug class.
6		*/
7		class SlugTest 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 Slug is valid validateSlug should not throw an exception
11		*
12		* @test
13		* @dataProvider getValidSlugs
14		*
15		* @param string $sku A Slug
16		*/
17	View Code Duplication	public function validateSlug_validSlugs_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 Slug($sku);
24		$exceptionThrown = false;
25
26		} catch (Exception $validationException) {
27		$exceptionThrown = true;
28		}
29
30		// assert
31		$this->assertFalse($exceptionThrown, "validateSlug('$sku') should not have thrown an exception");
32		}
33
34		/**
35		* If the given Slug is invalid validateSlug should throw an exception
36		*
37		* @test
38		* @dataProvider getInvalidSlugs
39		*
40		* @param string $sku A Slug
41		* @param string $expectedExceptionMessage The expected exception message
42		*/
43	View Code Duplication	public function validateSlug_invalidSlugs_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 Slug($sku);
50		$exceptionThrown = false;
51
52		} catch (Exception $validationException) {
53
54		// assert
55		$exceptionThrown = true;
56		$this->assertContains($expectedExceptionMessage, $validationException->getMessage(),
57		"validateSlug('$sku') should have thrown an exception with the message: $expectedExceptionMessage");
58
59		}
60
61		// assert
62		$this->assertTrue($exceptionThrown, "validateSlug('$sku') should have thrown an exception");
63		}
64
65		/**
66		* Get a list of valid Slugs
67		*
68		* @return array
69		*/
70		public static function getValidSlugs()
71		{
72		return [
73		["abcdefghijklmnopqrstuvwxyz012345abcdefghijklmnopqrstuvwxyz012345"], // 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		["abc-dfg"],
85		["abc_dfg"],
86		["abc:dfg"],
87		["abc.dfg"],
88		["abc,dfg"],
89		["abc+dfg"],
90		["ABC_xyz"],
91		['Åre'], // Swedish umlaut
92		['Öresund'], // German umlaut
93		['наушник'], // Russian
94		['이어폰'], // Korean
95		];
96		}
97
98		/**
99		* Get a list of invalid Slugs
100		*
101		* @return array
102		*/
103		public static function getInvalidSlugs()
104		{
105		// 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...
106		return [
107		// empty
108		["", "empty"],
109
110		// white space
111		[" product", "white space"],
112		["product ", "white space"],
113		[" product ", "white space"],
114		["pro duct", "white space"],
115
116		// invalid characters
117		['7$tshirt', "invalid characters"], // Dollar sign
118		['product(1)', "invalid characters"],
119		['product§1', "invalid characters"],
120		['👃-spray', "invalid characters"], // nose emoji
121
122		// minimum length
123		["a", "too short"],
124		["1", "too short"],
125		["0", "too short"],
126
127		// maximum length
128		["abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqrstuvwxyz0123456789", "too long"],
129
130		];
131		}
132		}
133

wambo-co / module-catalog

Pull Request — develop (#1)

SlugTest::getInvalidSlugs() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like