Sign upLogin

SAREhub/php_component_worker

View on GitHub
Star

Showing 70 of 70 total issues

Similar blocks of code found in 2 locations. Consider refactoring.
Open

<?php

namespace SAREhub\Component\Worker\Cli;

use SAREhub\Component\Worker\Command\CommandReply;
Severity: Major
Found in src/SAREhub/Component/Worker/Cli/StartWorkerCommand.php and 1 other location - About 7 hrs to fix
src/SAREhub/Component/Worker/Cli/StopWorkerCommand.php on lines 1..45

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 236.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

<?php

namespace SAREhub\Component\Worker\Cli;
Severity: Major
Found in src/SAREhub/Component/Worker/Cli/StopWorkerCommand.php and 1 other location - About 7 hrs to fix
src/SAREhub/Component/Worker/Cli/StartWorkerCommand.php on lines 1..45

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 236.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

class TestWorker extends BasicWorker {
    
    protected function doStart() {
        $this->logInfo('doStart');
    }
Severity: Major
Found in cli/test_worker/testWorkerRunner.php and 1 other location - About 1 hr to fix
examples/WorkerManager/workerScript.php on lines 18..40

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 118.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

class TestWorker extends BasicWorker {
    
    protected function doStart() {
        $this->logInfo('doStart');
    }
Severity: Major
Found in examples/WorkerManager/workerScript.php and 1 other location - About 1 hr to fix
cli/test_worker/testWorkerRunner.php on lines 15..37

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 118.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Method onStopAllCommand has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function onStopAllCommand(Command $command, callable $replyCallback) {
        $workerList = $this->getWorkerList();
        $replyAll = [];
        $inputCommand = $command;
        $stopAllCallback = function (Command $command, CommandReply $reply) use ($inputCommand, &$replyAll, &$workerList, $replyCallback) {
Severity: Minor
Found in src/SAREhub/Component/Worker/Manager/WorkerManager.php - About 1 hr to fix

    Avoid variables with short names like $e. Configured minimum length is 2.
    Open

        private function onProcessCommandException(Command $command, \Exception $e, callable $replyCallback) {
    Severity: Minor
    Found in src/SAREhub/Component/Worker/WorkerRunner.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

    Avoid variables with short names like $v. Configured minimum length is 2.
    Open

            $v = Validator::notEmpty();
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Command/ZmqCommandInputServiceFactory.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

    Avoid variables with short names like $v. Configured minimum length is 2.
    Open

            $v = Validator::notEmpty();
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Cli/CliWorkerManagerConfigBuilder.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

    Avoid variables with short names like $v. Configured minimum length is 2.
    Open

            $v = Validator::notEmpty();
    Severity: Minor
    Found in src/SAREhub/Component/Worker/ZmqWorkerRunnerBootstrap.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

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

    class WorkerManagerBootstrap {
    
    /**
     * @var WorkerContext
     */
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Cli/WorkerManagerBootstrap.php by phpmd

    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 class CliBootstrap has a coupling between objects value of 15. Consider to reduce the number of dependencies under 13.
    Open

    class CliBootstrap {
    
    /**
     * @var Parameters
     */
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Cli/CliBootstrap.php by phpmd

    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

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

        public function onStopAllCommand(Command $command, callable $replyCallback) {
        $workerList = $this->getWorkerList();
        $replyAll = [];
        $inputCommand = $command;
        $stopAllCallback = function (Command $command, CommandReply $reply) use ($inputCommand, &$replyAll, &$workerList, $replyCallback) {
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Manager/WorkerManager.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

    The method getNext has a boolean flag argument $wait, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function getNext($wait = false);
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Command/CommandInput.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

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

    The method send has a boolean flag argument $wait, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function send($topic, Command $command, $wait = false);
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Command/CommandOutput.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

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

    The method send has a boolean flag argument $wait, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function send(CommandReply $reply, $wait = false) {
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Command/ZmqCommandReplyOutput.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

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

    The method send has a boolean flag argument $wait, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function send(CommandReply $reply, $wait = false);
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Command/CommandReplyOutput.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

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

    The method getNext has a boolean flag argument $wait, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function getNext($wait = false) {
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Command/ZmqCommandInput.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

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

    The method getNext has a boolean flag argument $wait, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function getNext($wait = false) {
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Command/ZmqCommandReplyInput.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

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

    The method getNext has a boolean flag argument $wait, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function getNext($wait = false);
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Command/CommandReplyInput.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

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

    Missing class import via use statement (line '41', column '27').
    Open

            $this->zmqContext = new \ZMQContext();
    Severity: Minor
    Found in src/SAREhub/Component/Worker/Cli/WorkerManagerBootstrap.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

    Severity
    Category
    Status
    Source
    Language