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:
1 | <?php |
||
16 | class SpiderTest extends TestCase |
||
17 | { |
||
18 | /** |
||
19 | * @var Spider |
||
20 | */ |
||
21 | protected $spider; |
||
22 | |||
23 | /** |
||
24 | * @var logHandler |
||
25 | */ |
||
26 | protected $logHandler; |
||
27 | |||
28 | /** |
||
29 | * @var StatsHandler |
||
30 | */ |
||
31 | protected $statsHandler; |
||
32 | |||
33 | /** |
||
34 | * @var PHPUnit_Framework_MockObject_MockObject |
||
35 | */ |
||
36 | protected $requestHandler; |
||
37 | |||
38 | /** @var DiscoveredUri */ |
||
39 | protected $linkA; |
||
40 | /** @var DiscoveredUri */ |
||
41 | protected $linkB; |
||
42 | /** @var DiscoveredUri */ |
||
43 | protected $linkC; |
||
44 | /** @var DiscoveredUri */ |
||
45 | protected $linkD; |
||
46 | /** @var DiscoveredUri */ |
||
47 | protected $linkE; |
||
48 | /** @var DiscoveredUri */ |
||
49 | protected $linkF; |
||
50 | /** @var DiscoveredUri */ |
||
51 | protected $linkG; |
||
52 | |||
53 | /** @var Response */ |
||
54 | protected $responseA; |
||
55 | /** @var Response */ |
||
56 | protected $responseB; |
||
57 | /** @var Response */ |
||
58 | protected $responseC; |
||
59 | /** @var Response */ |
||
60 | protected $responseD; |
||
61 | /** @var Response */ |
||
62 | protected $responseE; |
||
63 | /** @var Response */ |
||
64 | protected $responseF; |
||
65 | /** @var Response */ |
||
66 | protected $responseG; |
||
67 | |||
68 | /** @var string */ |
||
69 | protected $hrefA; |
||
70 | protected $hrefB; |
||
71 | protected $hrefC; |
||
72 | protected $hrefD; |
||
73 | protected $hrefE; |
||
74 | protected $hrefF; |
||
75 | protected $hrefG; |
||
76 | |||
77 | /** |
||
78 | * @var array An associative array, containing a map of $this->linkX to $this->responseX. |
||
79 | */ |
||
80 | protected $linkToResponseMap = []; |
||
81 | |||
82 | /** |
||
83 | * Sets up the fixture, for example, opens a network connection. |
||
84 | * This method is called before a test is executed. |
||
85 | * |
||
86 | * Setting up the following structure: |
||
87 | * |
||
88 | * 0: A |
||
89 | * /|\ |
||
90 | * 1: B C E |
||
91 | * /| | | |
||
92 | * 2: D F G | |
||
93 | * | _ | |
||
94 | * |
||
95 | * Note: E links to F. |
||
96 | */ |
||
97 | protected function setUp() |
||
98 | { |
||
99 | $this->spider = new Spider('http://php-spider.org/A'); |
||
100 | |||
101 | $this->requestHandler = $this->getMock('VDB\Spider\RequestHandler\RequestHandlerInterface'); |
||
102 | |||
103 | $this->hrefA = 'http://php-spider.org/A'; |
||
104 | $this->hrefB = 'http://php-spider.org/B'; |
||
105 | $this->hrefC = 'http://php-spider.org/C'; |
||
106 | $this->hrefD = 'http://php-spider.org/D'; |
||
107 | $this->hrefE = 'http://php-spider.org/E'; |
||
108 | $this->hrefF = 'http://php-spider.org/F'; |
||
109 | $this->hrefG = 'http://php-spider.org/G'; |
||
110 | |||
111 | $this->linkA = new DiscoveredUri(new Uri($this->hrefA)); |
||
112 | $this->linkB = new DiscoveredUri(new Uri($this->hrefB)); |
||
113 | $this->linkC = new DiscoveredUri(new Uri($this->hrefC)); |
||
114 | $this->linkD = new DiscoveredUri(new Uri($this->hrefD)); |
||
115 | $this->linkE = new DiscoveredUri(new Uri($this->hrefE)); |
||
116 | $this->linkF = new DiscoveredUri(new Uri($this->hrefF)); |
||
117 | $this->linkG = new DiscoveredUri(new Uri($this->hrefG)); |
||
118 | |||
119 | $this->linkA->setDepthFound(0); |
||
120 | $this->linkB->setDepthFound(1); |
||
121 | $this->linkC->setDepthFound(1); |
||
122 | $this->linkD->setDepthFound(2); |
||
123 | $this->linkE->setDepthFound(1); |
||
124 | $this->linkF->setDepthFound(2); |
||
125 | $this->linkG->setDepthFound(2); |
||
126 | |||
127 | $htmlA = file_get_contents(__DIR__ . '/Fixtures/SpiderTestHTMLResourceA.html'); |
||
128 | $this->responseA = new Response(200, null, $htmlA); |
||
129 | |||
130 | $htmlB = file_get_contents(__DIR__ . '/Fixtures/SpiderTestHTMLResourceB.html'); |
||
131 | $this->responseB = new Response(200, null, $htmlB); |
||
132 | |||
133 | $htmlC = file_get_contents(__DIR__ . '/Fixtures/SpiderTestHTMLResourceC.html'); |
||
134 | $this->responseC = new Response(200, null, $htmlC); |
||
135 | |||
136 | $htmlD = file_get_contents(__DIR__ . '/Fixtures/SpiderTestHTMLResourceD.html'); |
||
137 | $this->responseD = new Response(200, null, $htmlD); |
||
138 | |||
139 | $htmlE = file_get_contents(__DIR__ . '/Fixtures/SpiderTestHTMLResourceE.html'); |
||
140 | $this->responseE = new Response(200, null, $htmlE); |
||
141 | |||
142 | $htmlF = file_get_contents(__DIR__ . '/Fixtures/SpiderTestHTMLResourceF.html'); |
||
143 | $this->responseF = new Response(200, null, $htmlF); |
||
144 | |||
145 | $htmlG = file_get_contents(__DIR__ . '/Fixtures/SpiderTestHTMLResourceG.html'); |
||
146 | $this->responseG = new Response(200, null, $htmlG); |
||
147 | |||
148 | $this->linkToResponseMap[$this->linkA->toString()] = $this->responseA; |
||
149 | $this->linkToResponseMap[$this->linkB->toString()] = $this->responseB; |
||
150 | $this->linkToResponseMap[$this->linkC->toString()] = $this->responseC; |
||
151 | $this->linkToResponseMap[$this->linkD->toString()] = $this->responseD; |
||
152 | $this->linkToResponseMap[$this->linkE->toString()] = $this->responseE; |
||
153 | $this->linkToResponseMap[$this->linkF->toString()] = $this->responseF; |
||
154 | $this->linkToResponseMap[$this->linkG->toString()] = $this->responseG; |
||
155 | |||
156 | $this->requestHandler |
||
157 | ->expects($this->any()) |
||
158 | ->method('request') |
||
159 | ->will($this->returnCallback(array($this, 'doTestRequest'))); |
||
160 | |||
161 | $this->spider->getDownloader()->setRequestHandler($this->requestHandler); |
||
162 | |||
163 | $this->spider->getDiscovererSet()->set(new XPathExpressionDiscoverer('//a')); |
||
164 | |||
165 | $this->statsHandler = new StatsHandler(); |
||
166 | $this->spider->getDispatcher()->addSubscriber($this->statsHandler); |
||
167 | $this->spider->getQueueManager()->getDispatcher()->addSubscriber($this->statsHandler); |
||
168 | $this->spider->getDownloader()->getDispatcher()->addSubscriber($this->statsHandler); |
||
169 | |||
170 | $this->logHandler = new LogHandler(); |
||
171 | $this->spider->getDispatcher()->addSubscriber($this->logHandler); |
||
172 | $this->spider->getQueueManager()->getDispatcher()->addSubscriber($this->logHandler); |
||
173 | $this->spider->getDownloader()->getDispatcher()->addSubscriber($this->logHandler); |
||
174 | } |
||
175 | |||
176 | /** |
||
177 | * @return Resource |
||
178 | * @throws \ErrorException |
||
179 | */ |
||
180 | public function doTestRequest() |
||
181 | { |
||
182 | $link = func_get_arg(0); |
||
183 | |||
184 | if (array_key_exists($link->toString(), $this->linkToResponseMap)) { |
||
185 | return $this->getResource($link, $this->linkToResponseMap[$link->toString()]); |
||
186 | } |
||
187 | |||
188 | throw new \ErrorException('The requested URI was not stubbed: ' . $link->toString()); |
||
189 | } |
||
190 | |||
191 | /** |
||
192 | * @covers VDB\Spider\Spider::crawl |
||
193 | * |
||
194 | * Behaviour as explained here: https://en.wikipedia.org/wiki/Depth-first_search#Example |
||
195 | */ |
||
196 | public function testCrawlDFSDefaultBehaviour() |
||
214 | |||
215 | /** |
||
216 | * @covers VDB\Spider\Spider::crawl |
||
217 | * |
||
218 | */ |
||
219 | public function testCrawlBFSDefaultBehaviour() |
||
238 | |||
239 | /** |
||
240 | * @covers VDB\Spider\Spider::crawl |
||
241 | * |
||
242 | * Behaviour as explained here: https://en.wikipedia.org/wiki/Depth-first_search#Example |
||
243 | * |
||
244 | * Given the following structure: |
||
245 | * |
||
246 | * 0: A |
||
247 | * /|\ |
||
248 | * 1: B C E |
||
249 | * /| | | |
||
250 | * 2: D F G | |
||
251 | * | _ | |
||
252 | * |
||
253 | * We expect the following result: A, E, C, B |
||
254 | * |
||
255 | */ |
||
256 | public function testCrawlDFSMaxDepthOne() |
||
271 | |||
272 | View Code Duplication | public function testCrawlBFSMaxDepthOne() |
|
288 | |||
289 | /** |
||
290 | * @covers VDB\Spider\Spider::crawl |
||
291 | */ |
||
292 | View Code Duplication | public function testCrawlDFSMaxQueueSize() |
|
307 | |||
308 | View Code Duplication | public function testCrawlBFSMaxQueueSize() |
|
324 | |||
325 | /** |
||
326 | * @covers VDB\Spider\Spider::crawl |
||
327 | */ |
||
328 | public function testCrawlFailedRequest() |
||
344 | } |
||
345 |