Chekote\NounStore\Store

Complexity

Total Complexity

14

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getAll()	0	3	2
A	keyValueContains()	0	5	2
A	keyExists()	0	3	1
A	get()	0	26	4
A	reset()	0	3	1
A	keyIsClass()	0	5	1
A	set()	0	3	1
A	__construct()	0	3	2

<?php namespace Chekote\NounStore;

use Illuminate\Support\Arr;
use InvalidArgumentException;

class Store
{
    protected Key $keyService;

    protected array $nouns;

    /**
     * @param Key|null $keyService the key service to use for parsing and building keys
     * @codeCoverageIgnore
     */
    public function __construct(Key $keyService = null)
    {
        $this->keyService = $keyService ?: Key::getInstance();
    }

    /**
     * Removes all entries from the store.
     *
     * @return void
     */
    public function reset(): void
    {
        $this->nouns = [];
    }

    /**
     * Retrieves a value for the specified key.
     *
     * Each key is actually a collection. If you do not specify which item in the collection you want,
     * the method will return the most recent entry. You can optionally specify the entry you want by
     * using the plain english 1st, 2nd, 3rd etc in the $key param. For example:
     *
     * Retrieve the most recent entry "Thing" collection:
     *   retrieve("Thing")
     *
     * Retrieve the 1st entry in the "Thing" collection:
     *   retrieve("1st Thing")
     *
     * Retrieve the 3rd entry in the "Thing" collection:
     *   retrieve("3rd Thing")
     *
     * @see    Key::build()
     * @see    Key::parseNoun()
     * @param  string                   $key The key to retrieve the value for. Supports nth notation.
     * @throws InvalidArgumentException if the key syntax is invalid.
     * @return mixed                    The value, or null if no value exists for the specified key/index combination.
     */
    public function get(string $key): mixed
    {
        $i = 0;

        return array_reduce(
            $this->keyService->parse($key),
            static function ($carry, $item) use (&$i) {
                list($noun, $index) = $item;

                $carry = data_get($carry, $noun);

                try {
                    // Was a specific index requested?
                    if ($index !== null) {
                        // Yes, fetch the specific index
                        return data_get($carry, $index);
                    } else {
                        // No, return the noun itself, or the latest noun if this is the
                        // first component of the key, and the noun is a collection
                        return $i === 0 && Arr::accessible($carry) ? end($carry) : $carry;

It seems like $carry can also be of type null; however, parameter $array of end() does only seem to accept array|object, maybe add an additional type check?

                    }
                } finally {
                    ++$i;
                }
            },
            $this->nouns
        );
    }

    /**
     * Retrieves all values for the specified key.
     *
     * @param  string $key The key to retrieve the values for. Does not support nth notation.
     * @return array  The values, or an empty array if no value exists for the specified key.
     */
    public function getAll(string $key): array
    {
        return isset($this->nouns[$key]) ? $this->nouns[$key] : [];
    }

    /**
     * Determines if a value has been stored for the specified key.
     *
     * @see    Key::build()
     * @see    Key::parseNoun()
     * @param  string                   $key The key to check. Supports nth notation.
     * @throws InvalidArgumentException if the key syntax is invalid.
     * @return bool                     True if the a value has been stored, false if not.
     */
    public function keyExists(string $key): bool
    {
        return $this->get($key) !== null;
    }

    /**
     * Asserts that the key's value contains the specified string.
     *
     * @see    Key::build()
     * @see    Key::parseNoun()
     * @param  string                   $key   The key to check.
     * @param  string                   $value The value expected to be contained within the key's value.
     * @throws InvalidArgumentException if the key syntax is invalid.
     * @return bool                     True if the key's value contains the specified string, false if not.
     */
    public function keyValueContains(string $key, string $value): bool
    {
        $actual = $this->get($key);

        return is_string($actual) && strpos($actual, $value) !== false;
    }

    /**
     * Stores a value for the specified key.
     *
     * The specified value is added to the top of the "stack" for the specified key.
     *
     * @param string $key   The key to store the value under. Does not support nth notation.
     * @param mixed  $value The value to store.
     */
    public function set(string $key, mixed $value): void
    {
        $this->nouns[$key][] = $value;
    }

    /**
     * Asserts that the key's value contains the specified class instance.
     *
     * @see    Key::build()
     * @see    Key::parseNoun()
     * @param  string                   $key   The key to check.
     * @param  class-string             $class The class instance expected to be contained within the key's value.

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     * @throws InvalidArgumentException if the key syntax is invalid.
     * @return bool                     True if the key's value contains the specified class instance, false if not.
     */
    public function keyIsClass(string $key, string $class): bool
    {
        $actual = $this->get($key);

        return $actual instanceof $class;
    }
}