Merge pull request #98 from dunglas/plural

Use singular for adders and removers (Symfony PropertyAccess compat)

Author: dunglas

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 2.0
 
 * Generated classes include scalar typehints and return type
+* New options to generate autoincremented IDs, UUIDs, custom IDs or to not generate IDs at all (DTO)
 * Nullable typehints are generated instead of a default `null` value
 * Add new `readable` and `writable` options to fields to skip getter or mutator generation.
 * A fluent interface isn't generated anymore by default unless you set the `fluentMutatorMethods` config flag to `true`
@@ -13,6 +14,8 @@
 * The annotation generator for API Platform v1 has been dropped. Only API Platform v2 is now supported.
 * Parent class is not generated by default anymore (using inheritance for entity is discouraged)
 * `SerializerGroupsAnnotationGenerator` is enabled by default
+* The property name is pluralized for `to-many` relations and singularized for `to-one` relations
+* Adder and remover methods are always singularized to be compatible with the Symfony Property Accessor
 * The code has been modernized to use PHP 7 and 7.1's new features (typehints, strict types), PHP 7.1 is now a requirement
 * PHP CS Fixer has ben upgraded to its version 2
 

composer.json

@@ -19,6 +19,7 @@
     },
     "require": {
         "php": ">=7.1",
+        "doctrine/inflector": "^1.0",
         "easyrdf/easyrdf": "^0.9",
         "ext-json": "*",
         "friendsofphp/php-cs-fixer": "^2.4",

src/AnnotationGenerator/PhpDocAnnotationGenerator.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\SchemaGenerator\AnnotationGenerator;
 
+use Doctrine\Common\Util\Inflector;
 use League\HTMLToMarkdown\HtmlConverter;
 use Psr\Log\LoggerInterface;
 
@@ -106,7 +107,9 @@ public function generateSetterAnnotations(string $className, string $fieldName):
             return [];
         }
 
-        return [sprintf('@param  %s $%s', $this->toPhpDocType($this->classes[$className]['fields'][$fieldName]), $fieldName)];
+        $field = $this->classes[$className]['fields'][$fieldName];
+
+        return [sprintf('@param %s $%s', $this->toPhpDocType($this->classes[$className]['fields'][$fieldName]), $field['name'])];
     }
 
     /**
@@ -118,7 +121,7 @@ public function generateAdderAnnotations(string $className, string $fieldName):
             return [];
         }
 
-        return [sprintf('@param  %s $%s', $this->toPhpType($this->classes[$className]['fields'][$fieldName], true), $fieldName)];
+        return [sprintf('@param %s $%s', $this->toPhpType($this->classes[$className]['fields'][$fieldName], true), Inflector::singularize($fieldName))];
     }
 
     /**
@@ -130,7 +133,7 @@ public function generateRemoverAnnotations(string $className, string $fieldName)
             return [];
         }
 
-        return [sprintf('@param  %s $%s', $this->toPhpType($this->classes[$className]['fields'][$fieldName], true), $fieldName)];
+        return [sprintf('@param  %s $%s', $this->toPhpType($this->classes[$className]['fields'][$fieldName], true), Inflector::singularize($fieldName))];
     }
 
     private function isDocUseful(string $className, string $fieldName, $adderOrRemover = false): bool

src/AnnotationGenerator/SerializerGroupsAnnotationGenerator.php

@@ -19,6 +19,7 @@
  * Symfony Serializer Groups annotation generator.
  *
  * @author Youssef El Montaser <[email protected]>
+ * @author Kévin Dunglas <[email protected]>
  *
  * @see https://symfony.com/doc/master/components/serializer.html
  */
@@ -29,15 +30,15 @@ final class SerializerGroupsAnnotationGenerator extends AbstractAnnotationGenera
      */
     public function generateFieldAnnotations(string $className, string $fieldName): array
     {
-        $annotations = [];
-
-        $properties = $this->config['types'][$className]['properties'];
+        if (null === $field = $this->config['types'][$className]['properties'] ?? null) {
+            return [];
+        }
 
-        if (false === $this->classes[$className]['fields'][$fieldName]['isId'] && $groups = $properties[$fieldName]['groups'] ?? false) {
-            $annotations[] = sprintf('@Groups({"%s"})', implode('","', $groups));
+        if (false === $this->classes[$className]['fields'][$fieldName]['isId'] && $groups = $field[$fieldName]['groups'] ?? false) {
+            return [sprintf('@Groups({"%s"})', implode('", "', $groups))];
         }
 
-        return $annotations;
+        return [];
     }
 
     /**

src/Command/GenerateTypesCommand.php

@@ -17,6 +17,7 @@
 use ApiPlatform\SchemaGenerator\GoodRelationsBridge;
 use ApiPlatform\SchemaGenerator\TypesGenerator;
 use ApiPlatform\SchemaGenerator\TypesGeneratorConfiguration;
+use Doctrine\Common\Util\Inflector;
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -86,10 +87,11 @@ protected function execute(InputInterface $input, OutputInterface $output): void
         $goodRelationsBridge = new GoodRelationsBridge($relations);
         $cardinalitiesExtractor = new CardinalitiesExtractor($graphs, $goodRelationsBridge);
 
-        $ucfirstFilter = new \Twig_SimpleFilter('ucfirst', 'ucfirst');
         $loader = new \Twig_Loader_Filesystem(__DIR__.'/../../templates/');
         $twig = new \Twig_Environment($loader, ['autoescape' => false, 'debug' => $processedConfiguration['debug']]);
-        $twig->addFilter($ucfirstFilter);
+        $twig->addFilter(new \Twig_SimpleFilter('ucfirst', 'ucfirst'));
+        $twig->addFilter(new \Twig_SimpleFilter('pluralize', [Inflector::class, 'pluralize']));
+        $twig->addFilter(new \Twig_SimpleFilter('singularize', [Inflector::class, 'singularize']));
 
         if ($processedConfiguration['debug']) {
             $twig->addExtension(new \Twig_Extension_Debug());

src/TypesGenerator.php

@@ -16,6 +16,7 @@
 use ApiPlatform\SchemaGenerator\AnnotationGenerator\AnnotationGeneratorInterface;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Util\Inflector;
 use MyCLabs\Enum\Enum;
 use PhpCsFixer\Cache\NullCacheManager;
 use PhpCsFixer\Differ\NullDiffer;
@@ -647,7 +648,7 @@ private function generateField(array $config, array $class, \EasyRdf_Resource $t
             }
 
             $class['fields'][$propertyName] = [
-                'name' => $propertyName,
+                'name' => $isArray ? Inflector::pluralize($propertyName) : Inflector::singularize($propertyName),
                 'resource' => $property,
                 'range' => $ranges[0],
                 'cardinality' => $cardinality,

templates/class.php.twig

@@ -6,8 +6,8 @@
  #}
 <?php
 
-{% if config.header %}{{ config.header }}{% endif %}
-
+{% if config.header %}{{ config.header }}
+{% endif %}
 declare(strict_types=1);
 
 namespace {{ class.namespace }};
@@ -68,9 +68,9 @@ use {{ use }};
      * {{ annotation }}
 {% endfor %}
      */
-    public function add{{ field.name|ucfirst }}({% if field.typeHint and not field.isEnum %}{{ field.adderRemoverTypeHint }} {% endif %}${{ field.name }}): {% if config.fluentMutatorMethods %}self{% else %}void{% endif %}
+    public function add{{ field.name|singularize|ucfirst }}({% if field.typeHint and not field.isEnum %}{{ field.adderRemoverTypeHint }} {% endif %}${{ field.name|singularize }}): {% if config.fluentMutatorMethods %}self{% else %}void{% endif %}
     {
-        $this->{{ field.name }}[] = {% if field.isEnum %}(string) {% endif %}${{ field.name }};
+        $this->{{ field.name }}[] = {% if field.isEnum %}(string) {% endif %}${{ field.name|singularize }};
 {% if config.fluentMutatorMethods %}
 
         return $this;
@@ -82,12 +82,12 @@ use {{ use }};
      * {{ annotation }}
 {% endfor %}
      */
-    public function remove{{ field.name|ucfirst }}({% if field.typeHint %}{{ field.adderRemoverTypeHint }} {% endif %}${{ field.name }}): {% if config.fluentMutatorMethods %}self{% else %}void{% endif %}
+    public function remove{{ field.name|singularize|ucfirst }}({% if field.typeHint %}{{ field.adderRemoverTypeHint }} {% endif %}${{ field.name|singularize }}): {% if config.fluentMutatorMethods %}self{% else %}void{% endif %}
     {
 {% if config.doctrine.useCollection and field.isArray and field.typeHint and not field.isEnum %}
-        $this->{{ field.name }}->removeElement({% if field.isEnum %}(string) {% endif %}${{ field.name }});
+        $this->{{ field.name }}->removeElement({% if field.isEnum %}(string) {% endif %}${{ field.name|singularize }});
 {% else %}
-        $key = array_search({% if field.isEnum %}(string) {% endif %}${{ field.name }}, $this->{{ field.name }}, true);
+        $key = array_search({% if field.isEnum %}(string) {% endif %}${{ field.name|singularize }}, $this->{{ field.name }}, true);
         if (false !== $key) {
             unset($this->{{ field.name }}[$key]);
         }

templates/interface.php.twig

@@ -6,8 +6,8 @@
  #}
 <?php
 
-{% if config.header %}{{ config.header }}{% endif %}
-
+{% if config.header %}{{ config.header }}
+{% endif %}
 declare(strict_types=1);
 
 namespace {{ class.interfaceNamespace }};

tests/Command/GenerateTypesCommandTest.php

@@ -98,16 +98,16 @@ public function setUrl(?string $url): self
         , $person);
 
         $this->assertContains(<<<'PHP'
-    public function addFriends(Person $friends): self
+    public function addFriend(Person $friend): self
     {
-        $this->friends[] = $friends;
+        $this->friends[] = $friend;
 
         return $this;
     }
 
-    public function removeFriends(Person $friends): self
+    public function removeFriend(Person $friend): self
     {
-        $this->friends->removeElement($friends);
+        $this->friends->removeElement($friend);
 
         return $this;
     }
@@ -148,8 +148,8 @@ public function testReadableWritable()
         $this->assertContains('public function getName(', $person);
         $this->assertNotContains('function setName(', $person);
         $this->assertContains('public function getFriends(', $person);
-        $this->assertNotContains('function addFriends(', $person);
-        $this->assertNotContains('function removeFriends(', $person);
+        $this->assertNotContains('function addFriend(', $person);
+        $this->assertNotContains('function removeFriend(', $person);
     }
 
     public function testGeneratedId()