TestingTokenStorage - Code Metrics - matthewslouismarie/auth-abstractor - Measure and Improve Code Quality continuously with Scrutinizer

TestingTokenStorage A
last analyzed 2021-04-26 10:30 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Importance

Changes

Metric	Value
eloc	19
dl	0
loc	57
rs	10
c	0
b	0
f	0
wmc	11

6 Methods

Rating	Name	Size	Complexity
A	__destruct()	4	1
A	setToken()	3	1
A	hasToken()	3	1
A	__construct()	8	4
A	getToken()	6	2
A	removeToken()	6	2

<?php

declare(strict_types=1);

namespace LM\AuthAbstractor\Implementation;

use Symfony\Component\Security\Csrf\Exception\TokenNotFoundException;
use Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface;
use UnexpectedValueException;

/**
 * This is an implementation of TokenStorageInterface that is used in unit
 * tests.
 *
 * @internal
 * @todo Add one using sessions?
 */
class TestingTokenStorage implements TokenStorageInterface
{
    /** @var string */
    private $dataDir;

    /**
     * @param string $projectRootPath The root directory to the project.
     */
    public function __construct(string $projectRootPath)
    {
        if (!file_exists($projectRootPath.'/tmp') && !mkdir($projectRootPath.'/tmp', 0744)) {
            throw new UnexpectedValueException();
        }
        $this->dataDir = $projectRootPath.'/tmp/'.rand();
        if (!mkdir($this->dataDir)) {
            throw new UnexpectedValueException();
        }
    }

    /**
     * @todo Should check that the folder has been deleted.
     */
    public function __destruct()
    {
        array_map('unlink', glob($this->dataDir.'/*'));
        rmdir($this->dataDir);
    }

    public function getToken($tokenId)
    {
        if (file_exists($this->dataDir.'/'.$tokenId)) {
            return file_get_contents($this->dataDir.'/'.$tokenId);
        } else {
            throw new TokenNotFoundException();
        }
    }

    /**
     * @todo Check for case where file_put_contents returns false.
     */
    public function setToken($tokenId, $token)
    {
        file_put_contents($this->dataDir.'/'.$tokenId, $token);
    }

    public function removeToken($tokenId)
    {
        if (file_exists($this->dataDir.'/'.$tokenId)) {
            return unlink($this->dataDir.'/'.$tokenId);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        } else {
            return;
        }
    }

    public function hasToken($tokenId)
    {
        return file_exists($this->dataDir.'/'.$tokenId);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace LM\AuthAbstractor\Implementation;
6
7			use Symfony\Component\Security\Csrf\Exception\TokenNotFoundException;
8			use Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface;
9			use UnexpectedValueException;
10
11			/**
12			* This is an implementation of TokenStorageInterface that is used in unit
13			* tests.
14			*
15			* @internal
16			* @todo Add one using sessions?
17			*/
18			class TestingTokenStorage implements TokenStorageInterface
19			{
20			/** @var string */
21			private $dataDir;
22
23			/**
24			* @param string $projectRootPath The root directory to the project.
25			*/
26			public function __construct(string $projectRootPath)
27			{
28			if (!file_exists($projectRootPath.'/tmp') && !mkdir($projectRootPath.'/tmp', 0744)) {
29			throw new UnexpectedValueException();
30			}
31			$this->dataDir = $projectRootPath.'/tmp/'.rand();
32			if (!mkdir($this->dataDir)) {
33			throw new UnexpectedValueException();
34			}
35			}
36
37			/**
38			* @todo Should check that the folder has been deleted.
39			*/
40			public function __destruct()
41			{
42			array_map('unlink', glob($this->dataDir.'/*'));
43			rmdir($this->dataDir);
44			}
45
46			public function getToken($tokenId)
47			{
48			if (file_exists($this->dataDir.'/'.$tokenId)) {
49			return file_get_contents($this->dataDir.'/'.$tokenId);
50			} else {
51			throw new TokenNotFoundException();
52			}
53			}
54
55			/**
56			* @todo Check for case where file_put_contents returns false.
57			*/
58			public function setToken($tokenId, $token)
59			{
60			file_put_contents($this->dataDir.'/'.$tokenId, $token);
61			}
62
63			public function removeToken($tokenId)
64			{
65			if (file_exists($this->dataDir.'/'.$tokenId)) {
66			return unlink($this->dataDir.'/'.$tokenId);
			0 ignored issues – show Bug Best Practice introduced 2018-04-29 11:58 UTC by Report Bug Copy Issue Report The expression `return unlink($this->dataDir . '/' . $tokenId)` returns the type `boolean` which is incompatible with the return type mandated by `Symfony\Component\Securi...nterface::removeToken()` of `null\|string`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
67			} else {
68			return;
69			}
70			}
71
72			public function hasToken($tokenId)
73			{
74			return file_exists($this->dataDir.'/'.$tokenId);
75			}
76			}
77

matthewslouismarie / auth-abstractor

GitHub Access Token became invalid

TestingTokenStorage A last analyzed 2021-04-26 10:30 UTC

Complexity

Size/Duplication

Importance

6 Methods

Duplication Side-by-Side

Filter issues like

TestingTokenStorage A
last analyzed 2021-04-26 10:30 UTC