Key::splitPossessions() - Code Metrics - Inspection of "Implement Key::splitPossessions()" - Chekote/noun-store - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — complex_graph ( acfdbf...ffa5e4 )

by Donald

created 2020-02-27 22:00 UTC

Key::splitPossessions() A

↳ Parent: Key

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	2
nc	2
nop	1

<?php namespace Chekote\NounStore;

use InvalidArgumentException;

class Key
{
    use Singleton;

    const ORDINAL_ST = 'st';
    const ORDINAL_ND = 'nd';
    const ORDINAL_RD = 'rd';
    const ORDINAL_TH = 'th';

    protected static $ordinals = [
        0 => self::ORDINAL_TH,
        1 => self::ORDINAL_ST,
        2 => self::ORDINAL_ND,
        3 => self::ORDINAL_RD,
        4 => self::ORDINAL_TH,
        5 => self::ORDINAL_TH,
        6 => self::ORDINAL_TH,
        7 => self::ORDINAL_TH,
        8 => self::ORDINAL_TH,
        9 => self::ORDINAL_TH,
    ];

    /**
     * Builds a key from it's separate key and index values.
     *
     * @example buildKey("Item", null): "Item"
     * @example buildKey("Item", 0): "1st Item"
     * @example buildKey("Item", 1): "2nd Item"
     * @example buildKey("Item", 2): "3rd Item"
     *
     * @param  string                   $key   The key to check.
     * @param  int|null                 $index The index (zero indexed) value for the key. If not specified, the method
     *                                         will not add an index notation to the key.
     * @throws InvalidArgumentException if $index is less than -1. Note: It should really be zero or higher, but this
     *                                        method does not assert that. The error is bubbling up from getOrdinal()
     * @return string                   the key with the index, or just the key if index is null.
     */
    public function build($key, $index)
    {
        if ($index === null) {
            return $key;
        }

        $nth = $index + 1;

        return $nth . $this->getOrdinal($nth) . ' ' . $key;
    }

    /**
     * Provides the ordinal notation for the specified nth number.
     *
     * @param  int                      $nth the number to determine the ordinal for
     * @throws InvalidArgumentException if $nth is not a positive number.
     * @return string                   the ordinal
     */
    public function getOrdinal($nth)
    {
        if ($nth < 0) {
            throw new InvalidArgumentException('$nth must be a positive number');
        }

        return $nth > 9 && $nth < 20 ? self::ORDINAL_TH : self::$ordinals[substr($nth, -1)];
    }

    /**
     * Parses a key into dot-notation.
     *
     * @example parseKey("Item"): "Item"
     * @example parseKey("1st Item"): "Item.0"
     * @example parseKey("2nd Item"): "Item.1"
     * @example parseKey("3rd Item"): "Item.2"
     *
     * @param  string                   $key the key to parse.
     * @throws InvalidArgumentException if the key syntax is invalid.
     * @return string                   the dot-notation string.
     */
    public function parse($key)
    {
        if (!preg_match("/^(([1-9][0-9]*)(?:st|nd|rd|th) )?([^']+)$/", $key, $matches)) {
            throw new InvalidArgumentException('Key syntax is invalid');
        }

        // @todo use null coalescing operator when upgrading to PHP 7
        $index = isset($matches[2]) && $matches[2] !== '' ? $matches[2] - 1 : null;
        $key = $matches[3];

        return $index !== null ? "$key.$index" : $key;
    }

    /**
     * Splits a possessive key into its separate nouns.
     *
     * @example splitPossessions("Customer's Car"): ['Customer', 'Car']
     * @example splitPossessions("8th Customer's Car"): ['8th Customer', 'Car']
     * @example splitPossessions("Customer's 2nd Car"): ['Customer', '2nd Car']
     * @example splitPossessions("7th Customer's 4th Car"): ['7th Customer', '4th Car']
     * @example splitPossessions("7th Customer's 4th Car's 2nd Wheel"): ['7th Customer', '4th Car', '2nd Wheel']
     *
     * @param  string   $key the possessive key to parse
     * @return string[] an array of nouns
     */
    protected function splitPossessions($key)
    {
        return ($nouns = preg_split('/' . self::POSSESSION . '/', $key)) ? $nouns : [];

    }
}


1			<?php namespace Chekote\NounStore;
2
3			use InvalidArgumentException;
4
5			class Key
6			{
7			use Singleton;
8
9			const ORDINAL_ST = 'st';
10			const ORDINAL_ND = 'nd';
11			const ORDINAL_RD = 'rd';
12			const ORDINAL_TH = 'th';
13
14			protected static $ordinals = [
15			0 => self::ORDINAL_TH,
16			1 => self::ORDINAL_ST,
17			2 => self::ORDINAL_ND,
18			3 => self::ORDINAL_RD,
19			4 => self::ORDINAL_TH,
20			5 => self::ORDINAL_TH,
21			6 => self::ORDINAL_TH,
22			7 => self::ORDINAL_TH,
23			8 => self::ORDINAL_TH,
24			9 => self::ORDINAL_TH,
25			];
26
27			/**
28			* Builds a key from it's separate key and index values.
29			*
30			* @example buildKey("Item", null): "Item"
31			* @example buildKey("Item", 0): "1st Item"
32			* @example buildKey("Item", 1): "2nd Item"
33			* @example buildKey("Item", 2): "3rd Item"
34			*
35			* @param string $key The key to check.
36			* @param int\|null $index The index (zero indexed) value for the key. If not specified, the method
37			* will not add an index notation to the key.
38			* @throws InvalidArgumentException if $index is less than -1. Note: It should really be zero or higher, but this
39			* method does not assert that. The error is bubbling up from getOrdinal()
40			* @return string the key with the index, or just the key if index is null.
41			*/
42			public function build($key, $index)
43			{
44			if ($index === null) {
45			return $key;
46			}
47
48			$nth = $index + 1;
49
50			return $nth . $this->getOrdinal($nth) . ' ' . $key;
51			}
52
53			/**
54			* Provides the ordinal notation for the specified nth number.
55			*
56			* @param int $nth the number to determine the ordinal for
57			* @throws InvalidArgumentException if $nth is not a positive number.
58			* @return string the ordinal
59			*/
60			public function getOrdinal($nth)
61			{
62			if ($nth < 0) {
63			throw new InvalidArgumentException('$nth must be a positive number');
64			}
65
66			return $nth > 9 && $nth < 20 ? self::ORDINAL_TH : self::$ordinals[substr($nth, -1)];
67			}
68
69			/**
70			* Parses a key into dot-notation.
71			*
72			* @example parseKey("Item"): "Item"
73			* @example parseKey("1st Item"): "Item.0"
74			* @example parseKey("2nd Item"): "Item.1"
75			* @example parseKey("3rd Item"): "Item.2"
76			*
77			* @param string $key the key to parse.
78			* @throws InvalidArgumentException if the key syntax is invalid.
79			* @return string the dot-notation string.
80			*/
81			public function parse($key)
82			{
83			if (!preg_match("/^(([1-9][0-9]*)(?:st\|nd\|rd\|th) )?([^']+)$/", $key, $matches)) {
84			throw new InvalidArgumentException('Key syntax is invalid');
85			}
86
87			// @todo use null coalescing operator when upgrading to PHP 7
88			$index = isset($matches[2]) && $matches[2] !== '' ? $matches[2] - 1 : null;
89			$key = $matches[3];
90
91			return $index !== null ? "$key.$index" : $key;
92			}
93
94			/**
95			* Splits a possessive key into its separate nouns.
96			*
97			* @example splitPossessions("Customer's Car"): ['Customer', 'Car']
98			* @example splitPossessions("8th Customer's Car"): ['8th Customer', 'Car']
99			* @example splitPossessions("Customer's 2nd Car"): ['Customer', '2nd Car']
100			* @example splitPossessions("7th Customer's 4th Car"): ['7th Customer', '4th Car']
101			* @example splitPossessions("7th Customer's 4th Car's 2nd Wheel"): ['7th Customer', '4th Car', '2nd Wheel']
102			*
103			* @param string $key the possessive key to parse
104			* @return string[] an array of nouns
105			*/
106			protected function splitPossessions($key)
107			{
108			return ($nouns = preg_split('/' . self::POSSESSION . '/', $key)) ? $nouns : [];
			0 ignored issues – show Bug introduced 2020-02-27 22:01 UTC by Report Bug Copy Issue Report The constant `Chekote\NounStore\Key::POSSESSION` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history... Bug Best Practice introduced 2020-02-18 19:46 UTC by Report Bug Copy Issue Report The expression `return $nouns = preg_spl...key) ? $nouns : array()` returns an array which contains values of type `array` which are incompatible with the documented value type `string`. Loading history...
109			}
110			}
111

Chekote / noun-store

Push — complex_graph ( acfdbf...ffa5e4 )

Key::splitPossessions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like