Sign upLogin

phug-php/reader

View on GitHub
Star
Reader.php

Summary

Maintainability
D
2 days
Test Coverage

File Reader.php has 430 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace Phug;

use Phug\Util\Partial\PathTrait;
Severity: Minor
Found in Reader.php - About 6 hrs to fix

    Reader has 42 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Reader
{
    use PathTrait;

    /**
    Severity: Minor
    Found in Reader.php - About 5 hrs to fix

      Function readExpression has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
      Open

          public function readExpression(array $breaks = null, array $brackets = null)
    {
        if (!$this->hasLength()) {
            return;
        }
      Severity: Minor
      Found in Reader.php - About 3 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

      The class Reader has 29 non-getter- and setter-methods. Consider refactoring Reader to keep number of methods under 25.
      Open

      class Reader
{
    use PathTrait;

    /**
      Severity: Minor
      Found in Reader.php by phpmd

      TooManyMethods

      Since: 0.1

      A class with too many 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'.

      The default was changed from 10 to 25 in PHPMD 2.3.

      Example

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

      The class Reader has 28 public methods. Consider refactoring Reader to keep number of public methods under 10.
      Open

      class Reader
{
    use PathTrait;

    /**
      Severity: Minor
      Found in Reader.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

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

      class Reader
{
    use PathTrait;

    /**
      Severity: Minor
      Found in Reader.php by phpmd

      Method readExpression has 48 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function readExpression(array $breaks = null, array $brackets = null)
    {
        if (!$this->hasLength()) {
            return;
        }
      Severity: Minor
      Found in Reader.php - About 1 hr to fix

        Method readString has 32 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function readString(array $escapeSequences = null, $raw = false)
    {
        if (!$this->peekQuote()) {
            return;
        }
        Severity: Minor
        Found in Reader.php - About 1 hr to fix

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

              public function readString(array $escapeSequences = null, $raw = false)
    {
        if (!$this->peekQuote()) {
            return;
        }
          Severity: Minor
          Found in Reader.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

          The method readString() has an NPath complexity of 216. The configured NPath complexity threshold is 200.
          Open

              public function readString(array $escapeSequences = null, $raw = false)
    {
        if (!$this->peekQuote()) {
            return;
        }
          Severity: Minor
          Found in Reader.php by phpmd

          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 readExpression() has an NPath complexity of 784. The configured NPath complexity threshold is 200.
          Open

              public function readExpression(array $breaks = null, array $brackets = null)
    {
        if (!$this->hasLength()) {
            return;
        }
          Severity: Minor
          Found in Reader.php by phpmd

          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 readString() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
          Open

              public function readString(array $escapeSequences = null, $raw = false)
    {
        if (!$this->peekQuote()) {
            return;
        }
          Severity: Minor
          Found in Reader.php by phpmd

          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

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

              public function readExpression(array $breaks = null, array $brackets = null)
    {
        if (!$this->hasLength()) {
            return;
        }
          Severity: Minor
          Found in Reader.php by phpmd

          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 '293', column '23').
          Open

                      throw new \InvalidArgumentException(
          Severity: Minor
          Found in Reader.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

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

                      throw new \InvalidArgumentException(
          Severity: Minor
          Found in Reader.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

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

              public function readString(array $escapeSequences = null, $raw = false)
          Severity: Minor
          Found in Reader.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

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

              public function peek($length = null, $start = null)
    {
        $this->lastPeekResult = null;
        $this->nextConsumeLength = null;
          Severity: Minor
          Found in Reader.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 consume uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
          Open

                      } else {
                $parts = explode("\n", $consumedPart);
                $this->offset = mb_strlen($parts[count($parts) - 1], $this->encoding);
            }
          Severity: Minor
          Found in Reader.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 using static access to class 'Phug\ReaderException' in method 'throwException'.
          Open

                      ReaderException::message($message, [
                'near'     => $this->peek(20),
                'path'     => $path,
                'line'     => $this->line,
                'offset'   => $this->offset,
          Severity: Minor
          Found in Reader.php by phpmd

          StaticAccess

          Since: 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example

          class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

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

          Call to method __construct from undeclared class \Phug\Util\SourceLocation
          Open

                      new SourceLocation(null, $this->line, $this->offset),
          Severity: Critical
          Found in Reader.php by phan

          Returning type void but readAlphaNumeric() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          Returning type void but peek() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          Doc-block of $allowedChars in peekIdentifier is phpdoc param type array which is not a permitted replacement of the nullable param type ?array declared in the signature ('?T' should be documented as 'T|null' or '?T')
          Open

               * @param array $allowedChars additional chars to allow in the identifier (default: ['_'])
          Severity: Minor
          Found in Reader.php by phan

          Returning type void but readSpaces() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          Returning type void but readWhile() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          Returning type void but readIdentifier() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          Call with 2 arg(s) to \Phug\ReaderException::__construct() which only takes 0 arg(s) defined at /code/ReaderException.php:10
          Open

                  $exception = new ReaderException(
          Severity: Info
          Found in Reader.php by phan

          Returning type void but readDigits() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          Doc-block of $brackets in readExpression is phpdoc param type array which is not a permitted replacement of the nullable param type ?array declared in the signature ('?T' should be documented as 'T|null' or '?T')
          Open

               * @param array $brackets the brackets to allow (Defaulting to whatever is defined in Reader->expressionBrackets)
          Severity: Minor
          Found in Reader.php by phan

          Doc-block of $allowedChars in peekAlphaIdentifier is phpdoc param type array which is not a permitted replacement of the nullable param type ?array declared in the signature ('?T' should be documented as 'T|null' or '?T')
          Open

               * @param array $allowedChars additional chars to allow in the identifier (default: ['_'])
          Severity: Minor
          Found in Reader.php by phan

          @throws annotation of match has suspicious class type \Phug\ReaderException, which does not extend Error/Exception
          Open

              public function match($pattern, $modifiers = null, $ignoredSuffixes = null)
          Severity: Minor
          Found in Reader.php by phan

          Doc-block of $breaks in readExpression is phpdoc param type array which is not a permitted replacement of the nullable param type ?array declared in the signature ('?T' should be documented as 'T|null' or '?T')
          Open

               * @param array $breaks   the break characters to use (Breaks on string end by default).
          Severity: Minor
          Found in Reader.php by phan

          Returning type void but readIdentifier() is declared to return null|string
          Open

                          return;
          Severity: Minor
          Found in Reader.php by phan

          Returning type void but readString() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          Call to undeclared method \Phug\Reader::getPath (Did you mean expr->getMatch())
          Open

                  $path = $this->getPath();
          Severity: Critical
          Found in Reader.php by phan

          Returning type void but readIndentation() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          Class uses undeclared trait \Phug\Util\Partial\PathTrait
          Open

          class Reader
          Severity: Critical
          Found in Reader.php by phan

          Returning type void but readAlpha() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          Suspicious array access to nullable ?array|?array{}
          Open

                              ? $escapeSequences[$nextChar]
          Severity: Minor
          Found in Reader.php by phan

          Returning type void but readExpression() is declared to return null|string
          Open

                      return;
          Severity: Minor
          Found in Reader.php by phan

          @throws annotation of throwException has suspicious class type \Phug\ReaderException, which does not extend Error/Exception
          Open

              protected function throwException($message)
          Severity: Minor
          Found in Reader.php by phan

          There are no issues that match your filters.

          Category
          Status