CoverFishMessageError::getErrorStreamTemplate() - Code Metrics - dunkelfrosch/phpcoverfish - Measure and Improve Code Quality continuously with Scrutinizer

CoverFishMessageError::getErrorStreamTemplate() C
last analyzed 2018-05-15 15:08 UTC

↳ Parent: CoverFishMessageError

Complexity

Conditions	18
Paths	24

Size

Total Lines	71
Code Lines	49

Duplication

Lines	48
Ratio	67.61 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
dl	48
loc	71
rs	5.5108
c	1
b	1
f	0
cc	18
eloc	49
nc	24
nop	2

How to fix Long Method Complexity

<?php

namespace DF\PHPCoverFish\Common;

use DF\PHPCoverFish\Common\CoverFishColor as Color;

/**
 * Class CoverFishMessageError, code coverage error definition
 *
 * @package   DF\PHPCoverFish
 * @author    Patrick Paechnatz <[email protected]>
 * @copyright 2015 Patrick Paechnatz <[email protected]>
 * @license   http://www.opensource.org/licenses/MIT
 * @link      http://github.com/dunkelfrosch/phpcoverfish/tree
 * @since     class available since Release 0.9.0
 * @version   0.9.9
 */
class CoverFishMessageError extends CoverFishMessage
{
    // reflection problem, cover class is not available during reflection using annotation defined namespace
    const PHPUNIT_REFLECTION_CLASS_NOT_FOUND = 1000;
    // reflection problem, cover class method is not available / not found during reflection using annotation defined namespace
    const PHPUNIT_REFLECTION_METHOD_NOT_FOUND = 2000;
    // reflection problem, class exists but no public methods available
    const PHPUNIT_REFLECTION_NO_PUBLIC_METHODS_FOUND = 2001;
    // reflection problem, class exists but no protected methods available
    const PHPUNIT_REFLECTION_NO_PROTECTED_METHODS_FOUND = 2002;
    // reflection problem, class exists but no protected methods available
    const PHPUNIT_REFLECTION_NO_PRIVATE_METHODS_FOUND = 2003;
    // reflection problem, class exists but no not public methods available
    const PHPUNIT_REFLECTION_NO_NOT_PUBLIC_METHODS_FOUND = 2004;
    // reflection problem, class exists but no not protected methods available
    const PHPUNIT_REFLECTION_NO_NOT_PROTECTED_METHODS_FOUND = 2005;
    // reflection problem, class exists but no not private methods available
    const PHPUNIT_REFLECTION_NO_NOT_PRIVATE_METHODS_FOUND = 2006;
    // class does not provide any of defined methods in corresponding visibility
    const PHPUNIT_REFLECTION_CLASS_NOT_DEFINED = 4000;
    // annotation problem, cover class not found or class part in 'class::method' not available
    const PHPUNIT_VALIDATOR_PROBLEM = 9000;
    // annotation problem, defaultCoverClass not found during global method validation
    const PHPUNIT_VALIDATOR_MISSING_DEFAULT_COVER_CLASS_PROBLEM = 9001;

    /**
     * @var array
     */
    public $messageTokens = array(
        self::PHPUNIT_REFLECTION_CLASS_NOT_FOUND => 'Class not found!', // annotation defined coverClass is not available during reflection, may be the class is not available system wide!
        self::PHPUNIT_REFLECTION_METHOD_NOT_FOUND => 'Method not found!', // annotation defined method is not available during reflection of corresponding coverClass!
        self::PHPUNIT_REFLECTION_NO_PUBLIC_METHODS_FOUND => 'no public methods in class!', // method-access/-visibility problem!
        self::PHPUNIT_REFLECTION_NO_PROTECTED_METHODS_FOUND => 'no protected methods in class!', // method-access/-visibility problem!
        self::PHPUNIT_REFLECTION_NO_PRIVATE_METHODS_FOUND => 'no private methods in class!', // method-access/-visibility problem!
        self::PHPUNIT_REFLECTION_NO_NOT_PUBLIC_METHODS_FOUND => 'no not public methods in class!', // method-access/-visibility problem!
        self::PHPUNIT_REFLECTION_NO_NOT_PROTECTED_METHODS_FOUND => 'no not protected methods in class!', // method-access/-visibility problem!
        self::PHPUNIT_REFLECTION_NO_NOT_PRIVATE_METHODS_FOUND => 'no not private methods in class!', // method-access/-visibility problem!
        self::PHPUNIT_REFLECTION_CLASS_NOT_DEFINED => 'Class not defined!', // class not defined, not found in use statement
        self::PHPUNIT_VALIDATOR_PROBLEM => 'cover Annotation problem!', // cover annotation spelling/validation error
        self::PHPUNIT_VALIDATOR_MISSING_DEFAULT_COVER_CLASS_PROBLEM => 'defaultCoverClass Annotation missing!', // defaultCoverClass annotation spelling/validation error
    );

    /**
     * @param CoverFishMapping $coverMapping
     * @param bool|false       $noAnsiColors
     *
     * @return null|string
     */
    public function getErrorStreamTemplate(CoverFishMapping $coverMapping, $noAnsiColors = false)
    {
        $coverLine = null;
        switch ($this->getMessageCode()) {
            case self::PHPUNIT_REFLECTION_CLASS_NOT_FOUND:
                $coverLine = sprintf('@covers %s::%s', $coverMapping->getClassFQN(), $coverMapping->getMethod());
                if (!$noAnsiColors) {
                    $coverLine  = Color::tplNormalColor('@covers ');
                    $coverLine .= Color::tplMarkFailure($coverMapping->getClassFQN());
                    $coverLine .= Color::tplYellowColor('::' . $coverMapping->getMethod());
                }

                if (null === $coverMapping->getMethod()) {
                    $coverLine = str_replace('::', null, $coverLine);
                }

                break;

            case self::PHPUNIT_REFLECTION_METHOD_NOT_FOUND:
                $coverLine = sprintf('@covers %s::%s', $coverMapping->getClassFQN(), $coverMapping->getMethod());
                if (!$noAnsiColors) {
                    $coverLine  = Color::tplNormalColor('@covers ');
                    $coverLine .= Color::tplYellowColor($coverMapping->getClassFQN() . '::');
                    $coverLine .= Color::tplMarkFailure($coverMapping->getMethod());
                }

                break;

            case self::PHPUNIT_REFLECTION_CLASS_NOT_DEFINED:
                $coverLine = sprintf('@covers %s', $coverMapping->getClassFQN());
                if (!$noAnsiColors) {
                    $coverLine  = Color::tplNormalColor('@covers ');
                    $coverLine .= Color::tplMarkFailure($coverMapping->getClassFQN());
                }

                break;

            case self::PHPUNIT_REFLECTION_NO_PUBLIC_METHODS_FOUND:
            case self::PHPUNIT_REFLECTION_NO_PROTECTED_METHODS_FOUND:
            case self::PHPUNIT_REFLECTION_NO_PRIVATE_METHODS_FOUND:
            case self::PHPUNIT_REFLECTION_NO_NOT_PUBLIC_METHODS_FOUND:
            case self::PHPUNIT_REFLECTION_NO_NOT_PROTECTED_METHODS_FOUND:
            case self::PHPUNIT_REFLECTION_NO_NOT_PRIVATE_METHODS_FOUND:
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

                $coverLine = sprintf('@covers %s::<%s>', $coverMapping->getClassFQN(), $coverMapping->getAccessor());
                if (!$noAnsiColors) {
                    $coverLine  = Color::tplNormalColor('@covers ');
                    $coverLine .= Color::tplYellowColor($coverMapping->getClassFQN() . '::<');
                    $coverLine .= Color::tplMarkFailure($coverMapping->getAccessor());
                    $coverLine .= Color::tplYellowColor('>');
                }

                break;

            case self::PHPUNIT_VALIDATOR_MISSING_DEFAULT_COVER_CLASS_PROBLEM:
                $coverLine = sprintf('@covers %s', $coverMapping->getClass());
                if (!$noAnsiColors) {
                    $coverLine  = Color::tplNormalColor('@covers ');
                    $coverLine .= Color::tplMarkFailure($coverMapping->getClass());
                }
                break;

            case self::PHPUNIT_VALIDATOR_PROBLEM:
                break;

            default:
                break;
        }

        return $coverLine;
    }
}

1		<?php
2
3		namespace DF\PHPCoverFish\Common;
4
5		use DF\PHPCoverFish\Common\CoverFishColor as Color;
6
7		/**
8		* Class CoverFishMessageError, code coverage error definition
9		*
10		* @package DF\PHPCoverFish
11		* @author Patrick Paechnatz <[email protected]>
12		* @copyright 2015 Patrick Paechnatz <[email protected]>
13		* @license http://www.opensource.org/licenses/MIT
14		* @link http://github.com/dunkelfrosch/phpcoverfish/tree
15		* @since class available since Release 0.9.0
16		* @version 0.9.9
17		*/
18		class CoverFishMessageError extends CoverFishMessage
19		{
20		// reflection problem, cover class is not available during reflection using annotation defined namespace
21		const PHPUNIT_REFLECTION_CLASS_NOT_FOUND = 1000;
22		// reflection problem, cover class method is not available / not found during reflection using annotation defined namespace
23		const PHPUNIT_REFLECTION_METHOD_NOT_FOUND = 2000;
24		// reflection problem, class exists but no public methods available
25		const PHPUNIT_REFLECTION_NO_PUBLIC_METHODS_FOUND = 2001;
26		// reflection problem, class exists but no protected methods available
27		const PHPUNIT_REFLECTION_NO_PROTECTED_METHODS_FOUND = 2002;
28		// reflection problem, class exists but no protected methods available
29		const PHPUNIT_REFLECTION_NO_PRIVATE_METHODS_FOUND = 2003;
30		// reflection problem, class exists but no not public methods available
31		const PHPUNIT_REFLECTION_NO_NOT_PUBLIC_METHODS_FOUND = 2004;
32		// reflection problem, class exists but no not protected methods available
33		const PHPUNIT_REFLECTION_NO_NOT_PROTECTED_METHODS_FOUND = 2005;
34		// reflection problem, class exists but no not private methods available
35		const PHPUNIT_REFLECTION_NO_NOT_PRIVATE_METHODS_FOUND = 2006;
36		// class does not provide any of defined methods in corresponding visibility
37		const PHPUNIT_REFLECTION_CLASS_NOT_DEFINED = 4000;
38		// annotation problem, cover class not found or class part in 'class::method' not available
39		const PHPUNIT_VALIDATOR_PROBLEM = 9000;
40		// annotation problem, defaultCoverClass not found during global method validation
41		const PHPUNIT_VALIDATOR_MISSING_DEFAULT_COVER_CLASS_PROBLEM = 9001;
42
43		/**
44		* @var array
45		*/
46		public $messageTokens = array(
47		self::PHPUNIT_REFLECTION_CLASS_NOT_FOUND => 'Class not found!', // annotation defined coverClass is not available during reflection, may be the class is not available system wide!
48		self::PHPUNIT_REFLECTION_METHOD_NOT_FOUND => 'Method not found!', // annotation defined method is not available during reflection of corresponding coverClass!
49		self::PHPUNIT_REFLECTION_NO_PUBLIC_METHODS_FOUND => 'no public methods in class!', // method-access/-visibility problem!
50		self::PHPUNIT_REFLECTION_NO_PROTECTED_METHODS_FOUND => 'no protected methods in class!', // method-access/-visibility problem!
51		self::PHPUNIT_REFLECTION_NO_PRIVATE_METHODS_FOUND => 'no private methods in class!', // method-access/-visibility problem!
52		self::PHPUNIT_REFLECTION_NO_NOT_PUBLIC_METHODS_FOUND => 'no not public methods in class!', // method-access/-visibility problem!
53		self::PHPUNIT_REFLECTION_NO_NOT_PROTECTED_METHODS_FOUND => 'no not protected methods in class!', // method-access/-visibility problem!
54		self::PHPUNIT_REFLECTION_NO_NOT_PRIVATE_METHODS_FOUND => 'no not private methods in class!', // method-access/-visibility problem!
55		self::PHPUNIT_REFLECTION_CLASS_NOT_DEFINED => 'Class not defined!', // class not defined, not found in use statement
56		self::PHPUNIT_VALIDATOR_PROBLEM => 'cover Annotation problem!', // cover annotation spelling/validation error
57		self::PHPUNIT_VALIDATOR_MISSING_DEFAULT_COVER_CLASS_PROBLEM => 'defaultCoverClass Annotation missing!', // defaultCoverClass annotation spelling/validation error
58		);
59
60		/**
61		* @param CoverFishMapping $coverMapping
62		* @param bool\|false $noAnsiColors
63		*
64		* @return null\|string
65		*/
66		public function getErrorStreamTemplate(CoverFishMapping $coverMapping, $noAnsiColors = false)
67		{
68		$coverLine = null;
69		switch ($this->getMessageCode()) {
70	View Code Duplication	case self::PHPUNIT_REFLECTION_CLASS_NOT_FOUND:
71		$coverLine = sprintf('@covers %s::%s', $coverMapping->getClassFQN(), $coverMapping->getMethod());
72		if (!$noAnsiColors) {
73		$coverLine = Color::tplNormalColor('@covers ');
74		$coverLine .= Color::tplMarkFailure($coverMapping->getClassFQN());
75		$coverLine .= Color::tplYellowColor('::' . $coverMapping->getMethod());
76		}
77
78		if (null === $coverMapping->getMethod()) {
79		$coverLine = str_replace('::', null, $coverLine);
80		}
81
82		break;
83
84	View Code Duplication	case self::PHPUNIT_REFLECTION_METHOD_NOT_FOUND:
85		$coverLine = sprintf('@covers %s::%s', $coverMapping->getClassFQN(), $coverMapping->getMethod());
86		if (!$noAnsiColors) {
87		$coverLine = Color::tplNormalColor('@covers ');
88		$coverLine .= Color::tplYellowColor($coverMapping->getClassFQN() . '::');
89		$coverLine .= Color::tplMarkFailure($coverMapping->getMethod());
90		}
91
92		break;
93
94	View Code Duplication	case self::PHPUNIT_REFLECTION_CLASS_NOT_DEFINED:
95		$coverLine = sprintf('@covers %s', $coverMapping->getClassFQN());
96		if (!$noAnsiColors) {
97		$coverLine = Color::tplNormalColor('@covers ');
98		$coverLine .= Color::tplMarkFailure($coverMapping->getClassFQN());
99		}
100
101		break;
102
103		case self::PHPUNIT_REFLECTION_NO_PUBLIC_METHODS_FOUND:
104		case self::PHPUNIT_REFLECTION_NO_PROTECTED_METHODS_FOUND:
105		case self::PHPUNIT_REFLECTION_NO_PRIVATE_METHODS_FOUND:
106		case self::PHPUNIT_REFLECTION_NO_NOT_PUBLIC_METHODS_FOUND:
107		case self::PHPUNIT_REFLECTION_NO_NOT_PROTECTED_METHODS_FOUND:
108	View Code Duplication	case self::PHPUNIT_REFLECTION_NO_NOT_PRIVATE_METHODS_FOUND:
		0 ignored issues – show Coding Style introduced 2018-05-15 15:08 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
109
110		$coverLine = sprintf('@covers %s::<%s>', $coverMapping->getClassFQN(), $coverMapping->getAccessor());
111		if (!$noAnsiColors) {
112		$coverLine = Color::tplNormalColor('@covers ');
113		$coverLine .= Color::tplYellowColor($coverMapping->getClassFQN() . '::<');
114		$coverLine .= Color::tplMarkFailure($coverMapping->getAccessor());
115		$coverLine .= Color::tplYellowColor('>');
116		}
117
118		break;
119
120	View Code Duplication	case self::PHPUNIT_VALIDATOR_MISSING_DEFAULT_COVER_CLASS_PROBLEM:
121		$coverLine = sprintf('@covers %s', $coverMapping->getClass());
122		if (!$noAnsiColors) {
123		$coverLine = Color::tplNormalColor('@covers ');
124		$coverLine .= Color::tplMarkFailure($coverMapping->getClass());
125		}
126		break;
127
128		case self::PHPUNIT_VALIDATOR_PROBLEM:
129		break;
130
131		default:
132		break;
133		}
134
135		return $coverLine;
136		}
137		}

dunkelfrosch / phpcoverfish

GitHub Access Token became invalid

CoverFishMessageError::getErrorStreamTemplate() C last analyzed 2018-05-15 15:08 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

CoverFishMessageError::getErrorStreamTemplate() C
last analyzed 2018-05-15 15:08 UTC