CacheDataCollector::getCasters() - Code Metrics - Inspection of "Properly clone variables (#82)" - php-cache/cache-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8850ba...7bafab )

by Tobias

created 2017-08-07 12:03 UTC

CacheDataCollector::getCasters() B

↳ Parent: CacheDataCollector

Complexity

Conditions	6
Paths	1

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	16
rs	8.8571
cc	6
eloc	8
nc	1
nop	0

<?php

/*
 * This file is part of php-cache\cache-bundle package.
 *
 * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Cache\CacheBundle\DataCollector;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\DataCollector\DataCollector;
use Symfony\Component\VarDumper\Caster\CutStub;
use Symfony\Component\VarDumper\Cloner\Stub;
use Symfony\Component\VarDumper\Cloner\VarCloner;

/**
 * @author Aaron Scherer <[email protected]>
 * @author Tobias Nyholm <[email protected]>
 *
 * @internal
 */
class CacheDataCollector extends DataCollector
{
    /**
     * @type CacheProxyInterface[]
     */
    private $instances = [];

    /**
     * @type VarCloner
     */
    private $cloner = null;


    /**
     * @param string              $name
     * @param CacheProxyInterface $instance
     */
    public function addInstance($name, CacheProxyInterface $instance)
    {
        $this->instances[$name] = $instance;
    }

    /**
     * {@inheritdoc}
     */
    public function collect(Request $request, Response $response, \Exception $exception = null)
    {
        $empty      = ['calls' => [], 'config' => [], 'options' => [], 'statistics' => []];
        $this->data = ['instances' => $empty, 'total' => $empty];
        foreach ($this->instances as $name => $instance) {
            $calls = $instance->__getCalls();
            foreach ($calls as $call) {
                if (isset($call->result)) {
                    $call->result = $this->cloneData($call->result);
                }
                if (isset($call->argument)) {
                    $call->argument = $this->cloneData($call->argument);
                }
            }
            $this->data['instances']['calls'][$name] = $calls;
        }

        $this->data['instances']['statistics'] = $this->calculateStatistics();
        $this->data['total']['statistics']     = $this->calculateTotalStatistics();
    }

    /**
     * To be compatible with many versions of Symfony.
     *
     * @param $var
     */
    private function cloneData($var)
    {
        if (method_exists($this, 'cloneVar')) {
            // Symfony 3.2 or higher
            return $this->cloneVar($var);
        }

        if (null === $this->cloner) {
            $this->cloner = new VarCloner();
            $this->cloner->setMaxItems(-1);
            $this->cloner->addCasters($this->getCasters());
        }

        return $this->cloner->cloneVar($var);
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'php-cache';
    }

    /**
     * Method returns amount of logged Cache reads: "get" calls.
     *
     * @return array
     */
    public function getStatistics()
    {
        return $this->data['instances']['statistics'];
    }

    /**
     * Method returns the statistic totals.
     *
     * @return array
     */
    public function getTotals()
    {
        return $this->data['total']['statistics'];
    }

    /**
     * Method returns all logged Cache call objects.
     *
     * @return mixed
     */
    public function getCalls()
    {
        return $this->data['instances']['calls'];
    }

    /**
     * @return array
     */
    private function calculateStatistics()
    {
        $statistics = [];
        foreach ($this->data['instances']['calls'] as $name => $calls) {
            $statistics[$name] = [
                'calls'   => 0,
                'time'    => 0,
                'reads'   => 0,
                'writes'  => 0,
                'deletes' => 0,
                'hits'    => 0,
                'misses'  => 0,
            ];
            /** @type TraceableAdapterEvent $call */
            foreach ($calls as $call) {
                $statistics[$name]['calls'] += 1;
                $statistics[$name]['time'] += $call->end - $call->start;
                if ('getItem' === $call->name) {
                    $statistics[$name]['reads'] += 1;
                    if ($call->hits) {

                        $statistics[$name]['hits'] += 1;
                    } else {
                        $statistics[$name]['misses'] += 1;
                    }
                } elseif ('getItems' === $call->name) {
                    $count = $call->hits + $call->misses;
                    $statistics[$name]['reads'] += $count;
                    $statistics[$name]['hits'] += $call->hits;
                    $statistics[$name]['misses'] += $count - $call->misses;
                } elseif ('hasItem' === $call->name) {
                    $statistics[$name]['reads'] += 1;
                    if (false === $call->result) {

                        $statistics[$name]['misses'] += 1;
                    } else {
                        $statistics[$name]['hits'] += 1;
                    }
                } elseif ('save' === $call->name) {
                    $statistics[$name]['writes'] += 1;
                } elseif ('deleteItem' === $call->name) {
                    $statistics[$name]['deletes'] += 1;
                }
            }
            if ($statistics[$name]['reads']) {
                $statistics[$name]['hit_read_ratio'] = round(100 * $statistics[$name]['hits'] / $statistics[$name]['reads'], 2);
            } else {
                $statistics[$name]['hit_read_ratio'] = null;
            }
        }

        return $statistics;
    }

    /**
     * @return array
     */
    private function calculateTotalStatistics()
    {
        $statistics = $this->getStatistics();
        $totals     = [
            'calls'   => 0,
            'time'    => 0,
            'reads'   => 0,
            'writes'  => 0,
            'deletes' => 0,
            'hits'    => 0,
            'misses'  => 0,
        ];
        foreach ($statistics as $name => $values) {
            foreach ($totals as $key => $value) {
                $totals[$key] += $statistics[$name][$key];
            }
        }
        if ($totals['reads']) {
            $totals['hit_read_ratio'] = round(100 * $totals['hits'] / $totals['reads'], 2);
        } else {
            $totals['hit_read_ratio'] = null;
        }

        return $totals;
    }

    /**
     * @return callable[] The casters to add to the cloner
     */
    private function getCasters()
    {
        return [
            '*' => function ($v, array $a, Stub $s, $isNested) {

                if (!$v instanceof Stub) {
                    foreach ($a as $k => $v) {
                        if (is_object($v) && !$v instanceof \DateTimeInterface && !$v instanceof Stub) {
                            $a[$k] = new CutStub($v);
                        }
                    }
                }

                return $a;
            },
        ];
    }
}


1		<?php
2
3		/*
4		* This file is part of php-cache\cache-bundle package.
5		*
6		* (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Cache\CacheBundle\DataCollector;
13
14		use Symfony\Component\HttpFoundation\Request;
15		use Symfony\Component\HttpFoundation\Response;
16		use Symfony\Component\HttpKernel\DataCollector\DataCollector;
17		use Symfony\Component\VarDumper\Caster\CutStub;
18		use Symfony\Component\VarDumper\Cloner\Stub;
19		use Symfony\Component\VarDumper\Cloner\VarCloner;
20
21		/**
22		* @author Aaron Scherer <[email protected]>
23		* @author Tobias Nyholm <[email protected]>
24		*
25		* @internal
26		*/
27		class CacheDataCollector extends DataCollector
28		{
29		/**
30		* @type CacheProxyInterface[]
31		*/
32		private $instances = [];
33
34		/**
35		* @type VarCloner
36		*/
37		private $cloner = null;
		0 ignored issues – show Comprehensibility introduced 2017-08-07 12:25 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
38
39		/**
40		* @param string $name
41		* @param CacheProxyInterface $instance
42		*/
43		public function addInstance($name, CacheProxyInterface $instance)
44		{
45		$this->instances[$name] = $instance;
46		}
47
48		/**
49		* {@inheritdoc}
50		*/
51		public function collect(Request $request, Response $response, \Exception $exception = null)
52		{
53		$empty = ['calls' => [], 'config' => [], 'options' => [], 'statistics' => []];
54		$this->data = ['instances' => $empty, 'total' => $empty];
55		foreach ($this->instances as $name => $instance) {
56		$calls = $instance->__getCalls();
57		foreach ($calls as $call) {
58		if (isset($call->result)) {
59		$call->result = $this->cloneData($call->result);
60		}
61		if (isset($call->argument)) {
62		$call->argument = $this->cloneData($call->argument);
63		}
64		}
65		$this->data['instances']['calls'][$name] = $calls;
66		}
67
68		$this->data['instances']['statistics'] = $this->calculateStatistics();
69		$this->data['total']['statistics'] = $this->calculateTotalStatistics();
70		}
71
72		/**
73		* To be compatible with many versions of Symfony.
74		*
75		* @param $var
76		*/
77		private function cloneData($var)
78		{
79		if (method_exists($this, 'cloneVar')) {
80		// Symfony 3.2 or higher
81		return $this->cloneVar($var);
82		}
83
84		if (null === $this->cloner) {
85		$this->cloner = new VarCloner();
86		$this->cloner->setMaxItems(-1);
87		$this->cloner->addCasters($this->getCasters());
88		}
89
90		return $this->cloner->cloneVar($var);
91		}
92
93		/**
94		* {@inheritdoc}
95		*/
96		public function getName()
97		{
98		return 'php-cache';
99		}
100
101		/**
102		* Method returns amount of logged Cache reads: "get" calls.
103		*
104		* @return array
105		*/
106		public function getStatistics()
107		{
108		return $this->data['instances']['statistics'];
109		}
110
111		/**
112		* Method returns the statistic totals.
113		*
114		* @return array
115		*/
116		public function getTotals()
117		{
118		return $this->data['total']['statistics'];
119		}
120
121		/**
122		* Method returns all logged Cache call objects.
123		*
124		* @return mixed
125		*/
126		public function getCalls()
127		{
128		return $this->data['instances']['calls'];
129		}
130
131		/**
132		* @return array
133		*/
134		private function calculateStatistics()
135		{
136		$statistics = [];
137		foreach ($this->data['instances']['calls'] as $name => $calls) {
138		$statistics[$name] = [
139		'calls' => 0,
140		'time' => 0,
141		'reads' => 0,
142		'writes' => 0,
143		'deletes' => 0,
144		'hits' => 0,
145		'misses' => 0,
146		];
147		/** @type TraceableAdapterEvent $call */
148		foreach ($calls as $call) {
149		$statistics[$name]['calls'] += 1;
150		$statistics[$name]['time'] += $call->end - $call->start;
151		if ('getItem' === $call->name) {
152		$statistics[$name]['reads'] += 1;
153	View Code Duplication	if ($call->hits) {
		0 ignored issues – show Duplication introduced 2017-03-29 09:19 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...
154		$statistics[$name]['hits'] += 1;
155		} else {
156		$statistics[$name]['misses'] += 1;
157		}
158		} elseif ('getItems' === $call->name) {
159		$count = $call->hits + $call->misses;
160		$statistics[$name]['reads'] += $count;
161		$statistics[$name]['hits'] += $call->hits;
162		$statistics[$name]['misses'] += $count - $call->misses;
163		} elseif ('hasItem' === $call->name) {
164		$statistics[$name]['reads'] += 1;
165	View Code Duplication	if (false === $call->result) {
		0 ignored issues – show Duplication introduced 2017-03-29 09:19 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...
166		$statistics[$name]['misses'] += 1;
167		} else {
168		$statistics[$name]['hits'] += 1;
169		}
170		} elseif ('save' === $call->name) {
171		$statistics[$name]['writes'] += 1;
172		} elseif ('deleteItem' === $call->name) {
173		$statistics[$name]['deletes'] += 1;
174		}
175		}
176		if ($statistics[$name]['reads']) {
177		$statistics[$name]['hit_read_ratio'] = round(100 * $statistics[$name]['hits'] / $statistics[$name]['reads'], 2);
178		} else {
179		$statistics[$name]['hit_read_ratio'] = null;
180		}
181		}
182
183		return $statistics;
184		}
185
186		/**
187		* @return array
188		*/
189		private function calculateTotalStatistics()
190		{
191		$statistics = $this->getStatistics();
192		$totals = [
193		'calls' => 0,
194		'time' => 0,
195		'reads' => 0,
196		'writes' => 0,
197		'deletes' => 0,
198		'hits' => 0,
199		'misses' => 0,
200		];
201		foreach ($statistics as $name => $values) {
202		foreach ($totals as $key => $value) {
203		$totals[$key] += $statistics[$name][$key];
204		}
205		}
206		if ($totals['reads']) {
207		$totals['hit_read_ratio'] = round(100 * $totals['hits'] / $totals['reads'], 2);
208		} else {
209		$totals['hit_read_ratio'] = null;
210		}
211
212		return $totals;
213		}
214
215		/**
216		* @return callable[] The casters to add to the cloner
217		*/
218		private function getCasters()
219		{
220		return [
221		'*' => function ($v, array $a, Stub $s, $isNested) {
		0 ignored issues – show Unused Code introduced 2017-08-07 12:25 UTC by Report Bug Copy Issue Report The parameter `$s` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2017-08-07 12:25 UTC by Report Bug Copy Issue Report The parameter `$isNested` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
222		if (!$v instanceof Stub) {
223		foreach ($a as $k => $v) {
224		if (is_object($v) && !$v instanceof \DateTimeInterface && !$v instanceof Stub) {
225		$a[$k] = new CutStub($v);
226		}
227		}
228		}
229
230		return $a;
231		},
232		];
233		}
234		}
235

php-cache / cache-bundle

Push — master ( 8850ba...7bafab )

CacheDataCollector::getCasters() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like