Sign upLogin

immense/php-macaroons

View on GitHub
Star
lib/Macaroons/Macaroon.php

Summary

Maintainability
A
3 hrs
Test Coverage

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

    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

      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

      Missing class import via use statement (line '58', column '17').
      Open

            throw new \InvalidArgumentException('Must supply updated signature');
      Severity: Minor
      Found in lib/Macaroons/Macaroon.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
    return new \stdClass();
}

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Avoid using static access to class 'Macaroons\Utils' in method 'addThirdPartyCaveat'.
      Open

          $derivedCaveatKey = Utils::truncateOrPad( Utils::generateDerivedKey($caveatKey) );
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'bindSignature'.
      Open

          $currentSignatureHash = Utils::hmac($key, Utils::unhexlify($this->getSignature()));
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'bindSignature'.
      Open

          $key                  = Utils::truncateOrPad("\0");
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'bindSignature'.
      Open

          return Utils::hmac($key, $currentSignatureHash . $newSignatureHash);
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'addFirstPartyCaveat'.
      Open

          $this->signature = Utils::signFirstPartyCaveat($this->signature, $predicate);
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'addThirdPartyCaveat'.
      Open

          $this->signature = Utils::signThirdPartyCaveat($this->signature, $verificationId, $caveatId);
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'addThirdPartyCaveat'.
      Open

          $derivedCaveatKey = Utils::truncateOrPad( Utils::generateDerivedKey($caveatKey) );
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'bindSignature'.
      Open

          $newSignatureHash     = Utils::hmac($key, Utils::unhexlify($signature));
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'toJSON'.
      Open

                $caveatAsArray['vid'] = Utils::hexlify($caveatAsArray['vid']);
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'serialize'.
      Open

          return Utils::base64_url_encode($s);
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'getSignature'.
      Open

          return strtolower( Utils::hexlify( $this->signature ) );
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'initialSignature'.
      Open

          return Utils::hmac( Utils::generateDerivedKey($key), $identifier);
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'addThirdPartyCaveat'.
      Open

          $truncatedOrPaddedSignature = Utils::truncateOrPad( $this->signature );
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'fromJSON'.
      Open

          $m->setSignature(Utils::unhexlify($signature));
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'bindSignature'.
      Open

          $currentSignatureHash = Utils::hmac($key, Utils::unhexlify($this->getSignature()));
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'bindSignature'.
      Open

          $newSignatureHash     = Utils::hmac($key, Utils::unhexlify($signature));
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'initialSignature'.
      Open

          return Utils::hmac( Utils::generateDerivedKey($key), $identifier);
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid using static access to class 'Macaroons\Utils' in method 'deserialize'.
      Open

          $decoded    = Utils::base64_url_decode($serialized);
      Severity: Minor
      Found in lib/Macaroons/Macaroon.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

      Avoid unused private fields such as '$id'.
      Open

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

      UnusedPrivateField

      Since: 0.2

      Detects when a private field is declared and/or assigned a value, but not used.

      Example

      class Something
{
    private static $FOO = 2; // Unused
    private $i = 5; // Unused
    private $j = 6;
    public function addOne()
    {
        return $this->j++;
    }
}

      Source https://phpmd.org/rules/unusedcode.html#unusedprivatefield

      TODO found
      Open

        // TODO: Move these into a separate object
      Severity: Minor
      Found in lib/Macaroons/Macaroon.php by fixme

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

      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

      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

      There are no issues that match your filters.

      Category
      Status