Cmp\Cache\Application\TestCacheDecorator

Complexity

Total Complexity

20

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	hasBeenDeleted()	0	4	1
A	hasBeenRetrieved()	0	4	1
A	hasBeenChecked()	0	4	1
A	hasBeenSet()	0	10	3
A	getCalls()	0	4	1
A	delete()	0	6	1
A	set()	0	10	1
A	has()	0	6	1
A	get()	0	6	1
A	hasBeenDoneByKey()	0	10	3
A	callMatches()	0	12	4
A	matches()	0	4	2

<?php

namespace Cmp\Cache\Application;

/**
 * Class TestCacheDecorator
 *
 * A backend especially designed for testing
 *
 * @package Cmp\Cache\Infrastureture
 */
class TestCacheDecorator extends CacheDecorator
{
    /**
     * Calls made to the cache
     *
     * @var array
     */
    private $calls = [
        'delete' => [],
        'set'    => [],
        'has'    => [],
        'get'    => [],
    ];

    /**
     * Checks if an item has been deleted
     *
     * @param string $key
     *
     * @return bool
     */
    public function hasBeenDeleted($key)
    {
        return $this->hasBeenDoneByKey($this->calls['delete'], $key);
    }

    /**
     * Checks if an item has been requested with 'get' or 'pull'
     *
     * @param string $key
     *
     * @return bool
     */
    public function hasBeenRetrieved($key)
    {
        return $this->hasBeenDoneByKey($this->calls['get'], $key);
    }

    /**
     * Checks if an item has been checked with the 'has' method
     *
     * @param string $key
     *
     * @return bool
     */
    public function hasBeenChecked($key)
    {
        return $this->hasBeenDoneByKey($this->calls['has'], $key);
    }

    /**
     * Checks if an item has been set
     *
     * @param string   $key
     * @param mixed    $value
     * @param int|null $timeToLive
     *
     * @return bool
     */
    public function hasBeenSet($key, $value = null, $timeToLive = null)
    {
        foreach ($this->calls['set'] as $set) {
            if ($this->callMatches($set, $key, $value, $timeToLive)) {
                return true;
            }
        }

        return false;
    }

    /**
     * @return array
     */
    public function getCalls()
    {
        return $this->calls;
    }

    /**
     * {@inheritdoc}
     */
    public function delete($key)
    {
        $this->calls['delete'][] = $key;

        parent::delete($key);
    }

    /**
     * {@inheritdoc}
     */
    public function set($key, $value, $timeToLive = 0)
    {
        $this->calls['set'][] = [
            'key'        => $key,
            'value'      => $value,
            'timeToLive' => $timeToLive,
        ];

        parent::set($key, $value, $timeToLive);
    }

    /**
     * {@inheritdoc}
     */
    public function has($key)
    {
        $this->calls['has'][] = $key;

        return parent::has($key);
    }

    /**
     * {@inheritdoc}
     */
    public function get($key)
    {
        $this->calls['get'][] = $key;

        return parent::get($key);
    }

    /**
     * Tries to match a call by the key
     *
     * @param array  $calls
     * @param string $key
     *
     * @return bool
     */
    private function hasBeenDoneByKey(array $calls, $key)
    {
        foreach ($calls as $keyOnCall) {
            if ($keyOnCall == $key) {
                return true;
            }
        }

        return false;
    }

    /**
     * @param array    $set
     * @param string   $key
     * @param mixed    $value
     * @param null|int $timeToLive
     *
     * @return bool
     */
    private function callMatches(array $set, $key, $value = null, $timeToLive)
    {
        if (
            $set['key'] != $key || 
            !$this->matches($set['value'], $value) || 
            !$this->matches($set['timeToLive'] !== $timeToLive)
        ) {
            return false;
        }

        return true;
    }

    /**
     * @param mixed $stored
     * @param null  $expected
     *
     * @return bool
     */
    private function matches($stored, $expected = null)
    {
        return $expected === null || $stored == $expected;
    }
}