Complex classes like ResultPrinter often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ResultPrinter, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
14 | class ResultPrinter |
||
15 | { |
||
16 | /** |
||
17 | * A collection of ExecutableTest objects |
||
18 | * |
||
19 | * @var array |
||
20 | */ |
||
21 | protected $suites = []; |
||
22 | |||
23 | /** |
||
24 | * @var \ParaTest\Logging\LogInterpreter |
||
25 | */ |
||
26 | protected $results; |
||
27 | |||
28 | /** |
||
29 | * The number of tests results currently printed. |
||
30 | * Used to determine when to tally current results |
||
31 | * and start a new row |
||
32 | * |
||
33 | * @var int |
||
34 | */ |
||
35 | protected $numTestsWidth; |
||
36 | |||
37 | /** |
||
38 | * Used for formatting results to a given width |
||
39 | * |
||
40 | * @var int |
||
41 | */ |
||
42 | protected $maxColumn; |
||
43 | |||
44 | /** |
||
45 | * The total number of cases to be run |
||
46 | * |
||
47 | * @var int |
||
48 | */ |
||
49 | protected $totalCases = 0; |
||
50 | |||
51 | /** |
||
52 | * The current column being printed to |
||
53 | * |
||
54 | * @var int |
||
55 | */ |
||
56 | protected $column = 0; |
||
57 | |||
58 | /** |
||
59 | * @var \PHP_Timer |
||
60 | */ |
||
61 | protected $timer; |
||
62 | |||
63 | /** |
||
64 | * The total number of cases printed so far |
||
65 | * |
||
66 | * @var int |
||
67 | */ |
||
68 | protected $casesProcessed = 0; |
||
69 | |||
70 | /** |
||
71 | * Whether to display a red or green bar |
||
72 | * |
||
73 | * @var bool |
||
74 | */ |
||
75 | protected $colors; |
||
76 | |||
77 | /** |
||
78 | * Warnings generated by the cases |
||
79 | * |
||
80 | * @var array |
||
81 | */ |
||
82 | protected $warnings = []; |
||
83 | |||
84 | /** |
||
85 | * Number of columns |
||
86 | * |
||
87 | * @var integer |
||
88 | */ |
||
89 | protected $numberOfColumns = 80; |
||
90 | |||
91 | /** |
||
92 | * Number of skipped or incomplete tests |
||
93 | * |
||
94 | * @var integer |
||
95 | */ |
||
96 | protected $totalSkippedOrIncomplete = 0; |
||
97 | |||
98 | /** |
||
99 | * Do we need to try to process skipped/incompleted tests. |
||
100 | * |
||
101 | * @var boolean |
||
102 | */ |
||
103 | protected $processSkipped = false; |
||
104 | |||
105 | 27 | public function __construct(LogInterpreter $results) |
|
110 | |||
111 | /** |
||
112 | * Adds an ExecutableTest to the tracked results |
||
113 | * |
||
114 | * @param ExecutableTest $suite |
||
115 | * @return $this |
||
116 | */ |
||
117 | 16 | public function addTest(ExecutableTest $suite) |
|
125 | |||
126 | /** |
||
127 | * Initializes printing constraints, prints header |
||
128 | * information and starts the test timer |
||
129 | * |
||
130 | * @param Options $options |
||
131 | */ |
||
132 | 9 | public function start(Options $options) |
|
152 | |||
153 | /** |
||
154 | * @param string $string |
||
155 | */ |
||
156 | 2 | public function println($string = "") |
|
161 | |||
162 | /** |
||
163 | * Prints all results and removes any log files |
||
164 | * used for aggregating results |
||
165 | */ |
||
166 | public function flush() |
||
171 | |||
172 | /** |
||
173 | * Print final results |
||
174 | */ |
||
175 | 2 | public function printResults() |
|
183 | |||
184 | /** |
||
185 | * Prints the individual "quick" feedback for run |
||
186 | * tests, that is the ".EF" items |
||
187 | * |
||
188 | * @param ExecutableTest $test |
||
189 | */ |
||
190 | 11 | public function printFeedback(ExecutableTest $test) |
|
208 | |||
209 | /** |
||
210 | * Returns the header containing resource usage |
||
211 | * |
||
212 | * @return string |
||
213 | */ |
||
214 | 3 | public function getHeader() |
|
218 | |||
219 | /** |
||
220 | * Add an array of warning strings. These cause the test run to be shown |
||
221 | * as failed |
||
222 | */ |
||
223 | public function addWarnings(array $warnings) |
||
227 | |||
228 | /** |
||
229 | * Returns warning messages as a string |
||
230 | */ |
||
231 | 2 | public function getWarnings() |
|
235 | |||
236 | /** |
||
237 | * Whether the test run is successful and has no warnings |
||
238 | * |
||
239 | * @return bool |
||
240 | */ |
||
241 | 4 | public function isSuccessful() |
|
245 | |||
246 | /** |
||
247 | * Return the footer information reporting success |
||
248 | * or failure |
||
249 | * |
||
250 | * @return string |
||
251 | */ |
||
252 | 4 | public function getFooter() |
|
258 | |||
259 | /** |
||
260 | * Returns the failure messages |
||
261 | * |
||
262 | * @return string |
||
263 | */ |
||
264 | 3 | public function getFailures() |
|
270 | |||
271 | /** |
||
272 | * Returns error messages |
||
273 | * |
||
274 | * @return string |
||
275 | */ |
||
276 | 4 | public function getErrors() |
|
282 | |||
283 | /** |
||
284 | * Returns the total cases being printed |
||
285 | * |
||
286 | * @return int |
||
287 | */ |
||
288 | 2 | public function getTotalCases() |
|
292 | |||
293 | /** |
||
294 | * Process reader feedback and print it. |
||
295 | * |
||
296 | * @param Reader $reader |
||
297 | * @param int $expectedTestCount |
||
298 | */ |
||
299 | 11 | protected function processReaderFeedback($reader, $expectedTestCount) |
|
300 | { |
||
301 | 11 | $feedbackItems = $reader->getFeedback(); |
|
302 | |||
303 | 11 | $actualTestCount = count($feedbackItems); |
|
304 | |||
305 | 11 | $this->processTestOverhead($actualTestCount, $expectedTestCount); |
|
306 | |||
307 | 11 | foreach ($feedbackItems as $item) { |
|
308 | 11 | $this->printFeedbackItem($item); |
|
309 | 11 | if ($item === 'S') { |
|
310 | $this->totalSkippedOrIncomplete++; |
||
311 | } |
||
312 | } |
||
313 | |||
314 | 11 | if ($this->processSkipped) { |
|
315 | 4 | $this->printSkippedAndIncomplete($actualTestCount, $expectedTestCount); |
|
316 | } |
||
317 | 11 | } |
|
318 | |||
319 | /** |
||
320 | * Prints test warnings. |
||
321 | * |
||
322 | * @param ExecutableTest $test |
||
323 | */ |
||
324 | 11 | protected function printTestWarnings($test) |
|
334 | |||
335 | /** |
||
336 | * Is skipped/incomplete amount can be properly processed. |
||
337 | * |
||
338 | * @todo Skipped/Incomplete test tracking available only in functional mode for now |
||
339 | * or in regular mode but without group/exclude-group filters. |
||
340 | * |
||
341 | * @return boolean |
||
342 | */ |
||
343 | 9 | protected function isSkippedIncompleTestCanBeTracked($options) |
|
348 | |||
349 | /** |
||
350 | * Process test overhead. |
||
351 | * |
||
352 | * In some situations phpunit can return more tests then we expect and in that case |
||
353 | * this method correct total amount of tests so paratest progress will be auto corrected. |
||
354 | * |
||
355 | * @todo May be we need to throw Exception here instead of silent correction. |
||
356 | * |
||
357 | * @param int $actualTestCount |
||
358 | * @param int $expectedTestCount |
||
359 | */ |
||
360 | 11 | protected function processTestOverhead($actualTestCount, $expectedTestCount) |
|
373 | |||
374 | /** |
||
375 | * Prints S for skipped and incomplete tests. |
||
376 | * |
||
377 | * If for some reason process return less tests than expected then we threat all remaining |
||
378 | * as skipped or incomplete and print them as skipped (S letter) |
||
379 | * |
||
380 | * @param int $actualTestCount |
||
381 | * @param int $expectedTestCount |
||
382 | */ |
||
383 | 4 | protected function printSkippedAndIncomplete($actualTestCount, $expectedTestCount) |
|
392 | |||
393 | /** |
||
394 | * Prints a single "quick" feedback item and increments |
||
395 | * the total number of processed cases and the column |
||
396 | * position |
||
397 | * |
||
398 | * @param $item |
||
399 | */ |
||
400 | 11 | protected function printFeedbackItem($item) |
|
410 | |||
411 | /** |
||
412 | * Method that returns a formatted string |
||
413 | * for a collection of errors or failures |
||
414 | * |
||
415 | * @param array $defects |
||
416 | * @param $type |
||
417 | * @return string |
||
418 | */ |
||
419 | 5 | protected function getDefects(array $defects, $type) |
|
420 | { |
||
421 | 5 | $count = sizeof($defects); |
|
422 | 5 | if ($count == 0) { |
|
423 | 2 | return ''; |
|
424 | } |
||
425 | 5 | $output = sprintf( |
|
426 | 5 | "There %s %d %s%s:\n", |
|
427 | 5 | ($count == 1) ? 'was' : 'were', |
|
428 | $count, |
||
429 | $type, |
||
430 | 5 | ($count == 1) ? '' : 's' |
|
431 | ); |
||
432 | |||
433 | 5 | for ($i = 1; $i <= sizeof($defects); $i++) { |
|
434 | 5 | $output .= sprintf("\n%d) %s\n", $i, $defects[$i - 1]); |
|
435 | } |
||
436 | |||
437 | 5 | return $output; |
|
438 | } |
||
439 | |||
440 | /** |
||
441 | * Prints progress for large test collections |
||
442 | */ |
||
443 | 9 | protected function getProgress() |
|
452 | |||
453 | /** |
||
454 | * Get the footer for a test collection that had tests with |
||
455 | * failures or errors |
||
456 | * |
||
457 | * @return string |
||
458 | */ |
||
459 | 3 | private function getFailedFooter() |
|
460 | { |
||
461 | 3 | $formatString = "FAILURES!\nTests: %d, Assertions: %d, Failures: %d, Errors: %d.\n"; |
|
462 | |||
463 | 3 | return "\n" . $this->red( |
|
464 | 3 | sprintf( |
|
465 | $formatString, |
||
466 | 3 | $this->results->getTotalTests(), |
|
467 | 3 | $this->results->getTotalAssertions(), |
|
468 | 3 | $this->results->getTotalFailures(), |
|
469 | 3 | $this->results->getTotalErrors() |
|
470 | ) |
||
471 | ); |
||
472 | } |
||
473 | |||
474 | /** |
||
475 | * Get the footer for a test collection containing all successful |
||
476 | * tests |
||
477 | * |
||
478 | * @return string |
||
479 | */ |
||
480 | 1 | private function getSuccessFooter() |
|
481 | { |
||
482 | 1 | $tests = $this->totalCases; |
|
483 | 1 | $asserts = $this->results->getTotalAssertions(); |
|
484 | |||
485 | 1 | if ($this->totalSkippedOrIncomplete > 0) { |
|
486 | // phpunit 4.5 produce NOT plural version for test(s) and assertion(s) in that case |
||
487 | // also it shows result in standard color scheme |
||
488 | return sprintf( |
||
489 | "OK, but incomplete, skipped, or risky tests!\n" |
||
490 | . "Tests: %d, Assertions: %d, Incomplete: %d.\n", |
||
491 | $tests, |
||
492 | $asserts, |
||
493 | $this->totalSkippedOrIncomplete |
||
494 | ); |
||
495 | } else { |
||
496 | // phpunit 4.5 produce plural version for test(s) and assertion(s) in that case |
||
497 | // also it shows result as black text on green background |
||
498 | 1 | return $this->green(sprintf( |
|
499 | 1 | "OK (%d test%s, %d assertion%s)\n", |
|
500 | $tests, |
||
501 | 1 | ($tests == 1) ? '' : 's', |
|
502 | $asserts, |
||
503 | 1 | ($asserts == 1) ? '' : 's' |
|
504 | )); |
||
505 | } |
||
506 | } |
||
507 | |||
508 | 1 | private function green($text) |
|
517 | |||
518 | 3 | private function red($text) |
|
527 | |||
528 | /** |
||
529 | * Deletes all the temporary log files for ExecutableTest objects |
||
530 | * being printed |
||
531 | */ |
||
532 | private function clearLogs() |
||
538 | } |
||
539 |
Since your code implements the magic setter
_set
, this function will be called for any write access on an undefined variable. You can add the@property
annotation to your class or interface to document the existence of this variable.Since the property has write access only, you can use the @property-write annotation instead.
Of course, you may also just have mistyped another name, in which case you should fix the error.
See also the PhpDoc documentation for @property.