Improvements, Fixes and Coding Standards

- fixed all files with new php-cs-fixer config - added setting `common.user.fields` instead of `common.user_mapping_fields` - added setting `common.user.class` - doctrine's target entities are resolved in DI (no need to do it manually in the neon config) - added english and czech translations for `ForgotPassword` Components - added interface `ITranslatableService`, implementors `NullTranslator` and `PrefixedTranslator` and trait `TTranslatableService` - added exception `ConfigurationException` - fixed catching of `DBALException` in method `PasswordRequestManager::findRequest()`
68publishers · Nov 30, 2020 · 080b0e6 · 080b0e6
1 parent 4a4f01a
commit 080b0e6
Show file tree

Hide file tree

Showing 66 changed files with 606 additions and 212 deletions.
diff --git a/src/Common/DI/CommonExtensionAdapter.php b/src/Common/DI/CommonExtensionAdapter.php
@@ -4,36 +4,55 @@
 
 namespace SixtyEightPublishers\User\Common\DI;
 
+use Kdyby;
 use Nette;
 use SixtyEightPublishers;
 
-final class CommonExtensionAdapter extends SixtyEightPublishers\User\DI\AbstractExtensionAdapter
+final class CommonExtensionAdapter extends SixtyEightPublishers\User\DI\AbstractExtensionAdapter implements Kdyby\Doctrine\DI\ITargetEntityProvider
 {
+	const 	SHARED_DATA_USER_CLASS_NAME = 'common.user_class_name';
+
 	/** @var array  */
 	protected static $defaults = [
+		'user' => [
+			'class' => '',
+			'fields' => [],
+		],
 		'password_strategy' => SixtyEightPublishers\User\Common\PasswordHashStrategy\DefaultPasswordHashStrategy::class,
-		'user_mapping_fields' => [],
 		'logger' => SixtyEightPublishers\User\Common\Logger\TracyLogger::class,
 		'mail_sender' => SixtyEightPublishers\User\Common\Mail\NullMailSender::class,
 	];
 
 	/**
 	 * {@inheritdoc}
 	 */
-	protected function processConfig(array $config) : array
+	protected function processConfig(array $config, \ArrayObject $sharedData): array
 	{
+		Nette\Utils\Validators::assertField($config, 'user', 'array');
+		Nette\Utils\Validators::assertField($config['user'], 'class', 'string');
+		Nette\Utils\Validators::assertField($config['user'], 'fields', 'array');
+
 		Nette\Utils\Validators::assertField($config, 'password_strategy', 'string|' . Nette\DI\Statement::class);
-		Nette\Utils\Validators::assertField($config, 'user_mapping_fields', 'array');
 		Nette\Utils\Validators::assertField($config, 'logger', 'string|' . Nette\DI\Statement::class);
 		Nette\Utils\Validators::assertField($config, 'mail_sender', 'string|' . Nette\DI\Statement::class);
 
+		if (!is_subclass_of($config['user']['class'], SixtyEightPublishers\User\Common\DoctrineEntity\IUser::class, TRUE)) {
+			throw new SixtyEightPublishers\User\Common\Exception\ConfigurationException(sprintf(
+				'Required setting %s.user_class_name must be valid classname of your User\'s entity that implements interface %s',
+				$this->name,
+				SixtyEightPublishers\User\Common\DoctrineEntity\IUser::class
+			));
+		}
+
+		$sharedData[self::SHARED_DATA_USER_CLASS_NAME] = $config['user']['class'];
+
 		return $config;
 	}
 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function loadConfiguration() : void
+	public function loadConfiguration(): void
 	{
 		$config = $this->getConfig();
 		$builder = $this->getContainerBuilder();
@@ -56,7 +75,7 @@ public function loadConfiguration() : void
 				->setFactory($config['mail_sender']);
 		}
 
-		$fields = $config['user_mapping_fields'];
+		$fields = $config['user']['fields'];
 
 		foreach ($fields as $k => $v) {
 			if (defined($k)) {
@@ -65,20 +84,60 @@ public function loadConfiguration() : void
 			}
 		}
 
-		$builder->addDefinition($this->prefix('user_mapping_fields'))
-			->setType(SixtyEightPublishers\User\Common\UserMappingFields::class)
+		$builder->addDefinition($this->prefix('user_mapping'))
+			->setType(SixtyEightPublishers\User\Common\UserMapping::class)
 			->setArguments([
+				'className' => $config['user']['class'],
 				'fields' => $fields,
 			]);
 	}
 
+	/**
+	 * {@inheritdoc}
+	 */
+	public function beforeCompile(): void
+	{
+		$builder = $this->getContainerBuilder();
+		$translator = $builder->getByType(Nette\Localization\ITranslator::class, FALSE);
+
+		if (NULL === $translator) {
+			return;
+		}
+
+		$translator = $builder->getDefinition($translator);
+
+		/** @var \Nette\DI\ServiceDefinition[] $translatableServices */
+		$translatableServices = array_filter($builder->getDefinitions(), function (Nette\DI\ServiceDefinition $def) {
+			return is_a($def->getImplement(), SixtyEightPublishers\User\Common\Translator\ITranslatableService::class, TRUE)
+				|| ($def->getImplementMode() !== $def::IMPLEMENT_MODE_GET && is_a($def->getType(), SixtyEightPublishers\User\Common\Translator\ITranslatableService::class, TRUE));
+		});
+
+		foreach ($translatableServices as $translatableService) {
+			$translatableService->addSetup('setTranslator', [
+				'translator' => $translator,
+			]);
+		}
+	}
+
 	/**
 	 * @param mixed $what
 	 *
 	 * @return bool
 	 */
-	private function needRegister($what) : bool
+	private function needRegister($what): bool
 	{
 		return (!is_string($what) || !Nette\Utils\Strings::startsWith($what, '@'));
 	}
+
+	/**************** interface \Kdyby\Doctrine\DI\ITargetEntityProvider ****************/
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getTargetEntityMappings(): array
+	{
+		return [
+			SixtyEightPublishers\User\Common\DoctrineEntity\IUser::class => $this->getSharedData(self::SHARED_DATA_USER_CLASS_NAME),
+		];
+	}
 }
diff --git a/src/Common/DoctrineEntity/Accessor/IEmailAccessor.php b/src/Common/DoctrineEntity/Accessor/IEmailAccessor.php
@@ -9,5 +9,5 @@ interface IEmailAccessor
 	/**
 	 * @return string
 	 */
-	public function getEmail() : string;
+	public function getEmail(): string;
 }
diff --git a/src/Common/DoctrineEntity/Accessor/ILoginAccessor.php b/src/Common/DoctrineEntity/Accessor/ILoginAccessor.php
@@ -9,5 +9,5 @@ interface ILoginAccessor
 	/**
 	 * @return string
 	 */
-	public function getLogin() : string;
+	public function getLogin(): string;
 }
diff --git a/src/Common/DoctrineEntity/Accessor/IPasswordAccessor.php b/src/Common/DoctrineEntity/Accessor/IPasswordAccessor.php
@@ -9,5 +9,5 @@ interface IPasswordAccessor
 	/**
 	 * @return string
 	 */
-	public function getPassword() : string;
+	public function getPassword(): string;
 }
diff --git a/src/Common/DoctrineEntity/Assigner/IPasswordAssigner.php b/src/Common/DoctrineEntity/Assigner/IPasswordAssigner.php
@@ -11,5 +11,5 @@ interface IPasswordAssigner
 	 *
 	 * @return void
 	 */
-	public function setPassword(string $password) : void;
+	public function setPassword(string $password): void;
 }
diff --git a/src/Common/DoctrineEntity/IUser.php b/src/Common/DoctrineEntity/IUser.php
@@ -11,5 +11,5 @@ interface IUser extends Nette\Security\IIdentity
 	/**
 	 * {@inheritdoc}
 	 */
-	public function getRoles() : array;
+	public function getRoles(): array;
 }
diff --git a/src/Common/Exception/ConfigurationException.php b/src/Common/Exception/ConfigurationException.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SixtyEightPublishers\User\Common\Exception;
+
+final class ConfigurationException extends RuntimeException
+{
+}
diff --git a/src/Common/Logger/ILogger.php b/src/Common/Logger/ILogger.php
@@ -11,19 +11,19 @@ interface ILogger
 	 *
 	 * @return void
 	 */
-	public function error(string $message) : void;
+	public function error(string $message): void;
 
 	/**
 	 * @param string $message
 	 *
 	 * @return void
 	 */
-	public function notice(string $message) : void;
+	public function notice(string $message): void;
 
 	/**
 	 * @param string $message
 	 *
 	 * @return void
 	 */
-	public function info(string $message) : void;
+	public function info(string $message): void;
 }
diff --git a/src/Common/Logger/NullLogger.php b/src/Common/Logger/NullLogger.php
@@ -15,21 +15,21 @@ final class NullLogger implements ILogger
 	/**
 	 * {@inheritdoc}
 	 */
-	public function error(string $message) : void
+	public function error(string $message): void
 	{
 	}
 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function notice(string $message) : void
+	public function notice(string $message): void
 	{
 	}
 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function info(string $message) : void
+	public function info(string $message): void
 	{
 	}
 }
diff --git a/src/Common/Logger/PsrLogger.php b/src/Common/Logger/PsrLogger.php
@@ -27,23 +27,23 @@ public function __construct(Psr\Log\LoggerInterface $logger)
 	/**
 	 * {@inheritdoc}
 	 */
-	public function error(string $message) : void
+	public function error(string $message): void
 	{
 		$this->logger->error($message);
 	}
 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function notice(string $message) : void
+	public function notice(string $message): void
 	{
 		$this->logger->notice($message);
 	}
 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function info(string $message) : void
+	public function info(string $message): void
 	{
 		$this->logger->info($message);
 	}

diff --git a/src/Common/Logger/TracyLogger.php b/src/Common/Logger/TracyLogger.php
@@ -16,23 +16,23 @@ final class TracyLogger implements ILogger
 	/**
 	 * {@inheritdoc}
 	 */
-	public function error(string $message) : void
+	public function error(string $message): void
 	{
 		Tracy\Debugger::log($message, Tracy\ILogger::ERROR);
 	}
 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function notice(string $message) : void
+	public function notice(string $message): void
 	{
 		Tracy\Debugger::log($message, Tracy\ILogger::WARNING);
 	}
 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function info(string $message) : void
+	public function info(string $message): void
 	{
 		Tracy\Debugger::log($message, Tracy\ILogger::INFO);
 	}

diff --git a/src/Common/Mail/Address.php b/src/Common/Mail/Address.php
@@ -33,15 +33,15 @@ public function __construct(string $email, ?string $name = NULL)
 	/**
 	 * @return string
 	 */
-	public function getEmail() : string
+	public function getEmail(): string
 	{
 		return $this->email;
 	}
 
 	/**
 	 * @return NULL|string
 	 */
-	public function getName() : ?string
+	public function getName(): ?string
 	{
 		return $this->name;
 	}

diff --git a/src/Common/Mail/DefaultMailSender.php b/src/Common/Mail/DefaultMailSender.php
@@ -47,7 +47,7 @@ public function __construct(
 	/**
 	 * {@inheritdoc}
 	 */
-	public function send(string $mailName, array $to, array $args) : void
+	public function send(string $mailName, array $to, array $args): void
 	{
 		$file = $this->templatesDir . '/' . $mailName . '.latte';
 

diff --git a/src/Common/Mail/IMailSender.php b/src/Common/Mail/IMailSender.php
@@ -13,5 +13,5 @@ interface IMailSender
 	 *
 	 * @return void
 	 */
-	public function send(string $mailName, array $to, array $args) : void;
+	public function send(string $mailName, array $to, array $args): void;
 }
diff --git a/src/Common/Mail/NullMailSender.php b/src/Common/Mail/NullMailSender.php
@@ -15,7 +15,7 @@ final class NullMailSender implements IMailSender
 	/**
 	 * {@inheritdoc}
 	 */
-	public function send(string $mailName, array $to, array $args) : void
+	public function send(string $mailName, array $to, array $args): void
 	{
 	}
 }
diff --git a/src/Common/PasswordHashStrategy/DefaultPasswordHashStrategy.php b/src/Common/PasswordHashStrategy/DefaultPasswordHashStrategy.php
@@ -26,23 +26,23 @@ public function __construct(array $options = [])
 	/**
 	 * {@inheritdoc}
 	 */
-	public function hash(string $password) : string
+	public function hash(string $password): string
 	{
 		return Nette\Security\Passwords::hash($password, $this->options);
 	}
 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function needRehash(string $password) : bool
+	public function needRehash(string $password): bool
 	{
 		return Nette\Security\Passwords::needsRehash($password, $this->options);
 	}
 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function verify(string $password, string $hash) : bool
+	public function verify(string $password, string $hash): bool
 	{
 		return Nette\Security\Passwords::verify($password, $hash);
 	}

diff --git a/src/Common/PasswordHashStrategy/IPasswordHashStrategy.php b/src/Common/PasswordHashStrategy/IPasswordHashStrategy.php
@@ -11,20 +11,20 @@ interface IPasswordHashStrategy
 	 *
 	 * @return string
 	 */
-	public function hash(string $password) : string;
+	public function hash(string $password): string;
 
 	/**
 	 * @param string $password
 	 *
 	 * @return bool
 	 */
-	public function needRehash(string $password) : bool;
+	public function needRehash(string $password): bool;
 
 	/**
 	 * @param string $password
 	 * @param string $hash
 	 *
 	 * @return bool
 	 */
-	public function verify(string $password, string $hash) : bool;
+	public function verify(string $password, string $hash): bool;
 }
diff --git a/src/Common/Translator/ITranslatableService.php b/src/Common/Translator/ITranslatableService.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SixtyEightPublishers\User\Common\Translator;
+
+use Nette;
+
+interface ITranslatableService
+{
+	/**
+	 * @param \Nette\Localization\ITranslator $translator
+	 *
+	 * @return void
+	 */
+	public function setTranslator(Nette\Localization\ITranslator $translator): void;
+
+	/**
+	 * @return \Nette\Localization\ITranslator
+	 *
+	 * @return void
+	 */
+	public function getTranslator(): Nette\Localization\ITranslator;
+}