Policy::__construct() - Code Metrics - Stadly/PasswordPolice - Measure and Improve Code Quality continuously with Scrutinizer

Policy::__construct() A
last analyzed 2020-05-08 06:26 UTC

↳ Parent: Policy

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

declare(strict_types=1);

namespace Stadly\PasswordPolice;

use Stadly\PasswordPolice\Rule\CouldNotUseRuleException;
use Symfony\Component\Translation\Loader\MoFileLoader;
use Symfony\Component\Translation\Translator;
use Symfony\Contracts\Translation\LocaleAwareInterface;
use Symfony\Contracts\Translation\TranslatorInterface;

final class Policy
{
    /**
     * @var array<Rule> Policy rules.
     */
    private $rules = [];

    /**
     * @var (TranslatorInterface&LocaleAwareInterface)|null Translator for translating messages.
     */
    private $translator = null;

    /**
     * @param Rule ...$rules Policy rules.
     */
    public function __construct(Rule ...$rules)
    {
        $this->addRules(...$rules);
    }

    /**
     * @param Rule ...$rules Policy rules.
     */
    public function addRules(Rule ...$rules): void
    {
        foreach ($rules as $rule) {
            $this->rules[] = $rule;
        }
    }

    /**
     * Check whether a password is in compliance with the policy.
     *
     * @param Password|string $password Password to check.
     * @param int|null $weight Don't consider rule constraints with lower weights.
     * @return bool Whether the password is in compliance with the policy.
     * @throws CouldNotUseRuleException If an error occurred.
     */
    public function test($password, ?int $weight = null): bool
    {
        foreach ($this->rules as $rule) {
            if (!$rule->test($password, $weight)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Validate that a password is in compliance with the policy.
     *
     * @param Password|string $password Password to validate.
     * @return array<ValidationError> Validation errors describing why the password isn't in compliance with the policy.
     * @throws CouldNotUseRuleException If an error occurred.
     */
    public function validate($password): array
    {
        $validationErrors = [];

        foreach ($this->rules as $rule) {
            $validationError = $rule->validate($password, $this->getTranslator());

            if ($validationError !== null) {
                $validationErrors[] = $validationError;
            }
        }

        return $validationErrors;
    }

    /**
     * @param (TranslatorInterface&LocaleAwareInterface)|null $translator Translator for translating messages.
     */
    public function setTranslator(?TranslatorInterface $translator): void
    {
        $this->translator = $translator;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * @return TranslatorInterface&LocaleAwareInterface Translator to use for the current instance.
     */
    public function getTranslator(): TranslatorInterface
    {
        if ($this->translator === null) {
            $this->translator = new Translator('en_US');

            $this->translator->addLoader('mo', new MoFileLoader());
            $this->translator->addResource('mo', __DIR__ . '/../translations/messages.nn_NO.mo', 'nn_NO');
            $this->translator->addResource('mo', __DIR__ . '/../translations/messages.nb_NO.mo', 'nb_NO');
        }

        return $this->translator;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Stadly\PasswordPolice;
6
7		use Stadly\PasswordPolice\Rule\CouldNotUseRuleException;
8		use Symfony\Component\Translation\Loader\MoFileLoader;
9		use Symfony\Component\Translation\Translator;
10		use Symfony\Contracts\Translation\LocaleAwareInterface;
11		use Symfony\Contracts\Translation\TranslatorInterface;
12
13		final class Policy
14		{
15		/**
16		* @var array<Rule> Policy rules.
17		*/
18		private $rules = [];
19
20		/**
21		* @var (TranslatorInterface&LocaleAwareInterface)\|null Translator for translating messages.
22		*/
23		private $translator = null;
24
25		/**
26		* @param Rule ...$rules Policy rules.
27		*/
28	13	public function __construct(Rule ...$rules)
29		{
30	13	$this->addRules(...$rules);
31	13	}
32
33		/**
34		* @param Rule ...$rules Policy rules.
35		*/
36	3	public function addRules(Rule ...$rules): void
37		{
38	3	foreach ($rules as $rule) {
39	3	$this->rules[] = $rule;
40		}
41	3	}
42
43		/**
44		* Check whether a password is in compliance with the policy.
45		*
46		* @param Password\|string $password Password to check.
47		* @param int\|null $weight Don't consider rule constraints with lower weights.
48		* @return bool Whether the password is in compliance with the policy.
49		* @throws CouldNotUseRuleException If an error occurred.
50		*/
51	6	public function test($password, ?int $weight = null): bool
52		{
53	6	foreach ($this->rules as $rule) {
54	5	if (!$rule->test($password, $weight)) {
55	5	return false;
56		}
57		}
58
59	3	return true;
60		}
61
62		/**
63		* Validate that a password is in compliance with the policy.
64		*
65		* @param Password\|string $password Password to validate.
66		* @return array<ValidationError> Validation errors describing why the password isn't in compliance with the policy.
67		* @throws CouldNotUseRuleException If an error occurred.
68		*/
69	2	public function validate($password): array
70		{
71	2	$validationErrors = [];
72
73	2	foreach ($this->rules as $rule) {
74	2	$validationError = $rule->validate($password, $this->getTranslator());
75
76	2	if ($validationError !== null) {
77	2	$validationErrors[] = $validationError;
78		}
79		}
80
81	2	return $validationErrors;
82		}
83
84		/**
85		* @param (TranslatorInterface&LocaleAwareInterface)\|null $translator Translator for translating messages.
86		*/
87	2	public function setTranslator(?TranslatorInterface $translator): void
88		{
89	2	$this->translator = $translator;
		0 ignored issues – show Documentation Bug introduced 2019-05-02 10:20 UTC by Report Bug Copy Issue Report It seems like `$translator` can also be of type `Symfony\Contracts\Translation\TranslatorInterface`. However, the property `$translator` is declared as type `Symfony\Contracts\Transl...caleAwareInterface\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
90	2	}
91
92		/**
93		* @return TranslatorInterface&LocaleAwareInterface Translator to use for the current instance.
94		*/
95	2	public function getTranslator(): TranslatorInterface
96		{
97	2	if ($this->translator === null) {
98	1	$this->translator = new Translator('en_US');
		0 ignored issues – show Documentation Bug introduced 2019-05-02 10:20 UTC by Report Bug Copy Issue Report It seems like `new Symfony\Component\Tr...ion\Translator('en_US')` of type `Symfony\Component\Translation\Translator` is incompatible with the declared type `Symfony\Contracts\Transl...caleAwareInterface\|null` of property `$translator`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
99	1	$this->translator->addLoader('mo', new MoFileLoader());
100	1	$this->translator->addResource('mo', __DIR__ . '/../translations/messages.nn_NO.mo', 'nn_NO');
101	1	$this->translator->addResource('mo', __DIR__ . '/../translations/messages.nb_NO.mo', 'nb_NO');
102		}
103
104	2	return $this->translator;
105		}
106		}
107

Stadly / PasswordPolice

Policy::__construct() A last analyzed 2020-05-08 06:26 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Policy::__construct() A
last analyzed 2020-05-08 06:26 UTC