Sign upLogin

immense/php-macaroons

View on GitHub
Star

Showing 65 of 65 total issues

The class Utils has 13 public methods. Consider refactoring Utils to keep number of public methods under 10.
Open

class Utils
{
  public static function hexlify($value)
  {
    return join('', array_map(function($byte){
Severity: Minor
Found in lib/Macaroons/Utils.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

Method deserialize has 45 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  public static function deserialize($serialized)
  {
    $location   = NULL;
    $identifier = NULL;
    $signature  = NULL;
Severity: Minor
Found in lib/Macaroons/Macaroon.php - About 1 hr to fix

    Avoid excessively long variable names like $caveatMacaroonVerifier. Keep variable name length under 20.
    Open

        $caveatMacaroonVerifier = new Verifier();
    Severity: Minor
    Found in lib/Macaroons/Verifier.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

    Source https://phpmd.org/rules/naming.html#longvariable

    Avoid excessively long variable names like $truncatedOrPaddedSignature. Keep variable name length under 20.
    Open

        $truncatedOrPaddedSignature = Utils::truncateOrPad( $this->signature );
    Severity: Minor
    Found in lib/Macaroons/Macaroon.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

    Source https://phpmd.org/rules/naming.html#longvariable

    Avoid excessively long variable names like $dischargesMatchingCaveat. Keep variable name length under 20.
    Open

        $dischargesMatchingCaveat = array_filter($dischargeMacaroons, function($discharge) use ($rootMacaroon, $caveat) {
    Severity: Minor
    Found in lib/Macaroons/Verifier.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

    Source https://phpmd.org/rules/naming.html#longvariable

    Method serialize has 28 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      public function serialize()
  {
    $p = new Packet();
    $s = $p->packetize(
                        array(
    Severity: Minor
    Found in lib/Macaroons/Macaroon.php - About 1 hr to fix

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

        private function verifyThirdPartyCaveat(Caveat $caveat, Macaroon $rootMacaroon, Array $dischargeMacaroons)
  {
    $caveatMet = false;

    $dischargesMatchingCaveat = array_filter($dischargeMacaroons, function($discharge) use ($rootMacaroon, $caveat) {
      Severity: Minor
      Found in lib/Macaroons/Verifier.php - About 1 hr to fix

        Function verifyCaveats has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

          private function verifyCaveats(Macaroon $macaroon, Array $dischargeMacaroons = array())
  {
    foreach ($macaroon->getCaveats() as $caveat)
    {
      $caveatMet = false;
        Severity: Minor
        Found in lib/Macaroons/Verifier.php - About 55 mins 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 deserialize has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

          public static function deserialize($serialized)
  {
    $location   = NULL;
    $identifier = NULL;
    $signature  = NULL;
        Severity: Minor
        Found in lib/Macaroons/Macaroon.php - About 55 mins 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

        Avoid variables with short names like $m. Configured minimum length is 3.
        Open

            $m          = new Macaroon(
        Severity: Minor
        Found in lib/Macaroons/Macaroon.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

        Source https://phpmd.org/rules/naming.html#shortvariable

        The property $caveat_location is not named in camelCase.
        Open

        class Caveat
{
  private $caveat_id;
  private $verification_id;
  private $caveat_location;
        Severity: Minor
        Found in lib/Macaroons/Caveat.php by phpmd

        CamelCasePropertyName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name attributes.

        Example

        class ClassName {
    protected $property_name;
}

        Source

        Avoid variables with short names like $p. Configured minimum length is 3.
        Open

            $p = new Packet();
        Severity: Minor
        Found in lib/Macaroons/Macaroon.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

        Source https://phpmd.org/rules/naming.html#shortvariable

        Avoid variables with short names like $s. Configured minimum length is 3.
        Open

            $s = $p->packetize(
        Severity: Minor
        Found in lib/Macaroons/Macaroon.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

        Source https://phpmd.org/rules/naming.html#shortvariable

        The property $verification_id is not named in camelCase.
        Open

        class Caveat
{
  private $caveat_id;
  private $verification_id;
  private $caveat_location;
        Severity: Minor
        Found in lib/Macaroons/Caveat.php by phpmd

        CamelCasePropertyName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name attributes.

        Example

        class ClassName {
    protected $property_name;
}

        Source

        Avoid variables with short names like $id. Configured minimum length is 3.
        Open

          private $id;
        Severity: Minor
        Found in lib/Macaroons/Macaroon.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

        Source https://phpmd.org/rules/naming.html#shortvariable

        Avoid variables with short names like $m. Configured minimum length is 3.
        Open

            $m = new Macaroon('no_key', $identifier, $location);
        Severity: Minor
        Found in lib/Macaroons/Macaroon.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

        Source https://phpmd.org/rules/naming.html#shortvariable

        Avoid variables with short names like $a. Configured minimum length is 3.
        Open

          private function signaturesMatch($a, $b)
        Severity: Minor
        Found in lib/Macaroons/Verifier.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

        Source https://phpmd.org/rules/naming.html#shortvariable

        Avoid variables with short names like $b. Configured minimum length is 3.
        Open

          private function signaturesMatch($a, $b)
        Severity: Minor
        Found in lib/Macaroons/Verifier.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

        Source https://phpmd.org/rules/naming.html#shortvariable

        The property $caveat_id is not named in camelCase.
        Open

        class Caveat
{
  private $caveat_id;
  private $verification_id;
  private $caveat_location;
        Severity: Minor
        Found in lib/Macaroons/Caveat.php by phpmd

        CamelCasePropertyName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name attributes.

        Example

        class ClassName {
    protected $property_name;
}

        Source

        Function verifyFirstPartyCaveat has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

          private function verifyFirstPartyCaveat(Caveat $caveat)
  {
    $caveatMet = false;
    if (in_array($caveat->getCaveatId(), $this->predicates))
      $caveatMet = true;
        Severity: Minor
        Found in lib/Macaroons/Verifier.php - About 45 mins 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

        Severity
        Category
        Status
        Source
        Language