ecoco/magento_profiler

View on GitHub
app/code/community/Ecocode/Profiler/Model/Profiler/FileStorage.php

Summary

Maintainability
C
1 day
Test Coverage

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

class Ecocode_Profiler_Model_Profiler_FileStorage
    implements Ecocode_Profiler_Model_Profiler_StorageInterface
{
    /**
     * Folder where profiler data are stored.

Function find has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

    public function find($ip, $url, $limit, $method, $start = null, $end = null, $statusCode = null)
    {
        $file = $this->getIndexFilename();

        if (!file_exists($file)) {
Severity: Minor
Found in app/code/community/Ecocode/Profiler/Model/Profiler/FileStorage.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 write has 43 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function write(Ecocode_Profiler_Model_Profile $profile)
    {
        $file = $this->getFilename($profile->getToken());

        $profileIndexed = is_file($file);
Severity: Minor
Found in app/code/community/Ecocode/Profiler/Model/Profiler/FileStorage.php - About 1 hr to fix

    Method find has 34 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function find($ip, $url, $limit, $method, $start = null, $end = null, $statusCode = null)
        {
            $file = $this->getIndexFilename();
    
            if (!file_exists($file)) {
    Severity: Minor
    Found in app/code/community/Ecocode/Profiler/Model/Profiler/FileStorage.php - About 1 hr to fix

      Consider simplifying this complex logical expression.
      Open

                  if ($ip && false === strpos($csvIp, $ip) || $url && false === strpos($csvUrl, $url) || $method && false === strpos($csvMethod, $method) || $statusCode && false === strpos($csvStatusCode, $statusCode)) {
                      continue;
                  }
      Severity: Critical
      Found in app/code/community/Ecocode/Profiler/Model/Profiler/FileStorage.php - About 1 hr to fix

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

            protected function readLineFromFile($file)
            {
                $line     = '';
                $position = ftell($file);
        
        
        Severity: Minor
        Found in app/code/community/Ecocode/Profiler/Model/Profiler/FileStorage.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 find has 7 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            public function find($ip, $url, $limit, $method, $start = null, $end = null, $statusCode = null)
        Severity: Major
        Found in app/code/community/Ecocode/Profiler/Model/Profiler/FileStorage.php - About 50 mins to fix

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

              public function write(Ecocode_Profiler_Model_Profile $profile)
              {
                  $file = $this->getFilename($profile->getToken());
          
                  $profileIndexed = is_file($file);
          Severity: Minor
          Found in app/code/community/Ecocode/Profiler/Model/Profiler/FileStorage.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 createProfileFromData has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

              protected function createProfileFromData($token, $data, $parent = null)
              {
                  $profile = new Ecocode_Profiler_Model_Profile($token);
                  $profile->setIp($data['ip']);
                  $profile->setMethod($data['method']);
          Severity: Minor
          Found in app/code/community/Ecocode/Profiler/Model/Profiler/FileStorage.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

          The method find() has an NPath complexity of 328. The configured NPath complexity threshold is 200.
          Open

              public function find($ip, $url, $limit, $method, $start = null, $end = null, $statusCode = null)
              {
                  $file = $this->getIndexFilename();
          
                  if (!file_exists($file)) {

          NPathComplexity

          Since: 0.1

          The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

          Example

          class Foo {
              function bar() {
                  // lots of complicated code
              }
          }

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

          The method find() has a Cyclomatic Complexity of 17. The configured cyclomatic complexity threshold is 10.
          Open

              public function find($ip, $url, $limit, $method, $start = null, $end = null, $statusCode = null)
              {
                  $file = $this->getIndexFilename();
          
                  if (!file_exists($file)) {

          CyclomaticComplexity

          Since: 0.1

          Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

          Example

          // Cyclomatic Complexity = 11
          class Foo {
          1   public function example() {
          2       if ($a == $b) {
          3           if ($a1 == $b1) {
                          fiddle();
          4           } elseif ($a2 == $b2) {
                          fiddle();
                      } else {
                          fiddle();
                      }
          5       } elseif ($c == $d) {
          6           while ($c == $d) {
                          fiddle();
                      }
          7        } elseif ($e == $f) {
          8           for ($n = 0; $n < $h; $n++) {
                          fiddle();
                      }
                  } else {
                      switch ($z) {
          9               case 1:
                              fiddle();
                              break;
          10              case 2:
                              fiddle();
                              break;
          11              case 3:
                              fiddle();
                              break;
                          default:
                              fiddle();
                              break;
                      }
                  }
              }
          }

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

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

                      throw new \RuntimeException(sprintf('Unable to create the storage directory (%s).', $this->folder));

          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

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

                          throw new \RuntimeException(sprintf('Unable to create the storage directory (%s).', $dir));

          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

          Remove error control operator '@' on line 145.
          Open

              public function write(Ecocode_Profiler_Model_Profile $profile)
              {
                  $file = $this->getFilename($profile->getToken());
          
                  $profileIndexed = is_file($file);

          ErrorControlOperator

          Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

          Example

          function foo($filePath) {
              $file = @fopen($filPath); // hides exceptions
              $key = @$array[$notExistingKey]; // assigns null to $key
          }

          Source http://phpmd.org/rules/cleancode.html#errorcontroloperator

          Missing class import via use statement (line '275', column '24').
          Open

                  $profile = new Ecocode_Profiler_Model_Profile($token);

          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

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

                      throw new \RuntimeException(sprintf('Please check your configuration. You are trying to use FileStorage with an invalid dsn "%s". The expected format is "file:/path/to/the/storage/folder".', $dsn));

          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

          Missing class import via use statement (line '109', column '25').
          Open

                  $iterator = new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::CHILD_FIRST);

          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

          Remove error control operator '@' on line 45.
          Open

              public function __construct(array $config)
              {
                  $dsn = $config['dsn'];
                  if (0 !== strpos($dsn, 'file:')) {
                      throw new \RuntimeException(sprintf('Please check your configuration. You are trying to use FileStorage with an invalid dsn "%s". The expected format is "file:/path/to/the/storage/folder".', $dsn));

          ErrorControlOperator

          Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

          Example

          function foo($filePath) {
              $file = @fopen($filPath); // hides exceptions
              $key = @$array[$notExistingKey]; // assigns null to $key
          }

          Source http://phpmd.org/rules/cleancode.html#errorcontroloperator

          Missing class import via use statement (line '108', column '25').
          Open

                  $iterator = new \RecursiveDirectoryIterator($this->folder, $flags);

          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 assigning values to variables in if clauses and the like (line '293', column '41').
          Open

              protected function createProfileFromData($token, $data, $parent = null)
              {
                  $profile = new Ecocode_Profiler_Model_Profile($token);
                  $profile->setIp($data['ip']);
                  $profile->setMethod($data['method']);

          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

          Avoid assigning values to variables in if clauses and the like (line '173', column '27').
          Open

              public function write(Ecocode_Profiler_Model_Profile $profile)
              {
                  $file = $this->getFilename($profile->getToken());
          
                  $profileIndexed = is_file($file);

          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

          Avoid assigning values to variables in if clauses and the like (line '250', column '28').
          Open

              protected function readLineFromFile($file)
              {
                  $line     = '';
                  $position = ftell($file);
          
          

          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

          Avoid assigning values to variables in if clauses and the like (line '125', column '37').
          Open

              public function read($token)
              {
                  if (!$token || !file_exists($file = $this->getFilename($token))) {
                      return;
                  }

          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

          Avoid using count() function in while loops.
          Open

                  while (count($result) < $limit && $line = $this->readLineFromFile($file)) {
                      $values = str_getcsv($line);
                      list($csvToken, $csvIp, $csvMethod, $csvUrl, $csvTime, $csvParent, $csvStatusCode) = $values;
                      //new feature to maintain backward compatibility
                      $fileSize = isset($values[7]) ? $values[7] : 0;

          CountInLoopExpression

          Since: 2.7.0

          Using count/sizeof in loops expressions is considered bad practice and is a potential source of many bugs, especially when the loop manipulates an array, as count happens on each iteration.

          Example

          class Foo {
          
            public function bar()
            {
              $array = array();
          
              for ($i = 0; count($array); $i++) {
                // ...
              }
            }
          }

          Source https://phpmd.org/rules/design.html#countinloopexpression

          Avoid excessively long class names like Ecocode_Profiler_Model_Profiler_FileStorage. Keep class name length under 40.
          Open

          class Ecocode_Profiler_Model_Profiler_FileStorage
              implements Ecocode_Profiler_Model_Profiler_StorageInterface
          {
              /**
               * Folder where profiler data are stored.

          LongClassName

          Since: 2.9

          Detects when classes or interfaces are declared with excessively long names.

          Example

          class ATooLongClassNameThatHintsAtADesignProblem {
          
          }
          
          interface ATooLongInterfaceNameThatHintsAtADesignProblem {
          
          }

          Source https://phpmd.org/rules/naming.html#longclassname

          There are no issues that match your filters.

          Category
          Status