Merge pull request #2953 from XWB/deprecate-group

stof · web-flow · commit b2e6a4d17fe5 · 2020-03-31T13:00:03.000+02:00
Deprecate Groups
diff --git a/Changelog.md b/Changelog.md
@@ -3,6 +3,7 @@ Changelog
 
 ### 2.2.0 (2020-01-xx)
 
+* Deprecated the Groups feature.
 * Marked all controllers final.
 * Added Mongolian translation.
 * Added an email provider.
diff --git a/Controller/GroupController.php b/Controller/GroupController.php
@@ -11,6 +11,8 @@
 
 namespace FOS\UserBundle\Controller;
 
+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
 use FOS\UserBundle\Event\FilterGroupResponseEvent;
 use FOS\UserBundle\Event\FormEvent;
 use FOS\UserBundle\Event\GetResponseGroupEvent;
@@ -32,7 +34,7 @@
  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
  * @author Christophe Coevoet <stof@notk.org>
  *
- * @final
+ * @deprecated
  */
 class GroupController extends Controller
 {
diff --git a/DependencyInjection/FOSUserExtension.php b/DependencyInjection/FOSUserExtension.php
@@ -126,6 +126,8 @@ public function load(array $configs, ContainerBuilder $container)
         }
 
         if (!empty($config['group'])) {
+            @trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
             $this->loadGroups($config['group'], $container, $loader, $config['db_driver']);
         }
 
diff --git a/Doctrine/GroupManager.php b/Doctrine/GroupManager.php
@@ -11,11 +11,16 @@
 
 namespace FOS\UserBundle\Doctrine;
 
+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
 use Doctrine\Common\Persistence\ObjectManager;
 use Doctrine\Common\Persistence\ObjectRepository;
 use FOS\UserBundle\Model\GroupInterface;
 use FOS\UserBundle\Model\GroupManager as BaseGroupManager;
 
+/**
+ * @deprecated
+ */
 class GroupManager extends BaseGroupManager
 {
     /**
diff --git a/Event/GroupEvent.php b/Event/GroupEvent.php
@@ -11,10 +11,15 @@
 
 namespace FOS\UserBundle\Event;
 
+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
 use FOS\UserBundle\Model\GroupInterface;
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\HttpFoundation\Request;
 
+/**
+ * @deprecated
+ */
 class GroupEvent extends Event
 {
     /**
diff --git a/Form/Type/GroupFormType.php b/Form/Type/GroupFormType.php
@@ -11,10 +11,15 @@
 
 namespace FOS\UserBundle\Form\Type;
 
+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @deprecated
+ */
 class GroupFormType extends AbstractType
 {
     /**
diff --git a/Model/Group.php b/Model/Group.php
@@ -11,8 +11,12 @@
 
 namespace FOS\UserBundle\Model;
 
+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
 /**
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ *
+ * @deprecated
  */
 abstract class Group implements GroupInterface
 {
diff --git a/Model/GroupInterface.php b/Model/GroupInterface.php
@@ -11,9 +11,13 @@
 
 namespace FOS\UserBundle\Model;
 
+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
 /**
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  * @author Christophe Coevoet <stof@notk.org>
+ *
+ * @deprecated
  */
 interface GroupInterface
 {
diff --git a/Model/GroupManager.php b/Model/GroupManager.php
@@ -11,11 +11,15 @@
 
 namespace FOS\UserBundle\Model;
 
+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
 /**
  * Abstract Group Manager implementation which can be used as base class for your
  * concrete manager.
  *
  * @author Christophe Coevoet <stof@notk.org>
+ *
+ * @deprecated
  */
 abstract class GroupManager implements GroupManagerInterface
 {
diff --git a/Model/GroupManagerInterface.php b/Model/GroupManagerInterface.php
@@ -11,13 +11,17 @@
 
 namespace FOS\UserBundle\Model;
 
+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
 /**
  * Interface to be implemented by group managers. This adds an additional level
  * of abstraction between your application, and the actual repository.
  *
  * All changes to groups should happen through this interface.
  *
  * @author Christophe Coevoet <stof@notk.org>
+ *
+ * @deprecated
  */
 interface GroupManagerInterface
 {
diff --git a/Model/GroupableInterface.php b/Model/GroupableInterface.php
@@ -11,10 +11,14 @@
 
 namespace FOS\UserBundle\Model;
 
+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
+
 /**
  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  * @author Christophe Coevoet <stof@notk.org>
+ *
+ * @deprecated
  */
 interface GroupableInterface
 {
diff --git a/Tests/DependencyInjection/FOSUserExtensionTest.php b/Tests/DependencyInjection/FOSUserExtensionTest.php
@@ -61,6 +61,8 @@ public function testUserLoadThrowsExceptionUnlessFirewallNameSet()
 
     /**
      * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     *
+     * @group legacy
      */
     public function testUserLoadThrowsExceptionUnlessGroupModelClassSet()
     {
@@ -238,6 +240,15 @@ public function testUserLoadManagerClassWithDefaults()
         $this->assertParameter('mongodb', 'fos_user.storage');
         $this->assertParameter(null, 'fos_user.model_manager_name');
         $this->assertAlias('fos_user.user_manager.default', 'fos_user.user_manager');
+    }
+
+    /**
+     * @group legacy
+     */
+    public function testLegacyUserLoadManagerClassWithDefaults()
+    {
+        $this->createEmptyConfiguration();
+
         $this->assertNotHasDefinition('fos_user.group_manager');
     }
 
@@ -248,6 +259,15 @@ public function testUserLoadManagerClass()
         $this->assertParameter('orm', 'fos_user.storage');
         $this->assertParameter('custom', 'fos_user.model_manager_name');
         $this->assertAlias('acme_my.user_manager', 'fos_user.user_manager');
+    }
+
+    /**
+     * @group legacy
+     */
+    public function testLegacyUserLoadManagerClass()
+    {
+        $this->createFullConfiguration();
+
         $this->assertAlias('fos_user.group_manager.default', 'fos_user.group_manager');
     }
 
@@ -257,11 +277,20 @@ public function testUserLoadFormClass()
 
         $this->assertParameter('acme_my_profile', 'fos_user.profile.form.type');
         $this->assertParameter('acme_my_registration', 'fos_user.registration.form.type');
-        $this->assertParameter('acme_my_group', 'fos_user.group.form.type');
         $this->assertParameter('acme_my_change_password', 'fos_user.change_password.form.type');
         $this->assertParameter('acme_my_resetting', 'fos_user.resetting.form.type');
     }
 
+    /**
+     * @group legacy
+     */
+    public function testLegacyUserLoadFormClass()
+    {
+        $this->createFullConfiguration();
+
+        $this->assertParameter('acme_my_group', 'fos_user.group.form.type');
+    }
+
     public function testUserLoadFormNameWithDefaults()
     {
         $this->createEmptyConfiguration();
@@ -278,33 +307,60 @@ public function testUserLoadFormName()
 
         $this->assertParameter('acme_profile_form', 'fos_user.profile.form.name');
         $this->assertParameter('acme_registration_form', 'fos_user.registration.form.name');
-        $this->assertParameter('acme_group_form', 'fos_user.group.form.name');
         $this->assertParameter('acme_change_password_form', 'fos_user.change_password.form.name');
         $this->assertParameter('acme_resetting_form', 'fos_user.resetting.form.name');
     }
 
+    /**
+     * @group legacy
+     */
+    public function testLegacyUserLoadFormName()
+    {
+        $this->createFullConfiguration();
+
+        $this->assertParameter('acme_group_form', 'fos_user.group.form.name');
+    }
+
     public function testUserLoadFormServiceWithDefaults()
     {
         $this->createEmptyConfiguration();
 
         $this->assertHasDefinition('fos_user.profile.form.factory');
         $this->assertHasDefinition('fos_user.registration.form.factory');
-        $this->assertNotHasDefinition('fos_user.group.form.factory');
         $this->assertHasDefinition('fos_user.change_password.form.factory');
         $this->assertHasDefinition('fos_user.resetting.form.factory');
     }
 
+    /**
+     * @group legacy
+     */
+    public function testLegacyUserLoadFormServiceWithDefaults()
+    {
+        $this->createEmptyConfiguration();
+
+        $this->assertNotHasDefinition('fos_user.group.form.factory');
+    }
+
     public function testUserLoadFormService()
     {
         $this->createFullConfiguration();
 
         $this->assertHasDefinition('fos_user.profile.form.factory');
         $this->assertHasDefinition('fos_user.registration.form.factory');
-        $this->assertHasDefinition('fos_user.group.form.factory');
         $this->assertHasDefinition('fos_user.change_password.form.factory');
         $this->assertHasDefinition('fos_user.resetting.form.factory');
     }
 
+    /**
+     * @group legacy
+     */
+    public function testLegacyUserLoadFormService()
+    {
+        $this->createFullConfiguration();
+
+        $this->assertHasDefinition('fos_user.group.form.factory');
+    }
+
     public function testUserLoadConfirmationEmailWithDefaults()
     {
         $this->createEmptyConfiguration();
diff --git a/Tests/Form/Type/GroupFormTypeTest.php b/Tests/Form/Type/GroupFormTypeTest.php
@@ -14,6 +14,9 @@
 use FOS\UserBundle\Form\Type\GroupFormType;
 use FOS\UserBundle\Tests\TestGroup;
 
+/**
+ * @group legacy
+ */
 class GroupFormTypeTest extends TypeTestCase
 {
     public function testSubmit()
diff --git a/Tests/Routing/LegacyRoutingTest.php b/Tests/Routing/LegacyRoutingTest.php
@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the FOSUserBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\UserBundle\Tests\Routing;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Routing\Loader\XmlFileLoader;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * @group legacy
+ */
+class LegacyRoutingTest extends TestCase
+{
+    /**
+     * @dataProvider loadRoutingProvider
+     *
+     * @param string $routeName
+     * @param string $path
+     */
+    public function testLegacyGroupRouting($routeName, $path, array $methods)
+    {
+        $locator = new FileLocator();
+        $loader = new XmlFileLoader($locator);
+
+        $collection = new RouteCollection();
+        $subCollection = $loader->load(__DIR__.'/../../Resources/config/routing/group.xml');
+        $subCollection->addPrefix('/group');
+        $collection->addCollection($subCollection);
+
+        $route = $collection->get($routeName);
+        $this->assertNotNull($route, sprintf('The route "%s" should exists', $routeName));
+        $this->assertSame($path, $route->getPath());
+        $this->assertSame($methods, $route->getMethods());
+    }
+
+    /**
+     * @return array
+     */
+    public function loadRoutingProvider()
+    {
+        return [
+            ['fos_user_group_list', '/group/list', ['GET']],
+            ['fos_user_group_new', '/group/new', ['GET', 'POST']],
+            ['fos_user_group_show', '/group/{groupName}', ['GET']],
+            ['fos_user_group_edit', '/group/{groupName}/edit', ['GET', 'POST']],
+            ['fos_user_group_delete', '/group/{groupName}/delete', ['GET']],
+        ];
+    }
+}
diff --git a/Tests/Routing/RoutingTest.php b/Tests/Routing/RoutingTest.php
@@ -31,9 +31,6 @@ public function testLoadRouting($routeName, $path, array $methods)
 
         $collection = new RouteCollection();
         $collection->addCollection($loader->load(__DIR__.'/../../Resources/config/routing/change_password.xml'));
-        $subCollection = $loader->load(__DIR__.'/../../Resources/config/routing/group.xml');
-        $subCollection->addPrefix('/group');
-        $collection->addCollection($subCollection);
         $subCollection = $loader->load(__DIR__.'/../../Resources/config/routing/profile.xml');
         $subCollection->addPrefix('/profile');
         $collection->addCollection($subCollection);
@@ -59,12 +56,6 @@ public function loadRoutingProvider()
         return [
             ['fos_user_change_password', '/change-password', ['GET', 'POST']],
 
-            ['fos_user_group_list', '/group/list', ['GET']],
-            ['fos_user_group_new', '/group/new', ['GET', 'POST']],
-            ['fos_user_group_show', '/group/{groupName}', ['GET']],
-            ['fos_user_group_edit', '/group/{groupName}/edit', ['GET', 'POST']],
-            ['fos_user_group_delete', '/group/{groupName}/delete', ['GET']],
-
             ['fos_user_profile_show', '/profile/', ['GET']],
             ['fos_user_profile_edit', '/profile/edit', ['GET', 'POST']],
 

Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,8 @@ public function load(array $configs, ContainerBuilder $container)`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`if (!empty($config['group'])) {`
	`129`	`+ @trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);`
	`130`	`+`
`129`	`131`	`$this->loadGroups($config['group'], $container, $loader, $config['db_driver']);`
`130`	`132`	`}`
`131`	`133`
Original file line number	Diff line number	Diff line change
`@@ -11,11 +11,15 @@`
`11`	`11`
`12`	`12`	`namespace FOS\UserBundle\Model;`
`13`	`13`
	`14`	`+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* Abstract Group Manager implementation which can be used as base class for your`
`16`	`18`	`* concrete manager.`
`17`	`19`	`*`
`18`	`20`	`* @author Christophe Coevoet <stof@notk.org>`
	`21`	`+ *`
	`22`	`+ * @deprecated`
`19`	`23`	`*/`
`20`	`24`	`abstract class GroupManager implements GroupManagerInterface`
`21`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,17 @@`
`11`	`11`
`12`	`12`	`namespace FOS\UserBundle\Model;`
`13`	`13`
	`14`	`+@trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* Interface to be implemented by group managers. This adds an additional level`
`16`	`18`	`* of abstraction between your application, and the actual repository.`
`17`	`19`	`*`
`18`	`20`	`* All changes to groups should happen through this interface.`
`19`	`21`	`*`
`20`	`22`	`* @author Christophe Coevoet <stof@notk.org>`
	`23`	`+ *`
	`24`	`+ * @deprecated`
`21`	`25`	`*/`
`22`	`26`	`interface GroupManagerInterface`
`23`	`27`	`{`