AbstractUserEmailFactory::getTokenUrl() - Code Metrics - Inspection of "WIP: Refactored UserMailer + Created Email Factori..." - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — feature/unit-tests (#37)

by Daniel

created 2020-04-21 17:49 UTC

AbstractUserEmailFactory::getTokenUrl() A

↳ Parent: AbstractUserEmailFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * This file is part of the Silverback API Component Bundle Project
 *
 * (c) Daniel West <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Silverback\ApiComponentBundle\Factory\Mailer\User;

use Psr\Container\ContainerInterface;
use Silverback\ApiComponentBundle\Entity\User\AbstractUser;
use Silverback\ApiComponentBundle\Event\UserEmailMessageEvent;
use Silverback\ApiComponentBundle\Exception\BadMethodCallException;
use Silverback\ApiComponentBundle\Exception\InvalidArgumentException;
use Silverback\ApiComponentBundle\Exception\RfcComplianceException;
use Silverback\ApiComponentBundle\Exception\UnexpectedValueException;
use Silverback\ApiComponentBundle\Url\RefererUrlHelper;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Exception\RfcComplianceException as SymfonyRfcComplianceException;
use Symfony\Component\Mime\RawMessage;
use Symfony\Contracts\Service\ServiceSubscriberInterface;
use Twig\Environment;

/**
 * @author Daniel West <[email protected]>
 */
abstract class AbstractUserEmailFactory implements ServiceSubscriberInterface
{
    protected ContainerInterface $container;
    private EventDispatcherInterface $eventDispatcher;
    protected bool $enabled;
    protected string $template;
    protected string $subject;
    protected array $emailContext;
    protected ?string $defaultRedirectPath;
    protected ?string $redirectPathQueryKey;
    protected ?RawMessage $message;
    private ?AbstractUser $user;

    public function __construct(
        ContainerInterface $container,
        EventDispatcherInterface $eventDispatcher,
        string $subject,
        bool $enabled = true,
        ?string $defaultRedirectPath = null,
        ?string $redirectPathQueryKey = null,
        array $emailContext = []
    ) {
        $this->container = $container;
        $this->eventDispatcher = $eventDispatcher;
        $this->subject = $subject;
        $this->enabled = $enabled;
        $this->emailContext = $emailContext;
        $this->defaultRedirectPath = $defaultRedirectPath;
        $this->redirectPathQueryKey = $redirectPathQueryKey;
    }

    public static function getSubscribedServices(): array
    {
        return [
            RequestStack::class,
            RefererUrlHelper::class,
            Environment::class,
        ];
    }

    protected static function getRequiredContextKeys(): ?array
    {
        return [
            'website_name',
            'user',
        ];
    }

    protected function initUser(AbstractUser $user): void
    {
        if (!$user->getUsername()) {
            throw new InvalidArgumentException('The user must have a username set to send them any email');
        }

        if (!$user->getEmailAddress()) {
            throw new InvalidArgumentException('The user must have an email address set to send them any email');
        }

        $this->user = $user;
    }

    protected function createEmailMessage(array $context = []): ?TemplatedEmail
    {
        if (!$this->enabled) {
            return null;
        }

        if (!isset($this->user)) {
            throw new BadMethodCallException('You must call the method `initUser` before `createEmailMessage`');
        }

        try {
            $toEmailAddress = Address::fromString((string) $this->user->getEmailAddress());
            $toEmailAddress = Address::fromString((string) $this->user->/** @scrutinizer ignore-call */ getEmailAddress());
        } catch (SymfonyRfcComplianceException $exception) {
            $exception = new RfcComplianceException($exception->getMessage());
            throw $exception;
        }

        $context = array_replace_recursive([
            'user' => $this->user,
        ], $this->emailContext, $context);
        $this->validateContext($context);

        $twig = $this->container->get(Environment::class);
        $template = $twig->createTemplate($this->subject);
        $subject = $template->render($context);

        $email = (new TemplatedEmail())
            ->to($toEmailAddress)
            ->subject($subject)
            ->htmlTemplate('@SilverbackApiComponent/emails/' . $this->getTemplate())
            ->context($context);

        $event = new UserEmailMessageEvent(static::class, $email);
        $this->eventDispatcher->dispatch($event);

        return $event->getEmail();
    }

    protected function getTokenUrl(string $token, string $username): string
    {
        $path = $this->populatePathVariables($this->getTokenPath(), [
            'token' => $token,
            'username' => $username,
        ]);

        $refererUrlHelper = $this->container->get(RefererUrlHelper::class);

        return $refererUrlHelper->getAbsoluteUrl($path);
    }

    private function getTokenPath(): string
    {
        if (null === $this->defaultRedirectPath && null === $this->redirectPathQueryKey) {
            throw new InvalidArgumentException('The `defaultRedirectPath` or `redirectPathQueryKey` must be set');
        }

        $requestStack = $this->container->get(RequestStack::class);
        $request = $requestStack->getMasterRequest();

        $path = ($request && $this->redirectPathQueryKey) ?
            $request->query->get($this->redirectPathQueryKey, $this->defaultRedirectPath) :
            $this->defaultRedirectPath;

        if (null === $path) {
            throw new UnexpectedValueException(sprintf('The querystring key `%s` could not be found in the request to generate a token URL', $this->redirectPathQueryKey));
        }

        return $path;
    }

    private function populatePathVariables(string $path, array $variables): string
    {
        preg_match_all('/{{[\s]*(\w+)[\s]*}}/', $path, $matches);
        foreach ($matches[0] as $matchIndex => $fullMatch) {
            if (\array_key_exists($varKey = $matches[1][$matchIndex], $variables)) {
                $path = str_replace($fullMatch, rawurlencode($variables[$varKey]), $path);
            }
        }

        return $path;
    }

    private function validateContext(array $context): void
    {
        $requiredKeys = self::getRequiredContextKeys();
        foreach ($requiredKeys as $requiredKey) {
            if (!\array_key_exists($requiredKey, $context)) {
                throw new InvalidArgumentException(sprintf('The context key `%s` is required to create an email message with the factory `%s`', $requiredKey, static::class));
            }
        }
    }

    abstract public function create(AbstractUser $user, array $context = []): ?RawMessage;

    abstract protected function getTemplate(): string;
}


components-web-app / api-components-bundle

Pull Request — feature/unit-tests (#37)

AbstractUserEmailFactory::getTokenUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like