BrowscapPhp - Code Metrics - Inspection of "adding some new methods" - ThaDafinser/UserAgentParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#44)

by Martin

created 2015-12-14 17:03 UTC

BrowscapPhp B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	281
Duplicated Lines	25.62 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

97.59%

Importance

Changes	15
Bugs	0	Features	1

Metric	Value
wmc	50
c	15
b	0
f	1
lcom	1
cbo	11
dl	72
loc	281
ccs	81
cts	83
cp	0.9759
rs	8.6207

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getVersion()	0	6	1
A	getUpdateDate()	0	4	1
A	getParser()	0	4	1
A	getDeviceModelDefaultValues()	0	9	1
A	hasResult()	0	12	3
A	isBot()	0	8	3
B	hydrateBot()	0	17	9
B	hydrateBrowser()	10	10	5
B	hydrateRenderingEngine()	10	10	5
B	hydrateOperatingSystem()	10	10	5
C	hydrateDevice()	3	23	12
B	parse()	39	39	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like BrowscapPhp often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use BrowscapPhp, and based on these observations, apply Extract Interface, too.

<?php
namespace UserAgentParser\Provider;

use BrowscapPHP\Browscap;
use stdClass;
use UserAgentParser\Exception;
use UserAgentParser\Model;

class BrowscapPhp extends AbstractProvider
{
    /**
     * Name of the provider
     *
     * @var string
     */
    protected $name = 'BrowscapPhp';

    /**
     * Homepage of the provider
     *
     * @var string
     */
    protected $homepage = 'https://github.com/browscap/browscap-php';

    /**
     * Composer package name
     *
     * @var string
     */
    protected $packageName = 'browscap/browscap-php';

    protected $detectionCapabilities = [

        'browser' => [
            'name'    => true,
            'version' => true,
        ],

        'renderingEngine' => [
            'name'    => true,
            'version' => true,
        ],

        'operatingSystem' => [
            'name'    => true,
            'version' => true,
        ],

        'device' => [
            'model'    => true,
            'brand'    => true,
            'type'     => true,
            'isMobile' => true,
            'isTouch'  => true,
        ],

        'bot' => [
            'isBot' => true,
            'name'  => true,
            'type'  => true,
        ],
    ];

    protected $defaultValues = [
        'DefaultProperties',
        'Default Browser',

        'unknown',
    ];

    /**
     *
     * @var Browscap
     */
    private $parser;

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

    public function getVersion()
    {
        return $this->getParser()
            ->getCache()
            ->getVersion();
    }

    public function getUpdateDate()
    {
        return;
    }

    /**
     *
     * @return Browscap
     */
    public function getParser()
    {
        return $this->parser;
    }

    /**
     *
     * @return array
     */
    private function getDeviceModelDefaultValues()
    {
        return [
            'general Desktop',
            'general Mobile Device',
            'general Mobile Phone',
            'general Tablet',
        ];
    }

    /**
     *
     * @param stdClass $resultRaw
     *
     * @return bool
     */
    private function hasResult(stdClass $resultRaw)
    {
        if (! isset($resultRaw->browser)) {
            return false;
        }

        if ($this->isRealResult($resultRaw->browser) !== true) {
            return false;
        }

        return true;
    }

    /**
     *
     * @param  stdClass $resultRaw
     * @return boolean
     */
    private function isBot(stdClass $resultRaw)
    {
        if (! isset($resultRaw->crawler) || $resultRaw->crawler !== true) {
            return false;
        }

        return true;
    }

    /**
     *
     * @param Model\Bot $bot
     * @param stdClass  $resultRaw
     */
    private function hydrateBot(Model\Bot $bot, stdClass $resultRaw)
    {
        $bot->setIsBot(true);

        if (isset($resultRaw->browser) && $this->isRealResult($resultRaw->browser) === true) {
            $bot->setName($resultRaw->browser);
        }

        // @todo convert to a common set of types (over all vendors)
        if (isset($resultRaw->issyndicationreader) && $resultRaw->issyndicationreader === true) {
            $bot->setType('RSS');
        } elseif (isset($resultRaw->browser_type) && $resultRaw->browser_type === 'Bot/Crawler') {
            $bot->setType('Crawler');
        } elseif (isset($resultRaw->browser_type) && $this->isRealResult($resultRaw->browser_type) === true) {
            $bot->setType($resultRaw->browser_type);
        }
    }

    /**
     *
     * @param Model\Browser $browser
     * @param stdClass      $resultRaw
     */
    private function hydrateBrowser(Model\Browser $browser, stdClass $resultRaw)

    {
        if (isset($resultRaw->browser) && $this->isRealResult($resultRaw->browser) === true) {
            $browser->setName($resultRaw->browser);
        }

        if (isset($resultRaw->version) && $this->isRealResult($resultRaw->version) === true) {
            $browser->getVersion()->setComplete($resultRaw->version);
        }
    }

    /**
     *
     * @param Model\RenderingEngine $engine
     * @param stdClass              $resultRaw
     */
    private function hydrateRenderingEngine(Model\RenderingEngine $engine, stdClass $resultRaw)

    {
        if (isset($resultRaw->renderingengine_name) && $this->isRealResult($resultRaw->renderingengine_name) === true) {
            $engine->setName($resultRaw->renderingengine_name);
        }

        if (isset($resultRaw->renderingengine_version) && $this->isRealResult($resultRaw->renderingengine_version) === true) {
            $engine->getVersion()->setComplete($resultRaw->renderingengine_version);
        }
    }

    /**
     *
     * @param Model\OperatingSystem $os
     * @param stdClass              $resultRaw
     */
    private function hydrateOperatingSystem(Model\OperatingSystem $os, stdClass $resultRaw)

    {
        if (isset($resultRaw->platform) && $this->isRealResult($resultRaw->platform) === true) {
            $os->setName($resultRaw->platform);
        }

        if (isset($resultRaw->platform_version) && $this->isRealResult($resultRaw->platform_version) === true) {
            $os->getVersion()->setComplete($resultRaw->platform_version);
        }
    }

    /**
     *
     * @param Model\UserAgent $device
     * @param stdClass        $resultRaw
     */
    private function hydrateDevice(Model\Device $device, stdClass $resultRaw)
    {
        if (isset($resultRaw->device_name) && $this->isRealResult($resultRaw->device_name, $this->getDeviceModelDefaultValues()) === true) {
            $device->setModel($resultRaw->device_name);
        }

        if (isset($resultRaw->device_brand_name) && $this->isRealResult($resultRaw->device_brand_name) === true) {

            $device->setBrand($resultRaw->device_brand_name);
        }

        if (isset($resultRaw->device_type) && $this->isRealResult($resultRaw->device_type) === true) {
            // @todo convert to a common set of types (over all vendors)
            $device->setType($resultRaw->device_type);
        }

        if (isset($resultRaw->ismobiledevice) && $this->isRealResult($resultRaw->ismobiledevice) === true && $resultRaw->ismobiledevice === true) {
            $device->setIsMobile(true);
        }

        if (isset($resultRaw->device_pointing_method) && $resultRaw->device_pointing_method == 'touchscreen') {
            $device->setIsTouch(true);
        }
    }

    public function parse($userAgent, array $headers = [])

    {
        $parser = $this->getParser();

        /* @var $resultRaw \stdClass */
        $resultRaw = $parser->getBrowser($userAgent);

        /*
         * No result found?
         */
        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 (does only work with full_php_browscap.ini)
         */
        if ($this->isBot($resultRaw) === true) {
            $this->hydrateBot($result->getBot(), $resultRaw);

            return $result;
        }

        /*
         * hydrate the result
         */
        $this->hydrateBrowser($result->getBrowser(), $resultRaw);
        $this->hydrateRenderingEngine($result->getRenderingEngine(), $resultRaw);
        $this->hydrateOperatingSystem($result->getOperatingSystem(), $resultRaw);
        $this->hydrateDevice($result->getDevice(), $resultRaw);

        return $result;
    }
}


1			<?php
2			namespace UserAgentParser\Provider;
3
4			use BrowscapPHP\Browscap;
5			use stdClass;
6			use UserAgentParser\Exception;
7			use UserAgentParser\Model;
8
9			class BrowscapPhp extends AbstractProvider
10			{
11			/**
12			* Name of the provider
13			*
14			* @var string
15			*/
16			protected $name = 'BrowscapPhp';
17
18			/**
19			* Homepage of the provider
20			*
21			* @var string
22			*/
23			protected $homepage = 'https://github.com/browscap/browscap-php';
24
25			/**
26			* Composer package name
27			*
28			* @var string
29			*/
30			protected $packageName = 'browscap/browscap-php';
31
32			protected $detectionCapabilities = [
33
34			'browser' => [
35			'name' => true,
36			'version' => true,
37			],
38
39			'renderingEngine' => [
40			'name' => true,
41			'version' => true,
42			],
43
44			'operatingSystem' => [
45			'name' => true,
46			'version' => true,
47			],
48
49			'device' => [
50			'model' => true,
51			'brand' => true,
52			'type' => true,
53			'isMobile' => true,
54			'isTouch' => true,
55			],
56
57			'bot' => [
58			'isBot' => true,
59			'name' => true,
60			'type' => true,
61			],
62			];
63
64			protected $defaultValues = [
65			'DefaultProperties',
66			'Default Browser',
67
68			'unknown',
69			];
70
71			/**
72			*
73			* @var Browscap
74			*/
75			private $parser;
76
77	16		public function __construct(Browscap $parser)
78			{
79	16		$this->parser = $parser;
80	16		}
81
82	1		public function getVersion()
83			{
84	1		return $this->getParser()
85	1		->getCache()
86	1		->getVersion();
87			}
88
89			public function getUpdateDate()
90			{
91			return;
92			}
93
94			/**
95			*
96			* @return Browscap
97			*/
98	12		public function getParser()
99			{
100	12		return $this->parser;
101			}
102
103			/**
104			*
105			* @return array
106			*/
107	1		private function getDeviceModelDefaultValues()
108			{
109			return [
110	1		'general Desktop',
111	1		'general Mobile Device',
112	1		'general Mobile Phone',
113	1		'general Tablet',
114	1		];
115			}
116
117			/**
118			*
119			* @param stdClass $resultRaw
120			*
121			* @return bool
122			*/
123	10		private function hasResult(stdClass $resultRaw)
124			{
125	10		if (! isset($resultRaw->browser)) {
126	1		return false;
127			}
128
129	9		if ($this->isRealResult($resultRaw->browser) !== true) {
130	4		return false;
131			}
132
133	5		return true;
134			}
135
136			/**
137			*
138			* @param stdClass $resultRaw
139			* @return boolean
140			*/
141	5		private function isBot(stdClass $resultRaw)
142			{
143	5		if (! isset($resultRaw->crawler) \|\| $resultRaw->crawler !== true) {
144	2		return false;
145			}
146
147	3		return true;
148			}
149
150			/**
151			*
152			* @param Model\Bot $bot
153			* @param stdClass $resultRaw
154			*/
155	3		private function hydrateBot(Model\Bot $bot, stdClass $resultRaw)
156			{
157	3		$bot->setIsBot(true);
158
159	3		if (isset($resultRaw->browser) && $this->isRealResult($resultRaw->browser) === true) {
160	3		$bot->setName($resultRaw->browser);
161			}
162
163			// @todo convert to a common set of types (over all vendors)
164	3		if (isset($resultRaw->issyndicationreader) && $resultRaw->issyndicationreader === true) {
165	1		$bot->setType('RSS');
166	3		} elseif (isset($resultRaw->browser_type) && $resultRaw->browser_type === 'Bot/Crawler') {
167	1		$bot->setType('Crawler');
168	2		} elseif (isset($resultRaw->browser_type) && $this->isRealResult($resultRaw->browser_type) === true) {
169	1		$bot->setType($resultRaw->browser_type);
170			}
171	3		}
172
173			/**
174			*
175			* @param Model\Browser $browser
176			* @param stdClass $resultRaw
177			*/
178	2	View Code Duplication	private function hydrateBrowser(Model\Browser $browser, stdClass $resultRaw)
			0 ignored issues – show Duplication introduced 2015-11-24 09:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
179			{
180	2		if (isset($resultRaw->browser) && $this->isRealResult($resultRaw->browser) === true) {
181	2		$browser->setName($resultRaw->browser);
182			}
183
184	2		if (isset($resultRaw->version) && $this->isRealResult($resultRaw->version) === true) {
185	2		$browser->getVersion()->setComplete($resultRaw->version);
186			}
187	2		}
188
189			/**
190			*
191			* @param Model\RenderingEngine $engine
192			* @param stdClass $resultRaw
193			*/
194	2	View Code Duplication	private function hydrateRenderingEngine(Model\RenderingEngine $engine, stdClass $resultRaw)
			0 ignored issues – show Duplication introduced 2015-11-24 09:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
195			{
196	2		if (isset($resultRaw->renderingengine_name) && $this->isRealResult($resultRaw->renderingengine_name) === true) {
197	1		$engine->setName($resultRaw->renderingengine_name);
198			}
199
200	2		if (isset($resultRaw->renderingengine_version) && $this->isRealResult($resultRaw->renderingengine_version) === true) {
201	1		$engine->getVersion()->setComplete($resultRaw->renderingengine_version);
202			}
203	2		}
204
205			/**
206			*
207			* @param Model\OperatingSystem $os
208			* @param stdClass $resultRaw
209			*/
210	2	View Code Duplication	private function hydrateOperatingSystem(Model\OperatingSystem $os, stdClass $resultRaw)
			0 ignored issues – show Duplication introduced 2015-11-24 09:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
211			{
212	2		if (isset($resultRaw->platform) && $this->isRealResult($resultRaw->platform) === true) {
213	1		$os->setName($resultRaw->platform);
214			}
215
216	2		if (isset($resultRaw->platform_version) && $this->isRealResult($resultRaw->platform_version) === true) {
217	1		$os->getVersion()->setComplete($resultRaw->platform_version);
218			}
219	2		}
220
221			/**
222			*
223			* @param Model\UserAgent $device
224			* @param stdClass $resultRaw
225			*/
226	2		private function hydrateDevice(Model\Device $device, stdClass $resultRaw)
227			{
228	2		if (isset($resultRaw->device_name) && $this->isRealResult($resultRaw->device_name, $this->getDeviceModelDefaultValues()) === true) {
229	1		$device->setModel($resultRaw->device_name);
230			}
231
232	2	View Code Duplication	if (isset($resultRaw->device_brand_name) && $this->isRealResult($resultRaw->device_brand_name) === true) {
			0 ignored issues – show Duplication introduced 2015-12-11 22:04 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
233	1		$device->setBrand($resultRaw->device_brand_name);
234			}
235
236	2		if (isset($resultRaw->device_type) && $this->isRealResult($resultRaw->device_type) === true) {
237			// @todo convert to a common set of types (over all vendors)
238	1		$device->setType($resultRaw->device_type);
239			}
240
241	2		if (isset($resultRaw->ismobiledevice) && $this->isRealResult($resultRaw->ismobiledevice) === true && $resultRaw->ismobiledevice === true) {
242	1		$device->setIsMobile(true);
243			}
244
245	2		if (isset($resultRaw->device_pointing_method) && $resultRaw->device_pointing_method == 'touchscreen') {
246	1		$device->setIsTouch(true);
247			}
248	2		}
249
250	10	View Code Duplication	public function parse($userAgent, array $headers = [])
			0 ignored issues – show Duplication introduced 2015-11-24 09:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
251			{
252	10		$parser = $this->getParser();
253
254			/* @var $resultRaw \stdClass */
255	10		$resultRaw = $parser->getBrowser($userAgent);
256
257			/*
258			* No result found?
259			*/
260	10		if ($this->hasResult($resultRaw) !== true) {
261	5		throw new Exception\NoResultFoundException('No result found for user agent: ' . $userAgent);
262			}
263
264			/*
265			* Hydrate the model
266			*/
267	5		$result = new Model\UserAgent();
268	5		$result->setProviderResultRaw($resultRaw);
269
270			/*
271			* Bot detection (does only work with full_php_browscap.ini)
272			*/
273	5		if ($this->isBot($resultRaw) === true) {
274	3		$this->hydrateBot($result->getBot(), $resultRaw);
275
276	3		return $result;
277			}
278
279			/*
280			* hydrate the result
281			*/
282	2		$this->hydrateBrowser($result->getBrowser(), $resultRaw);
283	2		$this->hydrateRenderingEngine($result->getRenderingEngine(), $resultRaw);
284	2		$this->hydrateOperatingSystem($result->getOperatingSystem(), $resultRaw);
285	2		$this->hydrateDevice($result->getDevice(), $resultRaw);
286
287	2		return $result;
288			}
289			}
290

ThaDafinser / UserAgentParser

GitHub Access Token became invalid