njuhel/php-swagger-to-md

View on GitHub
src/SwaggerValidator/Object/PathItem.php

Summary

Maintainability
C
7 hrs
Test Coverage

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

    public function getTags(\SwaggerValidator\Common\Context $context, $tags)
    {
        $method  = __FUNCTION__;
        $keyTags = \SwaggerValidator\Common\FactorySwagger::KEY_TAGS;
        $curPath = $context->getRoutePath();
Severity: Minor
Found in src/SwaggerValidator/Object/PathItem.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 getTags has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getTags(\SwaggerValidator\Common\Context $context, $tags)
    {
        $method  = __FUNCTION__;
        $keyTags = \SwaggerValidator\Common\FactorySwagger::KEY_TAGS;
        $curPath = $context->getRoutePath();
Severity: Minor
Found in src/SwaggerValidator/Object/PathItem.php - About 1 hr to fix

    Method markdown has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function markdown(\SwaggerValidator\Common\Context $context, $generalItems)
        {
            $method       = __FUNCTION__;
            $generalItems = $this->getMethodGeneric($context, $method, $generalItems);
            $tplOperation = array();
    Severity: Minor
    Found in src/SwaggerValidator/Object/PathItem.php - About 1 hr to fix

      Avoid using static access to class '\Swagger2md\Swagger2md' in method 'getTags'.
      Open

                      \Swagger2md\Swagger2md::printOutVV('Tags "' . $oneTag . '" found for path :' . $context->getDataPath() . ' and Method :' . $key);

      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 '\Swagger2md\Swagger2md' in method 'getTags'.
      Open

                          'link' => \Swagger2md\Swagger2md::makeAnchor($string),

      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

      The method getResourceForKey uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              else {
                  $isResource = false;
              }

      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 '\Swagger2md\Swagger2md' in method 'getSummary'.
      Open

              \Swagger2md\Swagger2md::printOutVV('Summary generated for path :' . $context->getDataPath());

      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 '\Swagger2md\Swagger2md' in method 'getTags'.
      Open

                              'link'    => \Swagger2md\Swagger2md::makeAnchor($string),

      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 '\Swagger2md\Swagger2md' in method 'getSummary'.
      Open

                  \Swagger2md\Swagger2md::printOutVV('Summary adding method : ' . $key);

      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 '\Swagger2md\Swagger2md' in method 'markdown'.
      Open

              \Swagger2md\Swagger2md::printOutV('Rendering this template : ' . $tpl);

      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 '\Swagger2md\Swagger2md' in method 'getTags'.
      Open

              \Swagger2md\Swagger2md::printOutVV('Tags generated for path :' . $context->getDataPath());

      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 '\Swagger2md\Swagger2md' in method 'markdown'.
      Open

                      \Swagger2md\Swagger2md::printOutVV('Skip PathItem Name : ' . $key);

      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 '\Swagger2md\Swagger2md' in method 'getSummary'.
      Open

                      'link' => \Swagger2md\Swagger2md::makeAnchor($string),

      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 unused local variables such as '$method'.
      Open

              $method  = __FUNCTION__;

      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

      Identical blocks of code found in 2 locations. Consider refactoring.
      Open

          protected function getResourceForKey($key)
          {
              $resources = explode('/', trim($key, '/'));
      
              if (count($resources) < 2) {
      Severity: Major
      Found in src/SwaggerValidator/Object/PathItem.php and 1 other location - About 2 hrs to fix
      src/SwaggerValidator/Object/Paths.php on lines 143..161

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 133.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      There are no issues that match your filters.

      Category
      Status