gdbots/pbjc-php

View on GitHub
src/Compiler.php

Summary

Maintainability
C
1 day
Test Coverage

Function __construct has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
Open

    public function __construct()
    {
        $enums = [];
        $schemas = [];

Severity: Minor
Found in src/Compiler.php - About 4 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 __construct has 65 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function __construct()
    {
        $enums = [];
        $schemas = [];

Severity: Major
Found in src/Compiler.php - About 2 hrs to fix

    Function run has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
    Open

        public function run($language, CompileOptions $options)
        {
            $namespaces = $options->getNamespaces();
    
            if (!$namespaces || count($namespaces) === 0) {
    Severity: Minor
    Found in src/Compiler.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 run has 39 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function run($language, CompileOptions $options)
        {
            $namespaces = $options->getNamespaces();
    
            if (!$namespaces || count($namespaces) === 0) {
    Severity: Minor
    Found in src/Compiler.php - About 1 hr to fix

      The method run() has an NPath complexity of 1728. The configured NPath complexity threshold is 200.
      Open

          public function run($language, CompileOptions $options)
          {
              $namespaces = $options->getNamespaces();
      
              if (!$namespaces || count($namespaces) === 0) {
      Severity: Minor
      Found in src/Compiler.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 __construct() has an NPath complexity of 1218. The configured NPath complexity threshold is 200.
      Open

          public function __construct()
          {
              $enums = [];
              $schemas = [];
      
      
      Severity: Minor
      Found in src/Compiler.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 __construct() has 107 lines of code. Current threshold is set to 100. Avoid really long methods.
      Open

          public function __construct()
          {
              $enums = [];
              $schemas = [];
      
      
      Severity: Minor
      Found in src/Compiler.php by phpmd

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

          public function __construct()
          {
              $enums = [];
              $schemas = [];
      
      
      Severity: Minor
      Found in src/Compiler.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 run() has a Cyclomatic Complexity of 15. The configured cyclomatic complexity threshold is 10.
      Open

          public function run($language, CompileOptions $options)
          {
              $namespaces = $options->getNamespaces();
      
              if (!$namespaces || count($namespaces) === 0) {
      Severity: Minor
      Found in src/Compiler.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 '136', column '23').
      Open

                  throw new \InvalidArgumentException('Missing "namespaces" options.');
      Severity: Minor
      Found in src/Compiler.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 '97', column '31').
      Open

                          throw new \RuntimeException(sprintf('Recursively requesting schema id "%s" from file "%s".', $e->getMessage(), $currentFile));
      Severity: Minor
      Found in src/Compiler.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 '145', column '27').
      Open

                      throw new \InvalidArgumentException(sprintf(
      Severity: Minor
      Found in src/Compiler.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 '93', column '31').
      Open

                          throw new \RuntimeException(sprintf('Schema with id "%s" is invalid.', $e->getMessage()));
      Severity: Minor
      Found in src/Compiler.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 '153', column '23').
      Open

                  throw new \InvalidArgumentException('Missing "output" directory options.');
      Severity: Minor
      Found in src/Compiler.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

      Avoid using static access to class 'Gdbots\Pbjc\SchemaStore' in method '__construct'.
      Open

              foreach (SchemaStore::getDirs() as $dir) {
      Severity: Minor
      Found in src/Compiler.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

      Avoid using static access to class '\Gdbots\Common\Util\StringUtils' in method 'run'.
      Open

              $class = sprintf('\Gdbots\Pbjc\Generator\%sGenerator', StringUtils::toCamelFromSlug($language));
      Severity: Minor
      Found in src/Compiler.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

      Avoid using static access to class 'Gdbots\Pbjc\SchemaStore' in method '__construct'.
      Open

                          SchemaStore::addSchema($schema->getId(), $schema);
      Severity: Minor
      Found in src/Compiler.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

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

          public function __construct()
          {
              $enums = [];
              $schemas = [];
      
      
      Severity: Minor
      Found in src/Compiler.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 __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                      } else {
                          $schemas[] = $file->getPathName();
                      }
      Severity: Minor
      Found in src/Compiler.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 'Gdbots\Pbjc\SchemaStore' in method 'run'.
      Open

              foreach (SchemaStore::getSchemas() as $schema) {
      Severity: Minor
      Found in src/Compiler.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

      Avoid using static access to class 'Gdbots\Pbjc\SchemaStore' in method 'run'.
      Open

              $outputFiles = array_merge($outputFiles, $generator->generateManifest(SchemaStore::getSchemas())->getFiles());
      Severity: Minor
      Found in src/Compiler.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

      Avoid using static access to class 'Gdbots\Pbjc\SchemaStore' in method '__construct'.
      Open

                      SchemaStore::addEnum($enum->getId(), $enum);
      Severity: Minor
      Found in src/Compiler.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

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

          public function run($language, CompileOptions $options)
          {
              $namespaces = $options->getNamespaces();
      
              if (!$namespaces || count($namespaces) === 0) {
      Severity: Minor
      Found in src/Compiler.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

      Avoid using static access to class 'Gdbots\Pbjc\SchemaStore' in method '__construct'.
      Open

              foreach (SchemaStore::getSchemasByCurieMajor() as $schema) {
      Severity: Minor
      Found in src/Compiler.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

      Avoid using static access to class 'Gdbots\Pbjc\SchemaStore' in method 'run'.
      Open

              foreach (SchemaStore::getEnums() as $enum) {
      Severity: Minor
      Found in src/Compiler.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

      Avoid using Gdbots\Pbjc\count() function in while loops.
      Open

              while (count($schemas) > 0) {
                  if (!$currentFile) {
                      $currentFile = current($schemas);
                  }
      
      
      Severity: Minor
      Found in src/Compiler.php by phpmd

      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

      Line exceeds 120 characters; contains 146 characters
      Open

                          throw new \RuntimeException(sprintf('Recursively requesting schema id "%s" from file "%s".', $e->getMessage(), $currentFile));
      Severity: Minor
      Found in src/Compiler.php by phpcodesniffer

      There are no issues that match your filters.

      Category
      Status