Stop suggesting "friendsofsymfony/user-bundle"

Author: phansys

Command/AutoClosingCommand.php

@@ -11,6 +11,7 @@
 
 namespace Hackzilla\Bundle\TicketBundle\Command;
 
+use Hackzilla\Bundle\TicketBundle\Entity\Ticket;
 use Hackzilla\Bundle\TicketBundle\Entity\TicketMessage;
 use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
 use Symfony\Component\Console\Input\InputArgument;
@@ -23,6 +24,8 @@
  */
 class AutoClosingCommand extends ContainerAwareCommand
 {
+    use UserManagerTrait;
+
     protected static $defaultName = 'ticket:autoclosing';
 
     /**
@@ -57,10 +60,9 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $ticketManager = $this->getContainer()->get('hackzilla_ticket.ticket_manager');
-        $userManager = $this->getContainer()->get('fos_user.user_manager');
-        $ticketRepository = $this->getContainer()->get('doctrine')->getRepository('HackzillaTicketBundle:Ticket');
+        $ticketRepository = $this->getContainer()->get('doctrine')->getRepository(Ticket::class);
 
-        $locale = $this->getContainer()->getParameter('locale') ? $this->getContainer()->getParameter('locale') : 'en';
+        $locale = $this->getContainer()->hasParameter('locale') ? $this->getContainer()->getParameter('locale') : 'en';
         $translator = $this->getContainer()->get('translator');
         $translator->setLocale($locale);
 
@@ -77,7 +79,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 )
                 ->setStatus(TicketMessage::STATUS_CLOSED)
                 ->setPriority($ticket->getPriority())
-                ->setUser($userManager->findUserByUsername($username))
+                ->setUser($this->findUser($username))
                 ->setTicket($ticket);
 
             $ticket->setStatus(TicketMessage::STATUS_CLOSED);

Command/TicketManagerCommand.php

@@ -23,6 +23,8 @@
  */
 class TicketManagerCommand extends ContainerAwareCommand
 {
+    use UserManagerTrait;
+
     protected static $defaultName = 'ticket:create';
 
     /**
@@ -57,12 +59,6 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        if (!$this->getContainer()->has('fos_user.user_manager')) {
-            throw new \RuntimeException(sprintf('Command "%s" requires the service "fos_user.user_manager". Is "friendsofsymfony/user-bundle" installed and enabled?', $this->getName()));
-        }
-
-        $userManager = $this->getContainer()->get('fos_user.user_manager');
-
         $ticketManager = $this->getContainer()->get('hackzilla_ticket.ticket_manager');
 
         $ticket = $ticketManager->createTicket()
@@ -72,7 +68,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             ->setMessage($input->getArgument('message'))
             ->setStatus(TicketMessage::STATUS_OPEN)
             ->setPriority($input->getOption('priority'))
-            ->setUser($userManager->findUserByUsername('system'));
+            ->setUser($this->findUser('system'));
 
         $ticketManager->updateTicket($ticket, $message);
 

Command/UserManagerTrait.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of HackzillaTicketBundle package.
+ *
+ * (c) Daniel Platt <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Hackzilla\Bundle\TicketBundle\Command;
+
+use Doctrine\Persistence\ObjectRepository;
+use Hackzilla\Bundle\TicketBundle\Model\UserInterface;
+
+/**
+ * NEXT_MAJOR: Inject the object repository and the user class directly in the command
+ * classes and remove this trait.
+ *
+ * @author Javier Spagnoletti <[email protected]>
+ */
+trait UserManagerTrait
+{
+    /**
+     * @var ObjectRepository
+     */
+    private $userRepository;
+
+    public function __construct(string $name = null, ?ObjectRepository $userRepository = null)
+    {
+        parent::__construct($name);
+
+        $this->userRepository = $userRepository;
+
+        if (null === $userRepository) {
+            @trigger_error(sprintf(
+                'Omitting or passing null as argument 2 for "%s()" is deprecated since hackzilla/ticket-bundle 3.x.',
+                __METHOD__
+            ), E_USER_DEPRECATED);
+        }
+    }
+
+    private function findUser(string $username): ?UserInterface
+    {
+        if (null !== $this->userRepository) {
+            return $this->userRepository->findBy(['username' => $username]);
+        }
+
+        if (!$this->getContainer()->has('fos_user.user_manager')) {
+            throw new \RuntimeException(sprintf('Command "%s" requires the service "fos_user.user_manager". Is "friendsofsymfony/user-bundle" installed and enabled?', $this->getName()));
+        }
+
+        return $this->getContainer()->get('fos_user.user_manager')->findUserByUsername($username);
+    }
+}

Model/UserInterface.php

@@ -15,7 +15,5 @@ interface UserInterface extends \Symfony\Component\Security\Core\User\UserInterf
 {
     public function getId();
 
-    public function getUsername();
-
     public function getEmail();
 }

README.md

@@ -13,8 +13,7 @@ You can see the full requirement definitions for each available version in [Pack
 
 ## Setup
 
-* [Installation with FOSUserBundle](Resources/doc/setup/fosuserbundle.md)
-* [Generic installation](Resources/doc/setup/other.md)
+* [Install](Resources/doc/setup/install.md)
 
 ## Optional features
 

Resources/config/services.yml

@@ -16,7 +16,7 @@ services:
 
     hackzilla_ticket.user_repository:
         class: Doctrine\ORM\EntityRepository
-        factory: ['@doctrine.orm.default_entity_manager', getRepository]
+        factory: ['@doctrine.orm.entity_manager', getRepository]
         arguments:
             - '%hackzilla_ticket.model.user.class%'
 
@@ -73,10 +73,16 @@ services:
 
     hackzilla_ticket.command.autoclosing:
         class: Hackzilla\Bundle\TicketBundle\Command\AutoClosingCommand
+        arguments:
+            - null
+            - '@hackzilla_ticket.user_repository'
         tags:
             - { name: console.command, command: 'ticket:autoclosing' }
 
     hackzilla_ticket.command.create:
         class: Hackzilla\Bundle\TicketBundle\Command\TicketManagerCommand
+        arguments:
+            - null
+            - '@hackzilla_ticket.user_repository'
         tags:
             - { name: console.command, command: 'ticket:create' }

Resources/doc/setup/fosuserbundle.md

@@ -8,7 +8,7 @@ Add HackzillaTicketBundle to your requirements:
 composer require hackzilla/ticket-bundle
 ```
 
-Specify your user class in your config, if you are using FOSUserBundle, then this will be exactly the same.
+Specify your user class in your config.
 
 ```yaml
 hackzilla_ticket:

Resources/doc/setup/other.md renamed to Resources/doc/setup/install.md

@@ -12,20 +12,80 @@
 namespace Hackzilla\Bundle\TicketBundle\Tests\Functional\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
-use FOS\UserBundle\Model\User as BaseUser;
+use Hackzilla\Bundle\TicketBundle\Model\UserInterface;
 
 /**
  * @ORM\Entity
- * @ORM\Table(name="fos_user")
+ * @ORM\Table(name="user")
  *
  * @author Javier Spagnoletti <[email protected]>
  */
-class User extends BaseUser
+class User implements UserInterface
 {
     /**
+     * @var int
+     *
      * @ORM\Id
      * @ORM\Column(type="integer")
      * @ORM\GeneratedValue(strategy="AUTO")
      */
-    protected $id;
+    private $id;
+
+    /**
+     * @var string
+     *
+     * @ORM\Column(type="string", nullable=false)
+     */
+    private $username;
+
+    /**
+     * @var string
+     *
+     * @ORM\Column(type="string", nullable=false)
+     */
+    private $email;
+
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    public function getUsername()
+    {
+        return $this->username;
+    }
+
+    public function setUsername(?string $username): void
+    {
+        $this->username = $username;
+    }
+
+    public function getEmail()
+    {
+        return $this->email;
+    }
+
+    public function setEmail(?string $email): void
+    {
+        $this->email = $email;
+    }
+
+    public function eraseCredentials()
+    {
+    }
+
+    public function getRoles()
+    {
+        return [];
+    }
+
+    public function getPassword()
+    {
+        return '';
+    }
+
+    public function getSalt()
+    {
+        return '';
+    }
 }

Tests/Functional/Entity/User.php

@@ -12,7 +12,6 @@
 namespace Hackzilla\Bundle\TicketBundle\Tests\Functional;
 
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
-use FOS\UserBundle\FOSUserBundle;
 use Hackzilla\Bundle\TicketBundle\HackzillaTicketBundle;
 use Hackzilla\Bundle\TicketBundle\Tests\Functional\Entity\User;
 use Knp\Bundle\PaginatorBundle\KnpPaginatorBundle;
@@ -51,7 +50,6 @@ public function registerBundles()
             new FrameworkBundle(),
             new SecurityBundle(),
             new DoctrineBundle(),
-            new FOSUserBundle(),
             new KnpPaginatorBundle(),
             new TwigBundle(),
             new HackzillaTicketBundle(),
@@ -165,20 +163,6 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
         }
         $c->loadFromExtension('twig', $twigConfig);
 
-        // FOSUserBundle config
-        $c->loadFromExtension('fos_user', [
-            'user_class' => User::class,
-            'db_driver' => 'orm',
-            'firewall_name' => 'api',
-            'from_email' => [
-                'address' => '[email protected]',
-                'sender_name' => 'HackzillaTicketBundle',
-            ],
-            'service' => [
-                'mailer' => 'fos_user.mailer.noop',
-            ],
-        ]);
-
         // HackzillaBundle config
         $c->loadFromExtension('hackzilla_ticket', [
             'user_class' => User::class,