LogPrinter - Code Metrics - Inspection of "Enable caching of Composer downloads in Travis bui..." - facile-it/paraunit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 979448...f8182d )

by Alessandro

created 2017-01-21 10:52 UTC

LogPrinter A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	297
Duplicated Lines	25.25 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

98.17%

Importance

Changes

Metric	Value
wmc	25
lcom	1
cbo	7
dl	75
loc	297
ccs	107
cts	109
cp	0.9817
rs	10
c	0
b	0
f	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getLogFilename()	0	6	1
A	__construct()	0	9	2
A	addError()	12	12	1
A	addWarning()	12	12	1
A	addFailure()	12	12	1
A	addIncompleteTest()	12	12	1
A	addRiskyTest()	12	12	1
A	addSkippedTest()	12	12	1
B	startTestSuite()	3	25	4
A	endTestSuite()	0	6	1
A	startTest()	0	13	1
A	endTest()	0	6	2
A	writeCase()	0	20	4
A	write()	0	16	3
A	getTestFilename()	0	6	1

How to fix Duplicated Code

<?php

namespace Paraunit\Parser\JSON;

/**
 * This class comes from \PHPUnit_Util_Log_JSON.
 * It's copied and refactored here because it's deprecated in PHPUnit 5.7 and it will be dropped in PHPUnit 6
 *
 * Class LogPrinter
 * @package Paraunit\Parser\JSON
 */
class LogPrinter extends \PHPUnit_Util_Printer implements \PHPUnit_Framework_TestListener
{
    /** @var string */
    private $logDirectory;

    /** @var int */
    private $testSuiteLevel;

    /** @var string */
    private $currentTestSuiteName;

    /** @var string */
    private $currentTestName;

    /** @var bool */
    private $currentTestPass;

    /**
     * LogPrinter constructor.
     * @param mixed $out
     */
    public function __construct($out = null)
    {
        if (substr($out, -1) !== DIRECTORY_SEPARATOR) {
            $out .= DIRECTORY_SEPARATOR;
        }

        $this->logDirectory = $out;
        $this->testSuiteLevel = 0;
    }

    /**
     * An error occurred.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception              $e
     * @param float                   $time
     */
    public function addError(\PHPUnit_Framework_Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            \PHPUnit_Framework_TestFailure::exceptionToString($e),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * A warning occurred.
     *
     * @param \PHPUnit_Framework_Test    $test
     * @param \PHPUnit_Framework_Warning $e
     * @param float                      $time
     */
    public function addWarning(\PHPUnit_Framework_Test $test, \PHPUnit_Framework_Warning $e, $time)

    {
        $this->writeCase(
            'warning',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            \PHPUnit_Framework_TestFailure::exceptionToString($e),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * A failure occurred.
     *
     * @param \PHPUnit_Framework_Test                 $test
     * @param \PHPUnit_Framework_AssertionFailedError $e
     * @param float                                   $time
     */
    public function addFailure(\PHPUnit_Framework_Test $test, \PHPUnit_Framework_AssertionFailedError $e, $time)

    {
        $this->writeCase(
            'fail',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            \PHPUnit_Framework_TestFailure::exceptionToString($e),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * Incomplete test.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception              $e
     * @param float                   $time
     */
    public function addIncompleteTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            'Incomplete Test: ' . $e->getMessage(),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * Risky test.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception              $e
     * @param float                   $time
     */
    public function addRiskyTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            'Risky Test: ' . $e->getMessage(),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * Skipped test.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception              $e
     * @param float                   $time
     */
    public function addSkippedTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            'Skipped Test: ' . $e->getMessage(),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * A testsuite started.
     *
     * @param \PHPUnit_Framework_TestSuite $suite
     * @throws \RuntimeException
     */
    public function startTestSuite(\PHPUnit_Framework_TestSuite $suite)
    {
        if ($this->testSuiteLevel === 0) {
            $logFilename = $this->getLogFilename($suite);

            $logDir = dirname($logFilename);
            if (! @mkdir($logDir, 0777, true) && !is_dir($logDir)) {

                throw new \RuntimeException('Cannot create folder for JSON logs');
            }

            $this->out = fopen($logFilename, 'wt');
        }

        $this->testSuiteLevel++;
        $this->currentTestSuiteName = $suite->getName();
        $this->currentTestName      = '';

        $this->write(
            array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'event' => 'suiteStart',
                'suite' => $this->currentTestSuiteName,
                'tests' => count($suite)
            )
        );
    }

    /**
     * A testsuite ended.
     *
     * @param \PHPUnit_Framework_TestSuite $suite
     */
    public function endTestSuite(\PHPUnit_Framework_TestSuite $suite)
    {
        $this->testSuiteLevel--;
        $this->currentTestSuiteName = '';
        $this->currentTestName      = '';
    }

    /**
     * A test started.
     *
     * @param \PHPUnit_Framework_Test $test
     */
    public function startTest(\PHPUnit_Framework_Test $test)
    {
        $this->currentTestName = \PHPUnit_Util_Test::describe($test);
        $this->currentTestPass = true;

        $this->write(
            array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'event' => 'testStart',
                'suite' => $this->currentTestSuiteName,
                'test'  => $this->currentTestName
            )
        );
    }

    /**
     * A test ended.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param float                  $time
     */
    public function endTest(\PHPUnit_Framework_Test $test, $time)
    {
        if ($this->currentTestPass) {
            $this->writeCase('pass', $time, array(), '', $test);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }

    /**
     * @param string                           $status
     * @param float                            $time
     * @param array                            $trace
     * @param string                           $message
     * @param \PHPUnit_Framework_TestCase|null $test
     */
    protected function writeCase($status, $time, array $trace = array(), $message = '', $test = null)
    {
        $output = '';
        // take care of TestSuite producing error (e.g. by running into exception) as TestSuite doesn't have hasOutput
        if ($test !== null && method_exists($test, 'hasOutput') && $test->hasOutput()) {
            $output = $test->getActualOutput();
        }
        $this->write(
            array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'event'   => 'test',
                'suite'   => $this->currentTestSuiteName,
                'test'    => $this->currentTestName,
                'status'  => $status,
                'time'    => $time,
                'trace'   => $trace,
                'message' => \PHPUnit_Util_String::convertToUtf8($message),
                'output'  => $output,
            )
        );
    }

    /**
     * @param string $buffer
     */
    public function write($buffer)
    {
        array_walk_recursive($buffer, function (&$input) {
            if (is_string($input)) {
                $input = \PHPUnit_Util_String::convertToUtf8($input);
            }
        });

        $flags = 0;

        if (defined('JSON_PRETTY_PRINT')) {
            $flags |= JSON_PRETTY_PRINT;
        }

        parent::write(json_encode($buffer, $flags));
    }

    /**
     * @param \PHPUnit_Framework_TestSuite $suite
     * @return string
     */
    private function getLogFilename(\PHPUnit_Framework_TestSuite $suite)
    {
        $testFilename = $this->getTestFilename($suite);
        
        return $this->logDirectory . md5($testFilename) . '.json.log';
    }

    /**
     * @param \PHPUnit_Framework_TestSuite $suite
     * @return string
     */
    private function getTestFilename(\PHPUnit_Framework_TestSuite $suite)
    {
        $reflection = new \ReflectionClass($suite->getName());
        
        return $reflection->getFileName();
    }
}


1		<?php
2
3		namespace Paraunit\Parser\JSON;
4
5		/**
6		* This class comes from \PHPUnit_Util_Log_JSON.
7		* It's copied and refactored here because it's deprecated in PHPUnit 5.7 and it will be dropped in PHPUnit 6
8		*
9		* Class LogPrinter
10		* @package Paraunit\Parser\JSON
11		*/
12		class LogPrinter extends \PHPUnit_Util_Printer implements \PHPUnit_Framework_TestListener
13		{
14		/** @var string */
15		private $logDirectory;
16
17		/** @var int */
18		private $testSuiteLevel;
19
20		/** @var string */
21		private $currentTestSuiteName;
22
23		/** @var string */
24		private $currentTestName;
25
26		/** @var bool */
27		private $currentTestPass;
28
29		/**
30		* LogPrinter constructor.
31		* @param mixed $out
32		*/
33	10	public function __construct($out = null)
34		{
35	10	if (substr($out, -1) !== DIRECTORY_SEPARATOR) {
36	10	$out .= DIRECTORY_SEPARATOR;
37		}
38
39	10	$this->logDirectory = $out;
40	10	$this->testSuiteLevel = 0;

facile-it / paraunit

Push — master ( 979448...f8182d )

LogPrinter A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

15 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like