Country - Code Metrics - Inspection of "json serializable value objects" - nicolopignatelli/valueobjects - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#62)

by Adam

created 2016-04-20 19:16 UTC

Country A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

90.91%

Importance

Changes	4
Bugs	0	Features	2

Metric	Value
wmc	8
c	4
b	0
f	2
lcom	1
cbo	4
dl	0
loc	85
ccs	20
cts	22
cp	0.9091
rs	10

7 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getCode()	4	1
A	__toString()	4	1
A	fromNative()	8	1
A	sameValueAs()	8	2
A	getName()	7	1
A	jsonSerialize()	4	1

<?php

namespace ValueObjects\Geography;

use ValueObjects\Util\Util;
use ValueObjects\ValueObjectInterface;

class Country implements ValueObjectInterface
{
    /** @var CountryCode */
    protected $code;

    /**
     * Returns a new Country object given a native PHP string country code
     *
     * @param  string $code
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return self
     */
    public static function fromNative()
    {
        $codeString = \func_get_arg(0);
        $code       = CountryCode::getByName($codeString);
        $country    = new self($code);

        return $country;
    }

    /**
     * Returns a new Country object
     *
     * @param CountryCode $code
     */
    public function __construct(CountryCode $code)
    {
        $this->code = $code;
    }

    /**
     * Tells whether two Country are equal
     *
     * @param  ValueObjectInterface $country
     * @return bool
     */
    public function sameValueAs(ValueObjectInterface $country)
    {
        if (false === Util::classEquals($this, $country)) {
            return false;
        }

        return $this->getCode()->sameValueAs($country->getCode());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
    }

    /**
     * Returns country code
     *
     * @return CountryCode
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * Returns country name
     *
     * @return String
     */
    public function getName()
    {
        $code = $this->getCode();
        $name = CountryCodeName::getName($code);

        return $name;
    }

    /**
     * Returns country name as native string
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getName()->toNative();
    }

    function jsonSerialize()

    {
        return (string) $this;
    }


}


1		<?php
2
3		namespace ValueObjects\Geography;
4
5		use ValueObjects\Util\Util;
6		use ValueObjects\ValueObjectInterface;
7
8		class Country implements ValueObjectInterface
9		{
10		/** @var CountryCode */
11		protected $code;
12
13		/**
14		* Returns a new Country object given a native PHP string country code
15		*
16		* @param string $code
		0 ignored issues – show Bug introduced 2015-11-21 01:12 UTC by Report Bug Copy Issue Report There is no parameter named `$code`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
17		* @return self
18		*/
19	2	public static function fromNative()
20		{
21	2	$codeString = \func_get_arg(0);
22	2	$code = CountryCode::getByName($codeString);
23	2	$country = new self($code);
24
25	2	return $country;
26		}
27
28		/**
29		* Returns a new Country object
30		*
31		* @param CountryCode $code
32		*/
33	16	public function __construct(CountryCode $code)
34		{
35	16	$this->code = $code;
36	16	}
37
38		/**
39		* Tells whether two Country are equal
40		*
41		* @param ValueObjectInterface $country
42		* @return bool
43		*/
44	5	public function sameValueAs(ValueObjectInterface $country)
45		{
46	5	if (false === Util::classEquals($this, $country)) {
47	1	return false;
48		}
49
50	5	return $this->getCode()->sameValueAs($country->getCode());
		0 ignored issues – show Bug introduced 2015-11-21 01:12 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `ValueObjects\ValueObjectInterface` as the method `getCode()` does only exist in the following implementations of said interface: `ValueObjects\Geography\Country`, `ValueObjects\Money\Currency`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
51		}
52
53		/**
54		* Returns country code
55		*
56		* @return CountryCode
57		*/
58	9	public function getCode()
59		{
60	9	return $this->code;
61		}
62
63		/**
64		* Returns country name
65		*
66		* @return String
67		*/
68	3	public function getName()
69		{
70	3	$code = $this->getCode();
71	3	$name = CountryCodeName::getName($code);
72
73	3	return $name;
74		}
75
76		/**
77		* Returns country name as native string
78		*
79		* @return string
80		*/
81	2	public function __toString()
82		{
83	2	return $this->getName()->toNative();
84		}
85
86		function jsonSerialize()
		0 ignored issues – show Best Practice introduced 2016-04-20 16:03 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... Comprehensibility Best Practice introduced 2016-04-20 16:03 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `jsonSerialize`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history...
87		{
88		return (string) $this;
89		}
90
91
92		}
93

nicolopignatelli / valueobjects

Pull Request — master (#62)

Country A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like