Sign upLogin

howardjones/network-weathermap

View on GitHub
Star
lib/Weathermap/Core/Spine.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

    public function findIndexNearDistance($targetDistance)
    {
        $left = 0;
        $right = count($this->elements) - 1;
Severity: Minor
Found in lib/Weathermap/Core/Spine.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 findIndexNearDistance has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function findIndexNearDistance($targetDistance)
    {
        $left = 0;
        $right = count($this->elements) - 1;
Severity: Minor
Found in lib/Weathermap/Core/Spine.php - About 1 hr to fix

    Avoid too many return statements within this method.
    Open

                    return $mid;
    Severity: Major
    Found in lib/Weathermap/Core/Spine.php - About 30 mins to fix

      Reduce the number of returns of this function 5, down to the maximum allowed 3.
      Open

          public function findIndexNearDistance($targetDistance)
      Severity: Major
      Found in lib/Weathermap/Core/Spine.php by sonar-php

      Having too many return statements in a function increases the function's essential complexity because the flow of execution is broken each time a return statement is encountered. This makes it harder to read and understand the logic of the function.

      Noncompliant Code Example

      With the default threshold of 3:

      function myFunction(){ // Noncompliant as there are 4 return statements
  if (condition1) {
    return true;
  } else {
    if (condition2) {
      return false;
    } else {
      return true;
    }
  }
  return false;
}

      Remove this commented out code.
      Open

                  //     MapUtility::wm_debug("  $totalDistance => $newDistance  \n");
      Severity: Major
      Found in lib/Weathermap/Core/Spine.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