Sign upLogin

PabloKowalczyk/SupercacheBundle

View on GitHub
Star
src/Filesystem/Finder.php

Summary

Maintainability
B
6 hrs
Test Coverage
F
46%

Function deleteDirectoryRecursive has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
Open

    public function deleteDirectoryRecursive(string $path, bool $safeDelete = true): bool
    {
        $path = $this->getAbsolutePathFromRelative($path);
        if (empty($path)) {
            return false;
Severity: Minor
Found in src/Filesystem/Finder.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 writeFile has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function writeFile(
        string $path,
        string $content,
        bool $minifyHtml
    ): bool {
Severity: Minor
Found in src/Filesystem/Finder.php - About 1 hr to fix

    Method deleteDirectoryRecursive has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function deleteDirectoryRecursive(string $path, bool $safeDelete = true): bool
    {
        $path = $this->getAbsolutePathFromRelative($path);
        if (empty($path)) {
            return false;
    Severity: Minor
    Found in src/Filesystem/Finder.php - About 1 hr to fix

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

          public function writeFile(
        string $path,
        string $content,
        bool $minifyHtml
    ): bool {
      Severity: Minor
      Found in src/Filesystem/Finder.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

      Refactor this function to reduce its Cognitive Complexity from 19 to the 15 allowed.
      Open

          public function deleteDirectoryRecursive(string $path, bool $safeDelete = true): bool
      Severity: Critical
      Found in src/Filesystem/Finder.php by sonar-php

      Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

      See

      Define a constant instead of duplicating this literal "dirname" 3 times.
      Open

              if (!isset($info['dirname']) || (!\is_dir($info['dirname']) && !\mkdir($info['dirname'], 0777, true))) {
      Severity: Critical
      Found in src/Filesystem/Finder.php by sonar-php

      Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

      On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

      Noncompliant Code Example

      With the default threshold of 3:

      function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

      Compliant Solution

      ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

      Exceptions

      To prevent generating some false-positives, literals having less than 5 characters are excluded.

      Define and throw a dedicated exception instead of using a generic one.
      Open

                          throw new \RuntimeException('Finder found unknown file ' . $realPath . ' - this was not created by SupercacheBundle. Inspect this issue manually.');
      Severity: Major
      Found in src/Filesystem/Finder.php by sonar-php

      If you throw a general exception type, such as ErrorException, RuntimeException, or Exception in a library or framework, it forces consumers to catch all exceptions, including unknown exceptions that they do not know how to handle.

      Instead, either throw a subtype that already exists in the Standard PHP Library, or create your own type that derives from Exception.

      Noncompliant Code Example

      throw new Exception();  // Noncompliant

      Compliant Solution

      throw new InvalidArgumentException();
// or
throw new UnexpectedValueException();

      See

      There are no issues that match your filters.

      Category
      Status