feat: replace doctrine/inflector by symfony/string (#5637)

* feat: replace doctrine/inflector by symfony/string

* fix: use the last element for a better match instead of the first

* feat: adding deprecation

* feat: adding config flag to activate new symfony inflector

* fix: revert change on old inflector

* fix: remove unused import

Author: Romaixn

src/Metadata/Util/Inflector.php

@@ -13,29 +13,39 @@
 
 namespace ApiPlatform\Metadata\Util;
 
-use Doctrine\Inflector\Inflector as InflectorObject;
+use Doctrine\Inflector\Inflector as LegacyInflector;
 use Doctrine\Inflector\InflectorFactory;
+use Symfony\Component\String\Inflector\EnglishInflector;
+use Symfony\Component\String\UnicodeString;
 
 /**
- * Facade for Doctrine Inflector.
- *
  * @internal
  */
 final class Inflector
 {
-    private static ?InflectorObject $instance = null;
+    private static bool $keepLegacyInflector;
+    private static ?LegacyInflector $instance = null;
 
-    private static function getInstance(): InflectorObject
+    private static function getInstance(): LegacyInflector
     {
         return self::$instance
             ?? self::$instance = InflectorFactory::create()->build();
     }
 
+    public static function keepLegacyInflector(bool $keepLegacyInflector): void
+    {
+        self::$keepLegacyInflector = $keepLegacyInflector;
+    }
+
     /**
      * @see InflectorObject::tableize()
      */
     public static function tableize(string $word): string
     {
+        if (!self::$keepLegacyInflector) {
+            return (new UnicodeString($word))->snake()->toString();
+        }
+
         return self::getInstance()->tableize($word);
     }
 
@@ -44,6 +54,11 @@ public static function tableize(string $word): string
      */
     public static function pluralize(string $word): string
     {
+        if (!self::$keepLegacyInflector) {
+            $pluralize = (new EnglishInflector())->pluralize($word);
+            return end($pluralize);
+        }
+
         return self::getInstance()->pluralize($word);
     }
 }

src/Metadata/composer.json

@@ -31,7 +31,8 @@
     "doctrine/inflector": "^2.0",
     "psr/cache": "^3.0",
     "psr/log": "^1.0 || ^2.0 || ^3.0",
-    "symfony/property-info": "^6.1"
+    "symfony/property-info": "^6.1",
+    "symfony/string": "^6.1"
   },
   "require-dev": {
     "phpstan/phpdoc-parser": "^1.16",

src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -31,6 +31,7 @@
 use ApiPlatform\GraphQl\Resolver\QueryItemResolverInterface;
 use ApiPlatform\GraphQl\Type\Definition\TypeInterface as GraphQlTypeInterface;
 use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Util\Inflector;
 use ApiPlatform\State\ProcessorInterface;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\Symfony\GraphQl\Resolver\Factory\DataCollectorResolverFactory;
@@ -141,6 +142,8 @@ public function load(array $configs, ContainerBuilder $container): void
         if (!$container->has('api_platform.state.item_provider')) {
             $container->setAlias('api_platform.state.item_provider', 'api_platform.state_provider.object');
         }
+
+        $this->registerInflectorConfiguration($config);
     }
 
     private function registerCommonConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader, array $formats, array $patchFormats, array $errorFormats): void
@@ -160,6 +163,7 @@ private function registerCommonConfiguration(ContainerBuilder $container, array
 
         $container->setParameter('api_platform.enable_entrypoint', $config['enable_entrypoint']);
         $container->setParameter('api_platform.enable_docs', $config['enable_docs']);
+        $container->setParameter('api_platform.keep_legacy_inflector', $config['keep_legacy_inflector']);
         $container->setParameter('api_platform.title', $config['title']);
         $container->setParameter('api_platform.description', $config['description']);
         $container->setParameter('api_platform.version', $config['version']);
@@ -786,4 +790,14 @@ private function registerArgumentResolverConfiguration(XmlFileLoader $loader): v
     {
         $loader->load('argument_resolver.xml');
     }
+
+    private function registerInflectorConfiguration(array $config): void
+    {
+        if ($config['keep_legacy_inflector']) {
+            Inflector::keepLegacyInflector(true);
+            trigger_deprecation('api-platform/core', '3.2', 'Using doctrine/inflector is deprecated since API Platform 3.2 and will be removed in API Platform 4. Use symfony/string instead. Run "composer require symfony/string" and set "keep_legacy_inflector" to false in config.');
+        } else {
+            Inflector::keepLegacyInflector(false);
+        }
+    }
 }

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -109,6 +109,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->booleanNode('enable_entrypoint')->defaultTrue()->info('Enable the entrypoint')->end()
                 ->booleanNode('enable_docs')->defaultTrue()->info('Enable the docs')->end()
                 ->booleanNode('enable_profiler')->defaultTrue()->info('Enable the data collector and the WebProfilerBundle integration.')->end()
+                ->booleanNode('keep_legacy_inflector')->defaultTrue()->info('Keep doctrine/inflector instead of symfony/string to generate plurals for routes.')->end()
                 ->arrayNode('collection')
                     ->addDefaultsIfNotSet()
                     ->children()

src/Util/Inflector.php

@@ -13,19 +13,17 @@
 
 namespace ApiPlatform\Util;
 
-use Doctrine\Inflector\Inflector as InflectorObject;
+use Doctrine\Inflector\Inflector as LegacyInflector;
 use Doctrine\Inflector\InflectorFactory;
 
 /**
- * Facade for Doctrine Inflector.
- *
  * @internal
  */
 final class Inflector
 {
-    private static ?InflectorObject $instance = null;
+    private static ?LegacyInflector $instance = null;
 
-    private static function getInstance(): InflectorObject
+    private static function getInstance(): LegacyInflector
     {
         return self::$instance
             ?? self::$instance = InflectorFactory::create()->build();