DisAllowParser::getRules() - Code Metrics - Inspection of "Merge branch '2.0-dev' of https://github.com/VIPny..." - VIPnytt/RobotsTxtParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 2.0-dev (4f313a)

by Jan-Petter

created 2016-06-03 21:10 UTC

DisAllowParser::getRules() A

↳ Parent: DisAllowParser

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	2
eloc	6
nc	2
nop	0

<?php
namespace vipnytt\RobotsTxtParser\Parser\Directives;

use vipnytt\RobotsTxtParser\Exceptions;
use vipnytt\RobotsTxtParser\Parser\UrlParser;
use vipnytt\RobotsTxtParser\RobotsTxtInterface;

/**
 * Class DisAllowParser
 *
 * @package vipnytt\RobotsTxtParser\Parser\Directives
 */
class DisAllowParser implements ParserInterface, RobotsTxtInterface
{
    use DirectiveParserCommons;
    use UrlParser;

    /**
     * Directive alternatives
     */
    const DIRECTIVE = [
        self::DIRECTIVE_ALLOW,
        self::DIRECTIVE_DISALLOW,
    ];

    /**
     * Sub directives white list
     */
    const SUB_DIRECTIVES = [
        self::DIRECTIVE_CLEAN_PARAM,
        self::DIRECTIVE_HOST,
    ];

    /**
     * Directive
     * @var string
     */
    private $directive;

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

    /**
     * User-agent
     * @var string
     */
    private $userAgent;

    /**
     * Rule array
     * @var array
     */
    private $array = [];

    /**
     * Sub-directive Clean-param
     * @var CleanParamParser
     */
    private $cleanParam;

    /**
     * Sub-directive Host
     * @var HostParser
     */
    private $host;

    /**
     * DisAllow constructor
     *
     * @param string $base
     * @param string $userAgent
     * @param string $directive
     */
    public function __construct($base, $userAgent, $directive)
    {
        $this->base = $base;
        $this->userAgent = $userAgent;
        $this->directive = $this->validateDirective($directive, self::DIRECTIVE);
        $this->cleanParam = new CleanParamParser();
        $this->host = new HostParser();
    }

    /**
     * Add
     *
     * @param string $line
     * @return bool
     */
    public function add($line)
    {
        $pair = $this->generateRulePair($line, self::SUB_DIRECTIVES);
        switch ($pair['directive']) {
            case self::DIRECTIVE_CLEAN_PARAM:
                return $this->cleanParam->add($pair['value']);
            case self::DIRECTIVE_HOST:
                return $this->host->add($pair['value']);
        }
        return $this->addPath($line);
    }

    /**
     * Add plain path to allow/disallow
     *
     * @param string $rule
     * @return bool
     */
    protected function addPath($rule)
    {
        if (isset($this->array['path']) && in_array($rule, $this->array['path'])) {
            return false;
        }
        $this->array['path'][] = $rule;
        return true;
    }

    /**
     * Check
     *
     * @param  string $url
     * @return bool
     */
    public function check($url)
    {
        $path = $this->getPath($url);
        return ($path === false) ? false : (
            $this->checkPath($path, isset($this->array['path']) ? $this->array['path'] : []) ||
            $this->cleanParam->check($path) ||
            $this->host->check($url)
        );
    }

    /**
     * Get path and query
     *
     * @param string $url
     * @return string
     * @throws Exceptions\ClientException
     */
    protected function getPath($url)
    {
        // Encode
        $url = $this->urlEncode($url);
        if (mb_stripos($url, '/') === 0) {

            // Strip fragments
            $url = mb_split('#', $url)[0];
            return $url;
        }
        if (!$this->urlValidate($url)) {
            throw new Exceptions\ClientException('Invalid URL');
        }
        $path = (($path = parse_url($url, PHP_URL_PATH)) === null) ? '/' : $path;
        $query = (($query = parse_url($url, PHP_URL_QUERY)) === null) ? '' : '?' . $query;
        return $path . $query;
    }

    /**
     * Rule array
     *
     * @return array
     */
    public function getRules()
    {
        $result = array_merge(
            $this->array,
            $this->cleanParam->getRules(),
            $this->host->getRules()
        );
        return empty($result) ? [] : [$this->directive => $result];
    }

    /**
     * Render
     *
     * @return string[]
     */
    public function render()
    {
        $result = [];
        $render = array_merge(
            $this->array,
            $this->cleanParam->render(),
            $this->host->render()
        );
        foreach ($render as $value) {
            if (is_array($value)) {
                foreach ($value as $path) {
                    $result[] = $this->directive . ':' . $path;
                }
                continue;
            }
            $result[] = $this->directive . ':' . $value;
        }
        return $result;
    }
}


1		<?php
2		namespace vipnytt\RobotsTxtParser\Parser\Directives;
3
4		use vipnytt\RobotsTxtParser\Exceptions;
5		use vipnytt\RobotsTxtParser\Parser\UrlParser;
6		use vipnytt\RobotsTxtParser\RobotsTxtInterface;
7
8		/**
9		* Class DisAllowParser
10		*
11		* @package vipnytt\RobotsTxtParser\Parser\Directives
12		*/
13		class DisAllowParser implements ParserInterface, RobotsTxtInterface
14		{
15		use DirectiveParserCommons;
16		use UrlParser;
17
18		/**
19		* Directive alternatives
20		*/
21		const DIRECTIVE = [
22		self::DIRECTIVE_ALLOW,
23		self::DIRECTIVE_DISALLOW,
24		];
25
26		/**
27		* Sub directives white list
28		*/
29		const SUB_DIRECTIVES = [
30		self::DIRECTIVE_CLEAN_PARAM,
31		self::DIRECTIVE_HOST,
32		];
33
34		/**
35		* Directive
36		* @var string
37		*/
38		private $directive;
39
40		/**
41		* Base Uri
42		* @var string
43		*/
44		private $base;
45
46		/**
47		* User-agent
48		* @var string
49		*/
50		private $userAgent;
51
52		/**
53		* Rule array
54		* @var array
55		*/
56		private $array = [];
57
58		/**
59		* Sub-directive Clean-param
60		* @var CleanParamParser
61		*/
62		private $cleanParam;
63
64		/**
65		* Sub-directive Host
66		* @var HostParser
67		*/
68		private $host;
69
70		/**
71		* DisAllow constructor
72		*
73		* @param string $base
74		* @param string $userAgent
75		* @param string $directive
76		*/
77		public function __construct($base, $userAgent, $directive)
78		{
79		$this->base = $base;
80		$this->userAgent = $userAgent;
81		$this->directive = $this->validateDirective($directive, self::DIRECTIVE);
82		$this->cleanParam = new CleanParamParser();
83		$this->host = new HostParser();
84		}
85
86		/**
87		* Add
88		*
89		* @param string $line
90		* @return bool
91		*/
92		public function add($line)
93		{
94		$pair = $this->generateRulePair($line, self::SUB_DIRECTIVES);
95		switch ($pair['directive']) {
96		case self::DIRECTIVE_CLEAN_PARAM:
97		return $this->cleanParam->add($pair['value']);
98		case self::DIRECTIVE_HOST:
99		return $this->host->add($pair['value']);
100		}
101		return $this->addPath($line);
102		}
103
104		/**
105		* Add plain path to allow/disallow
106		*
107		* @param string $rule
108		* @return bool
109		*/
110		protected function addPath($rule)
111		{
112		if (isset($this->array['path']) && in_array($rule, $this->array['path'])) {
113		return false;
114		}
115		$this->array['path'][] = $rule;
116		return true;
117		}
118
119		/**
120		* Check
121		*
122		* @param string $url
123		* @return bool
124		*/
125		public function check($url)
126		{
127		$path = $this->getPath($url);
128		return ($path === false) ? false : (
129		$this->checkPath($path, isset($this->array['path']) ? $this->array['path'] : []) \|\|
130		$this->cleanParam->check($path) \|\|
131		$this->host->check($url)
132		);
133		}
134
135		/**
136		* Get path and query
137		*
138		* @param string $url
139		* @return string
140		* @throws Exceptions\ClientException
141		*/
142		protected function getPath($url)
143		{
144		// Encode
145		$url = $this->urlEncode($url);
146	View Code Duplication	if (mb_stripos($url, '/') === 0) {
		0 ignored issues – show Duplication introduced 2016-05-23 18: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...
147		// Strip fragments
148		$url = mb_split('#', $url)[0];
149		return $url;
150		}
151		if (!$this->urlValidate($url)) {
152		throw new Exceptions\ClientException('Invalid URL');
153		}
154		$path = (($path = parse_url($url, PHP_URL_PATH)) === null) ? '/' : $path;
155		$query = (($query = parse_url($url, PHP_URL_QUERY)) === null) ? '' : '?' . $query;
156		return $path . $query;
157		}
158
159		/**
160		* Rule array
161		*
162		* @return array
163		*/
164		public function getRules()
165		{
166		$result = array_merge(
167		$this->array,
168		$this->cleanParam->getRules(),
169		$this->host->getRules()
170		);
171		return empty($result) ? [] : [$this->directive => $result];
172		}
173
174		/**
175		* Render
176		*
177		* @return string[]
178		*/
179		public function render()
180		{
181		$result = [];
182		$render = array_merge(
183		$this->array,
184		$this->cleanParam->render(),
185		$this->host->render()
186		);
187		foreach ($render as $value) {
188		if (is_array($value)) {
189		foreach ($value as $path) {
190		$result[] = $this->directive . ':' . $path;
191		}
192		continue;
193		}
194		$result[] = $this->directive . ':' . $value;
195		}
196		return $result;
197		}
198		}
199

VIPnytt / RobotsTxtParser

Branch — 2.0-dev (4f313a)

DisAllowParser::getRules() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like