OptionsTrait::ensureRequired() - Code Metrics - Inspection of "Separate command and options" - equip/command - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Woody

created 2016-04-05 15:12 UTC

OptionsTrait::ensureRequired() A

↳ Parent: OptionsTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Equip\Command;

use Equip;
use Equip\Data\Traits\ProtectedValueObjectTrait;

trait OptionsTrait /* implements OptionsInterface */
{
    use ProtectedValueObjectTrait;

    /**
     * Check that all required options are defined, then hydrate.
     *
     * @param array $values
     */
    public function __construct(array $values)
    {
        $values = Equip\grab($values, $this->valid());

        $this->ensureRequired($values);

        foreach ($values as $key => $value) {
            $this->$key = $value;
        }
    }

    /**
     * Ensure that all required options are included in the given values.
     *
     * @param array $values
     *
     * @return void
     *
     * @throws CommandException
     *  If any required options have not been defined.
     */
    private function ensureRequired(array $values)
    {
        $defined = array_filter($values, static function ($value) {
            return $value !== null;
        });

        $missing = array_diff($this->required(), array_keys($defined));


        if ($missing) {

            throw CommandException::missingOptions($missing);
        }
    }

    /**
     * @inheritdoc
     */
    public function valid()
    {
        return array_keys($this->toArray());
    }

    /**
     * @inheritdoc
     */
    public function toArray()
    {
        return get_object_vars($this);
    }
}


1		<?php
2
3		namespace Equip\Command;
4
5		use Equip;
6		use Equip\Data\Traits\ProtectedValueObjectTrait;
7
8		trait OptionsTrait /* implements OptionsInterface */
9		{
10		use ProtectedValueObjectTrait;
11
12		/**
13		* Check that all required options are defined, then hydrate.
14		*
15		* @param array $values
16		*/
17	2	public function __construct(array $values)
18		{
19	2	$values = Equip\grab($values, $this->valid());
20
21	2	$this->ensureRequired($values);
22
23	1	foreach ($values as $key => $value) {
24	1	$this->$key = $value;
25	1	}
26	1	}
27
28		/**
29		* Ensure that all required options are included in the given values.
30		*
31		* @param array $values
32		*
33		* @return void
34		*
35		* @throws CommandException
36		* If any required options have not been defined.
37		*/
38		private function ensureRequired(array $values)
39		{
40	2	$defined = array_filter($values, static function ($value) {
41	1	return $value !== null;
42	2	});
43
44	2	$missing = array_diff($this->required(), array_keys($defined));
		0 ignored issues – show Bug introduced 2016-04-05 15:16 UTC by Report Bug Copy Issue Report The method `required()` does not exist on `Equip\Command\OptionsTrait`. Did you maybe mean `ensureRequired()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
45
46	2	if ($missing) {
		0 ignored issues – show Bug Best Practice introduced 2016-04-05 15:16 UTC by Report Bug Copy Issue Report The expression `$missing` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
47	1	throw CommandException::missingOptions($missing);
48		}
49	1	}
50
51		/**
52		* @inheritdoc
53		*/
54	2	public function valid()
55		{
56	2	return array_keys($this->toArray());
57		}
58
59		/**
60		* @inheritdoc
61		*/
62	2	public function toArray()
63		{
64	2	return get_object_vars($this);
65		}
66		}
67

equip / command

Pull Request — master (#6)

OptionsTrait::ensureRequired() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like