ID support. Classic const doc support. Various fixes and enhancements.

dunglas · dunglas · commit 9c4c2f7be780 · 2014-12-06T20:12:21.000+01:00
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ vocables.
 ## Features
 
 * [PSR](http://www.php-fig.org/) compliant entity generator including properties, getters and setters
-* Full [PSR-5](https://github.com/php-fig/fig-standards/pull/169) compliant PHPDoc for classes, properties, constants (enum
+* Full PHPDoc ([PSR-5](https://github.com/php-fig/fig-standards/pull/169) compliant) for classes, properties, constants (enum
 values) and methods extracted from Schema.org
 * Doctrine annotation mapping (database columns and relations)
 * Data validation through [Symfony Validator](http://symfony.com/doc/current/book/validation.html) annotations
@@ -58,10 +58,13 @@ relations:
 # Debug mode
 debug:                false
 
+# Automatically add an id field to entities
+generateId:           true
+
 # Generate interfaces and use Doctrine's Resolve Target Entity feature
 useInterface:         false
 
-# Use PSR-5's @type annotation instead of @var in the PHPDoc.
+# Use PSR-5's @type annotation instead of @var in the PHPDoc
 useType:              false
 
 # Use Doctrine's ArrayCollection instead of standard arrays
diff --git a/src/SchemaOrgModel/AnnotationGenerator/ConstraintAnnotationGenerator.php b/src/SchemaOrgModel/AnnotationGenerator/ConstraintAnnotationGenerator.php
@@ -9,6 +9,8 @@
 
 namespace SchemaOrgModel\AnnotationGenerator;
 
+use SchemaOrgModel\CardinalitiesExtractor;
+
 /**
  * Constraint annotation generator.
  *
@@ -23,34 +25,47 @@ public function generateFieldAnnotations($className, $fieldName)
     {
         $field = $this->classes[$className]['fields'][$fieldName];
 
-        if ($field['isEnum']) {
+        if ($field['isId']) {
             return [];
         }
 
-        switch ($field['range']) {
-            case 'URL':
-                return ['@Assert\Url'];
+        $asserts = [];
+        if (!$field['isArray']) {
+            switch ($field['range']) {
+                case 'URL':
+                    $asserts[] = '@Assert\Url';
+                    break;
 
-            case 'Date':
-                return ['@Assert\Date'];
+                case 'Date':
+                    $asserts[] = '@Assert\Date';
+                    break;
 
-            case 'DateTime':
-                return ['@Assert\DateTime'];
+                case 'DateTime':
+                    $asserts[] = '@Assert\DateTime';
+                    break;
 
-            case 'Time':
-                return ['@Assert\Time'];
-        }
+                case 'Time':
+                    $asserts[] = '@Assert\Time';
+                    break;
+            }
+
+            if (isset($field['resource']) && 'email' === $field['resource']->localName()) {
+                $asserts[] = '@Assert\Email';
+            }
 
-        if ('email' === $field['resource']->localName()) {
-            return ['@Assert\Email'];
+            if (!$asserts) {
+                $phpType = $this->toPhpType($field);
+                if (in_array($phpType, ['boolean', 'float', 'integer', 'string'])) {
+                    $asserts[] = sprintf('@Assert\Type(type="%s")', $phpType);
+                }
+            }
         }
 
-        $phpType = $this->toPhpType($field);
-        if (in_array($phpType, ['boolean', 'float', 'integer', 'string'])) {
-            return [sprintf('@Assert\Type(type="%s")', $phpType)];
+        if (CardinalitiesExtractor::CARDINALITY_1_1 === $field['cardinality'] || CardinalitiesExtractor::CARDINALITY_1_N === $field['cardinality']) {
+            $asserts[] = '@Assert\NotNull';
         }
 
-        return [];
+        return $asserts;
     }
 
     /**
diff --git a/src/SchemaOrgModel/AnnotationGenerator/DoctrineOrmAnnotationGenerator.php b/src/SchemaOrgModel/AnnotationGenerator/DoctrineOrmAnnotationGenerator.php
@@ -140,6 +140,11 @@ public function generateFieldAnnotations($className, $fieldName)
             }
         }
 
+        if ($field['isId']) {
+            $annotations[] = '@ORM\Id';
+            $annotations[] = '@ORM\GeneratedValue(strategy="AUTO")';
+        }
+
         return $annotations;
     }
 
diff --git a/src/SchemaOrgModel/AnnotationGenerator/PhpDocAnnotationGenerator.php b/src/SchemaOrgModel/AnnotationGenerator/PhpDocAnnotationGenerator.php
@@ -42,12 +42,14 @@ public function generateConstantAnnotations($className, $constantName)
         $resource = $this->classes[$className]['constants'][$constantName]['resource'];
 
         $annotations = $this->formatDoc($resource->get('rdfs:comment'), true);
-        $annotations[0] = sprintf(
-            '@type %s %s',
-            'string',
-            $constantName,
-            $annotations[0]
-        );
+        if ($this->config['useType']) {
+            $annotations[0] = sprintf(
+                '@type %s %s',
+                'string',
+                $constantName,
+                $annotations[0]
+            );
+        }
 
         return $annotations;
     }
@@ -58,8 +60,9 @@ public function generateConstantAnnotations($className, $constantName)
     public function generateFieldAnnotations($className, $fieldName)
     {
         $field = $this->classes[$className]['fields'][$fieldName];
+        $comment = $field['resource'] ? $field['resource']->get('rdfs:comment') : '';
 
-        $annotations = $this->formatDoc($field['resource']->get('rdfs:comment'), true);
+        $annotations = $this->formatDoc($comment, true);
         $annotations[0] = sprintf(
             '@%s %s $%s %s',
             $this->config['useType'] ? 'type' : 'var',
diff --git a/src/SchemaOrgModel/TypesGenerator.php b/src/SchemaOrgModel/TypesGenerator.php
@@ -259,6 +259,7 @@ public function generate($config)
                         'cardinality' => $cardinality,
                         'isArray' => $isArray,
                         'isNullable' => $isNullable,
+                        'isId' => false,
                     ];
                     if ($isArray) {
                         $class['hasConstructor'] = true;
@@ -274,13 +275,33 @@ public function generate($config)
         }
 
         // Second pass
-        foreach ($classes as $className => $class) {
+        foreach ($classes as &$class) {
             if ($class['parent'] && isset($classes[$class['parent']])) {
                 $classes[$class['parent']]['hasChild'] = true;
             }
 
-            foreach ($class['fields'] as $fieldName => $field) {
-                $classes[$className]['fields'][$fieldName]['isEnum'] = isset($classes[$field['range']]) && $classes[$field['range']]['isEnum'];
+            foreach ($class['fields'] as &$field) {
+                $field['isEnum'] = isset($classes[$field['range']]) && $classes[$field['range']]['isEnum'];
+            }
+        }
+
+        // Generate ID
+        if ($config['generateId']) {
+            foreach ($classes as &$class) {
+                if (!$class['hasChild'] && !$class['isEnum']) {
+                    $class['fields'] = [
+                        'id' => [
+                            'name' => 'id',
+                            'resource' => null,
+                            'range' => 'Integer',
+                            'cardinality' => CardinalitiesExtractor::CARDINALITY_1_1,
+                            'isArray' => false,
+                            'isNullable' => false,
+                            'isEnum' => false,
+                            'isId' => true,
+                        ],
+                    ] + $class['fields'];
+                }
             }
         }
 
@@ -302,7 +323,7 @@ public function generate($config)
                 $class['constants'][$constantName]['annotations'] = $this->generateConstantAnnotations($annotationGenerators, $className, $constantName);
             }
 
-            foreach ($class['fields'] as $fieldName => $field) {
+            foreach ($class['fields'] as $fieldName => &$field) {
                 $typeHint = false;
                 if ($this->isDateTime($field['range'])) {
                     $typeHint = '\\DateTime';
@@ -314,15 +335,15 @@ public function generate($config)
                     }
                 }
 
-                $class['fields'][$fieldName]['typeHint'] = $typeHint;
-                $class['fields'][$fieldName]['annotations'] = $this->generateFieldAnnotations($annotationGenerators, $className, $fieldName);
-                $class['fields'][$fieldName]['getterAnnotations'] = $this->generateGetterAnnotations($annotationGenerators, $className, $fieldName);
+                $field['typeHint'] = $typeHint;
+                $field['annotations'] = $this->generateFieldAnnotations($annotationGenerators, $className, $fieldName);
+                $field['getterAnnotations'] = $this->generateGetterAnnotations($annotationGenerators, $className, $fieldName);
 
                 if ($field['isArray']) {
-                    $class['fields'][$fieldName]['adderAnnotations'] = $this->generateAdderAnnotations($annotationGenerators, $className, $fieldName);
-                    $class['fields'][$fieldName]['removerAnnotations'] = $this->generateRemoverAnnotations($annotationGenerators, $className, $fieldName);
+                    $field['adderAnnotations'] = $this->generateAdderAnnotations($annotationGenerators, $className, $fieldName);
+                    $field['removerAnnotations'] = $this->generateRemoverAnnotations($annotationGenerators, $className, $fieldName);
                 } else {
-                    $class['fields'][$fieldName]['setterAnnotations'] = $this->generateSetterAnnotations($annotationGenerators, $className, $fieldName);
+                    $field['setterAnnotations'] = $this->generateSetterAnnotations($annotationGenerators, $className, $fieldName);
                 }
             }
 
diff --git a/src/SchemaOrgModel/TypesGeneratorConfiguration.php b/src/SchemaOrgModel/TypesGeneratorConfiguration.php
@@ -46,8 +46,9 @@ public function getConfigTreeBuilder()
                     ->prototype('scalar')->end()
                 ->end()
                 ->booleanNode('debug')->defaultFalse()->info('Debug mode')->end()
+                ->booleanNode('generateId')->defaultTrue()->info('Automatically add an id field to entities')->end()
                 ->booleanNode('useInterface')->defaultFalse()->info('Generate interfaces and use Doctrine\'s Resolve Target Entity feature')->end()
-                ->booleanNode('useType')->defaultFalse()->info('Use PSR-5\'s @type annotation instead of @var in the PHPDoc.')->end()
+                ->booleanNode('useType')->defaultFalse()->info('Use PSR-5\'s @type annotation instead of @var in the PHPDoc')->end()
                 ->booleanNode('useDoctrineCollection')->defaultTrue()->info('Use Doctrine\'s ArrayCollection instead of standard arrays')->end()
                 ->booleanNode('checkIsGoodRelations')->defaultFalse()->info('Emit a warning if a property is not derived from GoodRelations')->end()
                 ->scalarNode('header')->defaultFalse()->info('A license or any text to use as header of generated files')->example('// (c) Kévin Dunglas <dunglas@gmail.com>')->end()

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,11 @@ public function generateFieldAnnotations($className, $fieldName)`
`140`	`140`	`}`
`141`	`141`	`}`
`142`	`142`
	`143`	`+ if ($field['isId']) {`
	`144`	`+ $annotations[] = '@ORM\Id';`
	`145`	`+ $annotations[] = '@ORM\GeneratedValue(strategy="AUTO")';`
	`146`	`+ }`
	`147`	`+`
`143`	`148`	`return $annotations;`
`144`	`149`	`}`
`145`	`150`