VSVverkeerskunde/gvq-api

View on GitHub
src/Command/CleanReadModelsCommand.php

Summary

Maintainability
A
3 hrs
Test Coverage

Method execute has 51 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function execute(InputInterface $input, OutputInterface $output): void
    {
        $helper = $this->getHelper('question');
        $question = new ConfirmationQuestion('Continue with cleaning the read models? ', false);

Severity: Major
Found in src/Command/CleanReadModelsCommand.php - About 2 hrs to fix

    Function execute has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function execute(InputInterface $input, OutputInterface $output): void
        {
            $helper = $this->getHelper('question');
            $question = new ConfirmationQuestion('Continue with cleaning the read models? ', false);
    
    
    Severity: Minor
    Found in src/Command/CleanReadModelsCommand.php - About 1 hr 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 class CleanReadModelsCommand has a coupling between objects value of 13. Consider to reduce the number of dependencies under 13.
    Open

    class CleanReadModelsCommand extends ContainerAwareCommand
    {
        /**
         * @var EntityManagerInterface
         */

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

            else {
                $output->writeln('Cleaning Redis...');
                $redis->flushDB();
            }

    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 $prefixesOfKeysToClear. Keep variable name length under 20.
    Open

                $prefixesOfKeysToClear = [

    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

    Line exceeds 120 characters; contains 125 characters
    Open

                    'Only clear read models that are related to the contest, not the ones needed for quizes that are in progress'

    Expected 1 space after closing brace; newline found
    Open

            }

    There are no issues that match your filters.

    Category
    Status