JwtUserProviderTest - Code Metrics - Inspection of "Fixed some timing bugs, added UserProvider, minor..." - kleijnweb/jwt-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a6f5e7...505dfd )

by John

created 2017-03-31 17:13 UTC

JwtUserProviderTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	94
Duplicated Lines	12.77 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	8
lcom	1
cbo	4
dl	12
loc	94
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	4	1
A	canLoadUserPopulatedFromToken()	0	9	1
A	willAddGroupsFromAudienceClaims()	0	6	1
A	onlySupportsJwtUser()	0	5	1
A	refreshUserReturnsNewInstance()	0	6	1
A	canCallSuperfluousMethods()	0	7	1
A	loadUser()	0	6	1
A	createToken()	12	12	1

How to fix Duplicated Code

<?php
/*
 * This file is part of the KleijnWeb\JwtBundle package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace KleijnWeb\JwtBundle\Tests\User;

use KleijnWeb\JwtBundle\Authenticator\JwtToken;
use KleijnWeb\JwtBundle\User\JwtUserProvider;
use KleijnWeb\JwtBundle\User\JwtUser;
use Symfony\Component\Security\Core\User\UserInterface;

/**
 * @author John Kleijn <[email protected]>
 */
class JwtUserProviderTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var JwtUserProvider
     */
    private $provider;

    protected function setUp()
    {
        $this->provider = new JwtUserProvider();
    }

    /**
     * @test
     */
    public function canLoadUserPopulatedFromToken()
    {
        $username = 'johndoe';
        $claims   = ['sub' => $username, 'iat' => time()];
        $user     = $this->loadUser($claims);
        $this->assertSame($username, $user->getUsername());
        $this->assertSame($claims, $user->getClaims());
        $this->assertSame([JwtUserProvider::BASE_ROLE], $user->getRoles());
    }

    /**
     * @test
     */
    public function willAddGroupsFromAudienceClaims()
    {
        $claims = ['sub' => 'johndoe', 'aud' => 'admin'];
        $user   = $this->loadUser($claims);
        $this->assertSame([JwtUserProvider::BASE_ROLE, 'ROLE_ADMIN'], $user->getRoles());
    }

    /**
     * @test
     */
    public function onlySupportsJwtUser()
    {
        $this->assertFalse($this->provider->supportsClass(UserInterface::class));
        $this->assertTrue($this->provider->supportsClass(JwtUser::class));
    }

    /**
     * @test
     */
    public function refreshUserReturnsNewInstance()
    {
        $username = 'johndoe';
        $user     = $this->loadUser(['sub' => $username]);
        $this->assertNotSame($user, $this->provider->refreshUser($user));
    }

    /**
     * @test
     */
    public function canCallSuperfluousMethods()
    {
        $user = $this->loadUser(['sub' => 'johndoe']);
        $user->eraseCredentials();
        $user->getSalt();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $user->getPassword();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
    }

    /**
     * @param array $claims
     * @return JwtUser
     */
    private function loadUser(array $claims)
    {
        $token = $this->createToken($claims);
        $this->provider->setClaimsUsingToken($token);
        return $this->provider->loadUserByUsername($claims['sub']);
    }

    /**
     * @param array $claims
     *
     * @return JwtToken
     */
    private function createToken(array $claims)

    {
        return new JwtToken([
            'header' => [
                'alg' => 'HS256',
                'typ' => 'JWT',
                'kid' => 'keyOne'
            ],
            'claims' => $claims,
            'secret' => 'secret'
        ]);
    }
}


1		<?php
2		/*
3		* This file is part of the KleijnWeb\JwtBundle package.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*/
8		namespace KleijnWeb\JwtBundle\Tests\User;
9
10		use KleijnWeb\JwtBundle\Authenticator\JwtToken;
11		use KleijnWeb\JwtBundle\User\JwtUserProvider;
12		use KleijnWeb\JwtBundle\User\JwtUser;
13		use Symfony\Component\Security\Core\User\UserInterface;
14
15		/**
16		* @author John Kleijn <[email protected]>
17		*/
18		class JwtUserProviderTest extends \PHPUnit_Framework_TestCase
19		{
20		/**
21		* @var JwtUserProvider
22		*/
23		private $provider;
24
25		protected function setUp()
26		{
27		$this->provider = new JwtUserProvider();
28		}
29
30		/**
31		* @test
32		*/
33		public function canLoadUserPopulatedFromToken()
34		{
35		$username = 'johndoe';
36		$claims = ['sub' => $username, 'iat' => time()];
37		$user = $this->loadUser($claims);
38		$this->assertSame($username, $user->getUsername());
39		$this->assertSame($claims, $user->getClaims());
40		$this->assertSame([JwtUserProvider::BASE_ROLE], $user->getRoles());
41		}
42
43		/**
44		* @test
45		*/
46		public function willAddGroupsFromAudienceClaims()
47		{
48		$claims = ['sub' => 'johndoe', 'aud' => 'admin'];
49		$user = $this->loadUser($claims);
50		$this->assertSame([JwtUserProvider::BASE_ROLE, 'ROLE_ADMIN'], $user->getRoles());
51		}
52
53		/**
54		* @test
55		*/
56		public function onlySupportsJwtUser()
57		{
58		$this->assertFalse($this->provider->supportsClass(UserInterface::class));
59		$this->assertTrue($this->provider->supportsClass(JwtUser::class));
60		}
61
62		/**
63		* @test
64		*/
65		public function refreshUserReturnsNewInstance()
66		{
67		$username = 'johndoe';
68		$user = $this->loadUser(['sub' => $username]);
69		$this->assertNotSame($user, $this->provider->refreshUser($user));
70		}
71
72		/**
73		* @test
74		*/
75		public function canCallSuperfluousMethods()
76		{
77		$user = $this->loadUser(['sub' => 'johndoe']);
78		$user->eraseCredentials();
79		$user->getSalt();
		0 ignored issues – show Unused Code introduced 2017-03-31 17:15 UTC by Report Bug Copy Issue Report The call to the method `KleijnWeb\JwtBundle\User\JwtUser::getSalt()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
80		$user->getPassword();
		0 ignored issues – show Unused Code introduced 2017-03-31 17:15 UTC by Report Bug Copy Issue Report The call to the method `KleijnWeb\JwtBundle\User\JwtUser::getPassword()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
81		}
82
83		/**
84		* @param array $claims
85		* @return JwtUser
86		*/
87		private function loadUser(array $claims)
88		{
89		$token = $this->createToken($claims);
90		$this->provider->setClaimsUsingToken($token);
91		return $this->provider->loadUserByUsername($claims['sub']);
92		}
93
94		/**
95		* @param array $claims
96		*
97		* @return JwtToken
98		*/
99	View Code Duplication	private function createToken(array $claims)
		0 ignored issues – show Duplication introduced 2017-03-31 17:15 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...
100		{
101		return new JwtToken([
102		'header' => [
103		'alg' => 'HS256',
104		'typ' => 'JWT',
105		'kid' => 'keyOne'
106		],
107		'claims' => $claims,
108		'secret' => 'secret'
109		]);
110		}
111		}
112

kleijnweb / jwt-bundle

Push — master ( a6f5e7...505dfd )

JwtUserProviderTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like