PoolDecorator - Code Metrics - Inspection of "Add back Iron decorator" - jeskew/psr6-encrypting-decorator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Jonathan

created 2016-05-24 07:35 UTC

PoolDecorator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	58
Duplicated Lines	29.31 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes	2
Bugs	0	Features	2

Metric	Value
wmc	7
lcom	2
cbo	4
dl	17
loc	58
rs	10
c	2
b	0
f	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	17	17	2
A	decorate()	0	8	1
A	save()	0	5	1
A	saveDeferred()	0	5	1
A	finalizeItem()	0	9	2

How to fix Duplicated Code

<?php
namespace Jsq\CacheEncryption\Iron;

use Iron;
use Iron\PasswordInterface;
use Jsq\CacheEncryption\InvalidArgumentException;
use Jsq\CacheEncryption\PoolDecorator as BasePoolDecorator;
use Psr\Cache\CacheItemInterface;
use Psr\Cache\CacheItemPoolInterface;

class PoolDecorator extends BasePoolDecorator
{
    /** @var CacheItemPoolInterface */
    private $decorated;

    /** @var PasswordInterface */
    private $password;
    /** @var string */
    private $cipher;

    public function __construct(

        CacheItemPoolInterface $decorated,
        $password,
        $cipher = Iron\Iron::DEFAULT_ENCRYPTION_METHOD
    ) {
        if (!class_exists(Iron\Iron::class)) {
            // @codeCoverageIgnoreStart
            throw new \RuntimeException('You must install'
                . ' jsq/iron-php to use the Iron decorator.');
            // @codeCoverageIgnoreEnd
        }
        
        parent::__construct($decorated);
        $this->decorated = $decorated;
        $this->password = Iron\normalize_password($password);
        $this->cipher = $cipher;
    }

    protected function decorate(CacheItemInterface $inner)
    {
        return new ItemDecorator(
            $inner,
            $this->password,
            $this->cipher
        );
    }

    public function save(CacheItemInterface $item)
    {
        $this->finalizeItem($item);
        return $this->decorated->save($item->getDecorated());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function saveDeferred(CacheItemInterface $item)
    {
        $this->finalizeItem($item);
        return $this->decorated->saveDeferred($item->getDecorated());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    private function finalizeItem(CacheItemInterface $item)
    {
        if ($item instanceof ItemDecorator) {
            return $item->finalize();
        }
        
        throw new InvalidArgumentException('The provided cache item cannot'
            . ' be saved, as it did not originate from this cache.');
    }
}


1		<?php
2		namespace Jsq\CacheEncryption\Iron;
3
4		use Iron;
5		use Iron\PasswordInterface;
6		use Jsq\CacheEncryption\InvalidArgumentException;
7		use Jsq\CacheEncryption\PoolDecorator as BasePoolDecorator;
8		use Psr\Cache\CacheItemInterface;
9		use Psr\Cache\CacheItemPoolInterface;
10
11		class PoolDecorator extends BasePoolDecorator
12		{
13		/** @var CacheItemPoolInterface */
14		private $decorated;
		0 ignored issues – show Comprehensibility introduced 2016-05-24 07:38 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
15		/** @var PasswordInterface */
16		private $password;
17		/** @var string */
18		private $cipher;
19
20	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2016-05-24 07:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
21		CacheItemPoolInterface $decorated,
22		$password,
23		$cipher = Iron\Iron::DEFAULT_ENCRYPTION_METHOD
24		) {
25		if (!class_exists(Iron\Iron::class)) {
26		// @codeCoverageIgnoreStart
27		throw new \RuntimeException('You must install'
28		. ' jsq/iron-php to use the Iron decorator.');
29		// @codeCoverageIgnoreEnd
30		}
31
32		parent::__construct($decorated);
33		$this->decorated = $decorated;
34		$this->password = Iron\normalize_password($password);
35		$this->cipher = $cipher;
36		}
37
38		protected function decorate(CacheItemInterface $inner)
39		{
40		return new ItemDecorator(
41		$inner,
42		$this->password,
43		$this->cipher
44		);
45		}
46
47		public function save(CacheItemInterface $item)
48		{
49		$this->finalizeItem($item);
50		return $this->decorated->save($item->getDecorated());
		0 ignored issues – show Bug introduced 2016-05-24 07:38 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Cache\CacheItemInterface` as the method `getDecorated()` does only exist in the following implementations of said interface: `Jsq\CacheEncryption\Envelope\ItemDecorator`, `Jsq\CacheEncryption\Iron\ItemDecorator`, `Jsq\CacheEncryption\ItemDecorator`, `Jsq\CacheEncryption\Password\ItemDecorator`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
51		}
52
53		public function saveDeferred(CacheItemInterface $item)
54		{
55		$this->finalizeItem($item);
56		return $this->decorated->saveDeferred($item->getDecorated());
		0 ignored issues – show Bug introduced 2016-05-24 07:38 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Cache\CacheItemInterface` as the method `getDecorated()` does only exist in the following implementations of said interface: `Jsq\CacheEncryption\Envelope\ItemDecorator`, `Jsq\CacheEncryption\Iron\ItemDecorator`, `Jsq\CacheEncryption\ItemDecorator`, `Jsq\CacheEncryption\Password\ItemDecorator`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
57		}
58
59		private function finalizeItem(CacheItemInterface $item)
60		{
61		if ($item instanceof ItemDecorator) {
62		return $item->finalize();
63		}
64
65		throw new InvalidArgumentException('The provided cache item cannot'
66		. ' be saved, as it did not originate from this cache.');
67		}
68		}
69

jeskew / psr6-encrypting-decorator

Pull Request — master (#2)

PoolDecorator A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like