HashArray - Code Metrics - Inspection of "Move Hashable interface from HashArray to SnakList" - wmde/WikibaseDataModel - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — moveGetSnakListHash ( 1df890 )

by no

created 2017-01-14 15:23 UTC

HashArray A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	326
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	35
lcom	1
cbo	1
dl	0
loc	326
rs	9
c	0
b	0
f	0

19 Methods

Rating	Name	Size	Complexity
	getObjectType()	1	?
B	__construct()	13	5
A	getNewOffset()	7	2
A	preSetElement()	14	2
A	hasElementHash()	3	1
A	hasElement()	3	1
A	removeElement()	3	1
A	removeByElementHash()	6	2
A	addElement()	9	2
A	getByElementHash()	9	2
A	offsetUnset()	14	2
A	equals()	8	3
A	append()	3	1
A	offsetSet()	3	1
A	hasValidType()	4	1
B	setElement()	15	5
A	serialize()	6	1
A	unserialize()	11	2
A	isEmpty()	3	1

<?php

namespace Wikibase\DataModel;

use ArrayObject;
use Comparable;
use Hashable;
use InvalidArgumentException;
use Traversable;

/**
 * Generic array object with lookups based on hashes of the elements.
 *
 * Elements need to implement Hashable.
 *
 * Note that by default the getHash method uses @see MapValueHashesr
 * which returns a hash based on the contents of the list, regardless
 * of order and keys.
 *
 * Also note that if the Hashable elements are mutable, any modifications
 * made to them via their mutator methods will not cause an update of
 * their associated hash in this array.
 *
 * @since 0.1
 *
 * @license GPL-2.0+
 * @author Jeroen De Dauw < [email protected] >
 */
abstract class HashArray extends ArrayObject implements Comparable {

	/**
	 * Maps element hashes to their offsets.
	 *
	 * @since 0.1
	 *
	 * @var array [ element hash (string) => element offset (string|int) ]
	 */
	protected $offsetHashes = [];

	/**
	 * @var integer
	 */
	protected $indexOffset = 0;

	/**
	 * Returns the name of an interface/class that the element should implement/extend.
	 *
	 * @since 0.4
	 *
	 * @return string
	 */
	abstract public function getObjectType();

	/**
	 * @see ArrayObject::__construct
	 *
	 * @param array|Traversable|null $input
	 * @param int $flags
	 * @param string $iteratorClass
	 *
	 * @throws InvalidArgumentException
	 */
	public function __construct( $input = null, $flags = 0, $iteratorClass = 'ArrayIterator' ) {
		parent::__construct( [], $flags, $iteratorClass );

		if ( $input !== null ) {
			if ( !is_array( $input ) && !( $input instanceof Traversable ) ) {
				throw new InvalidArgumentException( '$input must be an array or Traversable' );
			}

			foreach ( $input as $offset => $value ) {
				$this->offsetSet( $offset, $value );
			}
		}
	}

	/**
	 * Finds a new offset for when appending an element.
	 * The base class does this, so it would be better to integrate,
	 * but there does not appear to be any way to do this...
	 *
	 * @return integer
	 */
	protected function getNewOffset() {
		while ( $this->offsetExists( $this->indexOffset ) ) {
			$this->indexOffset++;
		}

		return $this->indexOffset;
	}

	/**
	 * Gets called before a new element is added to the ArrayObject.
	 *
	 * At this point the index is always set (ie not null) and the
	 * value is always of the type returned by @see getObjectType.
	 *
	 * Should return a boolean. When false is returned the element
	 * does not get added to the ArrayObject.
	 *
	 * @since 0.1
	 *
	 * @param int|string $index
	 * @param Hashable $hashable
	 *
	 * @return bool
	 */
	protected function preSetElement( $index, $hashable ) {
		$hash = $hashable->getHash();

		$hasHash = $this->hasElementHash( $hash );

		if ( $hasHash ) {
			return false;
		}
		else {
			$this->offsetHashes[$hash] = $index;

			return true;
		}
	}

	/**
	 * Returns if there is an element with the provided hash.
	 *
	 * @since 0.1
	 *
	 * @param string $elementHash
	 *
	 * @return bool
	 */
	public function hasElementHash( $elementHash ) {
		return array_key_exists( $elementHash, $this->offsetHashes );
	}

	/**
	 * Returns if there is an element with the same hash as the provided element in the list.
	 *
	 * @since 0.1
	 *
	 * @param Hashable $element
	 *
	 * @return bool
	 */
	public function hasElement( Hashable $element ) {
		return $this->hasElementHash( $element->getHash() );
	}

	/**
	 * Removes the element with the hash of the provided element, if there is such an element in the list.
	 *
	 * @since 0.1
	 *
	 * @param Hashable $element
	 */
	public function removeElement( Hashable $element ) {
		$this->removeByElementHash( $element->getHash() );
	}

	/**
	 * Removes the element with the provided hash, if there is such an element in the list.
	 *
	 * @since 0.1
	 *
	 * @param string $elementHash
	 */
	public function removeByElementHash( $elementHash ) {
		if ( $this->hasElementHash( $elementHash ) ) {
			$offset = $this->offsetHashes[$elementHash];
			$this->offsetUnset( $offset );
		}
	}

	/**
	 * Adds the provided element to the list if there is no element with the same hash yet.
	 *
	 * @since 0.1
	 *
	 * @param Hashable $element
	 *
	 * @return bool Indicates if the element was added or not.
	 */
	public function addElement( Hashable $element ) {
		$append = !$this->hasElementHash( $element->getHash() );

		if ( $append ) {
			$this->append( $element );
		}

		return $append;
	}

	/**
	 * Returns the element with the provided hash or false if there is no such element.
	 *
	 * @since 0.1
	 *
	 * @param string $elementHash
	 *
	 * @return mixed|bool
	 */
	public function getByElementHash( $elementHash ) {
		if ( $this->hasElementHash( $elementHash ) ) {
			$offset = $this->offsetHashes[$elementHash];
			return $this->offsetGet( $offset );
		}
		else {
			return false;
		}
	}

	/**
	 * @see ArrayObject::offsetUnset
	 *
	 * @since 0.1
	 *
	 * @param mixed $index
	 */
	public function offsetUnset( $index ) {
		if ( $this->offsetExists( $index ) ) {
			/**
			 * @var Hashable $element
			 */
			$element = $this->offsetGet( $index );

			$hash = $element->getHash();

			unset( $this->offsetHashes[$hash] );

			parent::offsetUnset( $index );
		}
	}

	/**
	 * @see Comparable::equals
	 *
	 * The comparison is done purely value based, ignoring the order of the elements in the array.
	 *
	 * @since 0.3
	 *
	 * @param mixed $target
	 *
	 * @return bool
	 */
	public function equals( $target ) {
		if ( $this === $target ) {
			return true;
		}

		return $target instanceof self
			&& $this->getHash() === $target->getHash();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}

	/**
	 * @see ArrayObject::append
	 *
	 * @param mixed $value
	 */
	public function append( $value ) {
		$this->setElement( null, $value );
	}

	/**
	 * @see ArrayObject::offsetSet()
	 *
	 * @param mixed $index
	 * @param mixed $value
	 */
	public function offsetSet( $index, $value ) {
		$this->setElement( $index, $value );
	}

	/**
	 * Returns if the provided value has the same type as the elements
	 * that can be added to this ArrayObject.
	 *
	 * @param mixed $value
	 *
	 * @return bool
	 */
	protected function hasValidType( $value ) {
		$class = $this->getObjectType();
		return $value instanceof $class;
	}

	/**
	 * Method that actually sets the element and holds
	 * all common code needed for set operations, including
	 * type checking and offset resolving.
	 *
	 * If you want to do additional indexing or have code that
	 * otherwise needs to be executed whenever an element is added,
	 * you can overload @see preSetElement.
	 *
	 * @param mixed $index
	 * @param mixed $value
	 *
	 * @throws InvalidArgumentException
	 */
	protected function setElement( $index, $value ) {
		if ( !$this->hasValidType( $value ) ) {
			$type = is_object( $value ) ? get_class( $value ) : gettype( $value );

			throw new InvalidArgumentException( '$value must be an instance of ' . $this->getObjectType() . '; got ' . $type );
		}

		if ( $index === null ) {
			$index = $this->getNewOffset();
		}

		if ( $this->preSetElement( $index, $value ) ) {
			parent::offsetSet( $index, $value );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
		}
	}

	/**
	 * @see Serializable::serialize
	 *
	 * @return string
	 */
	public function serialize() {
		return serialize( [
			'data' => $this->getArrayCopy(),
			'index' => $this->indexOffset,
		] );
	}

	/**
	 * @see Serializable::unserialize
	 *
	 * @param string $serialized
	 */
	public function unserialize( $serialized ) {
		$serializationData = unserialize( $serialized );

		foreach ( $serializationData['data'] as $offset => $value ) {
			// Just set the element, bypassing checks and offset resolving,
			// as these elements have already gone through this.
			parent::offsetSet( $offset, $value );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
		}

		$this->indexOffset = $serializationData['index'];
	}

	/**
	 * Returns if the ArrayObject has no elements.
	 *
	 * @return bool
	 */
	public function isEmpty() {
		return !$this->getIterator()->valid();
	}

}


1			<?php
2
3			namespace Wikibase\DataModel;
4
5			use ArrayObject;
6			use Comparable;
7			use Hashable;
8			use InvalidArgumentException;
9			use Traversable;
10
11			/**
12			* Generic array object with lookups based on hashes of the elements.
13			*
14			* Elements need to implement Hashable.
15			*
16			* Note that by default the getHash method uses @see MapValueHashesr
17			* which returns a hash based on the contents of the list, regardless
18			* of order and keys.
19			*
20			* Also note that if the Hashable elements are mutable, any modifications
21			* made to them via their mutator methods will not cause an update of
22			* their associated hash in this array.
23			*
24			* @since 0.1
25			*
26			* @license GPL-2.0+
27			* @author Jeroen De Dauw < [email protected] >
28			*/
29			abstract class HashArray extends ArrayObject implements Comparable {
30
31			/**
32			* Maps element hashes to their offsets.
33			*
34			* @since 0.1
35			*
36			* @var array [ element hash (string) => element offset (string\|int) ]
37			*/
38			protected $offsetHashes = [];
39
40			/**
41			* @var integer
42			*/
43			protected $indexOffset = 0;
44
45			/**
46			* Returns the name of an interface/class that the element should implement/extend.
47			*
48			* @since 0.4
49			*
50			* @return string
51			*/
52			abstract public function getObjectType();
53
54			/**
55			* @see ArrayObject::__construct
56			*
57			* @param array\|Traversable\|null $input
58			* @param int $flags
59			* @param string $iteratorClass
60			*
61			* @throws InvalidArgumentException
62			*/
63			public function __construct( $input = null, $flags = 0, $iteratorClass = 'ArrayIterator' ) {
64			parent::__construct( [], $flags, $iteratorClass );
65
66			if ( $input !== null ) {
67			if ( !is_array( $input ) && !( $input instanceof Traversable ) ) {
68			throw new InvalidArgumentException( '$input must be an array or Traversable' );
69			}
70
71			foreach ( $input as $offset => $value ) {
72			$this->offsetSet( $offset, $value );
73			}
74			}
75			}
76
77			/**
78			* Finds a new offset for when appending an element.
79			* The base class does this, so it would be better to integrate,
80			* but there does not appear to be any way to do this...
81			*
82			* @return integer
83			*/
84			protected function getNewOffset() {
85			while ( $this->offsetExists( $this->indexOffset ) ) {
86			$this->indexOffset++;
87			}
88
89			return $this->indexOffset;
90			}
91
92			/**
93			* Gets called before a new element is added to the ArrayObject.
94			*
95			* At this point the index is always set (ie not null) and the
96			* value is always of the type returned by @see getObjectType.
97			*
98			* Should return a boolean. When false is returned the element
99			* does not get added to the ArrayObject.
100			*
101			* @since 0.1
102			*
103			* @param int\|string $index
104			* @param Hashable $hashable
105			*
106			* @return bool
107			*/
108			protected function preSetElement( $index, $hashable ) {
109			$hash = $hashable->getHash();
110
111			$hasHash = $this->hasElementHash( $hash );
112
113			if ( $hasHash ) {
114			return false;
115			}
116			else {
117			$this->offsetHashes[$hash] = $index;
118
119			return true;
120			}
121			}
122
123			/**
124			* Returns if there is an element with the provided hash.
125			*
126			* @since 0.1
127			*
128			* @param string $elementHash
129			*
130			* @return bool
131			*/
132			public function hasElementHash( $elementHash ) {
133			return array_key_exists( $elementHash, $this->offsetHashes );
134			}
135
136			/**
137			* Returns if there is an element with the same hash as the provided element in the list.
138			*
139			* @since 0.1
140			*
141			* @param Hashable $element
142			*
143			* @return bool
144			*/
145			public function hasElement( Hashable $element ) {
146			return $this->hasElementHash( $element->getHash() );
147			}
148
149			/**
150			* Removes the element with the hash of the provided element, if there is such an element in the list.
151			*
152			* @since 0.1
153			*
154			* @param Hashable $element
155			*/
156			public function removeElement( Hashable $element ) {
157			$this->removeByElementHash( $element->getHash() );
158			}
159
160			/**
161			* Removes the element with the provided hash, if there is such an element in the list.
162			*
163			* @since 0.1
164			*
165			* @param string $elementHash
166			*/
167			public function removeByElementHash( $elementHash ) {
168			if ( $this->hasElementHash( $elementHash ) ) {
169			$offset = $this->offsetHashes[$elementHash];
170			$this->offsetUnset( $offset );
171			}
172			}
173
174			/**
175			* Adds the provided element to the list if there is no element with the same hash yet.
176			*
177			* @since 0.1
178			*
179			* @param Hashable $element
180			*
181			* @return bool Indicates if the element was added or not.
182			*/
183			public function addElement( Hashable $element ) {
184			$append = !$this->hasElementHash( $element->getHash() );
185
186			if ( $append ) {
187			$this->append( $element );
188			}
189
190			return $append;
191			}
192
193			/**
194			* Returns the element with the provided hash or false if there is no such element.
195			*
196			* @since 0.1
197			*
198			* @param string $elementHash
199			*
200			* @return mixed\|bool
201			*/
202			public function getByElementHash( $elementHash ) {
203			if ( $this->hasElementHash( $elementHash ) ) {
204			$offset = $this->offsetHashes[$elementHash];
205			return $this->offsetGet( $offset );
206			}
207			else {
208			return false;
209			}
210			}
211
212			/**
213			* @see ArrayObject::offsetUnset
214			*
215			* @since 0.1
216			*
217			* @param mixed $index
218			*/
219			public function offsetUnset( $index ) {
220			if ( $this->offsetExists( $index ) ) {
221			/**
222			* @var Hashable $element
223			*/
224			$element = $this->offsetGet( $index );
225
226			$hash = $element->getHash();
227
228			unset( $this->offsetHashes[$hash] );
229
230			parent::offsetUnset( $index );
231			}
232			}
233
234			/**
235			* @see Comparable::equals
236			*
237			* The comparison is done purely value based, ignoring the order of the elements in the array.
238			*
239			* @since 0.3
240			*
241			* @param mixed $target
242			*
243			* @return bool
244			*/
245			public function equals( $target ) {
246			if ( $this === $target ) {
247			return true;
248			}
249
250			return $target instanceof self
251			&& $this->getHash() === $target->getHash();
			0 ignored issues – show Bug introduced 2017-01-14 15:26 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Wikibase\DataModel\HashArray` as the method `getHash()` does only exist in the following sub-classes of `Wikibase\DataModel\HashArray`: `Wikibase\DataModel\Snak\SnakList`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
252			}
253
254			/**
255			* @see ArrayObject::append
256			*
257			* @param mixed $value
258			*/
259			public function append( $value ) {
260			$this->setElement( null, $value );
261			}
262
263			/**
264			* @see ArrayObject::offsetSet()
265			*
266			* @param mixed $index
267			* @param mixed $value
268			*/
269			public function offsetSet( $index, $value ) {
270			$this->setElement( $index, $value );
271			}
272
273			/**
274			* Returns if the provided value has the same type as the elements
275			* that can be added to this ArrayObject.
276			*
277			* @param mixed $value
278			*
279			* @return bool
280			*/
281			protected function hasValidType( $value ) {
282			$class = $this->getObjectType();
283			return $value instanceof $class;
284			}
285
286			/**
287			* Method that actually sets the element and holds
288			* all common code needed for set operations, including
289			* type checking and offset resolving.
290			*
291			* If you want to do additional indexing or have code that
292			* otherwise needs to be executed whenever an element is added,
293			* you can overload @see preSetElement.
294			*
295			* @param mixed $index
296			* @param mixed $value
297			*
298			* @throws InvalidArgumentException
299			*/
300			protected function setElement( $index, $value ) {
301			if ( !$this->hasValidType( $value ) ) {
302			$type = is_object( $value ) ? get_class( $value ) : gettype( $value );
303
304			throw new InvalidArgumentException( '$value must be an instance of ' . $this->getObjectType() . '; got ' . $type );
305			}
306
307			if ( $index === null ) {
308			$index = $this->getNewOffset();
309			}
310
311			if ( $this->preSetElement( $index, $value ) ) {
312			parent::offsetSet( $index, $value );
			0 ignored issues – show Comprehensibility Bug introduced 2015-11-27 17:36 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`offsetSet()` instead of `setElement()`). Are you sure this is correct? If so, you might want to change this to `$this->offsetSet()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
313			}
314			}
315
316			/**
317			* @see Serializable::serialize
318			*
319			* @return string
320			*/
321			public function serialize() {
322			return serialize( [
323			'data' => $this->getArrayCopy(),
324			'index' => $this->indexOffset,
325			] );
326			}
327
328			/**
329			* @see Serializable::unserialize
330			*
331			* @param string $serialized
332			*/
333			public function unserialize( $serialized ) {
334			$serializationData = unserialize( $serialized );
335
336			foreach ( $serializationData['data'] as $offset => $value ) {
337			// Just set the element, bypassing checks and offset resolving,
338			// as these elements have already gone through this.
339			parent::offsetSet( $offset, $value );
			0 ignored issues – show Comprehensibility Bug introduced 2015-11-27 17:36 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`offsetSet()` instead of `unserialize()`). Are you sure this is correct? If so, you might want to change this to `$this->offsetSet()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
340			}
341
342			$this->indexOffset = $serializationData['index'];
343			}
344
345			/**
346			* Returns if the ArrayObject has no elements.
347			*
348			* @return bool
349			*/
350			public function isEmpty() {
351			return !$this->getIterator()->valid();
352			}
353
354			}
355

wmde / WikibaseDataModel

Push — moveGetSnakListHash ( 1df890 )

HashArray A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

19 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like