Allow installing doctrine/inflector 2.0

symfony · weaverryan · May 8, 2020 · May 6, 2020 · May 7, 2020 · May 7, 2020
commit 48211390ad6201ad737ef0977ef26e853fba805e
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
     "minimum-stability": "dev",
     "require": {
         "php": "^7.1.3",
-        "doctrine/inflector": "^1.2",
+        "doctrine/inflector": "^1.2 || ^2.0",
         "nikic/php-parser": "^4.0",
         "symfony/config": "^3.4|^4.0|^5.0",
         "symfony/console": "^3.4|^4.0|^5.0",

diff --git a/src/DependencyInjection/MakerExtension.php b/src/DependencyInjection/MakerExtension.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\MakerBundle\DependencyInjection;
 
+use Doctrine\Inflector\InflectorFactory;
 use Symfony\Bundle\MakerBundle\DependencyInjection\CompilerPass\MakeCommandRegistrationPass;
 use Symfony\Bundle\MakerBundle\MakerInterface;
 use Symfony\Component\Config\FileLocator;
@@ -48,6 +49,10 @@ public function load(array $configs, ContainerBuilder $container)
         $doctrineHelperDefinition = $container->getDefinition('maker.doctrine_helper');
         $doctrineHelperDefinition->replaceArgument(0, $rootNamespace.'\\Entity');
 
+        if (!class_exists(InflectorFactory::class)) {
+            $container->removeDefinition('maker.doctrine_inflector');
+        }
+
         $container->registerForAutoconfiguration(MakerInterface::class)
             ->addTag(MakeCommandRegistrationPass::MAKER_TAG);
     }

diff --git a/src/Maker/MakeCrud.php b/src/Maker/MakeCrud.php
@@ -12,7 +12,9 @@
 namespace Symfony\Bundle\MakerBundle\Maker;
 
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
-use Doctrine\Common\Inflector\Inflector;
+use Doctrine\Common\Inflector\Inflector as LegacyInflector;
+use Doctrine\Inflector\Inflector;
+use Doctrine\Inflector\InflectorFactory;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
@@ -41,10 +43,22 @@ final class MakeCrud extends AbstractMaker
 
     private $formTypeRenderer;
 
-    public function __construct(DoctrineHelper $doctrineHelper, FormTypeRenderer $formTypeRenderer)
+    /** @var Inflector|null */
+    private $inflector;
+
+    public function __construct(DoctrineHelper $doctrineHelper, FormTypeRenderer $formTypeRenderer, Inflector $inflector = null)
     {
         $this->doctrineHelper = $doctrineHelper;
         $this->formTypeRenderer = $formTypeRenderer;
+        $this->inflector = $inflector;
+
+        if (null === $inflector) {
+            @trigger_error(sprintf('"%s" will require a value for the $inflector argument in 2.0.', __METHOD__), E_USER_DEPRECATED);
+
+            if (class_exists(InflectorFactory::class)) {
+                $this->inflector = InflectorFactory::create()->build();
+            }
+        }
     }
 
     public static function getCommandName(): string
@@ -103,7 +117,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             $repositoryVars = [
                 'repository_full_class_name' => $repositoryClassDetails->getFullName(),
                 'repository_class_name' => $repositoryClassDetails->getShortName(),
-                'repository_var' => lcfirst(Inflector::singularize($repositoryClassDetails->getShortName())),
+                'repository_var' => lcfirst($this->singularize($repositoryClassDetails->getShortName())),
             ];
         }
 
@@ -123,8 +137,8 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             ++$iter;
         } while (class_exists($formClassDetails->getFullName()));
 
-        $entityVarPlural = lcfirst(Inflector::pluralize($entityClassDetails->getShortName()));
-        $entityVarSingular = lcfirst(Inflector::singularize($entityClassDetails->getShortName()));
+        $entityVarPlural = lcfirst($this->pluralize($entityClassDetails->getShortName()));
+        $entityVarSingular = lcfirst($this->singularize($entityClassDetails->getShortName()));
 
         $entityTwigVarPlural = Str::asTwigVariable($entityVarPlural);
         $entityTwigVarSingular = Str::asTwigVariable($entityVarSingular);
@@ -248,4 +262,22 @@ public function configureDependencies(DependencyBuilder $dependencies)
             'annotations'
         );
     }
+
+    private function pluralize(string $word): string
+    {
+        if (null !== $this->inflector) {
+            return $this->inflector->pluralize($word);
+        }
+
+        return LegacyInflector::pluralize($word);
+    }
+
+    private function singularize(string $word): string
+    {
+        if (null !== $this->inflector) {
+            return $this->inflector->singularize($word);
+        }
+
+        return LegacyInflector::singularize($word);
+    }
 }
diff --git a/src/Resources/config/makers.xml b/src/Resources/config/makers.xml
@@ -27,6 +27,7 @@
             <service id="maker.maker.make_crud" class="Symfony\Bundle\MakerBundle\Maker\MakeCrud">
                 <argument type="service" id="maker.doctrine_helper" />
                 <argument type="service" id="maker.renderer.form_type_renderer" />
+                <argument type="service" id="maker.doctrine_inflector" on-invalid="null" />
                 <tag name="maker.command" />
             </service>
 

diff --git a/src/Resources/config/services.xml b/src/Resources/config/services.xml
@@ -40,6 +40,14 @@
                 <argument type="service" id="doctrine" on-invalid="ignore" />
             </service>
 
+            <service id="maker.doctrine_inflector_factory" class="Doctrine\Inflector\InflectorFactory">
+                <factory class="Doctrine\Inflector\InflectorFactory" method="create" />
+            </service>
+
+            <service id="maker.doctrine_inflector" class="Doctrine\Inflector\Inflector">
+                <factory service="maker.doctrine_inflector_factory" method="build" />
+            </service>
+
             <service id="maker.auto_command.abstract" class="Symfony\Bundle\MakerBundle\Command\MakerCommand" abstract="true">
                 <argument /> <!-- maker -->
                 <argument type="service" id="maker.file_manager" />

diff --git a/src/Str.php b/src/Str.php
@@ -11,7 +11,9 @@
 
 namespace Symfony\Bundle\MakerBundle;
 
-use Doctrine\Common\Inflector\Inflector;
+use Doctrine\Common\Inflector\Inflector as LegacyInflector;
+use Doctrine\Inflector\Inflector;
+use Doctrine\Inflector\InflectorFactory;
 use Symfony\Component\DependencyInjection\Container;
 
 /**
@@ -20,6 +22,9 @@
  */
 final class Str
 {
+    /** @var Inflector|null */
+    private static $inflector;
+
     /**
      * Looks for suffixes in strings in a case-insensitive way.
      */
@@ -141,7 +146,7 @@ public static function singularCamelCaseToPluralCamelCase(string $camelCase): st
     {
         $snake = self::asSnakeCase($camelCase);
         $words = explode('_', $snake);
-        $words[\count($words) - 1] = Inflector::pluralize($words[\count($words) - 1]);
+        $words[\count($words) - 1] = self::pluralize($words[\count($words) - 1]);
         $reSnaked = implode('_', $words);
 
         return self::asLowerCamelCase($reSnaked);
@@ -151,7 +156,7 @@ public static function pluralCamelCaseToSingular(string $camelCase): string
     {
         $snake = self::asSnakeCase($camelCase);
         $words = explode('_', $snake);
-        $words[\count($words) - 1] = Inflector::singularize($words[\count($words) - 1]);
+        $words[\count($words) - 1] = self::singularize($words[\count($words) - 1]);
         $reSnaked = implode('_', $words);
 
         return self::asLowerCamelCase($reSnaked);
@@ -210,4 +215,31 @@ public static function asHumanWords(string $variableName): string
     {
         return implode(' ', preg_split('/(?=[A-Z])/', $variableName));
     }
+
+    private static function pluralize(string $word): string
+    {
+        if (class_exists(Inflector::class)) {
+            return static::getInflector()->pluralize($word);
+        }
+
+        return LegacyInflector::pluralize($word);
+    }
+
+    private static function singularize(string $word): string
+    {
+        if (class_exists(Inflector::class)) {
+            return static::getInflector()->singularize($word);
+        }
+
+        return LegacyInflector::singularize($word);
+    }
+
+    private static function getInflector(): Inflector
+    {
+        if (null === static::$inflector) {
+            static::$inflector = InflectorFactory::create()->build();
+        }
+
+        return static::$inflector;
+    }
 }
diff --git a/src/Test/MakerTestCase.php b/src/Test/MakerTestCase.php
@@ -21,6 +21,7 @@ abstract class MakerTestCase extends TestCase
 
     /**
      * @dataProvider getTestDetails
+     * @group legacy
      */
     public function testExecute(MakerTestDetails $makerTestDetails)
     {

diff --git a/tests/Maker/FunctionalTest.php b/tests/Maker/FunctionalTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\MakerBundle\Tests\Maker;
 
+use Doctrine\Inflector\InflectorFactory;
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Bundle\MakerBundle\Command\MakerCommand;
@@ -24,6 +25,8 @@ class FunctionalTest extends TestCase
     /**
      * Smoke test to make sure the DI autowiring works and all makers
      * are registered and have the correct arguments.
+     *
+     * @group legacy
      */
     public function testWiring()
     {
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,6 +21,7 @@ abstract class MakerTestCase extends TestCase @@
         /**
          * @dataProvider getTestDetails
+         * @group legacy
          */
         public function testExecute(MakerTestDetails $makerTestDetails)
         {
@@ Expand Down @@