Sign upLogin

guibranco/Pancake

View on GitHub
Star

Showing 18 of 18 total issues

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

    public function generateColorFromText(string $text, int $minBrightness = 100, int $spec = 10): Color
    {
        if ($spec < 2 || $spec > 10) {
            throw new InvalidArgumentException("$spec is out of range");
        }
Severity: Minor
Found in src/Color.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 generateColorFromText has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function generateColorFromText(string $text, int $minBrightness = 100, int $spec = 10): Color
    {
        if ($spec < 2 || $spec > 10) {
            throw new InvalidArgumentException("$spec is out of range");
        }
Severity: Minor
Found in src/Color.php - About 1 hr to fix

    Method generateBadgeUrl has 6 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        public function generateBadgeUrl($label, $content, $color, $style, $labelColor, $logo)
    Severity: Minor
    Found in src/ShieldsIo.php - About 45 mins to fix

      Similar blocks of code found in 4 locations. Consider refactoring.
      Open

          public function patch($url, $headers = array(), $data = null): stdClass
    {
        $fields = $this->getFields($url, $headers);
        $fields[CURLOPT_CUSTOMREQUEST] = "PATCH";
        if ($data !== null) {
      Severity: Major
      Found in src/Request.php and 3 other locations - About 35 mins to fix
      src/Request.php on lines 96..104
      src/Request.php on lines 106..114
      src/Request.php on lines 116..124

      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 92.

      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

      Similar blocks of code found in 4 locations. Consider refactoring.
      Open

          public function put($url, $headers = array(), $data = null): stdClass
    {
        $fields = $this->getFields($url, $headers);
        $fields[CURLOPT_CUSTOMREQUEST] = "PUT";
        if ($data !== null) {
      Severity: Major
      Found in src/Request.php and 3 other locations - About 35 mins to fix
      src/Request.php on lines 96..104
      src/Request.php on lines 116..124
      src/Request.php on lines 126..134

      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 92.

      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

      Similar blocks of code found in 4 locations. Consider refactoring.
      Open

          public function delete($url, $headers = array(), $data = null): stdClass
    {
        $fields = $this->getFields($url, $headers);
        $fields[CURLOPT_CUSTOMREQUEST] = "DELETE";
        if ($data !== null) {
      Severity: Major
      Found in src/Request.php and 3 other locations - About 35 mins to fix
      src/Request.php on lines 96..104
      src/Request.php on lines 106..114
      src/Request.php on lines 126..134

      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 92.

      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

      Similar blocks of code found in 4 locations. Consider refactoring.
      Open

          public function post($url, $headers = array(), $data = null): stdClass
    {
        $fields = $this->getFields($url, $headers);
        $fields[CURLOPT_CUSTOMREQUEST] = "POST";
        if ($data !== null) {
      Severity: Major
      Found in src/Request.php and 3 other locations - About 35 mins to fix
      src/Request.php on lines 106..114
      src/Request.php on lines 116..124
      src/Request.php on lines 126..134

      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 92.

      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

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

          private function sendInternal($content, $headers, $isRetry = false)
      Severity: Minor
      Found in src/OneSignal.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 using static access to class 'GuiBranco\Pancake\GUIDv4' in method '__construct'.
      Open

                  "X-Correlation-Id: ".GUIDv4::random()
      Severity: Minor
      Found in src/Logger.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

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

          public function generateColorFromText(string $text, int $minBrightness = 100, int $spec = 10): Color
    {
        if ($spec < 2 || $spec > 10) {
            throw new InvalidArgumentException("$spec is out of range");
        }
      Severity: Minor
      Found in src/Color.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

      Argument 3 ($pad_string) is 0 of type 0 but \str_pad() takes string
      Open

                  $output .= str_pad(dechex($colors[$i]), 2, 0, STR_PAD_LEFT);
      Severity: Minor
      Found in src/Color.php by phan

      Argument #2 of this call to \str_pad is typically a literal or constant but isn't, but argument #1 (which is typically a variable) is a literal or constant. The arguments may be in the wrong order.
      Open

                  $current = round(((hexdec(substr($hash, $spec * $i, $spec))) / hexdec(str_pad("", $spec, "F"))) * 255);
      Severity: Minor
      Found in src/Color.php by phan

      Call to method log on non-class type ?mixed
      Open

                  $this->logger->log("Error sending OneSignal", json_encode($result));
      Severity: Critical
      Found in src/OneSignal.php by phan

      Saw an @param annotation for $hexColor, but it was not found in the param list of function setRed(string $red) : void
      Open

           * @param string $hexColor The hex color.
      Severity: Info
      Found in src/Color.php by phan

      Invalid operator: left operand of * is string (expected number)
      Open

              return ($this->red * 0.2126 + $this->green * 0.7152 + $this->blue * 0.0722) / 255;
      Severity: Minor
      Found in src/Color.php by phan

      Define a constant instead of duplicating this literal "object" 3 times.
      Open

              $caller["object"] = isset($caller["object"]) ? print_r($caller["object"], true) : "";
      Severity: Critical
      Found in src/Logger.php by sonar-php

      Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

      On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

      Noncompliant Code Example

      With the default threshold of 3:

      function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

      Compliant Solution

      ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

      Exceptions

      To prevent generating some false-positives, literals having less than 5 characters are excluded.

      Possibly invalid offset $i of $colors of array type array{0?:mixed}
      Open

                          $colors[$i] += 10;
      Severity: Minor
      Found in src/Color.php by phan

      Possibly invalid offset $i of $colors of array type array{0?:float|int|mixed}
      Open

                  $output .= str_pad(dechex($colors[$i]), 2, 0, STR_PAD_LEFT);
      Severity: Minor
      Found in src/Color.php by phan
      Severity
      Category
      Status
      Source
      Language