jaroslavtyc/drd-plus-codes

View on GitHub
tests/Codes/AllTranslatableCodesTest.php

Summary

Maintainability
B
4 hrs
Test Coverage

Function I_can_get_its_czech_translation has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

    public function I_can_get_its_czech_translation()
    {
        foreach ($this->getTranslatableCodeClasses() as $codeClass) {
            $hasSinglesOnly = $this->hasSinglesOnly($codeClass);
            $hasMultiplesOnly = $this->hasMultiplesOnly($codeClass);
Severity: Minor
Found in tests/Codes/AllTranslatableCodesTest.php - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Method I_can_get_its_czech_translation has 48 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function I_can_get_its_czech_translation()
    {
        foreach ($this->getTranslatableCodeClasses() as $codeClass) {
            $hasSinglesOnly = $this->hasSinglesOnly($codeClass);
            $hasMultiplesOnly = $this->hasMultiplesOnly($codeClass);
Severity: Minor
Found in tests/Codes/AllTranslatableCodesTest.php - About 1 hr to fix

    Function I_can_get_its_english_translation has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        public function I_can_get_its_english_translation()
        {
            foreach ($this->getTranslatableCodeClasses() as $codeClass) {
                $testClass = $this->getTestClass($codeClass);
                self::assertTrue(
    Severity: Minor
    Found in tests/Codes/AllTranslatableCodesTest.php - About 45 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    The method I_can_get_its_czech_translation() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
    Open

        public function I_can_get_its_czech_translation()
        {
            foreach ($this->getTranslatableCodeClasses() as $codeClass) {
                $hasSinglesOnly = $this->hasSinglesOnly($codeClass);
                $hasMultiplesOnly = $this->hasMultiplesOnly($codeClass);

    CyclomaticComplexity

    Since: 0.1

    Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

    Example

    // Cyclomatic Complexity = 11
    class Foo {
    1   public function example() {
    2       if ($a == $b) {
    3           if ($a1 == $b1) {
                    fiddle();
    4           } elseif ($a2 == $b2) {
                    fiddle();
                } else {
                    fiddle();
                }
    5       } elseif ($c == $d) {
    6           while ($c == $d) {
                    fiddle();
                }
    7        } elseif ($e == $f) {
    8           for ($n = 0; $n < $h; $n++) {
                    fiddle();
                }
            } else {
                switch ($z) {
    9               case 1:
                        fiddle();
                        break;
    10              case 2:
                        fiddle();
                        break;
    11              case 3:
                        fiddle();
                        break;
                    default:
                        fiddle();
                        break;
                }
            }
        }
    }

    Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

    The class AllTranslatableCodesTest has a coupling between objects value of 29. Consider to reduce the number of dependencies under 13.
    Open

    class AllTranslatableCodesTest extends TestWithMockery
    {
    
        use GetCodeClassesTrait;
    
    

    CouplingBetweenObjects

    Since: 1.1.0

    A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

    Example

    class Foo {
        /**
         * @var \foo\bar\X
         */
        private $x = null;
    
        /**
         * @var \foo\bar\Y
         */
        private $y = null;
    
        /**
         * @var \foo\bar\Z
         */
        private $z = null;
    
        public function setFoo(\Foo $foo) {}
        public function setBar(\Bar $bar) {}
        public function setBaz(\Baz $baz) {}
    
        /**
         * @return \SplObjectStorage
         * @throws \OutOfRangeException
         * @throws \InvalidArgumentException
         * @throws \ErrorException
         */
        public function process(\Iterator $it) {}
    
        // ...
    }

    Source https://phpmd.org/rules/design.html#couplingbetweenobjects

    The method I_can_get_its_english_translation uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                    } else {
                        self::assertNotSame(
                            $one = $sut->translateTo('en', 1),
                            $two = $sut->translateTo('en', 2),
                            "Expected different translation in english from $codeClass for numbers 1 and 2: $one, $two"

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($flag) {
                // one branch
            } else {
                // another branch
            }
        }
    }

    Source https://phpmd.org/rules/cleancode.html#elseexpression

    The method I_can_get_its_czech_translation uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                    } else {
                        self::assertNotSame(
                            $oneInCzech,
                            $twoInCzech,
                            "Expected different translation in czech from $codeClass for numbers 1 and 2: $oneInCzech, $twoInCzech"

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($flag) {
                // one branch
            } else {
                // another branch
            }
        }
    }

    Source https://phpmd.org/rules/cleancode.html#elseexpression

    The method I_can_get_its_czech_translation uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                    } else {
                        self::assertNotSame(
                            $fourInCzech,
                            $fiveInCzech,
                            "Expected different translation in czech from $codeClass for numbers 4 and 5: $fourInCzech, $fiveInCzech"

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($flag) {
                // one branch
            } else {
                // another branch
            }
        }
    }

    Source https://phpmd.org/rules/cleancode.html#elseexpression

    The method I_can_get_its_czech_translation uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                    } else {
                        self::assertNotSame(
                            $oneInEnglish,
                            $oneInCzech,
                            "Expected translation of '{$value}' to be different in czech than in english in code {$codeClass}, got '{$oneInCzech}'"

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($flag) {
                // one branch
            } else {
                // another branch
            }
        }
    }

    Source https://phpmd.org/rules/cleancode.html#elseexpression

    Avoid excessively long variable names like $translatableCodeClasses. Keep variable name length under 20.
    Open

            $translatableCodeClasses = [];

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

    Source https://phpmd.org/rules/naming.html#longvariable

    Avoid excessively long variable names like $previousErrorReporting. Keep variable name length under 20.
    Open

                    $previousErrorReporting = error_reporting(-1 ^ E_USER_WARNING);

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

    Source https://phpmd.org/rules/naming.html#longvariable

    The method I_can_get_its_english_translation is not named in camelCase.
    Open

        public function I_can_get_its_english_translation()
        {
            foreach ($this->getTranslatableCodeClasses() as $codeClass) {
                $testClass = $this->getTestClass($codeClass);
                self::assertTrue(

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    The method I_can_get_its_czech_translation is not named in camelCase.
    Open

        public function I_can_get_its_czech_translation()
        {
            foreach ($this->getTranslatableCodeClasses() as $codeClass) {
                $hasSinglesOnly = $this->hasSinglesOnly($codeClass);
                $hasMultiplesOnly = $this->hasMultiplesOnly($codeClass);

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    The method I_get_warning_for_unknown_locale is not named in camelCase.
    Open

        public function I_get_warning_for_unknown_locale()
        {
            foreach ($this->getTranslatableCodeClasses() as $codeClass) {
                foreach ($codeClass::getPossibleValues() as $value) {
                    /** @var TranslatableCode $sut */

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    There are no issues that match your filters.

    Category
    Status