CacheAdapter::containsKey() - Code Metrics - Inspection of "Release 1.0" - kleijnweb/rest-e-tag-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by John

created 2016-02-21 12:54 UTC

CacheAdapter::containsKey() A

↳ Parent: CacheAdapter

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/*
 * This file is part of the KleijnWeb\RestETagBundle package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace KleijnWeb\RestETagBundle\Cache;

use Doctrine\Common\Cache\Cache;
use Symfony\Component\HttpFoundation\Request;

/**
 * @author John Kleijn <[email protected]>
 */
class CacheAdapter
{
    const KEY_VERSION = 1;
    const KEY_CHILDREN = 2;

    /**
     * @var Cache
     */
    private $cache;

    /**
     * @var string
     */
    private $childInvalidationConstraint;

    /**
     * @param Cache  $cache
     * @param string $childInvalidationConstraint
     */
    public function __construct(Cache $cache, $childInvalidationConstraint = '')
    {
        $this->cache = $cache;
        $this->childInvalidationConstraint = $childInvalidationConstraint;
    }

    /**
     * @param string $childInvalidationConstraint
     *
     * @return $this
     */
    public function setChildInvalidationConstraint($childInvalidationConstraint)
    {
        $this->childInvalidationConstraint = $childInvalidationConstraint;

        return $this;
    }

    /**
     * @param Request $request
     *
     * @return string
     */
    public function fetch(Request $request)
    {
        if (!$record = $this->cache->fetch($this->createKey($request))) {
            return '';
        }

        return $record[self::KEY_VERSION];
    }

    /**
     * @param Request $request
     *
     * @return bool
     */
    public function contains(Request $request)
    {
        return $this->containsKey($this->createKey($request));
    }

    /**
     * @param string $key
     *
     * @return bool
     */
    public function containsKey($key)
    {
        return $this->cache->contains($key);
    }

    /**
     * @param Request $request
     * @param string  $version
     *
     * @return mixed
     */
    public function update(Request $request, $version)
    {
        $segments = $this->getSegments($request);
        $paths = [];
        $path = '';
        foreach ($segments as $segment) {
            $path .= "/$segment";
            $paths[] = $path;
        }

        foreach ($paths as $i => $path) {
            $record = $this->cache->fetch($path);
            if ($record) {
                $this->invalidateChildren($record[self::KEY_CHILDREN], $version);
            } else {
                $record = [self::KEY_CHILDREN => []];
            }
            $record[self::KEY_VERSION] = $version;
            if (isset($paths[$i + 1])) {

                $record[self::KEY_CHILDREN][] = $paths[$i + 1];
            }
            $this->cache->save($path, $record);
        }

        return $version;
    }

    /**
     * @param Request $request
     * @param string  $version
     *
     * @return mixed
     */
    public function register(Request $request, $version)
    {
        $segments = $this->getSegments($request);
        $paths = [];
        $path = '';
        foreach ($segments as $segment) {
            $path .= "/$segment";
            $paths[] = $path;
        }

        foreach ($paths as $i => $path) {
            $record = $this->cache->fetch($path);
            if (!$record) {
                $record = [self::KEY_VERSION => $version, self::KEY_CHILDREN => []];
            }
            if (isset($paths[$i + 1])) {

                $record[self::KEY_CHILDREN][] = $paths[$i + 1];
            }
            $this->cache->save($path, $record);
        }
        $record = [self::KEY_VERSION => $version, self::KEY_CHILDREN => []];
        $this->cache->save($this->createKeyFromSegments($segments), $record);

        return $version;
    }

    private function invalidateChildren(array $children, $version)
    {
        foreach ($children as $child) {
            if ($this->childInvalidationConstraint !== ''
                && preg_match("/$this->childInvalidationConstraint/", $child)
            ) {
                // Stop recursive invalidation if it matches
                return;
            }
            $record = $this->cache->fetch($child);
            $record[self::KEY_VERSION] = $version;
            $this->cache->save($child, $record);
            if ($record) {
                $this->invalidateChildren($record[self::KEY_CHILDREN], $version);
            }
        }
    }

    /**
     * @param Request $request
     *
     * @return array
     */
    private function getSegments(Request $request)
    {
        $key = $request->getPathInfo();
        $segments = explode('/', ltrim($key, '/'));
        if ($query = $request->getQueryString()) {
            $segments[] = '?' . $query;
        }

        array_walk($segments, function (&$value) {
            $value = preg_replace('/[^[:print:]]/', '_', $value);
        });

        return array_filter($segments, function ($value) {
            return $value !== '';
        });
    }

    /**
     * @param Request $request
     *
     * @return string
     */
    private function createKey(Request $request)
    {
        return $this->createKeyFromSegments($this->getSegments($request));
    }

    /**
     * @param array $segments
     *
     * @return string
     */
    private function createKeyFromSegments(array $segments)
    {
        return '/' . implode('/', $segments);
    }
}


1		<?php
2		/*
3		* This file is part of the KleijnWeb\RestETagBundle package.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*/
8
9		namespace KleijnWeb\RestETagBundle\Cache;
10
11		use Doctrine\Common\Cache\Cache;
12		use Symfony\Component\HttpFoundation\Request;
13
14		/**
15		* @author John Kleijn <[email protected]>
16		*/
17		class CacheAdapter
18		{
19		const KEY_VERSION = 1;
20		const KEY_CHILDREN = 2;
21
22		/**
23		* @var Cache
24		*/
25		private $cache;
26
27		/**
28		* @var string
29		*/
30		private $childInvalidationConstraint;
31
32		/**
33		* @param Cache $cache
34		* @param string $childInvalidationConstraint
35		*/
36		public function __construct(Cache $cache, $childInvalidationConstraint = '')
37		{
38		$this->cache = $cache;
39		$this->childInvalidationConstraint = $childInvalidationConstraint;
40		}
41
42		/**
43		* @param string $childInvalidationConstraint
44		*
45		* @return $this
46		*/
47		public function setChildInvalidationConstraint($childInvalidationConstraint)
48		{
49		$this->childInvalidationConstraint = $childInvalidationConstraint;
50
51		return $this;
52		}
53
54		/**
55		* @param Request $request
56		*
57		* @return string
58		*/
59		public function fetch(Request $request)
60		{
61		if (!$record = $this->cache->fetch($this->createKey($request))) {
62		return '';
63		}
64
65		return $record[self::KEY_VERSION];
66		}
67
68		/**
69		* @param Request $request
70		*
71		* @return bool
72		*/
73		public function contains(Request $request)
74		{
75		return $this->containsKey($this->createKey($request));
76		}
77
78		/**
79		* @param string $key
80		*
81		* @return bool
82		*/
83		public function containsKey($key)
84		{
85		return $this->cache->contains($key);
86		}
87
88		/**
89		* @param Request $request
90		* @param string $version
91		*
92		* @return mixed
93		*/
94		public function update(Request $request, $version)
95		{
96		$segments = $this->getSegments($request);
97		$paths = [];
98		$path = '';
99		foreach ($segments as $segment) {
100		$path .= "/$segment";
101		$paths[] = $path;
102		}
103
104		foreach ($paths as $i => $path) {
105		$record = $this->cache->fetch($path);
106		if ($record) {
107		$this->invalidateChildren($record[self::KEY_CHILDREN], $version);
108		} else {
109		$record = [self::KEY_CHILDREN => []];
110		}
111		$record[self::KEY_VERSION] = $version;
112	View Code Duplication	if (isset($paths[$i + 1])) {
		0 ignored issues – show Duplication introduced 2016-02-21 12:28 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
113		$record[self::KEY_CHILDREN][] = $paths[$i + 1];
114		}
115		$this->cache->save($path, $record);
116		}
117
118		return $version;
119		}
120
121		/**
122		* @param Request $request
123		* @param string $version
124		*
125		* @return mixed
126		*/
127		public function register(Request $request, $version)
128		{
129		$segments = $this->getSegments($request);
130		$paths = [];
131		$path = '';
132		foreach ($segments as $segment) {
133		$path .= "/$segment";
134		$paths[] = $path;
135		}
136
137		foreach ($paths as $i => $path) {
138		$record = $this->cache->fetch($path);
139		if (!$record) {
140		$record = [self::KEY_VERSION => $version, self::KEY_CHILDREN => []];
141		}
142	View Code Duplication	if (isset($paths[$i + 1])) {
		0 ignored issues – show Duplication introduced 2016-02-21 12:28 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
143		$record[self::KEY_CHILDREN][] = $paths[$i + 1];
144		}
145		$this->cache->save($path, $record);
146		}
147		$record = [self::KEY_VERSION => $version, self::KEY_CHILDREN => []];
148		$this->cache->save($this->createKeyFromSegments($segments), $record);
149
150		return $version;
151		}
152
153		private function invalidateChildren(array $children, $version)
154		{
155		foreach ($children as $child) {
156		if ($this->childInvalidationConstraint !== ''
157		&& preg_match("/$this->childInvalidationConstraint/", $child)
158		) {
159		// Stop recursive invalidation if it matches
160		return;
161		}
162		$record = $this->cache->fetch($child);
163		$record[self::KEY_VERSION] = $version;
164		$this->cache->save($child, $record);
165		if ($record) {
166		$this->invalidateChildren($record[self::KEY_CHILDREN], $version);
167		}
168		}
169		}
170
171		/**
172		* @param Request $request
173		*
174		* @return array
175		*/
176		private function getSegments(Request $request)
177		{
178		$key = $request->getPathInfo();
179		$segments = explode('/', ltrim($key, '/'));
180		if ($query = $request->getQueryString()) {
181		$segments[] = '?' . $query;
182		}
183
184		array_walk($segments, function (&$value) {
185		$value = preg_replace('/[^[:print:]]/', '_', $value);
186		});
187
188		return array_filter($segments, function ($value) {
189		return $value !== '';
190		});
191		}
192
193		/**
194		* @param Request $request
195		*
196		* @return string
197		*/
198		private function createKey(Request $request)
199		{
200		return $this->createKeyFromSegments($this->getSegments($request));
201		}
202
203		/**
204		* @param array $segments
205		*
206		* @return string
207		*/
208		private function createKeyFromSegments(array $segments)
209		{
210		return '/' . implode('/', $segments);
211		}
212		}
213

kleijnweb / rest-e-tag-bundle

Pull Request — master (#2)

CacheAdapter::containsKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like