PabloKowalczyk/SupercacheBundle

View on GitHub

Showing 18 of 18 total issues

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

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

          public function getElement(string $path, ?string $type = null)
          {
              if (null === $type) {
                  $basePath = $path . '/';
      
      
      Severity: Minor
      Found in src/Cache/CacheManager.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 isCacheable has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          public function isCacheable(Request $request, Response $response)
          {
              if (!$this->supercacheEnabled) {
                  return CacheManager::UNCACHEABLE_DISABLED;
              }
      Severity: Minor
      Found in src/Cache/ResponseHandler.php - About 45 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

      Function getEntriesList has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          public function getEntriesList($parent = null)
          {
              $filesList = $this->finder->getFilesList();
              $basePath = $this->finder->getRealCacheDir();
              $basePathLength = \mb_strlen($basePath);
      Severity: Minor
      Found in src/Cache/CacheManager.php - About 45 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 true;
      Severity: Major
      Found in src/Cache/ResponseHandler.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                    return CacheManager::UNCACHEABLE_NO_STORE_POLICY;
        Severity: Major
        Found in src/Cache/ResponseHandler.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                  return null;
          Severity: Major
          Found in src/Cache/CacheManager.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                        return CacheManager::UNCACHEABLE_PRIVATE;
            Severity: Major
            Found in src/Cache/ResponseHandler.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                          return CacheManager::UNCACHEABLE_CODE;
              Severity: Major
              Found in src/Cache/ResponseHandler.php - About 30 mins to fix

                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

                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

                Reduce the number of returns of this function 8, down to the maximum allowed 3.
                Open

                    public function isCacheable(Request $request, Response $response)
                Severity: Major
                Found in src/Cache/ResponseHandler.php by sonar-php

                Having too many return statements in a function increases the function's essential complexity because the flow of execution is broken each time a return statement is encountered. This makes it harder to read and understand the logic of the function.

                Noncompliant Code Example

                With the default threshold of 3:

                function myFunction(){ // Noncompliant as there are 4 return statements
                  if (condition1) {
                    return true;
                  } else {
                    if (condition2) {
                      return false;
                    } else {
                      return true;
                    }
                  }
                  return false;
                }
                

                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.

                Reduce the number of returns of this function 5, down to the maximum allowed 3.
                Open

                    public function getElement(string $path, ?string $type = null)
                Severity: Major
                Found in src/Cache/CacheManager.php by sonar-php

                Having too many return statements in a function increases the function's essential complexity because the flow of execution is broken each time a return statement is encountered. This makes it harder to read and understand the logic of the function.

                Noncompliant Code Example

                With the default threshold of 3:

                function myFunction(){ // Noncompliant as there are 4 return statements
                  if (condition1) {
                    return true;
                  } else {
                    if (condition2) {
                      return false;
                    } else {
                      return true;
                    }
                  }
                  return false;
                }
                

                Define a constant instead of duplicating this literal "/index." 5 times.
                Open

                            $content = $this->finder->readFile($basePath . '/index.' . CacheElement::TYPE_HTML);
                Severity: Critical
                Found in src/Cache/CacheManager.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.

                Severity
                Category
                Status
                Source
                Language