Sign upLogin

octolab/Cleaner

View on GitHub
Star

Showing 27 of 27 total issues

Function clear has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    public function clear($packagePath, array $devFiles)
    {
        assert(is_string($packagePath));
        assert(is_readable($packagePath));
        $result = array();
Severity: Minor
Found in src/Util/FakeCleaner.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

Function handlePackage has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    public function handlePackage(PackageInterface $package)
    {
        $packageExtra = $package->getExtra();
        $devFiles = $this->devFiles;
        if (isset($packageExtra[self::EXTRA_KEY])) {
Severity: Minor
Found in src/Plugin.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

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

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $composer = $this->getComposer();

        // @todo is this a proper way to get current plugin instance?
Severity: Minor
Found in src/Command/ClearCommand.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

Function optimized has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    private function optimized(array $patterns)
    {
        $files = array();
        $before = getcwd();
        chdir($cwd = $this->current);
Severity: Minor
Found in src/Util/GlobFinder.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

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

    public function handlePackage(PackageInterface $package)
    {
        $packageExtra = $package->getExtra();
        $devFiles = $this->devFiles;
        if (isset($packageExtra[self::EXTRA_KEY])) {
Severity: Minor
Found in src/Plugin.php - About 1 hr to fix

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

        public function __construct(IOInterface $io)
    Severity: Minor
    Found in src/Util/FakeCleaner.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 $io. Configured minimum length is 3.
    Open

        private $io;
    Severity: Minor
    Found in src/Util/FakeCleaner.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 $io. Configured minimum length is 3.
    Open

        public function activate(Composer $composer, IOInterface $io)
    Severity: Minor
    Found in src/Plugin.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 $io. Configured minimum length is 3.
    Open

        private $io;
    Severity: Minor
    Found in src/Plugin.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 Plugin has a coupling between objects value of 16. Consider to reduce the number of dependencies under 13.
    Open

    final class Plugin implements Capable, EventSubscriberInterface, PluginInterface
{
    const CONFIG_KEY = 'octolab/cleaner';
    const EXTRA_KEY = 'dev-files';
    Severity: Minor
    Found in src/Plugin.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 closing brace must go on the next line following the body; found 1 blank lines before brace
    Open

        }
    Severity: Minor
    Found in src/Plugin.php by phpcodesniffer

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

                    throw new \InvalidArgumentException('No packages found for "'.$packageFilter.'"');
    Severity: Minor
    Found in src/Command/ClearCommand.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

    Avoid too many return statements within this method.
    Open

                    return array();
    Severity: Major
    Found in src/Util/WeightMatcher.php - About 30 mins to fix

      Missing class import via use statement (line '85', column '23').
      Open

                  throw new \InvalidArgumentException('The plugin configuration is invalid.');
      Severity: Minor
      Found in src/Config/PluginConfig.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 normalize has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          public function normalize(array $devFiles)
    {
        $normalized = array();
        foreach ($devFiles as $i => $value) {
            if (is_numeric($i) || $i === 'other') {
      Severity: Minor
      Found in src/Util/CategoryNormalizer.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 origin uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                  } else {
                $add[] = glob(ltrim($pattern, '/'));
            }
      Severity: Minor
      Found in src/Util/GlobFinder.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 execute uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
            $packages = $repo->getPackages();
        }
      Severity: Minor
      Found in src/Command/ClearCommand.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 optimized uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                  } else {
                foreach (glob(ltrim($pattern, '/')) as $file) {
                    $files[$file] = true;
                }
            }
      Severity: Minor
      Found in src/Util/GlobFinder.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 '66', column '14').
      Open

          public function activate(Composer $composer, IOInterface $io)
    {
        $this->composer = $composer;
        $this->io = $io;
        $this->config = $config = new Config\PluginConfig((array)$composer->getConfig()->get(self::CONFIG_KEY));
      Severity: Minor
      Found in src/Plugin.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 clear uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
            $this->io->write('<comment>- there is nothing to clear</comment>', true);
        }
      Severity: Minor
      Found in src/Util/FakeCleaner.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

      Severity
      Category
      Status
      Source
      Language