Style::titleLineFrom() - Code Metrics - Inspection of "Merge pull request #87 from nunomaduro/analysis-GD..." - nunomaduro/collision - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — stable ( 8ba0c8...0d8cdb )

by Nuno

created 2020-01-31 22:00 UTC

Style::titleLineFrom() A

↳ Parent: Style

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	0
cts	12
cp	0
rs	9.6666
c	0
b	0
f	0
cc	1
nc	1
nop	4
crap	2

<?php

/**
 * This file is part of Collision.
 *
 * (c) Nuno Maduro <[email protected]>
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 */

namespace NunoMaduro\Collision\Adapters\Phpunit;

use NunoMaduro\Collision\Writer;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\ExceptionWrapper;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\ConsoleSectionOutput;
use Throwable;
use Whoops\Exception\Inspector;

/**
 * @internal
 */
final class Style
{
    /**
     * @var ConsoleOutput
     */
    private $output;

    /**
     * @var ConsoleSectionOutput
     */
    private $footer;

    /**
     * Style constructor.
     *
     * @param  ConsoleOutput  $output
     */
    public function __construct(ConsoleOutput $output)
    {
        $this->output = $output;

        $this->footer = $output->section();
    }

    /**
     * Prints the content similar too:.
     *
     * ```
     *    PASS  Unit\ExampleTest
     *    ✓ basic test
     * ```
     *
     * @param  State  $state
     *
     * @return void
     */
    public function writeCurrentRecap(State $state): void
    {
        if (! $state->testCaseTestsCount()) {
            return;
        }

        $this->footer->clear();

        $this->output->writeln($this->titleLineFrom(
            $state->getTestCaseTitle() === 'FAIL' ? 'white' : 'black',
            $state->getTestCaseTitleColor(),
            $state->getTestCaseTitle(),
            $state->testCaseClass
        ));

        $state->eachTestCaseTests(function (TestResult $testResult) {
            $this->output->writeln($this->testLineFrom(
                $testResult->color,
                $testResult->icon,
                $testResult->description,
                $testResult->warning
            ));
        });
    }

    /**
     * Prints the content similar too on the footer. Where
     * we are updating the current test.
     *
     * ```
     *    Runs  Unit\ExampleTest
     *    • basic test
     * ```
     *
     * @param  State  $state
     * @param  TestCase|null  $testCase
     *
     * @return void
     */
    public function updateFooter(State $state, TestCase $testCase = null): void
    {
        $runs = [];

        if ($testCase) {
            $runs[] = $this->titleLineFrom(
                'black',
                'yellow',
                'RUNS',
                get_class($testCase)
            );

            $testResult = TestResult::fromTestCase($testCase, TestResult::RUNS);
            $runs[] = $this->testLineFrom(
                $testResult->color,
                $testResult->icon,
                $testResult->description
            );
        }

        $types = [TestResult::FAIL, TestResult::WARN, TestResult::RISKY, TestResult::INCOMPLETE, TestResult::SKIPPED, TestResult::PASS];

        foreach ($types as $type) {
            if ($countTests = $state->countTestsInTestSuiteBy($type)) {
                $color = TestResult::makeColor($type);
                $tests[] = "<fg=$color;options=bold>$countTests $type</>";
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            }
        }

        $pending = $state->suiteTotalTests - $state->testSuiteTestsCount();
        if ($pending) {
            $tests[] = "$pending pending";
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        }

        if (! empty($tests)) {
            $this->footer->overwrite(array_merge($runs, [
                '',
                sprintf(
                    '  <fg=white;options=bold>Tests:  </><fg=default>%s</>',
                    implode(', ', $tests)
                ),
            ]));
        }
    }

    /**
     * Writes the final recap.
     *
     * @param  Timer  $timer
     */
    public function writeRecap(Timer $timer): void
    {
        $timeElapsed = number_format($timer->result(), 2, '.', '');
        $this->footer->writeln(
            sprintf(
                '  <fg=white;options=bold>Time:   </><fg=default>%ss</>',
                $timeElapsed
            )
        );
    }

    /**
     * Displays the error using Collision's writer
     * and terminates with exit code === 1.
     *
     * @param  Throwable  $throwable
     *
     * @return void
     */
    public function writeError(State $state, Throwable $throwable)
    {
        $this->writeCurrentRecap($state);

        $this->updateFooter($state);

        $writer = (new Writer())->setOutput($this->output);

        if ($throwable instanceof AssertionFailedError) {
            $writer->showTitle(false);
            $this->output->write('', true);
        }

        $writer->ignoreFilesIn([
            '/vendor\/phpunit\/phpunit\/src/',
            '/vendor\/mockery\/mockery/',
            '/vendor\/laravel\/framework\/src\/Illuminate\/Testing/',
            '/vendor\/laravel\/framework\/src\/Illuminate\/Foundation\/Testing/',
        ]);

        if ($throwable instanceof ExceptionWrapper && $throwable->getOriginalException() !== null) {
            $throwable = $throwable->getOriginalException();
        }

        $inspector = new Inspector($throwable);

        $writer->write($inspector);

        if ($throwable instanceof ExpectationFailedException && $comparisionFailure = $throwable->getComparisonFailure()) {
            $this->output->write($comparisionFailure->getDiff());
        }

        exit(1);
    }

    /**
     * Returns the title contents.
     *
     * @param  string  $fg
     * @param  string  $bg
     * @param  string  $title
     * @param  string  $testCaseClass
     *
     * @return string
     */
    private function titleLineFrom(string $fg, string $bg, string $title, string $testCaseClass): string
    {
        $classParts = explode('\\', $testCaseClass);
        // Removes `Tests` part
        array_shift($classParts);
        $highlightedPart = array_pop($classParts);
        $nonHighlightedPart = implode('\\', $classParts);

        $testCaseClass = sprintf("\e[2m%s\e[22m<fg=white;options=bold>%s</>", "$nonHighlightedPart\\", $highlightedPart);

        return sprintf(
            "\n  <fg=%s;bg=%s;options=bold> %s </><fg=default> %s</>",
            $fg,
            $bg,
            $title,
            $testCaseClass
        );
    }

    /**
     * Returns the test contents.
     *
     * @param  string  $fg
     * @param  string  $icon
     * @param  string  $description
     *
     * @return string
     */
    private function testLineFrom(string $fg, string $icon, string $description, string $warning = null): string
    {
        if (! empty($warning)) {
            $warning = sprintf(
                ' → %s',
                $warning
            );
        }

        return sprintf(
            "  <fg=%s;options=bold>%s</><fg=default> \e[2m%s\e[22m</><fg=yellow>%s</>",
            $fg,
            $icon,
            $description,
            $warning
        );
    }
}


1		<?php
2
3		/**
4		* This file is part of Collision.
5		*
6		* (c) Nuno Maduro <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace NunoMaduro\Collision\Adapters\Phpunit;
13
14		use NunoMaduro\Collision\Writer;
15		use PHPUnit\Framework\AssertionFailedError;
16		use PHPUnit\Framework\ExceptionWrapper;
17		use PHPUnit\Framework\ExpectationFailedException;
18		use PHPUnit\Framework\TestCase;
19		use Symfony\Component\Console\Output\ConsoleOutput;
20		use Symfony\Component\Console\Output\ConsoleSectionOutput;
21		use Throwable;
22		use Whoops\Exception\Inspector;
23
24		/**
25		* @internal
26		*/
27		final class Style
28		{
29		/**
30		* @var ConsoleOutput
31		*/
32		private $output;
33
34		/**
35		* @var ConsoleSectionOutput
36		*/
37		private $footer;
38
39		/**
40		* Style constructor.
41		*
42		* @param ConsoleOutput $output
43		*/
44	3	public function __construct(ConsoleOutput $output)
45		{
46	3	$this->output = $output;
47
48	3	$this->footer = $output->section();
49	3	}
50
51		/**
52		* Prints the content similar too:.
53		*
54		* ```
55		* PASS Unit\ExampleTest
56		* ✓ basic test
57		* ```
58		*
59		* @param State $state
60		*
61		* @return void
62		*/
63		public function writeCurrentRecap(State $state): void
64		{
65		if (! $state->testCaseTestsCount()) {
66		return;
67		}
68
69		$this->footer->clear();
70
71		$this->output->writeln($this->titleLineFrom(
72		$state->getTestCaseTitle() === 'FAIL' ? 'white' : 'black',
73		$state->getTestCaseTitleColor(),
74		$state->getTestCaseTitle(),
75		$state->testCaseClass
76		));
77
78		$state->eachTestCaseTests(function (TestResult $testResult) {
79		$this->output->writeln($this->testLineFrom(
80		$testResult->color,
81		$testResult->icon,
82		$testResult->description,
83		$testResult->warning
84		));
85		});
86		}
87
88		/**
89		* Prints the content similar too on the footer. Where
90		* we are updating the current test.
91		*
92		* ```
93		* Runs Unit\ExampleTest
94		* • basic test
95		* ```
96		*
97		* @param State $state
98		* @param TestCase\|null $testCase
99		*
100		* @return void
101		*/
102		public function updateFooter(State $state, TestCase $testCase = null): void
103		{
104		$runs = [];
105
106		if ($testCase) {
107		$runs[] = $this->titleLineFrom(
108		'black',
109		'yellow',
110		'RUNS',
111		get_class($testCase)
112		);
113
114		$testResult = TestResult::fromTestCase($testCase, TestResult::RUNS);
115		$runs[] = $this->testLineFrom(
116		$testResult->color,
117		$testResult->icon,
118		$testResult->description
119		);
120		}
121
122		$types = [TestResult::FAIL, TestResult::WARN, TestResult::RISKY, TestResult::INCOMPLETE, TestResult::SKIPPED, TestResult::PASS];
123
124		foreach ($types as $type) {
125		if ($countTests = $state->countTestsInTestSuiteBy($type)) {
126		$color = TestResult::makeColor($type);
127		$tests[] = "<fg=$color;options=bold>$countTests $type</>";
		0 ignored issues – show Coding Style Comprehensibility introduced 2020-01-31 22:16 UTC by Report Bug Copy Issue Report `$tests` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$tests = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
128		}
129		}
130
131		$pending = $state->suiteTotalTests - $state->testSuiteTestsCount();
132		if ($pending) {
133		$tests[] = "$pending pending";
		0 ignored issues – show Bug introduced 2020-01-31 22:16 UTC by Report Bug Copy Issue Report The variable `$tests` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
134		}
135
136		if (! empty($tests)) {
137		$this->footer->overwrite(array_merge($runs, [
138		'',
139		sprintf(
140		' <fg=white;options=bold>Tests: </><fg=default>%s</>',
141		implode(', ', $tests)
142		),
143		]));
144		}
145		}
146
147		/**
148		* Writes the final recap.
149		*
150		* @param Timer $timer
151		*/
152		public function writeRecap(Timer $timer): void
153		{
154		$timeElapsed = number_format($timer->result(), 2, '.', '');
155		$this->footer->writeln(
156		sprintf(
157		' <fg=white;options=bold>Time: </><fg=default>%ss</>',
158		$timeElapsed
159		)
160		);
161		}
162
163		/**
164		* Displays the error using Collision's writer
165		* and terminates with exit code === 1.
166		*
167		* @param Throwable $throwable
168		*
169		* @return void
170		*/
171		public function writeError(State $state, Throwable $throwable)
172		{
173		$this->writeCurrentRecap($state);
174
175		$this->updateFooter($state);
176
177		$writer = (new Writer())->setOutput($this->output);
178
179		if ($throwable instanceof AssertionFailedError) {
180		$writer->showTitle(false);
181		$this->output->write('', true);
182		}
183
184		$writer->ignoreFilesIn([
185		'/vendor\/phpunit\/phpunit\/src/',
186		'/vendor\/mockery\/mockery/',
187		'/vendor\/laravel\/framework\/src\/Illuminate\/Testing/',
188		'/vendor\/laravel\/framework\/src\/Illuminate\/Foundation\/Testing/',
189		]);
190
191		if ($throwable instanceof ExceptionWrapper && $throwable->getOriginalException() !== null) {
192		$throwable = $throwable->getOriginalException();
193		}
194
195		$inspector = new Inspector($throwable);
196
197		$writer->write($inspector);
198
199		if ($throwable instanceof ExpectationFailedException && $comparisionFailure = $throwable->getComparisonFailure()) {
200		$this->output->write($comparisionFailure->getDiff());
201		}
202
203		exit(1);
204		}
205
206		/**
207		* Returns the title contents.
208		*
209		* @param string $fg
210		* @param string $bg
211		* @param string $title
212		* @param string $testCaseClass
213		*
214		* @return string
215		*/
216		private function titleLineFrom(string $fg, string $bg, string $title, string $testCaseClass): string
217		{
218		$classParts = explode('\\', $testCaseClass);
219		// Removes `Tests` part
220		array_shift($classParts);
221		$highlightedPart = array_pop($classParts);
222		$nonHighlightedPart = implode('\\', $classParts);
223
224		$testCaseClass = sprintf("\e[2m%s\e[22m<fg=white;options=bold>%s</>", "$nonHighlightedPart\\", $highlightedPart);
225
226		return sprintf(
227		"\n <fg=%s;bg=%s;options=bold> %s </><fg=default> %s</>",
228		$fg,
229		$bg,
230		$title,
231		$testCaseClass
232		);
233		}
234
235		/**
236		* Returns the test contents.
237		*
238		* @param string $fg
239		* @param string $icon
240		* @param string $description
241		*
242		* @return string
243		*/
244		private function testLineFrom(string $fg, string $icon, string $description, string $warning = null): string
245		{
246		if (! empty($warning)) {
247		$warning = sprintf(
248		' → %s',
249		$warning
250		);
251		}
252
253		return sprintf(
254		" <fg=%s;options=bold>%s</><fg=default> \e[2m%s\e[22m</><fg=yellow>%s</>",
255		$fg,
256		$icon,
257		$description,
258		$warning
259		);
260		}
261		}
262

nunomaduro / collision

Push — stable ( 8ba0c8...0d8cdb )

Style::titleLineFrom() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like