BrowscapPhp - Code Metrics - Inspection of "browscap split to hydrate methods" - ThaDafinser/UserAgentParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#33)

by Martin

created 2015-11-23 16:40 UTC

BrowscapPhp B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	248
Duplicated Lines	14.52 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

100%

Importance

Changes	11
Bugs	0	Features	1

Metric	Value
wmc	52
c	11
b	0
f	1
lcom	1
cbo	11
dl	36
loc	248
ccs	93
cts	93
cp	1
rs	7.9487

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getName()	0	4	1
A	getComposerPackageName()	0	4	1
A	getVersion()	0	6	1
A	setParser()	0	4	1
A	getParser()	0	4	1
A	getDeviceModelDefaultValues()	0	9	1
A	isBot()	0	8	3
A	hasResult()	0	12	3
B	hydrateBotResult()	0	18	9
B	hydrateBrowser()	12	12	5
B	hydrateRenderingEngine()	12	12	5
B	hydrateOperatingSystem()	12	12	5
C	hydrateDevice()	0	25	12
B	parse()	0	36	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
{
    protected $defaultValues = [
        'DefaultProperties',
        'Default Browser',

        'unknown',
    ];

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

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

    public function getName()
    {
        return 'BrowscapPhp';
    }

    public function getComposerPackageName()
    {
        return 'browscap/browscap-php';
    }

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

    /**
     *
     * @param Browscap $parser
     */
    public function setParser(Browscap $parser)
    {
        $this->parser = $parser;
    }

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

        return true;
    }

    /**
     *
     * @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
     * @param Model\UserAgent $result
     */
    private function hydrateBotResult(stdClass $resultRaw, Model\UserAgent $result)
    {
        $bot = $result->getBot();
        $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 stdClass        $resultRaw
     * @param Model\UserAgent $result
     */
    private function hydrateBrowser(stdClass $resultRaw, Model\UserAgent $result)

    {
        $browser = $result->getBrowser();

        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 stdClass        $resultRaw
     * @param Model\UserAgent $result
     */
    private function hydrateRenderingEngine(stdClass $resultRaw, Model\UserAgent $result)

    {
        $renderingEngine = $result->getRenderingEngine();

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

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

    /**
     *
     * @param stdClass        $resultRaw
     * @param Model\UserAgent $result
     */
    private function hydrateOperatingSystem(stdClass $resultRaw, Model\UserAgent $result)

    {
        $operatingSystem = $result->getOperatingSystem();

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

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

    /**
     * 
     * @param stdClass        $resultRaw
     * @param Model\UserAgent $result
     */
    private function hydrateDevice(stdClass $resultRaw, Model\UserAgent $result)
    {
        $device = $result->getDevice();

        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->hydrateBotResult($resultRaw, $result);

            return $result;
        }

        $this->hydrateBrowser($resultRaw, $result);
        $this->hydrateRenderingEngine($resultRaw, $result);
        $this->hydrateOperatingSystem($resultRaw, $result);
        $this->hydrateDevice($resultRaw, $result);

        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			protected $defaultValues = [
12			'DefaultProperties',
13			'Default Browser',
14
15			'unknown',
16			];
17
18			/**
19			*
20			* @var Browscap
21			*/
22			private $parser;
23
24	15		public function __construct(Browscap $parser)
25			{
26	15		$this->setParser($parser);
27	15		}
28
29	1		public function getName()
30			{
31	1		return 'BrowscapPhp';
32			}
33
34	1		public function getComposerPackageName()
35			{
36	1		return 'browscap/browscap-php';
37			}
38
39	1		public function getVersion()
40			{
41	1		return $this->getParser()
42	1		->getCache()
43	1		->getVersion();
44			}
45
46			/**
47			*
48			* @param Browscap $parser
49			*/
50	15		public function setParser(Browscap $parser)
51			{
52	15		$this->parser = $parser;
53	15		}
54
55			/**
56			*
57			* @return Browscap
58			*/
59	13		public function getParser()
60			{
61	13		return $this->parser;
62			}
63
64			/**
65			*
66			* @return array
67			*/
68	1		private function getDeviceModelDefaultValues()
69			{
70			return [
71	1		'general Desktop',
72	1		'general Mobile Device',
73	1		'general Mobile Phone',
74	1		'general Tablet',
75	1		];
76			}
77
78			/**
79			*
80			* @param stdClass $resultRaw
81			* @return boolean
82			*/
83	5		private function isBot(stdClass $resultRaw)
84			{
85	5		if (! isset($resultRaw->crawler) \|\| $resultRaw->crawler !== true) {
86	2		return false;
87			}
88
89	3		return true;
90			}
91
92			/**
93			*
94			* @param stdClass $resultRaw
95			*
96			* @return bool
97			*/
98	11		private function hasResult(stdClass $resultRaw)
99			{
100	11		if (! isset($resultRaw->browser)) {
101	2		return false;
102			}
103
104	9		if ($this->isRealResult($resultRaw->browser) !== true) {
105	4		return false;
106			}
107
108	5		return true;
109			}
110
111			/**
112			*
113			* @param stdClass $resultRaw
114			* @param Model\UserAgent $result
115			*/
116	3		private function hydrateBotResult(stdClass $resultRaw, Model\UserAgent $result)
117			{
118	3		$bot = $result->getBot();
119	3		$bot->setIsBot(true);
120
121	3		if (isset($resultRaw->browser) && $this->isRealResult($resultRaw->browser) === true) {
122	3		$bot->setName($resultRaw->browser);
123			}
124
125			// @todo convert to a common set of types (over all vendors)
126	3		if (isset($resultRaw->issyndicationreader) && $resultRaw->issyndicationreader === true) {
127	1		$bot->setType('RSS');
128	3		} elseif (isset($resultRaw->browser_type) && $resultRaw->browser_type === 'Bot/Crawler') {
129	1		$bot->setType('Crawler');
130	2		} elseif (isset($resultRaw->browser_type) && $this->isRealResult($resultRaw->browser_type) === true) {
131	1		$bot->setType($resultRaw->browser_type);
132			}
133	3		}
134
135			/**
136			*
137			* @param stdClass $resultRaw
138			* @param Model\UserAgent $result
139			*/
140	2	View Code Duplication	private function hydrateBrowser(stdClass $resultRaw, Model\UserAgent $result)
			0 ignored issues – show Duplication introduced 2015-11-23 16:45 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...
141			{
142	2		$browser = $result->getBrowser();
143
144	2		if (isset($resultRaw->browser) && $this->isRealResult($resultRaw->browser) === true) {
145	2		$browser->setName($resultRaw->browser);
146			}
147
148	2		if (isset($resultRaw->version) && $this->isRealResult($resultRaw->version) === true) {
149	2		$browser->getVersion()->setComplete($resultRaw->version);
150			}
151	2		}
152
153			/**
154			*
155			* @param stdClass $resultRaw
156			* @param Model\UserAgent $result
157			*/
158	2	View Code Duplication	private function hydrateRenderingEngine(stdClass $resultRaw, Model\UserAgent $result)
			0 ignored issues – show Duplication introduced 2015-11-23 16:45 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...
159			{
160	2		$renderingEngine = $result->getRenderingEngine();
161
162	2		if (isset($resultRaw->renderingengine_name) && $this->isRealResult($resultRaw->renderingengine_name) === true) {
163	1		$renderingEngine->setName($resultRaw->renderingengine_name);
164			}
165
166	2		if (isset($resultRaw->renderingengine_version) && $this->isRealResult($resultRaw->renderingengine_version) === true) {
167	1		$renderingEngine->getVersion()->setComplete($resultRaw->renderingengine_version);
168			}
169	2		}
170
171			/**
172			*
173			* @param stdClass $resultRaw
174			* @param Model\UserAgent $result
175			*/
176	2	View Code Duplication	private function hydrateOperatingSystem(stdClass $resultRaw, Model\UserAgent $result)
			0 ignored issues – show Duplication introduced 2015-11-23 16:45 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...
177			{
178	2		$operatingSystem = $result->getOperatingSystem();
179
180	2		if (isset($resultRaw->platform) && $this->isRealResult($resultRaw->platform) === true) {
181	1		$operatingSystem->setName($resultRaw->platform);
182			}
183
184	2		if (isset($resultRaw->platform_version) && $this->isRealResult($resultRaw->platform_version) === true) {
185	1		$operatingSystem->getVersion()->setComplete($resultRaw->platform_version);
186			}
187	2		}
188
189			/**
190			*
191			* @param stdClass $resultRaw
192			* @param Model\UserAgent $result
193			*/
194	2		private function hydrateDevice(stdClass $resultRaw, Model\UserAgent $result)
195			{
196	2		$device = $result->getDevice();
197
198	2		if (isset($resultRaw->device_name) && $this->isRealResult($resultRaw->device_name, $this->getDeviceModelDefaultValues()) === true) {
199	1		$device->setModel($resultRaw->device_name);
200			}
201
202	2		if (isset($resultRaw->device_brand_name) && $this->isRealResult($resultRaw->device_brand_name) === true) {
203	1		$device->setBrand($resultRaw->device_brand_name);
204			}
205
206	2		if (isset($resultRaw->device_type) && $this->isRealResult($resultRaw->device_type) === true) {
207			// @todo convert to a common set of types (over all vendors)
208	1		$device->setType($resultRaw->device_type);
209			}
210
211	2		if (isset($resultRaw->ismobiledevice) && $this->isRealResult($resultRaw->ismobiledevice) === true && $resultRaw->ismobiledevice === true) {
212	1		$device->setIsMobile(true);
213			}
214
215	2		if (isset($resultRaw->device_pointing_method) && $resultRaw->device_pointing_method == 'touchscreen') {
216	1		$device->setIsTouch(true);
217			}
218	2		}
219
220	11		public function parse($userAgent, array $headers = [])
221			{
222	11		$parser = $this->getParser();
223
224			/* @var $resultRaw \stdClass */
225	11		$resultRaw = $parser->getBrowser($userAgent);
226
227			/*
228			* No result found?
229			*/
230	11		if ($this->hasResult($resultRaw) !== true) {
231	6		throw new Exception\NoResultFoundException('No result found for user agent: ' . $userAgent);
232			}
233
234			/*
235			* Hydrate the model
236			*/
237	5		$result = new Model\UserAgent();
238	5		$result->setProviderResultRaw($resultRaw);
239
240			/*
241			* Bot detection (does only work with full_php_browscap.ini)
242			*/
243	5		if ($this->isBot($resultRaw) === true) {
244	3		$this->hydrateBotResult($resultRaw, $result);
245
246	3		return $result;
247			}
248
249	2		$this->hydrateBrowser($resultRaw, $result);
250	2		$this->hydrateRenderingEngine($resultRaw, $result);
251	2		$this->hydrateOperatingSystem($resultRaw, $result);
252	2		$this->hydrateDevice($resultRaw, $result);
253
254	2		return $result;
255			}
256			}
257

ThaDafinser / UserAgentParser

GitHub Access Token became invalid