howardjones/network-weathermap

View on GitHub
lib/Weathermap/Tests/DocsTest.php

Summary

Maintainability
B
6 hrs
Test Coverage

Function testIndexOrphans has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

    public function testIndexOrphans()
    {
        # Check that all the little config XML files actually appear somewhere in the index.xml
        $docsIndex = $this->docsRoot . "/index.xml";

Severity: Minor
Found in lib/Weathermap/Tests/DocsTest.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

Function testKeywordCoverage has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

    public function testKeywordCoverage()
    {

        $docsIndex = $this->docsRoot . "/index.xml";

Severity: Minor
Found in lib/Weathermap/Tests/DocsTest.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 testIndexOrphans has 32 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function testIndexOrphans()
    {
        # Check that all the little config XML files actually appear somewhere in the index.xml
        $docsIndex = $this->docsRoot . "/index.xml";

Severity: Minor
Found in lib/Weathermap/Tests/DocsTest.php - About 1 hr to fix

    Method testKeywordCoverage has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function testKeywordCoverage()
        {
    
            $docsIndex = $this->docsRoot . "/index.xml";
    
    
    Severity: Minor
    Found in lib/Weathermap/Tests/DocsTest.php - About 1 hr to fix

      Refactor this function to reduce its Cognitive Complexity from 17 to the 15 allowed.
      Open

          public function testIndexOrphans()
      Severity: Critical
      Found in lib/Weathermap/Tests/DocsTest.php by sonar-php

      Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

      See

      Remove this commented out code.
      Open

      //require_once dirname(__FILE__) . '/../lib/all.php';
      Severity: Major
      Found in lib/Weathermap/Tests/DocsTest.php by sonar-php

      Programmers should not comment out code as it bloats programs and reduces readability.

      Unused code should be deleted and can be retrieved from source control history if required.

      See

      • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
      • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
      • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
      • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

      Merge this if statement with the enclosing one.
      Open

                          if (preg_match('/^(node|global|link)_/', $file)) {
      Severity: Major
      Found in lib/Weathermap/Tests/DocsTest.php by sonar-php

      Merging collapsible if statements increases the code's readability.

      Noncompliant Code Example

      if (condition1) {
        if (condition2) {
          ...
        }
      }
      

      Compliant Solution

      if (condition1 && condition2) {
        ...
      }
      

      Remove this commented out code.
      Open

      //            $keyword = $p[1];
      Severity: Major
      Found in lib/Weathermap/Tests/DocsTest.php by sonar-php

      Programmers should not comment out code as it bloats programs and reduces readability.

      Unused code should be deleted and can be retrieved from source control history if required.

      See

      • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
      • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
      • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
      • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

      There are no issues that match your filters.

      Category
      Status