PeekAndPoke\Component\Slumber\Core\LookUp\CachedEntityConfigLookUp

Complexity

Total Complexity

14

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	loadOrCreate()	0	15	3
A	getEntityConfig()	0	13	1
A	fetchFromCache()	0	12	4
A	saveToCache()	0	9	3
A	__construct()	0	6	1
A	isCacheFresh()	0	11	2

<?php
/**
 * File was created 06.10.2015 06:25
 */

namespace PeekAndPoke\Component\Slumber\Core\LookUp;

use Doctrine\Common\Cache\Cache;

/**
 * @author Karsten J. Gerber <kontakt@karsten-gerber.de>
 */
class CachedEntityConfigLookUp implements EntityConfigReader
{
    /** @var EntityConfigReader */
    private $delegate;
    /** @var Cache */
    private $cache;
    /** @var string */
    private $prefix;
    /** @var bool */
    private $debug;

    /**
     * We have another level of caching here
     *
     * @var array
     */
    private $known = [];

    /**
     * @param EntityConfigReader $delegate
     * @param Cache              $cache
     * @param string             $prefix
     * @param bool               $debug
     */
    public function __construct(EntityConfigReader $delegate, Cache $cache, $prefix = '[Slumber]@', $debug = false)
    {
        $this->delegate = $delegate;
        $this->cache    = $cache;
        $this->prefix   = $prefix;
        $this->debug    = $debug;
    }

    /**
     * @param \ReflectionClass $cls
     *
     * @return PropertyMarkedForSlumber[]
     */
    public function getEntityConfig(\ReflectionClass $cls)
    {
        $cacheKey = $this->prefix . $cls->name;

        return $this->loadOrCreate(

The expression return $this->loadOrCreate($cacheKey, function(...) { /* ... */ }, function(...) { /* ... */ }, $cls) also could return the type PeekAndPoke\Component\Slumber\Core\LookUp\EntityConfig which is incompatible with the documented return type PeekAndPoke\Component\Slumber\Core\LookUp\PropertyMarkedForSlumber[].

            $cacheKey,
            function () use ($cacheKey, $cls) {
                return $this->fetchFromCache($cacheKey, $cls);
            },
            function () use ($cls) {
                return $this->delegate->getEntityConfig($cls);
            },
            $cls
        );
    }

    /**
     * @param string           $cacheKey
     * @param \Closure         $fetcher
     * @param \Closure         $creator
     * @param \ReflectionClass $class
     *
     * @return mixed
     */
    private function loadOrCreate($cacheKey, \Closure $fetcher, \Closure $creator, \ReflectionClass $class)
    {
        if (isset($this->known[$cacheKey])) {
            return $this->known[$cacheKey];
        }

        /** @var EntityConfig $cacheData */
        $cacheData = $fetcher();

        if (false === $cacheData) {

The condition $cacheData is always false. If $cacheData can have other possible types, add them to src/Slumber/Core/LookUp/CachedEntityConfigLookUp.php:80

            $cacheData = $creator();
            $this->saveToCache($cacheKey, $cacheData, $class);
        }

        return $this->known[$cacheKey] = $cacheData;
    }

    /**
     * Fetches a value from the cache.
     *
     * @param string           $rawCacheKey The cache key.
     * @param \ReflectionClass $class       The related class.
     *
     * @return mixed The cached value or false when the value is not in cache.
     */
    private function fetchFromCache($rawCacheKey, \ReflectionClass $class)
    {
        $cacheKey = $this->prefix . $rawCacheKey;

        if (($data = $this->cache->fetch($cacheKey)) !== false) {
            /** @noinspection NestedPositiveIfStatementsInspection */
            if (! $this->debug || $this->isCacheFresh($cacheKey, $class)) {
                return $data;
            }
        }

        return false;
    }

    /**
     * Saves a value to the cache.
     *
     * @param string           $rawCacheKey The cache key.
     * @param mixed            $value       The value.
     * @param \ReflectionClass $class
     */
    private function saveToCache($rawCacheKey, $value, \ReflectionClass $class)
    {
        $cacheKey = $this->prefix . $rawCacheKey;
        $this->cache->save($cacheKey, $value);

        // in debug mode record the creation time of the entry
        if ($this->debug && false !== $filename = $class->getFileName()) {

            $this->cache->save('[C]' . $cacheKey, filemtime($filename));
        }
    }

    /**
     * Checks if the cache is fresh.
     *
     * @param string           $cacheKey
     * @param \ReflectionClass $class
     *
     * @return boolean
     */
    private function isCacheFresh($cacheKey, \ReflectionClass $class)
    {
        // built in classes have no filename
        if (false === $filename = $class->getFileName()) {
            return true;
        }

//        echo $cacheKey . " " . $this->cache->fetch('[C]'.$cacheKey) . " " . filemtime($filename) . " " . ($this->cache->fetch('[C]'.$cacheKey) >= filemtime($filename)) . "\n";

46% of this comment could be valid code. Did you maybe forget this after debugging?

        // When we have the creation time (debug mode) and it is less than the current file time, the cache is also not fresh
        return $this->cache->fetch('[C]' . $cacheKey) >= filemtime($filename);
    }
}