Wambo\Catalog\Model\SKU

Complexity

Total Complexity

11

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	__toString()	0	4	1
C	validateSKU()	0	53	9

<?php

namespace Wambo\Catalog\Model;

use Wambo\Catalog\Exception\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));
        }
    }
}