Bump nucleos/user-bundle

UPGRADE-2.0.md

@@ -0,0 +1,28 @@
+UPGRADE FROM 1.x to 2.0
+=======================
+
+## Removed XML configurations
+
+All configuration files were migrated to PHP to improve overall performance.
+
+The `@NucleosProfileBundle/Resources/config/routing/all.xml` routing configuration was removed.
+
+## Remove listeners configuration
+
+All listeneres are now registered by default. The `use_authentication_listener`, `use_listener` and `use_flash_notifications` configuration keys were removed.
+
+## Removed `Interface` suffix
+
+The `Interface` suffix was removed from all interfaces. All default implementation use specific class prefix.
+
+- `Nucleos\ProfileBundle\Mailer\MailerInterface` => `Nucleos\ProfileBundle\Mailer\RegistrationMailer`
+- `Nucleos\ProfileBundle\Mailer\NoopMailer` => `Nucleos\ProfileBundle\Mailer\NoopRegistrationMailer`
+- `Nucleos\ProfileBundle\Mailer\Mailer` => `Nucleos\ProfileBundle\Mailer\SimpleRegistrationMailer`
+-
+## Deprecations
+
+All the deprecated code introduced on 1.8.x is removed on 2.0.
+
+Please read [1.8.x](https://github.com/nucleos/NucleosProfileBundle/tree/1.8.x) upgrade guides for more information.
+
+See also the [diff code](https://github.com/nucleos/NucleosProfileBundle/compare/1.8.x...2.0.0).

composer.json

@@ -37,7 +37,7 @@
     "require": {
         "php": "^8.0",
         "doctrine/persistence": "^2.2.2",
-        "nucleos/user-bundle": "^1.7",
+        "nucleos/user-bundle": "^2.0",
         "symfony/config": "^5.4",
         "symfony/dependency-injection": "^5.4",
         "symfony/event-dispatcher": "^5.4",

docs/configuration.rst

@@ -6,12 +6,9 @@ All available configuration options are listed below with their default values.
 .. code-block:: yaml
 
     nucleos_profile:
-        use_listener:               true
-        use_flash_notifications:    true
-        use_authentication_listener: true
         registration:
             confirmation:
                 from_email:         ~ # Required
                 enabled:            false # change to true for required email confirmation
         service:
-            mailer:                 nucleos_profile.mailer.default
+            mailer:                 nucleos_profile.mailer.simple

docs/mailing.rst

@@ -29,7 +29,7 @@ Default Mailer Implementations
 The bundle comes with three mailer implementations. They are listed below
 by service id:
 
-- ``nucleos_profile.mailer.default`` is the default implementation, and uses symfony mailer to send emails.
+- ``nucleos_profile.mailer.simple`` is the default implementation, and uses symfony mailer to send emails.
 - ``nucleos_profile.mailer.noop`` is a mailer implementation which performs no operation, so no emails are sent.
 
 Configuring the Sender Email Address

src/Action/CheckRegistrationMailAction.php

@@ -11,7 +11,7 @@
 
 namespace Nucleos\ProfileBundle\Action;
 
-use Nucleos\UserBundle\Model\UserManagerInterface;
+use Nucleos\UserBundle\Model\UserManager;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -20,13 +20,13 @@
 
 final class CheckRegistrationMailAction
 {
-    private UserManagerInterface $userManager;
+    private UserManager $userManager;
 
     private Environment $twig;
 
     private RouterInterface $router;
 
-    public function __construct(UserManagerInterface $userManager, Environment $twig, RouterInterface $router)
+    public function __construct(UserManager $userManager, Environment $twig, RouterInterface $router)
     {
         $this->userManager = $userManager;
         $this->twig        = $twig;

src/Action/ConfirmRegistrationAction.php

@@ -14,7 +14,7 @@
 use Nucleos\ProfileBundle\NucleosProfileEvents;
 use Nucleos\UserBundle\Event\FilterUserResponseEvent;
 use Nucleos\UserBundle\Event\GetResponseUserEvent;
-use Nucleos\UserBundle\Model\UserManagerInterface;
+use Nucleos\UserBundle\Model\UserManager;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -25,13 +25,13 @@ final class ConfirmRegistrationAction
 {
     private EventDispatcherInterface $eventDispatcher;
 
-    private UserManagerInterface $userManager;
+    private UserManager $userManager;
 
     private RouterInterface $router;
 
     public function __construct(
         EventDispatcherInterface $eventDispatcher,
-        UserManagerInterface $userManager,
+        UserManager $userManager,
         RouterInterface $router
     ) {
         $this->eventDispatcher = $eventDispatcher;

src/Action/EditProfileAction.php

@@ -17,7 +17,7 @@
 use Nucleos\UserBundle\Event\FilterUserResponseEvent;
 use Nucleos\UserBundle\Event\GetResponseUserEvent;
 use Nucleos\UserBundle\Model\UserInterface;
-use Nucleos\UserBundle\Model\UserManagerInterface;
+use Nucleos\UserBundle\Model\UserManager;
 use Symfony\Component\Form\Extension\Core\Type\SubmitType;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\Form\FormInterface;
@@ -36,7 +36,7 @@ final class EditProfileAction
 
     private FormFactoryInterface $formFactory;
 
-    private UserManagerInterface $userManager;
+    private UserManager $userManager;
 
     private Environment $twig;
 
@@ -47,7 +47,7 @@ final class EditProfileAction
     public function __construct(
         EventDispatcherInterface $eventDispatcher,
         FormFactoryInterface $formFactory,
-        UserManagerInterface $userManager,
+        UserManager $userManager,
         Environment $twig,
         RouterInterface $router,
         Security $security

src/Action/RegistrationAction.php

@@ -18,7 +18,7 @@
 use Nucleos\UserBundle\Event\FilterUserResponseEvent;
 use Nucleos\UserBundle\Event\FormEvent;
 use Nucleos\UserBundle\Model\UserInterface;
-use Nucleos\UserBundle\Model\UserManagerInterface;
+use Nucleos\UserBundle\Model\UserManager;
 use Symfony\Component\Form\Extension\Core\Type\SubmitType;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\Form\FormInterface;
@@ -35,7 +35,7 @@ final class RegistrationAction
 
     private FormFactoryInterface $formFactory;
 
-    private UserManagerInterface $userManager;
+    private UserManager $userManager;
 
     private Environment $twig;
 
@@ -44,7 +44,7 @@ final class RegistrationAction
     public function __construct(
         EventDispatcherInterface $eventDispatcher,
         FormFactoryInterface $formFactory,
-        UserManagerInterface $userManager,
+        UserManager $userManager,
         RouterInterface $router,
         Environment $twig
     ) {

src/DependencyInjection/Configuration.php

@@ -29,14 +29,6 @@ public function getConfigTreeBuilder(): TreeBuilder
 
         $rootNode = $treeBuilder->getRootNode();
 
-        $rootNode
-            ->children()
-                ->booleanNode('use_authentication_listener')->defaultTrue()->end()
-                ->booleanNode('use_listener')->defaultTrue()->end()
-                ->booleanNode('use_flash_notifications')->defaultTrue()->end()
-            ->end()
-        ;
-
         $this->addRegistrationSection($rootNode);
         $this->addServiceSection($rootNode);
 
@@ -71,7 +63,7 @@ private function addServiceSection(ArrayNodeDefinition $node): void
                 ->arrayNode('service')
                     ->addDefaultsIfNotSet()
                         ->children()
-                            ->scalarNode('mailer')->defaultValue('nucleos_profile.mailer.default')->end()
+                            ->scalarNode('mailer')->defaultValue('nucleos_profile.mailer.simple')->end()
                         ->end()
                     ->end()
                 ->end()

src/DependencyInjection/NucleosProfileExtension.php

@@ -31,18 +31,8 @@ public function load(array $configs, ContainerBuilder $container): void
         $config = $processor->processConfiguration($configuration, $configs);
 
         $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
-
-        foreach (['mailer', 'listeners'] as $basename) {
-            $loader->load(sprintf('%s.php', $basename));
-        }
-
-        if (!$config['use_authentication_listener']) {
-            $container->removeDefinition('nucleos_profile.listener.authentication');
-        }
-
-        if ($config['use_flash_notifications']) {
-            $loader->load('flash_notifications.php');
-        }
+        $loader->load('mailer.php');
+        $loader->load('listeners.php');
 
         $this->loadRegistration($config['registration'], $container, $loader);
         $this->loadProfile($loader);

src/EventListener/AuthenticationListener.php

@@ -15,18 +15,18 @@
 use Nucleos\UserBundle\Event\FilterUserResponseEvent;
 use Nucleos\UserBundle\Event\UserEvent;
 use Nucleos\UserBundle\NucleosUserEvents;
-use Nucleos\UserBundle\Security\LoginManagerInterface;
+use Nucleos\UserBundle\Security\LoginManager;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Security\Core\Exception\AccountStatusException;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 final class AuthenticationListener implements EventSubscriberInterface
 {
-    private LoginManagerInterface $loginManager;
+    private LoginManager $loginManager;
 
     private string $firewallName;
 
-    public function __construct(LoginManagerInterface $loginManager, string $firewallName)
+    public function __construct(LoginManager $loginManager, string $firewallName)
     {
         $this->loginManager = $loginManager;
         $this->firewallName = $firewallName;

src/EventListener/EmailConfirmationListener.php

@@ -12,27 +12,27 @@
 namespace Nucleos\ProfileBundle\EventListener;
 
 use Nucleos\ProfileBundle\Event\UserFormEvent;
-use Nucleos\ProfileBundle\Mailer\MailerInterface;
+use Nucleos\ProfileBundle\Mailer\RegistrationMailer;
 use Nucleos\ProfileBundle\NucleosProfileEvents;
-use Nucleos\UserBundle\Util\TokenGeneratorInterface;
+use Nucleos\UserBundle\Util\TokenGenerator;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
 final class EmailConfirmationListener implements EventSubscriberInterface
 {
-    private MailerInterface $mailer;
+    private RegistrationMailer $mailer;
 
-    private TokenGeneratorInterface $tokenGenerator;
+    private TokenGenerator $tokenGenerator;
 
     private UrlGeneratorInterface $router;
 
     private SessionInterface $session;
 
     public function __construct(
-        MailerInterface $mailer,
-        TokenGeneratorInterface $tokenGenerator,
+        RegistrationMailer $mailer,
+        TokenGenerator $tokenGenerator,
         UrlGeneratorInterface $router,
         SessionInterface $session
     ) {

src/Mailer/NoopMailer.php → src/Mailer/NoopRegistrationMailer.php

@@ -18,7 +18,7 @@
  * It is used when the 'email' configuration is not set,
  * and allows to use this bundle without swiftmailer.
  */
-final class NoopMailer implements MailerInterface
+final class NoopRegistrationMailer implements RegistrationMailer
 {
     public function sendConfirmationEmailMessage(UserInterface $user): void
     {

src/Mailer/MailerInterface.php → src/Mailer/RegistrationMailer.php

@@ -13,7 +13,7 @@
 
 use Nucleos\UserBundle\Model\UserInterface;
 
-interface MailerInterface
+interface RegistrationMailer
 {
     /**
      * Send an email to a user to confirm the account creation.

src/Mailer/Mailer.php → src/Mailer/SimpleRegistrationMailer.php

@@ -19,7 +19,7 @@
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Contracts\Translation\TranslatorInterface;
 
-final class Mailer implements MailerInterface
+final class SimpleRegistrationMailer implements RegistrationMailer
 {
     private SymfonyMailer $mailer;
 
@@ -46,11 +46,9 @@ public function __construct(
      */
     public function sendConfirmationEmailMessage(UserInterface $user): void
     {
-        $url  = $this->router->generate(
-            'nucleos_profile_registration_confirm',
-            ['token' => $user->getConfirmationToken()],
-            UrlGeneratorInterface::ABSOLUTE_URL
-        );
+        $url = $this->router->generate('nucleos_profile_registration_confirm', [
+            'token' => $user->getConfirmationToken(),
+        ], UrlGeneratorInterface::ABSOLUTE_URL);
 
         $mail = (new RegistrationMail())
             ->to(new Address($user->getEmail()))
@@ -62,7 +60,7 @@ public function sendConfirmationEmailMessage(UserInterface $user): void
         ;
 
         if (null !== $this->fromEmail) {
-            $mail->from(Address::fromString($this->fromEmail));
+            $mail->from(new Address($this->fromEmail));
         }
 
         $this->mailer->send($mail);

src/Resources/config/listeners.php

@@ -13,6 +13,7 @@
 
 use Nucleos\ProfileBundle\EventListener\AlreadyLoggedinListener;
 use Nucleos\ProfileBundle\EventListener\AuthenticationListener;
+use Nucleos\ProfileBundle\EventListener\FlashListener;
 use Symfony\Component\DependencyInjection\Parameter;
 use Symfony\Component\DependencyInjection\Reference;
 
@@ -33,5 +34,11 @@
                 new Reference('router'),
             ])
 
+        ->set(FlashListener::class)
+            ->tag('kernel.event_subscriber')
+            ->args([
+                new Reference('session.flash_bag'),
+                new Reference('translator'),
+            ])
     ;
 };

src/Resources/config/mailer.php

@@ -11,23 +11,23 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
-use Nucleos\ProfileBundle\Mailer\Mailer;
-use Nucleos\ProfileBundle\Mailer\NoopMailer;
+use Nucleos\ProfileBundle\Mailer\NoopRegistrationMailer;
+use Nucleos\ProfileBundle\Mailer\SimpleRegistrationMailer;
 use Symfony\Component\DependencyInjection\Parameter;
 use Symfony\Component\DependencyInjection\Reference;
 
 return static function (ContainerConfigurator $container): void {
     $container->services()
 
-        ->set('nucleos_profile.mailer.default', Mailer::class)
+        ->set('nucleos_profile.mailer.simple', SimpleRegistrationMailer::class)
             ->args([
                 new Reference('mailer.mailer'),
                 new Reference('translator'),
                 new Reference('router'),
                 new Parameter('nucleos_profile.registration.confirmation.from_email'),
             ])
 
-        ->set('nucleos_profile.mailer.noop', NoopMailer::class)
+        ->set('nucleos_profile.mailer.noop', NoopRegistrationMailer::class)
 
     ;
 };