ObjectMap::fetchBucketValue() - Code Metrics - Inspection of "Fix fetching value from weak map" - pinepain/php-object-maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( af4a9f...0754ab )

by Bogdan

created 2017-10-08 20:43 UTC

ObjectMap::fetchBucketValue() A

↳ Parent: ObjectMap

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	5
cts	5
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	1
crap	2

<?php declare(strict_types=1);


/*
 * This file is part of the pinepain/php-object-maps PHP library.
 *
 * Copyright (c) 2016-2017 Bogdan Padalko <[email protected]>
 *
 * Licensed under the MIT license: http://opensource.org/licenses/MIT
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code or visit http://opensource.org/licenses/MIT
 */


namespace Pinepain\ObjectMaps;


use Pinepain\ObjectMaps\Exceptions\OutOfBoundsException;
use Pinepain\ObjectMaps\Exceptions\OverflowException;
use Ref\WeakReference;
use function spl_object_hash;


class ObjectMap implements ObjectMapInterface
{
    use ObjectTypeHintTrait;

    protected $behavior = self::DEFAULT;

    /**
     * @var Bucket[]
     */
    protected $keys = [];

    /**
     * @param int $behavior
     */
    public function __construct(int $behavior = self::DEFAULT)

    {
        $this->behavior = $behavior;
    }

    /**
     * {@inheritdoc}
     */
    public function put($key, $value)
    {
        $this->assertObject($key, 'Key');
        $this->assertObject($value, 'Value'); // while we may associate non-object value, for interface compatibility we don't do that

        $hash = $this->getHash($key);

        if (isset($this->keys[$hash])) {
            throw new OverflowException('Value with such key already exists');
        }

        $bucket = $this->createBucket($key, $value, $hash);

        $this->keys[$hash] = $bucket;
    }

    /**
     * {@inheritdoc}
     */
    public function get($key)

    {
        $this->assertObject($key, 'Key');

        $hash = $this->getHash($key);

        if (!isset($this->keys[$hash])) {
            throw new OutOfBoundsException('Value with such key not found');
        }

        $bucket = $this->keys[$hash];

        return $this->fetchBucketValue($bucket);
    }

    /**
     * {@inheritdoc}
     */
    public function has($key): bool
    {
        $this->assertObject($key, 'Key');

        $hash = $this->getHash($key);

        return isset($this->keys[$hash]);
    }

    /**
     * {@inheritdoc}
     */
    public function remove($key)

    {
        $this->assertObject($key, 'Key');

        $hash = $this->getHash($key);

        if (!isset($this->keys[$hash])) {
            throw new OutOfBoundsException('Value with such key not found');
        }

        $bucket = $this->keys[$hash];

        $this->doRemove($hash);

        return $this->fetchBucketValue($bucket);
    }

    /**
     * {@inheritdoc}
     */
    public function count()
    {
        return count($this->keys);
    }

    /**
     * {@inheritdoc}
     */
    public function clear()
    {
        $this->keys = [];
    }

    /**
     * @param object $value
     *
     * @return string
     */
    protected function getHash($value)
    {
        return spl_object_hash($value);
    }

    /**
     * @param string $hash
     *
     * @return void
     */
    protected function doRemove(string $hash)
    {
        unset($this->keys[$hash]);
    }

    /**
     * @param object $key
     * @param object $value
     * @param string $hash
     *
     * @return Bucket
     */
    protected function createBucket($key, $value, string $hash): Bucket
    {
        if ($this->behavior & self::WEAK_KEY) {
            $key = $this->createReference($key, $hash);
        }

        if ($this->behavior & self::WEAK_VALUE) {
            $value = $this->createReference($value, $hash);
        }

        return new Bucket($key, $value);
    }

    /**
     * @param Bucket $bucket
     *
     * @return null|object
     */
    protected function fetchBucketValue(Bucket $bucket)
    {
        if ($this->behavior & self::WEAK_VALUE) {
            assert($bucket->value instanceof WeakReference);

            return $bucket->value->get();
        }

        return $bucket->value;
    }

    /**
     * @param        $obj
     * @param string $hash
     *
     * @return WeakReference
     */
    protected function createReference($obj, string $hash): WeakReference
    {
        return new WeakReference($obj, function () use ($hash) {
            $this->doRemove($hash);
        });
    }
}


1			<?php declare(strict_types=1);
			0 ignored issues – show Coding Style Compatibility introduced 2017-08-26 22:21 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 24 and the first side effect is on line 196. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			/*
4			* This file is part of the pinepain/php-object-maps PHP library.
5			*
6			* Copyright (c) 2016-2017 Bogdan Padalko <[email protected]>
7			*
8			* Licensed under the MIT license: http://opensource.org/licenses/MIT
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code or visit http://opensource.org/licenses/MIT
12			*/
13
14
15			namespace Pinepain\ObjectMaps;
16
17
18			use Pinepain\ObjectMaps\Exceptions\OutOfBoundsException;
19			use Pinepain\ObjectMaps\Exceptions\OverflowException;
20			use Ref\WeakReference;
21			use function spl_object_hash;
22
23
24			class ObjectMap implements ObjectMapInterface
25			{
26			use ObjectTypeHintTrait;
27
28			protected $behavior = self::DEFAULT;
29
30			/**
31			* @var Bucket[]
32			*/
33			protected $keys = [];
34
35			/**
36			* @param int $behavior
37			*/
38	42		public function __construct(int $behavior = self::DEFAULT)
			0 ignored issues – show Coding Style introduced 2017-08-26 22:21 UTC by Report Bug Copy Issue Report Possible parse error: non-abstract method defined as abstract Loading history... Coding Style introduced 2017-08-26 22:21 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history...
39			{
40	42		$this->behavior = $behavior;
41	42		}
42
43			/**
44			* {@inheritdoc}
45			*/
46	28		public function put($key, $value)
47			{
48	28		$this->assertObject($key, 'Key');
49	27		$this->assertObject($value, 'Value'); // while we may associate non-object value, for interface compatibility we don't do that
50
51	26		$hash = $this->getHash($key);
52
53	26		if (isset($this->keys[$hash])) {
54	1		throw new OverflowException('Value with such key already exists');
55			}
56
57	26		$bucket = $this->createBucket($key, $value, $hash);
58
59	26		$this->keys[$hash] = $bucket;
60	26		}
61
62			/**
63			* {@inheritdoc}
64			*/
65	9	View Code Duplication	public function get($key)
			0 ignored issues – show Duplication introduced 2017-10-08 20:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
66			{
67	9		$this->assertObject($key, 'Key');
68
69	8		$hash = $this->getHash($key);
70
71	8		if (!isset($this->keys[$hash])) {
72	2		throw new OutOfBoundsException('Value with such key not found');
73			}
74
75	6		$bucket = $this->keys[$hash];
76
77	6		return $this->fetchBucketValue($bucket);
78			}
79
80			/**
81			* {@inheritdoc}
82			*/
83	23		public function has($key): bool
84			{
85	23		$this->assertObject($key, 'Key');
86
87	22		$hash = $this->getHash($key);
88
89	22		return isset($this->keys[$hash]);
90			}
91
92			/**
93			* {@inheritdoc}
94			*/
95	7	View Code Duplication	public function remove($key)
			0 ignored issues – show Duplication introduced 2017-10-08 20:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
96			{
97	7		$this->assertObject($key, 'Key');
98
99	6		$hash = $this->getHash($key);
100
101	6		if (!isset($this->keys[$hash])) {
102	1		throw new OutOfBoundsException('Value with such key not found');
103			}
104
105	5		$bucket = $this->keys[$hash];
106
107	5		$this->doRemove($hash);
108
109	5		return $this->fetchBucketValue($bucket);
110			}
111
112			/**
113			* {@inheritdoc}
114			*/
115	16		public function count()
116			{
117	16		return count($this->keys);
118			}
119
120			/**
121			* {@inheritdoc}
122			*/
123	3		public function clear()
124			{
125	3		$this->keys = [];
126	3		}
127
128			/**
129			* @param object $value
130			*
131			* @return string
132			*/
133	33		protected function getHash($value)
134			{
135	33		return spl_object_hash($value);
136			}
137
138			/**
139			* @param string $hash
140			*
141			* @return void
142			*/
143	14		protected function doRemove(string $hash)
144			{
145	14		unset($this->keys[$hash]);
146	14		}
147
148			/**
149			* @param object $key
150			* @param object $value
151			* @param string $hash
152			*
153			* @return Bucket
154			*/
155	26		protected function createBucket($key, $value, string $hash): Bucket
156			{
157	26		if ($this->behavior & self::WEAK_KEY) {
158	8		$key = $this->createReference($key, $hash);
159			}
160
161	26		if ($this->behavior & self::WEAK_VALUE) {
162	8		$value = $this->createReference($value, $hash);
163			}
164
165	26		return new Bucket($key, $value);
166			}
167
168			/**
169			* @param Bucket $bucket
170			*
171			* @return null\|object
172			*/
173	11		protected function fetchBucketValue(Bucket $bucket)
174			{
175	11		if ($this->behavior & self::WEAK_VALUE) {
176	2		assert($bucket->value instanceof WeakReference);
177
178	2		return $bucket->value->get();
179			}
180
181	9		return $bucket->value;
182			}
183
184			/**
185			* @param $obj
186			* @param string $hash
187			*
188			* @return WeakReference
189			*/
190			protected function createReference($obj, string $hash): WeakReference
191			{
192	9		return new WeakReference($obj, function () use ($hash) {
193	9		$this->doRemove($hash);
194	9		});
195			}
196			}
197

pinepain / php-object-maps

Push — master ( af4a9f...0754ab )

ObjectMap::fetchBucketValue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like