RequestRateParser::getRatio() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'" - VIPnytt/RobotsTxtParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5c065e...6cdc7d )

by Jan-Petter

created 2018-02-15 20:07 UTC

RequestRateParser::getRatio() A

↳ Parent: RequestRateParser

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	11
nc	3
nop	2

<?php
/**
 * vipnytt/RobotsTxtParser
 *
 * @link https://github.com/VIPnytt/RobotsTxtParser
 * @license https://github.com/VIPnytt/RobotsTxtParser/blob/master/LICENSE The MIT License (MIT)
 */

namespace vipnytt\RobotsTxtParser\Parser\Directives;

use vipnytt\RobotsTxtParser\Client\Directives\RequestRateClient;
use vipnytt\RobotsTxtParser\Handler\RenderHandler;
use vipnytt\RobotsTxtParser\RobotsTxtInterface;

/**
 * Class RequestRateParser
 *
 * @package vipnytt\RobotsTxtParser\Parser\Directives
 */
class RequestRateParser implements ParserInterface, RobotsTxtInterface
{
    use DirectiveParserTrait;

    /**
     * Base uri
     * @var string
     */
    private $base;

    /**
     * RequestRate array
     * @var array
     */
    private $requestRates = [];

    /**
     * Sorted
     * @var bool
     */
    private $sorted = false;

    /**
     * Time units
     * @var int[]
     */
    private $units = [
        'w' => 604800,
        'd' => 86400,
        'h' => 3600,
        'm' => 60,
    ];

    /**
     * RequestRate constructor.
     *
     * @param string $base
     */
    public function __construct($base)
    {
        $this->base = $base;
    }

    /**
     * Add
     *
     * @param string $line
     * @return bool
     */
    public function add($line)
    {
        $array = preg_split('/\s+/', $line, 2);
        $parts = array_map('trim', explode('/', $array[0]));
        if (count($parts) != 2) {
            return false;
        }
        $unit = strtolower(substr(preg_replace('/[^A-Za-z]/', '', filter_var($parts[1], FILTER_SANITIZE_STRING)), 0, 1));
        $multiplier = isset($this->units[$unit]) ? $this->units[$unit] : 1;

        $rate = (int)abs(filter_var($parts[0], FILTER_SANITIZE_NUMBER_INT));
        $time = $multiplier * (int)abs(filter_var($parts[1], FILTER_SANITIZE_NUMBER_INT));

        $result = [
            'rate' => $time / $rate,
            'ratio' => $this->getRatio($rate, $time),
            'from' => null,
            'to' => null,
        ];
        if (!empty($array[1]) &&
            ($times = $this->draftParseTime($array[1])) !== false
        ) {
            $result = array_merge($result, $times);
        }
        $this->requestRates[] = $result;
        return true;
    }

    /**
     * Get ratio string
     *
     * @param int $rate
     * @param int $time
     * @return string
     */
    private function getRatio($rate, $time)
    {
        $gcd = $this->getGCD($rate, $time);
        $requests = $rate / $gcd;
        $time = $time / $gcd;
        $suffix = 's';
        foreach ($this->units as $unit => $sec) {
            if ($time % $sec === 0) {
                $suffix = $unit;
                $time /= $sec;
                break;
            }
        }
        return $requests . '/' . $time . $suffix;
    }

    /**
     * Returns the greatest common divisor of two integers using the Euclidean algorithm.
     *
     * @param int $a
     * @param int $b
     * @return int
     */
    private function getGCD($a, $b)
    {
        if (extension_loaded('gmp')) {
            return gmp_intval(gmp_gcd((string)$a, (string)$b));
        }
        $large = $a > $b ? $a : $b;
        $small = $a > $b ? $b : $a;
        $remainder = $large % $small;
        return 0 === $remainder ? $small : $this->getGCD($small, $remainder);
    }

    /**
     * Client
     *
     * @param string $userAgent
     * @param float|int $fallbackValue
     * @return RequestRateClient
     */
    public function client($userAgent = self::USER_AGENT, $fallbackValue = 0)
    {
        $this->sort();
        return new RequestRateClient($this->base, $userAgent, $this->requestRates, $fallbackValue);
    }

    /**
     * Sort
     *
     * @return bool
     */
    private function sort()
    {
        if (!$this->sorted) {
            $this->sorted = true;
            return usort($this->requestRates, function (array $requestRateA, array $requestRateB) {
                // PHP 7: Switch to the <=> "Spaceship" operator
                return $requestRateB['rate'] > $requestRateA['rate'];
            });
        }
        return $this->sorted;
    }

    /**
     * Render
     *
     * @param RenderHandler $handler
     * @return bool
     */
    public function render(RenderHandler $handler)
    {
        $this->sort();
        foreach ($this->requestRates as $array) {

            $time = '';
            if (isset($array['from']) &&
                isset($array['to'])
            ) {
                $time .= ' ' . $array['from'] . '-' . $array['to'];
            }
            $handler->add(self::DIRECTIVE_REQUEST_RATE, $array['ratio'] . $time);
        }
        return true;
    }
}


1		<?php
2		/**
3		* vipnytt/RobotsTxtParser
4		*
5		* @link https://github.com/VIPnytt/RobotsTxtParser
6		* @license https://github.com/VIPnytt/RobotsTxtParser/blob/master/LICENSE The MIT License (MIT)
7		*/
8
9		namespace vipnytt\RobotsTxtParser\Parser\Directives;
10
11		use vipnytt\RobotsTxtParser\Client\Directives\RequestRateClient;
12		use vipnytt\RobotsTxtParser\Handler\RenderHandler;
13		use vipnytt\RobotsTxtParser\RobotsTxtInterface;
14
15		/**
16		* Class RequestRateParser
17		*
18		* @package vipnytt\RobotsTxtParser\Parser\Directives
19		*/
20		class RequestRateParser implements ParserInterface, RobotsTxtInterface
21		{
22		use DirectiveParserTrait;
23
24		/**
25		* Base uri
26		* @var string
27		*/
28		private $base;
29
30		/**
31		* RequestRate array
32		* @var array
33		*/
34		private $requestRates = [];
35
36		/**
37		* Sorted
38		* @var bool
39		*/
40		private $sorted = false;
41
42		/**
43		* Time units
44		* @var int[]
45		*/
46		private $units = [
47		'w' => 604800,
48		'd' => 86400,
49		'h' => 3600,
50		'm' => 60,
51		];
52
53		/**
54		* RequestRate constructor.
55		*
56		* @param string $base
57		*/
58		public function __construct($base)
59		{
60		$this->base = $base;
61		}
62
63		/**
64		* Add
65		*
66		* @param string $line
67		* @return bool
68		*/
69		public function add($line)
70		{
71		$array = preg_split('/\s+/', $line, 2);
72		$parts = array_map('trim', explode('/', $array[0]));
73		if (count($parts) != 2) {
74		return false;
75		}
76		$unit = strtolower(substr(preg_replace('/[^A-Za-z]/', '', filter_var($parts[1], FILTER_SANITIZE_STRING)), 0, 1));
77		$multiplier = isset($this->units[$unit]) ? $this->units[$unit] : 1;
78
79		$rate = (int)abs(filter_var($parts[0], FILTER_SANITIZE_NUMBER_INT));
80		$time = $multiplier * (int)abs(filter_var($parts[1], FILTER_SANITIZE_NUMBER_INT));
81
82		$result = [
83		'rate' => $time / $rate,
84		'ratio' => $this->getRatio($rate, $time),
85		'from' => null,
86		'to' => null,
87		];
88		if (!empty($array[1]) &&
89		($times = $this->draftParseTime($array[1])) !== false
90		) {
91		$result = array_merge($result, $times);
92		}
93		$this->requestRates[] = $result;
94		return true;
95		}
96
97		/**
98		* Get ratio string
99		*
100		* @param int $rate
101		* @param int $time
102		* @return string
103		*/
104		private function getRatio($rate, $time)
105		{
106		$gcd = $this->getGCD($rate, $time);
107		$requests = $rate / $gcd;
108		$time = $time / $gcd;
109		$suffix = 's';
110		foreach ($this->units as $unit => $sec) {
111		if ($time % $sec === 0) {
112		$suffix = $unit;
113		$time /= $sec;
114		break;
115		}
116		}
117		return $requests . '/' . $time . $suffix;
118		}
119
120		/**
121		* Returns the greatest common divisor of two integers using the Euclidean algorithm.
122		*
123		* @param int $a
124		* @param int $b
125		* @return int
126		*/
127		private function getGCD($a, $b)
128		{
129		if (extension_loaded('gmp')) {
130		return gmp_intval(gmp_gcd((string)$a, (string)$b));
131		}
132		$large = $a > $b ? $a : $b;
133		$small = $a > $b ? $b : $a;
134		$remainder = $large % $small;
135		return 0 === $remainder ? $small : $this->getGCD($small, $remainder);
136		}
137
138		/**
139		* Client
140		*
141		* @param string $userAgent
142		* @param float\|int $fallbackValue
143		* @return RequestRateClient
144		*/
145		public function client($userAgent = self::USER_AGENT, $fallbackValue = 0)
146		{
147		$this->sort();
148		return new RequestRateClient($this->base, $userAgent, $this->requestRates, $fallbackValue);
149		}
150
151		/**
152		* Sort
153		*
154		* @return bool
155		*/
156		private function sort()
157		{
158		if (!$this->sorted) {
159		$this->sorted = true;
160		return usort($this->requestRates, function (array $requestRateA, array $requestRateB) {
161		// PHP 7: Switch to the <=> "Spaceship" operator
162		return $requestRateB['rate'] > $requestRateA['rate'];
163		});
164		}
165		return $this->sorted;
166		}
167
168		/**
169		* Render
170		*
171		* @param RenderHandler $handler
172		* @return bool
173		*/
174		public function render(RenderHandler $handler)
175		{
176		$this->sort();
177	View Code Duplication	foreach ($this->requestRates as $array) {
		0 ignored issues – show Duplication introduced 2016-08-08 13:45 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...
178		$time = '';
179		if (isset($array['from']) &&
180		isset($array['to'])
181		) {
182		$time .= ' ' . $array['from'] . '-' . $array['to'];
183		}
184		$handler->add(self::DIRECTIVE_REQUEST_RATE, $array['ratio'] . $time);
185		}
186		return true;
187		}
188		}
189

VIPnytt / RobotsTxtParser

Push — master ( 5c065e...6cdc7d )

RequestRateParser::getRatio() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like