DonatjUAParser - Code Metrics - Inspection of "refactoring hydration" - ThaDafinser/UserAgentParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#34)

by Martin

created 2015-11-24 09:46 UTC

DonatjUAParser A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes	9
Bugs	0	Features	0

Metric	Value
wmc	9
c	9
b	0
f	0
lcom	1
cbo	5
dl	0
loc	76
ccs	22
cts	22
cp	1
rs	10

5 Methods

Rating	Name	Size	Complexity
A	getName()	4	1
A	getComposerPackageName()	4	1
A	hasResult()	8	2
A	hydrateBrowser()	10	3
B	parse()	32	2

<?php
namespace UserAgentParser\Provider;

use UserAgentParser\Exception;
use UserAgentParser\Model;

class DonatjUAParser extends AbstractProvider
{
    public function getName()
    {
        return 'DonatjUAParser';
    }

    public function getComposerPackageName()
    {
        return 'donatj/phpuseragentparser';
    }

    /**
     *
     * @param array $resultRaw
     *
     * @return bool
     */
    private function hasResult(array $resultRaw)
    {
        if ($this->isRealResult($resultRaw['browser'])) {
            return true;
        }

        return false;
    }

    /**
     *
     * @param Model\Browser $browser
     * @param array         $resultRaw
     */
    private function hydrateBrowser(Model\Browser $browser, array $resultRaw)
    {
        if ($this->isRealResult($resultRaw['browser']) === true) {
            $browser->setName($resultRaw['browser']);
        }

        if ($this->isRealResult($resultRaw['version']) === true) {
            $browser->getVersion()->setComplete($resultRaw['version']);
        }
    }

    public function parse($userAgent, array $headers = [])
    {
        $resultRaw = parse_user_agent($userAgent);

        if ($this->hasResult($resultRaw) !== true) {
            throw new Exception\NoResultFoundException('No result found for user agent: ' . $userAgent);
        }

        /*
         * Hydrate the model
         */
        $result = new Model\UserAgent();
        $result->setProviderResultRaw($resultRaw);

        /*
         * Bot detection - is currently not possible!
         */

        /*
         * Browser
         */
        $this->hydrateBrowser($result->getBrowser(), $resultRaw);

        /*
         * operatingSystem
         *
         * @todo $resultRaw['platform'] has sometimes informations about the OS or the device
         * ... maybe split it or how do that?
         */

        return $result;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1		<?php
2		namespace UserAgentParser\Provider;
3
4		use UserAgentParser\Exception;
5		use UserAgentParser\Model;
6
7		class DonatjUAParser extends AbstractProvider
8		{
9	1	public function getName()
10		{
11	1	return 'DonatjUAParser';
12		}
13
14	2	public function getComposerPackageName()
15		{
16	2	return 'donatj/phpuseragentparser';
17		}
18
19		/**
20		*
21		* @param array $resultRaw
22		*
23		* @return bool
24		*/
25	2	private function hasResult(array $resultRaw)
26		{
27	2	if ($this->isRealResult($resultRaw['browser'])) {
28	1	return true;
29		}
30
31	1	return false;
32		}
33
34		/**
35		*
36		* @param Model\Browser $browser
37		* @param array $resultRaw
38		*/
39	1	private function hydrateBrowser(Model\Browser $browser, array $resultRaw)
40		{
41	1	if ($this->isRealResult($resultRaw['browser']) === true) {
42	1	$browser->setName($resultRaw['browser']);
43		}
44
45	1	if ($this->isRealResult($resultRaw['version']) === true) {
46	1	$browser->getVersion()->setComplete($resultRaw['version']);
47		}
48	1	}
49
50	2	public function parse($userAgent, array $headers = [])
51		{
52	2	$resultRaw = parse_user_agent($userAgent);
53
54	2	if ($this->hasResult($resultRaw) !== true) {
55	1	throw new Exception\NoResultFoundException('No result found for user agent: ' . $userAgent);
56		}
57
58		/*
59		* Hydrate the model
60		*/
61	1	$result = new Model\UserAgent();
62	1	$result->setProviderResultRaw($resultRaw);
63
64		/*
65		* Bot detection - is currently not possible!
66		*/
67
68		/*
69		* Browser
70		*/
71	1	$this->hydrateBrowser($result->getBrowser(), $resultRaw);
72
73		/*
74		* operatingSystem
75		*
76		* @todo $resultRaw['platform'] has sometimes informations about the OS or the device
77		* ... maybe split it or how do that?
78		*/
79
80	1	return $result;
		0 ignored issues – show Bug Best Practice introduced 2015-11-23 18:27 UTC by Report Bug Copy Issue Report The return type of `return $result;` (`UserAgentParser\Model\UserAgent`) is incompatible with the return type declared by the abstract method `UserAgentParser\Provider\AbstractProvider::parse` of type `UserAgentParser\Result\UserAgent`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
81		}
82		}
83

ThaDafinser / UserAgentParser

GitHub Access Token became invalid

Pull Request — master (#34)

DonatjUAParser A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like