ResetPasswordControl - Code Metrics - Inspection of "Reset password - autologin" - 68publishers/user - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c495da...16538c )

by Tomáš

created 2020-11-30 00:47 UTC

ResetPasswordControl A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	132
Duplicated Lines	15.15 %

Coupling/Cohesion

Components	2
Dependencies	9

Importance

Changes

Metric	Value
wmc	8
lcom	2
cbo	9
dl	20
loc	132
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	setAutoLogin()	0	4	1
A	render()	0	5	1
A	createComponentForm()	20	20	1
A	processForm()	0	28	4

How to fix Duplicated Code

<?php

declare(strict_types=1);

namespace SixtyEightPublishers\User\ForgotPassword\Control\ResetPassword;

use Throwable;
use Nette\Security\User;
use Nette\Application\UI\Form;
use SixtyEightPublishers\SmartNetteComponent\UI\Control;
use SixtyEightPublishers\User\Common\Logger\LoggerInterface;
use SixtyEightPublishers\TranslationBridge\TranslatorAwareTrait;
use SixtyEightPublishers\TranslationBridge\TranslatorAwareInterface;
use SixtyEightPublishers\User\ForgotPassword\Entity\PasswordRequestInterface;
use SixtyEightPublishers\User\ForgotPassword\Mail\PasswordHasBeenResetEmailInterface;
use SixtyEightPublishers\User\ForgotPassword\Exception\PasswordRequestProcessException;
use SixtyEightPublishers\User\ForgotPassword\PasswordRequest\PasswordRequestManagerInterface;

/**
 * @method void onSuccess(PasswordRequestInterface $request)
 * @method void onError(PasswordRequestInterface $request, PasswordRequestProcessException $e)
 * @method void onFormCreation(Form $form)
 */
class ResetPasswordControl extends Control implements TranslatorAwareInterface
{
	use TranslatorAwareTrait;

	/** @var \SixtyEightPublishers\User\ForgotPassword\Entity\PasswordRequestInterface  */
	private $passwordRequest;

	/** @var \SixtyEightPublishers\User\Common\Logger\LoggerInterface  */
	private $logger;

	/** @var \SixtyEightPublishers\User\ForgotPassword\Mail\PasswordHasBeenResetEmailInterface  */
	private $passwordHasBeenResetEmail;

	/** @var \SixtyEightPublishers\User\ForgotPassword\PasswordRequest\PasswordRequestManagerInterface  */
	private $passwordRequestManager;

	/** @var \Nette\Security\User  */
	private $user;

	/** @var bool  */
	private $autoLogin = FALSE;

	/** @var callable[] */
	public $onSuccess = [];

	/** @var callable[] */
	public $onError = [];

	/** @var callable[] */
	public $onFormCreation = [];

	/**
	 * @param \SixtyEightPublishers\User\ForgotPassword\Entity\PasswordRequestInterface                 $passwordRequest
	 * @param \SixtyEightPublishers\User\Common\Logger\LoggerInterface                                  $logger
	 * @param \SixtyEightPublishers\User\ForgotPassword\Mail\PasswordHasBeenResetEmailInterface         $passwordHasBeenResetEmail
	 * @param \SixtyEightPublishers\User\ForgotPassword\PasswordRequest\PasswordRequestManagerInterface $passwordRequestManager
	 * @param \Nette\Security\User                                                                      $user
	 */
	public function __construct(
		PasswordRequestInterface $passwordRequest,
		LoggerInterface $logger,
		PasswordHasBeenResetEmailInterface $passwordHasBeenResetEmail,
		PasswordRequestManagerInterface $passwordRequestManager,
		User $user
	) {
		$this->passwordRequest = $passwordRequest;
		$this->logger = $logger;
		$this->passwordHasBeenResetEmail = $passwordHasBeenResetEmail;
		$this->passwordRequestManager = $passwordRequestManager;
		$this->user = $user;
	}

	/**
	 * @param bool $autoLogin
	 *
	 * @return void
	 */
	public function setAutoLogin(bool $autoLogin): void
	{
		$this->autoLogin = $autoLogin;
	}

	/**
	 * @return void
	 */
	public function render(): void
	{
		$this->template->setTranslator($this->getPrefixedTranslator());
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		$this->doRender();
	}

	/**
	 * @return \Nette\Application\UI\Form
	 */
	protected function createComponentForm(): Form

	{
		$form = new Form();

		$form->setTranslator($this->getPrefixedTranslator());

		$form->addPassword('password', 'password.field')
			->setRequired('password.required')
			->setHtmlAttribute('autocomplete', 'new-password');

		$form->addProtection('protection.rule');

		$form->onSuccess[] = [$this, 'processForm'];

		$this->onFormCreation($form);

		$form->addSubmit('send', 'send.field');

		return $form;
	}

	/**
	 * @internal
	 *
	 * @param \Nette\Application\UI\Form $form
	 *
	 * @return void
	 * @throws \Nette\Security\AuthenticationException
	 */
	public function processForm(Form $form): void
	{
		try {
			$request = $this->passwordRequest;
			$password = $form->values->password;

			$this->passwordRequestManager->reset($request, $password);

			try {
				$this->passwordHasBeenResetEmail->send($request->getUser());
				$this->logger->info(sprintf(
					'Mail %s was successfully sent to %s',
					get_class($this->passwordHasBeenResetEmail),
					$request->getUser()->getEmail()
				));
			} catch (Throwable $e) {
				$this->logger->error((string) $e);
			}

			if ($this->autoLogin) {
				$this->user->login($request->getUser()->getUsername(), $password);
			}

			$this->onSuccess($this->passwordRequest);
		} catch (PasswordRequestProcessException $e) {
			$this->onError($this->passwordRequest, $e);
		}
	}
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace SixtyEightPublishers\User\ForgotPassword\Control\ResetPassword;
6
7		use Throwable;
8		use Nette\Security\User;
9		use Nette\Application\UI\Form;
10		use SixtyEightPublishers\SmartNetteComponent\UI\Control;
11		use SixtyEightPublishers\User\Common\Logger\LoggerInterface;
12		use SixtyEightPublishers\TranslationBridge\TranslatorAwareTrait;
13		use SixtyEightPublishers\TranslationBridge\TranslatorAwareInterface;
14		use SixtyEightPublishers\User\ForgotPassword\Entity\PasswordRequestInterface;
15		use SixtyEightPublishers\User\ForgotPassword\Mail\PasswordHasBeenResetEmailInterface;
16		use SixtyEightPublishers\User\ForgotPassword\Exception\PasswordRequestProcessException;
17		use SixtyEightPublishers\User\ForgotPassword\PasswordRequest\PasswordRequestManagerInterface;
18
19		/**
20		* @method void onSuccess(PasswordRequestInterface $request)
21		* @method void onError(PasswordRequestInterface $request, PasswordRequestProcessException $e)
22		* @method void onFormCreation(Form $form)
23		*/
24		class ResetPasswordControl extends Control implements TranslatorAwareInterface
25		{
26		use TranslatorAwareTrait;
27
28		/** @var \SixtyEightPublishers\User\ForgotPassword\Entity\PasswordRequestInterface */
29		private $passwordRequest;
30
31		/** @var \SixtyEightPublishers\User\Common\Logger\LoggerInterface */
32		private $logger;
33
34		/** @var \SixtyEightPublishers\User\ForgotPassword\Mail\PasswordHasBeenResetEmailInterface */
35		private $passwordHasBeenResetEmail;
36
37		/** @var \SixtyEightPublishers\User\ForgotPassword\PasswordRequest\PasswordRequestManagerInterface */
38		private $passwordRequestManager;
39
40		/** @var \Nette\Security\User */
41		private $user;
42
43		/** @var bool */
44		private $autoLogin = FALSE;
45
46		/** @var callable[] */
47		public $onSuccess = [];
48
49		/** @var callable[] */
50		public $onError = [];
51
52		/** @var callable[] */
53		public $onFormCreation = [];
54
55		/**
56		* @param \SixtyEightPublishers\User\ForgotPassword\Entity\PasswordRequestInterface $passwordRequest
57		* @param \SixtyEightPublishers\User\Common\Logger\LoggerInterface $logger
58		* @param \SixtyEightPublishers\User\ForgotPassword\Mail\PasswordHasBeenResetEmailInterface $passwordHasBeenResetEmail
59		* @param \SixtyEightPublishers\User\ForgotPassword\PasswordRequest\PasswordRequestManagerInterface $passwordRequestManager
60		* @param \Nette\Security\User $user
61		*/
62		public function __construct(
63		PasswordRequestInterface $passwordRequest,
64		LoggerInterface $logger,
65		PasswordHasBeenResetEmailInterface $passwordHasBeenResetEmail,
66		PasswordRequestManagerInterface $passwordRequestManager,
67		User $user
68		) {
69		$this->passwordRequest = $passwordRequest;
70		$this->logger = $logger;
71		$this->passwordHasBeenResetEmail = $passwordHasBeenResetEmail;
72		$this->passwordRequestManager = $passwordRequestManager;
73		$this->user = $user;
74		}
75
76		/**
77		* @param bool $autoLogin
78		*
79		* @return void
80		*/
81		public function setAutoLogin(bool $autoLogin): void
82		{
83		$this->autoLogin = $autoLogin;
84		}
85
86		/**
87		* @return void
88		*/
89		public function render(): void
90		{
91		$this->template->setTranslator($this->getPrefixedTranslator());
		0 ignored issues – show Documentation introduced 2019-07-07 23:05 UTC by Report Bug Copy Issue Report The property `$template` is declared private in `Nette\Application\UI\Control`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
92		$this->doRender();
93		}
94
95		/**
96		* @return \Nette\Application\UI\Form
97		*/
98	View Code Duplication	protected function createComponentForm(): Form
		0 ignored issues – show Duplication introduced 2020-11-25 02:03 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...
99		{
100		$form = new Form();
101
102		$form->setTranslator($this->getPrefixedTranslator());
103
104		$form->addPassword('password', 'password.field')
105		->setRequired('password.required')
106		->setHtmlAttribute('autocomplete', 'new-password');
107
108		$form->addProtection('protection.rule');
109
110		$form->onSuccess[] = [$this, 'processForm'];
111
112		$this->onFormCreation($form);
113
114		$form->addSubmit('send', 'send.field');
115
116		return $form;
117		}
118
119		/**
120		* @internal
121		*
122		* @param \Nette\Application\UI\Form $form
123		*
124		* @return void
125		* @throws \Nette\Security\AuthenticationException
126		*/
127		public function processForm(Form $form): void
128		{
129		try {
130		$request = $this->passwordRequest;
131		$password = $form->values->password;
132
133		$this->passwordRequestManager->reset($request, $password);
134
135		try {
136		$this->passwordHasBeenResetEmail->send($request->getUser());
137		$this->logger->info(sprintf(
138		'Mail %s was successfully sent to %s',
139		get_class($this->passwordHasBeenResetEmail),
140		$request->getUser()->getEmail()
141		));
142		} catch (Throwable $e) {
143		$this->logger->error((string) $e);
144		}
145
146		if ($this->autoLogin) {
147		$this->user->login($request->getUser()->getUsername(), $password);
148		}
149
150		$this->onSuccess($this->passwordRequest);
151		} catch (PasswordRequestProcessException $e) {
152		$this->onError($this->passwordRequest, $e);
153		}
154		}
155		}
156

68publishers / user

Push — master ( c495da...16538c )

ResetPasswordControl A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like