SKU::validateSKU() - Code Metrics - Inspection of "Add strutinizer for build status" - wambo-co/module-catalog - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — feature/base (2a2134)

by Andreas

created 2016-07-12 17:34 UTC

SKU::validateSKU() C

↳ Parent: SKU

Complexity

Conditions	9
Paths	9

Size

Total Lines	53
Code Lines	29

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	6.8963
cc	9
eloc	29
nc	9
nop	1

How to fix Long Method

<?php

namespace Wambo\Catalog\Model;

use Wambo\Catalog\Error\SKUException;

/**
 * Class SKU represents an unique identifier (stock keeping unit) for a product (e.g. "fancy-short-1")
 *
 * @package Wambo\Catalog\Model
 */
class SKU
{
    /**
     * @var string $whiteSpacePattern A regular expression that matches white-space characters
     */
    private $whiteSpacePattern = '/[\s]/';

    /**
     * @var string $invalidCharactersPattern A regular expression that matches all characters that are invalid for a SKU
     */
    private $invalidCharactersPattern = '/[^a-z0-9-]/';

    /**
     * @var string $uppercaseCharactersPattern A regular expression that matches uppercase characters
     */
    private $uppercaseCharactersPattern = '/[A-Z]/';

    /**
     * @var string $invalidPrefixCharacters A regular expression that matches characters that cannot be used as a prefix
     *      for SKUs
     */
    private $invalidPrefixCharacters = '/^[-]/';

    /**
     * @var string $invalidSuffixCharacters A regular expression that matches characters that cannot be used as a prefix
     *      for SKUs
     */
    private $invalidSuffixCharacters = '/[-]$/';

    /**
     * @var int $minLength Defines the minimum length for a SKU
     */
    private $minLength = 2;

    /**
     * @var int $maxLength Defines the maximum length of a SKU
     */
    private $maxLength = 32;
    /**
     * @var string
     */
    private $sku;

    /**
     * Create a new SKU instance
     *
     * @param string $sku A unique identifier for a product (e.g. "fancy-short-1")
     *
     * @throws SKUException If the given $sku is invalid
     */
    public function __construct(string $sku)
    {
        $this->validateSKU($sku);
        $this->sku = $sku;
    }

    /**
     * Get a string representation of the current SKU.
     * 
     * @return string
     */
    public function __toString()
    {
        return $this->sku;
    }

    /**
     * Validate the given SKU
     *
     * @param string $sku A unique identifier for a product (e.g. "fancy-short-1")
     *
     * @return void
     *
     * @throws SKUException If the given $sku is invalid
     */
    private function validateSKU(string $sku)
    {
        if (strlen($sku) == 0) {
            throw new SKUException("A SKU cannot be empty");
        }

        // check for white-space
        $containsWhitespace = preg_match($this->whiteSpacePattern, $sku) == 1;
        if ($containsWhitespace) {
            throw new SKUException(sprintf("A SKU cannot contain white space characters: \"%s\"", $sku));
        }

        // uppercase
        $containsUppercaseCharacters = preg_match($this->uppercaseCharactersPattern, $sku) == 1;
        if ($containsUppercaseCharacters) {
            throw new SKUException(sprintf("A SKU cannot contain uppercase characters: \"%s\"", $sku));
        }

        // check for invalid characters
        $containsInvalidCharacters = preg_match($this->invalidCharactersPattern, $sku) == 1;
        if ($containsInvalidCharacters) {
            throw new SKUException(sprintf("The SKU \"%s\" contains invalid characters. A SKU can only contain the following characters: a-z, 0-9 and -",
                $sku));
        }

        // check prefix
        $prefixMatches = [];
        $prefixContainsInvalidCharacters = preg_match($this->invalidPrefixCharacters, $sku, $prefixMatches) == 1;
        if ($prefixContainsInvalidCharacters) {
            throw new SKUException(sprintf("A SKU cannot start with the given characters: \"%s\"",
                implode("", $prefixMatches)));
        }

        // check suffix
        $suffixMatches = [];
        $suffixContainsInvalidCharacters = preg_match($this->invalidSuffixCharacters, $sku, $suffixMatches) == 1;
        if ($suffixContainsInvalidCharacters) {
            throw new SKUException(sprintf("A SKU cannot end with the given characters: \"%s\"",
                implode("", $suffixMatches)));
        }

        // check minimum length
        if (strlen($sku) < $this->minLength) {
            throw new SKUException(sprintf("The given SKU \"%s\" is too short. The minimum length for a SKU is: %s",
                $sku, $this->minLength));
        }

        // check maximum length
        if (strlen($sku) > $this->maxLength) {
            throw new SKUException(sprintf("The given SKU \"%s\" is too long (%s character). The maximum length for a SKU is: %s",
                strlen($sku), $sku, $this->maxLength));
        }
    }
}

1			<?php
2
3			namespace Wambo\Catalog\Model;
4
5			use Wambo\Catalog\Error\SKUException;
6
7			/**
8			* Class SKU represents an unique identifier (stock keeping unit) for a product (e.g. "fancy-short-1")
9			*
10			* @package Wambo\Catalog\Model
11			*/
12			class SKU
13			{
14			/**
15			* @var string $whiteSpacePattern A regular expression that matches white-space characters
16			*/
17			private $whiteSpacePattern = '/[\s]/';
18
19			/**
20			* @var string $invalidCharactersPattern A regular expression that matches all characters that are invalid for a SKU
21			*/
22			private $invalidCharactersPattern = '/[^a-z0-9-]/';
23
24			/**
25			* @var string $uppercaseCharactersPattern A regular expression that matches uppercase characters
26			*/
27			private $uppercaseCharactersPattern = '/[A-Z]/';
28
29			/**
30			* @var string $invalidPrefixCharacters A regular expression that matches characters that cannot be used as a prefix
31			* for SKUs
32			*/
33			private $invalidPrefixCharacters = '/^[-]/';
34
35			/**
36			* @var string $invalidSuffixCharacters A regular expression that matches characters that cannot be used as a prefix
37			* for SKUs
38			*/
39			private $invalidSuffixCharacters = '/[-]$/';
40
41			/**
42			* @var int $minLength Defines the minimum length for a SKU
43			*/
44			private $minLength = 2;
45
46			/**
47			* @var int $maxLength Defines the maximum length of a SKU
48			*/
49			private $maxLength = 32;
50			/**
51			* @var string
52			*/
53			private $sku;
54
55			/**
56			* Create a new SKU instance
57			*
58			* @param string $sku A unique identifier for a product (e.g. "fancy-short-1")
59			*
60			* @throws SKUException If the given $sku is invalid
61			*/
62			public function __construct(string $sku)
63			{
64			$this->validateSKU($sku);
65			$this->sku = $sku;
66			}
67
68			/**
69			* Get a string representation of the current SKU.
70			*
71			* @return string
72			*/
73			public function __toString()
74			{
75			return $this->sku;
76			}
77
78			/**
79			* Validate the given SKU
80			*
81			* @param string $sku A unique identifier for a product (e.g. "fancy-short-1")
82			*
83			* @return void
84			*
85			* @throws SKUException If the given $sku is invalid
86			*/
87			private function validateSKU(string $sku)
88			{
89			if (strlen($sku) == 0) {
90			throw new SKUException("A SKU cannot be empty");
91			}
92
93			// check for white-space
94			$containsWhitespace = preg_match($this->whiteSpacePattern, $sku) == 1;
95			if ($containsWhitespace) {
96			throw new SKUException(sprintf("A SKU cannot contain white space characters: \"%s\"", $sku));
97			}
98
99			// uppercase
100			$containsUppercaseCharacters = preg_match($this->uppercaseCharactersPattern, $sku) == 1;
101			if ($containsUppercaseCharacters) {
102			throw new SKUException(sprintf("A SKU cannot contain uppercase characters: \"%s\"", $sku));
103			}
104
105			// check for invalid characters
106			$containsInvalidCharacters = preg_match($this->invalidCharactersPattern, $sku) == 1;
107			if ($containsInvalidCharacters) {
108			throw new SKUException(sprintf("The SKU \"%s\" contains invalid characters. A SKU can only contain the following characters: a-z, 0-9 and -",
109			$sku));
110			}
111
112			// check prefix
113			$prefixMatches = [];
114			$prefixContainsInvalidCharacters = preg_match($this->invalidPrefixCharacters, $sku, $prefixMatches) == 1;
115			if ($prefixContainsInvalidCharacters) {
116			throw new SKUException(sprintf("A SKU cannot start with the given characters: \"%s\"",
117			implode("", $prefixMatches)));
118			}
119
120			// check suffix
121			$suffixMatches = [];
122			$suffixContainsInvalidCharacters = preg_match($this->invalidSuffixCharacters, $sku, $suffixMatches) == 1;
123			if ($suffixContainsInvalidCharacters) {
124			throw new SKUException(sprintf("A SKU cannot end with the given characters: \"%s\"",
125			implode("", $suffixMatches)));
126			}
127
128			// check minimum length
129			if (strlen($sku) < $this->minLength) {
130			throw new SKUException(sprintf("The given SKU \"%s\" is too short. The minimum length for a SKU is: %s",
131			$sku, $this->minLength));
132			}
133
134			// check maximum length
135			if (strlen($sku) > $this->maxLength) {
136			throw new SKUException(sprintf("The given SKU \"%s\" is too long (%s character). The maximum length for a SKU is: %s",
137			strlen($sku), $sku, $this->maxLength));
138			}
139			}
140			}

wambo-co / module-catalog

Branch — feature/base (2a2134)

SKU::validateSKU() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like