hnhdigital-os/laravel-frontend-asset-loader

View on GitHub
src/FrontendAsset.php

Summary

Maintainability
C
1 day
Test Coverage

FrontendAsset has 28 functions (exceeds 20 allowed). Consider refactoring.
Open

class FrontendAsset
{
    /**
     * The domain for assets.
     *
Severity: Minor
Found in src/FrontendAsset.php - About 3 hrs to fix

    The class FrontendAsset has an overall complexity of 75 which is very high. The configured complexity threshold is 50.
    Open

    class FrontendAsset
    {
        /**
         * The domain for assets.
         *
    Severity: Minor
    Found in src/FrontendAsset.php by phpmd

    The class FrontendAsset has 23 public methods. Consider refactoring FrontendAsset to keep number of public methods under 10.
    Open

    class FrontendAsset
    {
        /**
         * The domain for assets.
         *
    Severity: Minor
    Found in src/FrontendAsset.php by phpmd

    TooManyPublicMethods

    Since: 0.1

    A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

    By default it ignores methods starting with 'get' or 'set'.

    Example

    Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

    File FrontendAsset.php has 293 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    
    namespace HnhDigital\LaravelFrontendAssetLoader;
    
    /*
    Severity: Minor
    Found in src/FrontendAsset.php - About 3 hrs to fix

      Function parseExtension has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

          public function parseExtension($path, $location = null)
          {
              $key = null;
      
              foreach ($this->extension_mapping as $store => $extensions) {
      Severity: Minor
      Found in src/FrontendAsset.php - About 55 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 autoloadAssets has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          public function autoloadAssets($extensions, $path)
          {
              // Force array.
              $extensions = Arr::wrap($extensions);
      
      
      Severity: Minor
      Found in src/FrontendAsset.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 autoloadWildcardAssets has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          public function autoloadWildcardAssets($extensions, $path)
          {
              // Force array.
              $extensions = Arr::wrap($extensions);
      
      
      Severity: Minor
      Found in src/FrontendAsset.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 '/assets/'.$path;
      Severity: Major
      Found in src/FrontendAsset.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                return '';
        Severity: Major
        Found in src/FrontendAsset.php - About 30 mins to fix

          Function url has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              public function url($path)
              {
                  // Detect path points to external url.
                  if (stripos($path, '://') !== false) {
                      return $path;
          Severity: Minor
          Found in src/FrontendAsset.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

          Avoid using undefined variables such as '$path' which will lead to PHP notices.
          Open

                  $asset = Asset::createByContent($path, $content, $location);
          Severity: Minor
          Found in src/FrontendAsset.php by phpmd

          UndefinedVariable

          Since: 2.8.0

          Detects when a variable is used that has not been defined before.

          Example

          class Foo
          {
              private function bar()
              {
                  // $message is undefined
                  echo $message;
              }
          }

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

          Avoid using undefined variables such as '$file' which will lead to PHP notices.
          Open

                  $path = str_replace('.', '/', $file);
          Severity: Minor
          Found in src/FrontendAsset.php by phpmd

          UndefinedVariable

          Since: 2.8.0

          Detects when a variable is used that has not been defined before.

          Example

          class Foo
          {
              private function bar()
              {
                  // $message is undefined
                  echo $message;
              }
          }

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

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

              public function packageVersion($name, $version = false)
          Severity: Minor
          Found in src/FrontendAsset.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 package uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
          Open

                  } else {
                      $asset_name = $settings;
                      $settings = [];
                  }
          Severity: Minor
          Found in src/FrontendAsset.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 autoloadAssets uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
          Open

                          } else {
                              $full_path = public_path().'/assets/'.$file_name;
                          }
          Severity: Minor
          Found in src/FrontendAsset.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 '393', column '13').
          Open

              public function package($settings, $config = [])
              {
                  if (is_array($settings)) {
                      $asset_name = array_shift($settings);
                  } else {
          Severity: Minor
          Found in src/FrontendAsset.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 packageIntegrity uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
          Open

                      } else {
                          return '';
                      }
          Severity: Minor
          Found in src/FrontendAsset.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 unused parameters such as '$hash'.
          Open

                  })->sortBy(function ($asset, $hash) {
          Severity: Minor
          Found in src/FrontendAsset.php by phpmd

          UnusedFormalParameter

          Since: 0.2

          Avoid passing parameters to methods or constructors and then not using those parameters.

          Example

          class Foo
          {
              private function bar($howdy)
              {
                  // $howdy is not used
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

          Avoid unused local variables such as '$file'.
          Open

                  $path = str_replace('.', '/', $file);
          Severity: Minor
          Found in src/FrontendAsset.php by phpmd

          UnusedLocalVariable

          Since: 0.2

          Detects when a local variable is declared and/or assigned, but not used.

          Example

          class Foo {
              public function doSomething()
              {
                  $i = 5; // Unused
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

          Avoid unused parameters such as '$extension'.
          Open

              public function loadAsset($file_name, $extension, $full_path = '')
          Severity: Minor
          Found in src/FrontendAsset.php by phpmd

          UnusedFormalParameter

          Since: 0.2

          Avoid passing parameters to methods or constructors and then not using those parameters.

          Example

          class Foo
          {
              private function bar($howdy)
              {
                  // $howdy is not used
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

          Avoid unused parameters such as '$type'.
          Open

              public function content($type, $content, $location)
          Severity: Minor
          Found in src/FrontendAsset.php by phpmd

          UnusedFormalParameter

          Since: 0.2

          Avoid passing parameters to methods or constructors and then not using those parameters.

          Example

          class Foo
          {
              private function bar($howdy)
              {
                  // $howdy is not used
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

          Avoid unused local variables such as '$path'.
          Open

                  $asset = Asset::createByContent($path, $content, $location);
          Severity: Minor
          Found in src/FrontendAsset.php by phpmd

          UnusedLocalVariable

          Since: 0.2

          Detects when a local variable is declared and/or assigned, but not used.

          Example

          class Foo {
              public function doSomething()
              {
                  $i = 5; // Unused
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

          Avoid excessively long variable names like $extension_default_locations. Keep variable name length under 20.
          Open

              public $extension_default_locations = [
                  'css'  => 'header',
                  'js'   => 'footer',
              ];
          Severity: Minor
          Found in src/FrontendAsset.php by phpmd

          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

          There are no issues that match your filters.

          Category
          Status