Chekote\NounStore\Assert

Complexity

Total Complexity

7

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	keyExists()	0	11	2
A	keyValueIs()	0	9	2
A	keyValueContains()	0	9	2

<?php namespace Chekote\NounStore;

use InvalidArgumentException;
use OutOfBoundsException;
use RuntimeException;

/**
 * Makes assertions regarding store data.
 */
class Assert
{
    /** @var Store */
    protected $store;

    /** @var Key */
    protected $keyService;

    /**
     * Assert constructor.
     *
     * @param Store $store      the store to assert against.
     * @param Key   $keyService the keyService to use for key parsing/building.
     *
     * @codeCoverageIgnore
     */
    public function __construct(Store $store, Key $keyService)
    {
        $this->store = $store;
        $this->keyService = $keyService;
    }

    /**
     * Asserts that a value has been stored for the specified key.
     *
     * @param  string                   $key   The key to check. @see self::get() for formatting options.
     * @param  int                      $index [optional] The index of the key entry to check. If not specified, the
     *                                         method will ensure that at least one item is stored for the key.
     * @throws OutOfBoundsException     if a value has not been stored for the specified key.
     * @throws InvalidArgumentException if both an $index and $key are provided, but the $key contains an nth value
     *                                        that does not match the index.
     * @return mixed                    The value.
     */
    public function keyExists($key, $index = null)
    {
        list($key, $index) = $this->keyService->parse($key, $index);

        if (!$this->store->keyExists($key, $index)) {
            throw new OutOfBoundsException(
                "Entry '" . $this->keyService->build($key, $index) . "' was not found in the store."
            );
        }

        return $this->store->get($key, $index);
    }

    /**
     * Asserts that the key's value contains the specified string.
     *
     * @param  string                   $key   The key to check. @see self::get() for formatting options.
     * @param  string                   $value The value expected to be contained within the key's value.
     * @param  int                      $index [optional] The index of the key entry to retrieve. If not specified, the
     *                                         method will check the most recent value stored under the key.
     * @throws OutOfBoundsException     If a value has not been stored for the specified key.
     * @throws InvalidArgumentException if both an $index and $key are provided, but the $key contains an nth value
     *                                        that does not match the index.
     */
    public function keyValueContains($key, $value, $index = null)
    {
        list($key, $index) = $this->keyService->parse($key, $index);

        $this->keyExists($key, $index);

        if (!$this->store->keyValueContains($key, $value, $index)) {
            throw new RuntimeException(
                "Entry '" . $this->keyService->build($key, $index) . "' does not contain '$value'"
            );
        }
    }

    /**
     * Asserts that the key's value matches the specified value.
     *
     * @param  string                   $key   The key to check. @see self::get() for formatting options.
     * @param  mixed                    $value The expected value.
     * @param  int                      $index [optional] The index of the key entry to retrieve. If not specified, the
     *                                         method will check the most recent value stored under the key.
     * @throws OutOfBoundsException     If a value has not been stored for the specified key.
     * @throws InvalidArgumentException if both an $index and $key are provided, but the $key contains an nth value
     *                                        that does not match the index.
     */
    public function keyValueIs($key, $value, $index = null)
    {
        list($key, $index) = $this->keyService->parse($key, $index);

        $this->keyExists($key, $index);

        if ($this->store->get($key, $index) != $value) {
            throw new RuntimeException(
                "Entry '" . $this->keyService->build($key, $index) . "' does not match '" . print_r($value, true) . "'"
            );
        }
    }
}