ApplicationConfiguration::findComposerDir() - Code Metrics - Inspection of "Step up test coverage condition with MSI>70%" - matthewslouismarie/auth-abstractor - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 217541...83405a )

by Louis-Marie

created 2018-05-01 01:24 UTC

ApplicationConfiguration::findComposerDir() A

↳ Parent: ApplicationConfiguration

Complexity

Conditions	4
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	5
nc	3
nop	1
dl	0
loc	11
rs	9.2
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace LM\AuthAbstractor\Implementation;

use InvalidArgumentException;
use LM\AuthAbstractor\Configuration\IApplicationConfiguration;
use LM\AuthAbstractor\Model\IMember;
use Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface;
use Symfony\Component\Security\Csrf\TokenStorage\NativeSessionTokenStorage;
use Closure;
use Exception;

/**
 * This is a convenience implementation of IApplicationConfiguration.
 *
 * It removes
 * the burden of having to implement (and then instantiate)
 * IApplicationConfiguration. It assumes the library is used as a Composer
 * dependency. It also uses native PHP sessions. Finally, it does not let you
 * define the password complexity settings. If you want more control over these
 * options, you will need to provide your own implementation of
 * IApplicationConfiguration.
 *
 * @see \LM\AuthAbstractor\Configuration\IApplicationConfiguration
 * @todo Put implementations in a different library?
 */
class ApplicationConfiguration implements IApplicationConfiguration
{
    /** @var string */
    private $appId;

    /** @var string */
    private $assetBaseUri;

    /** @var string */
    private $customTwigDir;

    /** @var string */
    private $composerDir;

    /** @var string */
    private $libDir;


    /** @var Closure */
    private $memberFinder;

    /** @var mixed[] */
    private $pwdSettings;


    /** @var TokenStorageInterface */
    private $tokenStorage;

    /** @var Closure */
    private $u2fRegistrationFinder;

    /**
     * @api
     * @param string $appId The application ID of the application. This is used
     * for U2F challenges. The application ID is either:
     *  - The ID of the mobile application, if the application is a mobile
     * application. The format of it differs on Android and on Apple devices.
     *  - The origin of the website (HTTPS protocol + domain name + port).
     *  - A link to an HTTPS link listing all the application IDs of the
     * application.
     * @param string $assetBaseUri The local path in which assets are stored
     * (i.e JavaScript files and CSS files).
     * @param Closure $memberFinder A callable to find a user from their
     * username. It must return null if the user does not exist.
     * @param null|string $customTwigDir A custom Twig directory for overriding
     * all, or some templates that come with auth-abstractor by default.
     */
    public function __construct(
        string $appId,
        string $assetBaseUri,
        Closure $memberFinder,
        ?string $customTwigDir = null
    ) {
        $this->appId = $appId;
        $this->assetBaseUri = $assetBaseUri;
        $this->composerDir = $this->findComposerDir(__DIR__);
        $this->customTwigDir = $customTwigDir;
        $this->memberFinder = $memberFinder;
        $this->tokenStorage = new NativeSessionTokenStorage();
        $this->u2fRegistrationFinder = $u2fRegistrationFinder ?? function ($username) {
        $this->u2fRegistrationFinder = $u2fRegistrationFinder ?? function (/** @scrutinizer ignore-unused */ $username) {
            return [];
        };
    }

    /**
     * @todo Move in another class?
     */
    private function findComposerDir(string $folder): string
    {
        if (is_dir("{$folder}/vendor") && is_file("{$folder}/composer.json")) {
            return "{$folder}/vendor";
        }

        if ('/' === $folder) {
            throw new Exception('Composer not found');
        }

        return $this->findComposerDir(realpath("{$folder}/.."));
    }

    public function getAppId(): string
    {
        return $this->appId;
    }

    public function getAssetUri(string $assetId): string
    {
        return $this->assetBaseUri.'/'.$assetId;
    }

    public function getComposerDir(): string
    {
        return $this->composerDir;
    }

    public function getCustomTwigDir(): ?string
    {
        return $this->customTwigDir;
    }

    public function getLibdir(): string
    {
        return realpath(__DIR__.'/../../../..');
    }

    /**
     * @todo Not efficient.
     * @todo What if the state change between isExistingUsername() and the
     * second call to $this->memberFinder?
     * @todo Exception for non existent member.
     */
    public function getMember(string $username): IMember
    {
        if ($this->isExistingMember($username)) {
            return ($this->memberFinder)($username);
        }
        throw new InvalidArgumentException();
    }

    public function getPwdSettings(): array
    {
        return [
            'min_length' => 5,
            'enforce_min_length' =>true,
            'uppercase' => false,
            'special_chars' => false,
            'numbers' => false,
        ];
    }

    public function getTokenStorage(): TokenStorageInterface
    {
        return $this->tokenStorage;
    }

    public function getU2fCertificates(): ?array
    {
        return null;
    }

    public function getU2fRegistrations(string $username): array
    {
        return ($this->u2fRegistrationFinder)($username);
    }

    public function isExistingMember(string $username): bool
    {
        return null !== ($this->memberFinder)($username);
    }
}


matthewslouismarie / auth-abstractor

GitHub Access Token became invalid

Push — master ( 217541...83405a )

ApplicationConfiguration::findComposerDir() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like