gluck1986/project-lvl1-s156

View on GitHub

Showing 12 of 12 total issues

Avoid using short method names like ::br(). The configured minimum method name length is 3.
Open

function br($colOfLines = 1): void
{
    if ($colOfLines < 1) {
        return;
    }
Severity: Minor
Found in src/CliIOFunctions.php by phpmd

ShortMethodName

Since: 0.2

Detects when very short method names are used.

Example

class ShortMethod {
    public function a( $index ) { // Violation
    }
}

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

Avoid variables with short names like $a. Configured minimum length is 3.
Open

    $a = mt_rand(1, $number - 1);
Severity: Minor
Found in src/Helpers.php by phpmd

ShortVariable

Since: 0.2

Detects when a field, local, or parameter has a very short name.

Example

class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

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

Function runGame has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

function runGame(\Closure $game, int $try): bool
{
    if ($try < 1) {
        return true;
    }
Severity: Minor
Found in src/GamesCore.php - About 35 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

Avoid too many return statements within this method.
Open

    return isPrime($number, $try + 1);
Severity: Major
Found in src/Helpers.php - About 30 mins to fix

    Missing class import via use statement (line '16', column '19').
    Open

            throw new \Exception('Invalid signal:\'' . $signal . '\'');
    Severity: Minor
    Found in src/Scenario.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Function isPrime has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

    function isPrime(float $number, int $try = 0): bool
    {
        if ($try > FERMA_MAX_TRY) {
            return true;
        }
    Severity: Minor
    Found in src/Helpers.php - About 25 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 initGame uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

        } else {
            sayTryAgain($name);
        }
    Severity: Minor
    Found in src/GamesCore.php by phpmd

    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 assigning values to variables in if clauses and the like (line '10', column '10').
    Open

    function calcGCD(int $fval, int $sval): int
    {
        list($lower, $highest) = ($fval > $sval ? [$sval, $fval] : [$fval, $sval]);
        if (($remainder = ($highest % $lower)) === 0) {
            return $lower;
    Severity: Minor
    Found in src/Helpers.php by phpmd

    IfStatementAssignment

    Since: 2.7.0

    Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($foo = 'bar') { // possible typo
                // ...
            }
            if ($baz = 0) { // always false
                // ...
            }
        }
    }

    Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

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

        } else {
            return findIndexMinValue($arr, $minIndex, $current + 1);
        }
    Severity: Minor
    Found in src/gameScenarios/BalanceScenario.php by phpmd

    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 runGame uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

        } else {
            sayNotCorrect($actual, $expected);
    
            return false;
        }
    Severity: Minor
    Found in src/GamesCore.php by phpmd

    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 findIndexMaxValue uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

        } else {
            return findIndexMaxValue($arr, $minIndex, $current + 1);
        }
    Severity: Minor
    Found in src/gameScenarios/BalanceScenario.php by phpmd

    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 using static access to class '\cli\Colors' in method 'say'.
    Open

        echo Colors::colorize($text, true);
    Severity: Minor
    Found in src/CliIOFunctions.php by phpmd

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
    {
        public function bar()
        {
            Bar::baz();
        }
    }

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

    Severity
    Category
    Status
    Source
    Language