GuardTrait::validateKeyExists() - Code Metrics - italolelis/collections - Measure and Improve Code Quality continuously with Scrutinizer

GuardTrait::validateKeyExists() A
last analyzed 2016-12-13 14:12 UTC

↳ Parent: GuardTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

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

<?php

namespace Collections\Traits;

use Collections\Exception\EmptyException;
use Collections\Exception\InvalidArgumentException;
use Collections\Exception\KeyException;
use Collections\Exception\TypeException;

trait GuardTrait
{
    abstract function isEmpty();


    abstract function count();


    /**
     * Ensures that we throw the correct exception when an empty collection is found
     * @param $method
     * @throws EmptyException
     */
    protected function emptyGuard($method)
    {
        if ($this->isEmpty()) {
            throw new EmptyException("{$method} cannot be called when the structure is empty");
        }
    }

    /**
     * Validates if a key is withing bounds (usually only useful with vectors)
     * @param $key
     */
    protected function validateKeyBounds($key)
    {
        if (!$this->isBoundedKey($key)) {
            throw new \OutOfBoundsException("Integer key $key is out of bounds");
        }
    }

    /**
     * @param $key
     */
    protected function validateKeyDoesNotExists($key)
    {
        if (!$this->containsKey($key)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            throw new \OutOfBoundsException('No element at position ' . $key);
        }
    }

    /**
     * @param $key
     */
    protected function validateKeyExists($key)
    {
        if ($this->containsKey($key)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            throw new KeyException('The key ' . $key . ' already exists!');
        }
    }

    /**
     * @param int $element
     * @return bool
     */
    protected function isBoundedKey($element)
    {
        return $element >= 0 && $element < $this->count();
    }

    /**
     * Validate if an element respects the correct type (usually only useful with vectors)
     * @param $element
     * @throws TypeException
     */
    protected function validateKeyType($element)
    {
        if (filter_var($element, FILTER_VALIDATE_INT) === false) {
            throw new TypeException('Only integer keys may be used with ' . (get_class($this)));
        }
    }

    protected function validateTraversable($traversable)
    {
        if (!is_array($traversable) && !$traversable instanceof \Traversable) {
            throw InvalidArgumentException::invalidTraversable();
        }
    }
}


1		<?php
2
3		namespace Collections\Traits;
4
5		use Collections\Exception\EmptyException;
6		use Collections\Exception\InvalidArgumentException;
7		use Collections\Exception\KeyException;
8		use Collections\Exception\TypeException;
9
10		trait GuardTrait
11		{
12		abstract function isEmpty();
		0 ignored issues – show Best Practice introduced 2015-11-22 16:24 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
13
14		abstract function count();
		0 ignored issues – show Best Practice introduced 2015-11-22 16:24 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
15
16		/**
17		* Ensures that we throw the correct exception when an empty collection is found
18		* @param $method
19		* @throws EmptyException
20		*/
21		protected function emptyGuard($method)
22		{
23		if ($this->isEmpty()) {
24		throw new EmptyException("{$method} cannot be called when the structure is empty");
25		}
26		}
27
28		/**
29		* Validates if a key is withing bounds (usually only useful with vectors)
30		* @param $key
31		*/
32	5	protected function validateKeyBounds($key)
33		{
34	5	if (!$this->isBoundedKey($key)) {
35	2	throw new \OutOfBoundsException("Integer key $key is out of bounds");
36		}
37	3	}
38
39		/**
40		* @param $key
41		*/
42		protected function validateKeyDoesNotExists($key)
43	5	{
44		if (!$this->containsKey($key)) {
		0 ignored issues – show Bug introduced 2016-06-24 22:28 UTC by Report Bug Copy Issue Report It seems like `containsKey()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
45	5	throw new \OutOfBoundsException('No element at position ' . $key);
46		}
47		}
48
49		/**
50		* @param $key
51		*/
52		protected function validateKeyExists($key)
53	22	{
54		if ($this->containsKey($key)) {
		0 ignored issues – show Bug introduced 2016-06-24 22:28 UTC by Report Bug Copy Issue Report It seems like `containsKey()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
55	22	throw new KeyException('The key ' . $key . ' already exists!');
56	4	}
57		}
58	19
59		/**
60		* @param int $element
61		* @return bool
62		*/
63		protected function isBoundedKey($element)
64		{
65		return $element >= 0 && $element < $this->count();
66		}
67
68		/**
69		* Validate if an element respects the correct type (usually only useful with vectors)
70		* @param $element
71		* @throws TypeException
72		*/
73		protected function validateKeyType($element)
74		{
75		if (filter_var($element, FILTER_VALIDATE_INT) === false) {
76		throw new TypeException('Only integer keys may be used with ' . (get_class($this)));
77		}
78		}
79
80		protected function validateTraversable($traversable)
81		{
82		if (!is_array($traversable) && !$traversable instanceof \Traversable) {
83		throw InvalidArgumentException::invalidTraversable();
84		}
85		}
86		}
87

italolelis / collections

GuardTrait::validateKeyExists() A last analyzed 2016-12-13 14:12 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

GuardTrait::validateKeyExists() A
last analyzed 2016-12-13 14:12 UTC