UserAgentParser::add() - Code Metrics - Inspection of "Refactoring" - VIPnytt/RobotsTxtParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 2.0-dev (d250b8)

by Jan-Petter

created 2016-05-29 19:53 UTC

UserAgentParser::add() D

↳ Parent: UserAgentParser

Complexity

Conditions	10
Paths	10

Size

Total Lines	34
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	34
rs	4.8196
cc	10
eloc	30
nc	10
nop	1

How to fix Complexity

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

use vipnytt\RobotsTxtParser\RobotsTxtInterface;

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

    /**
     * Sub directives white list
     */
    const SUB_DIRECTIVES = [
        self::DIRECTIVE_ALLOW,
        self::DIRECTIVE_CACHE_DELAY,
        self::DIRECTIVE_COMMENT,
        self::DIRECTIVE_CRAWL_DELAY,
        self::DIRECTIVE_DISALLOW,
        self::DIRECTIVE_REQUEST_RATE,
        self::DIRECTIVE_ROBOT_VERSION,
        self::DIRECTIVE_VISIT_TIME,
    ];

    /**
     * Directive
     */
    const DIRECTIVE = self::DIRECTIVE_USER_AGENT;

    /**
     * All User-agents declared
     * @var array
     */
    public $userAgents = [];

    /**
     * Sub-directive Allow
     * @var DisAllowParser[]
     */
    public $allow = [];

    /**
     * Sub-directive Cache-delay
     * @var CrawlDelayParser[]
     */
    public $cacheDelay = [];

    /**
     * Sub-directive Comment
     * @var CommentParser[]
     */
    public $comment = [];

    /**
     * Sub-directive Crawl-delay
     * @var CrawlDelayParser[]
     */
    public $crawlDelay = [];

    /**
     * Sub-directive Disallow
     * @var DisAllowParser[]
     */
    public $disallow = [];

    /**
     * Sub-directive RequestClient-rate
     * @var RequestRateParser[]
     */
    public $requestRate = [];

    /**
     * Sub-directive Robot-version
     * @var RobotVersionParser[]
     */
    public $robotVersion = [];

    /**
     * Sub-directive Visit-time
     * @var VisitTimeParser[]
     */
    public $visitTime = [];

    /**
     * Current User-agent(s)
     * @var array
     */
    protected $userAgent = [];

    /**
     * UserAgent constructor.
     */
    public function __construct()
    {
        $this->set();
    }

    /**
     * Set new User-agent
     *
     * @param array $array
     * @return bool
     */
    public function set(array $array = [self::USER_AGENT])
    {
        $this->userAgent = array_map('mb_strtolower', $array);
        foreach ($this->userAgent as $userAgent) {
            if (!in_array($userAgent, $this->userAgents)) {
                $this->allow[$userAgent] = new DisAllowParser(self::DIRECTIVE_ALLOW);
                $this->cacheDelay[$userAgent] = new CrawlDelayParser(self::DIRECTIVE_CACHE_DELAY);
                $this->comment[$userAgent] = new CommentParser();
                $this->crawlDelay[$userAgent] = new CrawlDelayParser(self::DIRECTIVE_CRAWL_DELAY);
                $this->disallow[$userAgent] = new DisAllowParser(self::DIRECTIVE_DISALLOW);
                $this->requestRate[$userAgent] = new RequestRateParser();
                $this->robotVersion[$userAgent] = new RobotVersionParser();
                $this->visitTime[$userAgent] = new VisitTimeParser();
                $this->userAgents[] = $userAgent;
            }
        }
        return true;
    }

    /**
     * Add
     *
     * @param string $line
     * @return bool
     */
    public function add($line)
    {
        $result = [];
        $pair = $this->generateRulePair($line, self::SUB_DIRECTIVES);
        foreach ($this->userAgent as $userAgent) {
            switch ($pair['directive']) {
                case self::DIRECTIVE_ALLOW:
                    $result[] = $this->allow[$userAgent]->add($pair['value']);
                    break;
                case self::DIRECTIVE_CACHE_DELAY:
                    $result[] = $this->cacheDelay[$userAgent]->add($pair['value']);
                    break;
                case self::DIRECTIVE_COMMENT:
                    $result[] = $this->comment[$userAgent]->add($pair['value']);
                    break;
                case self::DIRECTIVE_CRAWL_DELAY:
                    $result[] = $this->crawlDelay[$userAgent]->add($pair['value']);
                    break;
                case self::DIRECTIVE_DISALLOW:
                    $result[] = $this->disallow[$userAgent]->add($pair['value']);
                    break;
                case self::DIRECTIVE_REQUEST_RATE:
                    $result[] = $this->requestRate[$userAgent]->add($pair['value']);
                    break;
                case self::DIRECTIVE_ROBOT_VERSION:
                    $result[] = $this->robotVersion[$userAgent]->add($pair['value']);
                    break;
                case self::DIRECTIVE_VISIT_TIME:
                    $result[] = $this->visitTime[$userAgent]->add($pair['value']);
                    break;
            }
        }
        return in_array(true, $result, true);
    }

    /**
     * Export rules
     *
     * @return array
     */
    public function export()
    {
        $result = [];
        foreach ($this->userAgents as $userAgent) {
            $current = array_merge(
                $this->allow[$userAgent]->export(),
                $this->comment[$userAgent]->export(),
                $this->cacheDelay[$userAgent]->export(),
                $this->crawlDelay[$userAgent]->export(),
                $this->disallow[$userAgent]->export(),
                $this->requestRate[$userAgent]->export(),
                $this->robotVersion[$userAgent]->export(),
                $this->visitTime[$userAgent]->export()
            );
            if (!empty($current)) {
                $result[$userAgent] = $current;
            }
        }
        return empty($result) ? [] : [self::DIRECTIVE => $result];
    }

    /**
     * Render
     *
     * @return string[]
     */
    public function render()
    {
        $result = [];
        sort($this->userAgents);
        foreach ($this->userAgents as $userAgent) {
            $current = array_merge(
                $this->allow[$userAgent]->render(),
                $this->comment[$userAgent]->render(),
                $this->cacheDelay[$userAgent]->render(),
                $this->crawlDelay[$userAgent]->render(),
                $this->disallow[$userAgent]->render(),
                $this->requestRate[$userAgent]->render(),
                $this->robotVersion[$userAgent]->render(),
                $this->visitTime[$userAgent]->render()
            );
            if (!empty($current)) {
                $result = array_merge($result, [self::DIRECTIVE . ':' . $userAgent], $current);
            }
        }
        return $result;
    }
}


1			<?php
2			namespace vipnytt\RobotsTxtParser\Parser\Directives;
3
4			use vipnytt\RobotsTxtParser\RobotsTxtInterface;
5
6			/**
7			* Class UserAgentParser
8			*
9			* @package vipnytt\RobotsTxtParser\Parser\Directives
10			*/
11			class UserAgentParser implements ParserInterface, RobotsTxtInterface
12			{
13			use DirectiveParserCommons;
14
15			/**
16			* Sub directives white list
17			*/
18			const SUB_DIRECTIVES = [
19			self::DIRECTIVE_ALLOW,
20			self::DIRECTIVE_CACHE_DELAY,
21			self::DIRECTIVE_COMMENT,
22			self::DIRECTIVE_CRAWL_DELAY,
23			self::DIRECTIVE_DISALLOW,
24			self::DIRECTIVE_REQUEST_RATE,
25			self::DIRECTIVE_ROBOT_VERSION,
26			self::DIRECTIVE_VISIT_TIME,
27			];
28
29			/**
30			* Directive
31			*/
32			const DIRECTIVE = self::DIRECTIVE_USER_AGENT;
33
34			/**
35			* All User-agents declared
36			* @var array
37			*/
38			public $userAgents = [];
39
40			/**
41			* Sub-directive Allow
42			* @var DisAllowParser[]
43			*/
44			public $allow = [];
45
46			/**
47			* Sub-directive Cache-delay
48			* @var CrawlDelayParser[]
49			*/
50			public $cacheDelay = [];
51
52			/**
53			* Sub-directive Comment
54			* @var CommentParser[]
55			*/
56			public $comment = [];
57
58			/**
59			* Sub-directive Crawl-delay
60			* @var CrawlDelayParser[]
61			*/
62			public $crawlDelay = [];
63
64			/**
65			* Sub-directive Disallow
66			* @var DisAllowParser[]
67			*/
68			public $disallow = [];
69
70			/**
71			* Sub-directive RequestClient-rate
72			* @var RequestRateParser[]
73			*/
74			public $requestRate = [];
75
76			/**
77			* Sub-directive Robot-version
78			* @var RobotVersionParser[]
79			*/
80			public $robotVersion = [];
81
82			/**
83			* Sub-directive Visit-time
84			* @var VisitTimeParser[]
85			*/
86			public $visitTime = [];
87
88			/**
89			* Current User-agent(s)
90			* @var array
91			*/
92			protected $userAgent = [];
93
94			/**
95			* UserAgent constructor.
96			*/
97			public function __construct()
98			{
99			$this->set();
100			}
101
102			/**
103			* Set new User-agent
104			*
105			* @param array $array
106			* @return bool
107			*/
108			public function set(array $array = [self::USER_AGENT])
109			{
110			$this->userAgent = array_map('mb_strtolower', $array);
111			foreach ($this->userAgent as $userAgent) {
112			if (!in_array($userAgent, $this->userAgents)) {
113			$this->allow[$userAgent] = new DisAllowParser(self::DIRECTIVE_ALLOW);
114			$this->cacheDelay[$userAgent] = new CrawlDelayParser(self::DIRECTIVE_CACHE_DELAY);
115			$this->comment[$userAgent] = new CommentParser();
116			$this->crawlDelay[$userAgent] = new CrawlDelayParser(self::DIRECTIVE_CRAWL_DELAY);
117			$this->disallow[$userAgent] = new DisAllowParser(self::DIRECTIVE_DISALLOW);
118			$this->requestRate[$userAgent] = new RequestRateParser();
119			$this->robotVersion[$userAgent] = new RobotVersionParser();
120			$this->visitTime[$userAgent] = new VisitTimeParser();
121			$this->userAgents[] = $userAgent;
122			}
123			}
124			return true;
125			}
126
127			/**
128			* Add
129			*
130			* @param string $line
131			* @return bool
132			*/
133			public function add($line)
134			{
135			$result = [];
136			$pair = $this->generateRulePair($line, self::SUB_DIRECTIVES);
137			foreach ($this->userAgent as $userAgent) {
138			switch ($pair['directive']) {
139			case self::DIRECTIVE_ALLOW:
140			$result[] = $this->allow[$userAgent]->add($pair['value']);
141			break;
142			case self::DIRECTIVE_CACHE_DELAY:
143			$result[] = $this->cacheDelay[$userAgent]->add($pair['value']);
144			break;
145			case self::DIRECTIVE_COMMENT:
146			$result[] = $this->comment[$userAgent]->add($pair['value']);
147			break;
148			case self::DIRECTIVE_CRAWL_DELAY:
149			$result[] = $this->crawlDelay[$userAgent]->add($pair['value']);
150			break;
151			case self::DIRECTIVE_DISALLOW:
152			$result[] = $this->disallow[$userAgent]->add($pair['value']);
153			break;
154			case self::DIRECTIVE_REQUEST_RATE:
155			$result[] = $this->requestRate[$userAgent]->add($pair['value']);
156			break;
157			case self::DIRECTIVE_ROBOT_VERSION:
158			$result[] = $this->robotVersion[$userAgent]->add($pair['value']);
159			break;
160			case self::DIRECTIVE_VISIT_TIME:
161			$result[] = $this->visitTime[$userAgent]->add($pair['value']);
162			break;
163			}
164			}
165			return in_array(true, $result, true);
166			}
167
168			/**
169			* Export rules
170			*
171			* @return array
172			*/
173			public function export()
174			{
175			$result = [];
176			foreach ($this->userAgents as $userAgent) {
177			$current = array_merge(
178			$this->allow[$userAgent]->export(),
179			$this->comment[$userAgent]->export(),
180			$this->cacheDelay[$userAgent]->export(),
181			$this->crawlDelay[$userAgent]->export(),
182			$this->disallow[$userAgent]->export(),
183			$this->requestRate[$userAgent]->export(),
184			$this->robotVersion[$userAgent]->export(),
185			$this->visitTime[$userAgent]->export()
186			);
187			if (!empty($current)) {
188			$result[$userAgent] = $current;
189			}
190			}
191			return empty($result) ? [] : [self::DIRECTIVE => $result];
192			}
193
194			/**
195			* Render
196			*
197			* @return string[]
198			*/
199			public function render()
200			{
201			$result = [];
202			sort($this->userAgents);
203			foreach ($this->userAgents as $userAgent) {
204			$current = array_merge(
205			$this->allow[$userAgent]->render(),
206			$this->comment[$userAgent]->render(),
207			$this->cacheDelay[$userAgent]->render(),
208			$this->crawlDelay[$userAgent]->render(),
209			$this->disallow[$userAgent]->render(),
210			$this->requestRate[$userAgent]->render(),
211			$this->robotVersion[$userAgent]->render(),
212			$this->visitTime[$userAgent]->render()
213			);
214			if (!empty($current)) {
215			$result = array_merge($result, [self::DIRECTIVE . ':' . $userAgent], $current);
216			}
217			}
218			return $result;
219			}
220			}
221

VIPnytt / RobotsTxtParser

Branch — 2.0-dev (d250b8)

UserAgentParser::add() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like