UAParser::getDeviceModelDefaultValues() - Code Metrics - Inspection of "rewrite filter generic" - ThaDafinser/UserAgentParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#59)

by Martin

created 2016-02-16 12:48 UTC

UAParser::getDeviceModelDefaultValues() A

↳ Parent: UAParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	5
nc	1
nop	0
crap	1

<?php
namespace UserAgentParser\Provider;

use UAParser\Parser;
use UserAgentParser\Exception\NoResultFoundException;
use UserAgentParser\Exception\PackageNotLoadedException;
use UserAgentParser\Model;

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

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

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

    protected $detectionCapabilities = [

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

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

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

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

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

    protected $defaultValues = [

        'general' => [
            '/^Other$/i',
        ],

        'device' => [

            'brand' => [
                '/^Generic/i',
            ],

            'model' => [
                '/^Smartphone$/i',
                '/^Feature Phone$/i',
                '/^iOS-Device$/i',
                '/^Tablet$/i',
                '/^Touch$/i',
                '/^Windows$/i',
                '/^Windows Phone$/i',
            ],
        ],

        'bot' => [
            'name' => [
                '/^Other$/i',
                '/^crawler$/i',
                '/^robot$/i',
                '/^crawl$/i',
                '/^Spider$/i',
            ],
        ],
    ];

    private $parser;

    /**
     *
     * @param  Parser                    $parser
     * @throws PackageNotLoadedException
     */
    public function __construct(Parser $parser = null)

    {
        if ($parser === null && ! file_exists('vendor/' . $this->getPackageName() . '/composer.json')) {
            throw new PackageNotLoadedException('You need to install the package ' . $this->getPackageName() . ' to use this provider');
        }

        $this->parser = $parser;
    }

    /**
     *
     * @return Parser
     */
    public function getParser()
    {
        if ($this->parser !== null) {
            return $this->parser;
        }

        $this->parser = Parser::create();

        return $this->parser;
    }

    /**
     *
     * @param \UAParser\Result\Client $resultRaw
     *
     * @return bool
     */
    private function hasResult(\UAParser\Result\Client $resultRaw)
    {
        if ($this->isRealResult($resultRaw->ua->family)) {
            return true;
        }

        if ($this->isRealResult($resultRaw->os->family)) {
            return true;
        }

        if ($this->isRealResult($resultRaw->device->model, 'device', 'model')) {
            return true;
        }

        return false;
    }

    /**
     *
     * @param \UAParser\Result\Client $resultRaw
     *
     * @return bool
     */
    private function isBot(\UAParser\Result\Client $resultRaw)
    {
        if ($resultRaw->device->family === 'Spider') {
            return true;
        }

        return false;
    }

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

        if ($this->isRealResult($resultRaw->ua->family, 'bot', 'name') === true) {
            $bot->setName($resultRaw->ua->family);
        }
    }

    /**
     *
     * @param Model\Browser              $browser
     * @param \UAParser\Result\UserAgent $uaRaw
     */
    private function hydrateBrowser(Model\Browser $browser, \UAParser\Result\UserAgent $uaRaw)

    {
        if ($this->isRealResult($uaRaw->family) === true) {
            $browser->setName($uaRaw->family);
        }

        if ($this->isRealResult($uaRaw->major) === true) {
            $browser->getVersion()->setMajor($uaRaw->major);
        }

        if ($this->isRealResult($uaRaw->minor) === true) {
            $browser->getVersion()->setMinor($uaRaw->minor);
        }

        if ($this->isRealResult($uaRaw->patch) === true) {
            $browser->getVersion()->setPatch($uaRaw->patch);
        }
    }

    /**
     *
     * @param Model\OperatingSystem            $os
     * @param \UAParser\Result\OperatingSystem $osRaw
     */
    private function hydrateOperatingSystem(Model\OperatingSystem $os, \UAParser\Result\OperatingSystem $osRaw)

    {
        if ($this->isRealResult($osRaw->family) === true) {
            $os->setName($osRaw->family);
        }

        if ($this->isRealResult($osRaw->major) === true) {
            $os->getVersion()->setMajor($osRaw->major);
        }

        if ($this->isRealResult($osRaw->minor) === true) {
            $os->getVersion()->setMinor($osRaw->minor);
        }

        if ($this->isRealResult($osRaw->patch) === true) {
            $os->getVersion()->setPatch($osRaw->patch);
        }
    }

    /**
     *
     * @param Model\UserAgent         $device
     * @param \UAParser\Result\Device $deviceRaw
     */
    private function hydrateDevice(Model\Device $device, \UAParser\Result\Device $deviceRaw)
    {
        if ($this->isRealResult($deviceRaw->model, 'device', 'model') === true) {
            $device->setModel($deviceRaw->model);
        }

        if ($this->isRealResult($deviceRaw->brand, 'device', 'brand') === true) {
            $device->setBrand($deviceRaw->brand);
        }
    }

    public function parse($userAgent, array $headers = [])
    {
        $parser = $this->getParser();

        /* @var $resultRaw \UAParser\Result\Client */
        $resultRaw = $parser->parse($userAgent);

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

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

        /*
         * Bot detection
         */
        if ($this->isBot($resultRaw) === true) {
            $this->hydrateBot($result->getBot(), $resultRaw);

            return $result;
        }

        /*
         * hydrate the result
         */
        $this->hydrateBrowser($result->getBrowser(), $resultRaw->ua);
        // renderingEngine not available
        $this->hydrateOperatingSystem($result->getOperatingSystem(), $resultRaw->os);
        $this->hydrateDevice($result->getDevice(), $resultRaw->device);

        return $result;
    }
}


1			<?php
2			namespace UserAgentParser\Provider;
3
4			use UAParser\Parser;
5			use UserAgentParser\Exception\NoResultFoundException;
6			use UserAgentParser\Exception\PackageNotLoadedException;
7			use UserAgentParser\Model;
8
9			class UAParser extends AbstractProvider
10			{
11			/**
12			* Name of the provider
13			*
14			* @var string
15			*/
16			protected $name = 'UAParser';
17
18			/**
19			* Homepage of the provider
20			*
21			* @var string
22			*/
23			protected $homepage = 'https://github.com/ua-parser/uap-php';
24
25			/**
26			* Composer package name
27			*
28			* @var string
29			*/
30			protected $packageName = 'ua-parser/uap-php';
31
32			protected $detectionCapabilities = [
33
34			'browser' => [
35			'name' => true,
36			'version' => true,
37			],
38
39			'renderingEngine' => [
40			'name' => false,
41			'version' => false,
42			],
43
44			'operatingSystem' => [
45			'name' => true,
46			'version' => true,
47			],
48
49			'device' => [
50			'model' => true,
51			'brand' => true,
52			'type' => false,
53			'isMobile' => false,
54			'isTouch' => false,
55			],
56
57			'bot' => [
58			'isBot' => true,
59			'name' => true,
60			'type' => false,
61			],
62			];
63
64			protected $defaultValues = [
65
66			'general' => [
67			'/^Other$/i',
68			],
69
70			'device' => [
71
72			'brand' => [
73			'/^Generic/i',
74			],
75
76			'model' => [
77			'/^Smartphone$/i',
78			'/^Feature Phone$/i',
79			'/^iOS-Device$/i',
80			'/^Tablet$/i',
81			'/^Touch$/i',
82			'/^Windows$/i',
83			'/^Windows Phone$/i',
84			],
85			],
86
87			'bot' => [
88			'name' => [
89			'/^Other$/i',
90			'/^crawler$/i',
91			'/^robot$/i',
92			'/^crawl$/i',
93			'/^Spider$/i',
94			],
95			],
96			];
97
98			private $parser;
99
100			/**
101			*
102			* @param Parser $parser
103			* @throws PackageNotLoadedException
104			*/
105	28	View Code Duplication	public function __construct(Parser $parser = null)
			0 ignored issues – show Duplication introduced 2015-12-09 14:43 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...
106			{
107	28		if ($parser === null && ! file_exists('vendor/' . $this->getPackageName() . '/composer.json')) {
108	1		throw new PackageNotLoadedException('You need to install the package ' . $this->getPackageName() . ' to use this provider');
109			}
110
111	27		$this->parser = $parser;
112	27		}
113
114			/**
115			*
116			* @return Parser
117			*/
118	6		public function getParser()
119			{
120	6		if ($this->parser !== null) {
121	6		return $this->parser;
122			}
123
124	1		$this->parser = Parser::create();
125
126	1		return $this->parser;
127			}
128
129			/**
130			*
131			* @param \UAParser\Result\Client $resultRaw
132			*
133			* @return bool
134			*/
135	5		private function hasResult(\UAParser\Result\Client $resultRaw)
136			{
137	5		if ($this->isRealResult($resultRaw->ua->family)) {
138	2		return true;
139			}
140
141	3		if ($this->isRealResult($resultRaw->os->family)) {
142	1		return true;
143			}
144
145	2		if ($this->isRealResult($resultRaw->device->model, 'device', 'model')) {
146	1		return true;
147			}
148
149	1		return false;
150			}
151
152			/**
153			*
154			* @param \UAParser\Result\Client $resultRaw
155			*
156			* @return bool
157			*/
158	4		private function isBot(\UAParser\Result\Client $resultRaw)
159			{
160	4		if ($resultRaw->device->family === 'Spider') {
161	1		return true;
162			}
163
164	3		return false;
165			}
166
167			/**
168			*
169			* @param Model\Bot $bot
170			* @param \UAParser\Result\Client $resultRaw
171			*/
172	1		private function hydrateBot(Model\Bot $bot, \UAParser\Result\Client $resultRaw)
173			{
174	1		$bot->setIsBot(true);
175
176	1		if ($this->isRealResult($resultRaw->ua->family, 'bot', 'name') === true) {
177	1		$bot->setName($resultRaw->ua->family);
178	1		}
179	1		}
180
181			/**
182			*
183			* @param Model\Browser $browser
184			* @param \UAParser\Result\UserAgent $uaRaw
185			*/
186	3	View Code Duplication	private function hydrateBrowser(Model\Browser $browser, \UAParser\Result\UserAgent $uaRaw)
			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...
187			{
188	3		if ($this->isRealResult($uaRaw->family) === true) {
189	1		$browser->setName($uaRaw->family);
190	1		}
191
192	3		if ($this->isRealResult($uaRaw->major) === true) {
193	1		$browser->getVersion()->setMajor($uaRaw->major);
194	1		}
195
196	3		if ($this->isRealResult($uaRaw->minor) === true) {
197	1		$browser->getVersion()->setMinor($uaRaw->minor);
198	1		}
199
200	3		if ($this->isRealResult($uaRaw->patch) === true) {
201	1		$browser->getVersion()->setPatch($uaRaw->patch);
202	1		}
203	3		}
204
205			/**
206			*
207			* @param Model\OperatingSystem $os
208			* @param \UAParser\Result\OperatingSystem $osRaw
209			*/
210	3	View Code Duplication	private function hydrateOperatingSystem(Model\OperatingSystem $os, \UAParser\Result\OperatingSystem $osRaw)
			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	3		if ($this->isRealResult($osRaw->family) === true) {
213	1		$os->setName($osRaw->family);
214	1		}
215
216	3		if ($this->isRealResult($osRaw->major) === true) {
217	1		$os->getVersion()->setMajor($osRaw->major);
218	1		}
219
220	3		if ($this->isRealResult($osRaw->minor) === true) {
221	1		$os->getVersion()->setMinor($osRaw->minor);
222	1		}
223
224	3		if ($this->isRealResult($osRaw->patch) === true) {
225	1		$os->getVersion()->setPatch($osRaw->patch);
226	1		}
227	3		}
228
229			/**
230			*
231			* @param Model\UserAgent $device
232			* @param \UAParser\Result\Device $deviceRaw
233			*/
234	3		private function hydrateDevice(Model\Device $device, \UAParser\Result\Device $deviceRaw)
235			{
236	3		if ($this->isRealResult($deviceRaw->model, 'device', 'model') === true) {
237	1		$device->setModel($deviceRaw->model);
238	1		}
239
240	3		if ($this->isRealResult($deviceRaw->brand, 'device', 'brand') === true) {
241	1		$device->setBrand($deviceRaw->brand);
242	1		}
243	3		}
244
245	5		public function parse($userAgent, array $headers = [])
246			{
247	5		$parser = $this->getParser();
248
249			/* @var $resultRaw \UAParser\Result\Client */
250	5		$resultRaw = $parser->parse($userAgent);
251
252			/*
253			* No result found?
254			*/
255	5		if ($this->hasResult($resultRaw) !== true) {
256	1		throw new NoResultFoundException('No result found for user agent: ' . $userAgent);
257			}
258
259			/*
260			* Hydrate the model
261			*/
262	4		$result = new Model\UserAgent();
263	4		$result->setProviderResultRaw($resultRaw);
264
265			/*
266			* Bot detection
267			*/
268	4		if ($this->isBot($resultRaw) === true) {
269	1		$this->hydrateBot($result->getBot(), $resultRaw);
270
271	1		return $result;
272			}
273
274			/*
275			* hydrate the result
276			*/
277	3		$this->hydrateBrowser($result->getBrowser(), $resultRaw->ua);
278			// renderingEngine not available
279	3		$this->hydrateOperatingSystem($result->getOperatingSystem(), $resultRaw->os);
280	3		$this->hydrateDevice($result->getDevice(), $resultRaw->device);
281
282	3		return $result;
283			}
284			}
285

ThaDafinser / UserAgentParser

GitHub Access Token became invalid

Pull Request — master (#59)

UAParser::getDeviceModelDefaultValues() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like