feat: add api(Resource/Property)Arguments to types and vocab (#378)

alanpoulain · web-flow · commit cc3461983b93 · 2022-06-20T16:56:57.000+02:00
diff --git a/phpstan.neon b/phpstan.neon
@@ -10,7 +10,7 @@ parameters:
                 relationTableName: ?string,
                 cardinality: string,
                 ormColumn: array<string, string|string[]>,
-                security: ?string,
+                apiPropertyArguments: array{},
                 groups: string[],
                 mappedBy: ?string,
                 inversedBy: ?string,
@@ -34,14 +34,14 @@ parameters:
                 parent: false|string,
                 guessFrom: string,
                 operations: array<string, array<string, string[]>>,
-                security: ?string,
+                apiResourceArguments: array{},
                 allProperties: boolean,
                 properties: array<string, PropertyConfiguration>
             }
         '''
         Configuration: '''
             array{
-                 vocabularies: array{uri: string, format: string, allTypes: ?boolean}[],
+                 vocabularies: array{uri: string, format: string, allTypes: ?boolean, apiResourceArguments: array{}}[],
                  vocabularyNamespace: string,
                  relations: string[],
                  debug: boolean,
diff --git a/src/AttributeGenerator/ApiPlatformCoreAttributeGenerator.php b/src/AttributeGenerator/ApiPlatformCoreAttributeGenerator.php
@@ -46,8 +46,8 @@ public function generateClassAttributes(Class_ $class): array
         if ($class->rdfType()) {
             $arguments['iri'] = $class->rdfType();
         }
-        if ($class->security) {
-            $arguments['security'] = $class->security;
+        if ($class->apiResourceArguments) {
+            $arguments = array_merge($arguments, $class->apiResourceArguments);
         }
 
         if ($class->operations) {
@@ -98,8 +98,8 @@ public function generatePropertyAttributes(Property $property, string $className
             $arguments['iri'] = $property->rdfType();
         }
 
-        if ($property->security) {
-            $arguments['security'] = $property->security;
+        if ($property->apiPropertyArguments) {
+            $arguments = array_merge($arguments, $property->apiPropertyArguments);
         }
 
         return $property->isCustom ? [] : [new Attribute('ApiProperty', $arguments)];
diff --git a/src/ClassMutator/ClassMutatorInterface.php b/src/ClassMutator/ClassMutatorInterface.php
@@ -17,6 +17,6 @@
 
 interface ClassMutatorInterface
 {
-    // @phpstan-ignore-next-line
+    // @phpstan-ignore-next-line dynamic context
     public function __invoke(Class_ $class, array $context): void;
 }
diff --git a/src/Model/Class_.php b/src/Model/Class_.php
@@ -44,7 +44,8 @@ abstract class Class_
     public bool $isAbstract = false;
     public bool $hasChild = false;
     public bool $isEmbeddable = false;
-    public ?string $security = null;
+    // @phpstan-ignore-next-line dynamic array
+    public array $apiResourceArguments = [];
     /** @var array<string, array<string, string[]|null>> */
     public array $operations = [];
 
diff --git a/src/Model/Property.php b/src/Model/Property.php
@@ -51,7 +51,8 @@ abstract class Property
     public ?string $adderRemoverTypeHint = null;
     /** @var string[] */
     public array $groups = [];
-    public ?string $security = null;
+    // @phpstan-ignore-next-line dynamic array
+    public array $apiPropertyArguments = [];
     /** @var Attribute[] */
     private array $attributes = [];
     /** @var string[] */
diff --git a/src/PropertyGenerator/PropertyGeneratorInterface.php b/src/PropertyGenerator/PropertyGeneratorInterface.php
@@ -21,7 +21,7 @@ interface PropertyGeneratorInterface
     /**
      * @param Configuration $config
      */
-    // @phpstan-ignore-next-line
+    // @phpstan-ignore-next-line dynamic context
     public function __invoke(
         string $name,
         array $config,
diff --git a/src/Schema/Generator.php b/src/Schema/Generator.php
@@ -34,12 +34,12 @@ final class Generator
     public function generate(array $configuration, OutputInterface $output, SymfonyStyle $io): void
     {
         $graphs = [];
-        foreach ($configuration['vocabularies'] as $vocab) {
-            $graph = new RdfGraph($vocab['uri']);
-            if (0 === strpos($vocab['uri'], 'http://') || 0 === strpos($vocab['uri'], 'https://')) {
-                $graph->load($vocab['uri'], $vocab['format']);
+        foreach ($configuration['vocabularies'] as $uri => $vocab) {
+            $graph = new RdfGraph($uri);
+            if (0 === strpos($uri, 'http://') || 0 === strpos($uri, 'https://')) {
+                $graph->load($uri, $vocab['format']);
             } else {
-                $graph->parseFile($vocab['uri'], $vocab['format']);
+                $graph->parseFile($uri, $vocab['format']);
             }
 
             $graphs[] = $graph;
diff --git a/src/Schema/PropertyGenerator/PropertyGenerator.php b/src/Schema/PropertyGenerator/PropertyGenerator.php
@@ -163,7 +163,7 @@ public function __invoke(string $name, array $config, Class_ $class, array $cont
         $schemaProperty->mappedBy = $propertyConfig['mappedBy'] ?? null;
         $schemaProperty->inversedBy = $propertyConfig['inversedBy'] ?? null;
         $schemaProperty->groups = $propertyConfig['groups'] ?? [];
-        $schemaProperty->security = $propertyConfig['security'] ?? null;
+        $schemaProperty->apiPropertyArguments = $propertyConfig['apiPropertyArguments'] ?? [];
 
         return $schemaProperty;
     }
diff --git a/src/SchemaGeneratorConfiguration.php b/src/SchemaGeneratorConfiguration.php
@@ -46,6 +46,15 @@ public function getConfigTreeBuilder(): TreeBuilder
     {
         $namespacePrefix = $this->defaultPrefix ?? 'App\\';
 
+        /* @see https://yaml.org/type/omap.html */
+        $transformOmap = fn (array $nodeConfig) => !empty(array_filter(
+            $nodeConfig,
+            fn ($v, $k) => \is_int($k) && \is_array($v) && 1 === \count($v) && \is_string(array_keys($v)[0]),
+            \ARRAY_FILTER_USE_BOTH
+        ))
+            ? array_reduce(array_values($nodeConfig), fn (array $map, array $v) => $map + $v, [])
+            : $nodeConfig;
+
         $treeBuilder = new TreeBuilder('config');
 
         $treeBuilder
@@ -59,23 +68,25 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->end()
                 ->arrayNode('vocabularies')
                     ->info('RDF vocabularies')
-                    ->defaultValue([['uri' => self::SCHEMA_ORG_URI, 'format' => 'rdfxml']])
+                    ->defaultValue([self::SCHEMA_ORG_URI => ['format' => 'rdfxml']])
                     ->beforeNormalization()
                         ->ifArray()
-                        ->then(static function (array $v) {
-                            return array_map(
-                                static function ($rdf) {
-                                    return \is_scalar($rdf) ? ['uri' => $rdf, 'format' => null] : $rdf;
-                                },
-                                $v
-                            );
-                        })
+                        ->then(fn (array $v) => array_map(fn ($rdf) => \is_scalar($rdf) ? ['uri' => $rdf] : $rdf, $v))
                     ->end()
+                    ->useAttributeAsKey('uri')
                     ->arrayPrototype()
                         ->children()
-                            ->scalarNode('uri')->defaultValue(self::SCHEMA_ORG_URI)->info('RDF vocabulary to use')->example('https://schema.org/version/latest/schemaorg-current-https.rdf')->end()
+                            ->scalarNode('uri')->info('RDF vocabulary to use')->example('https://schema.org/version/latest/schemaorg-current-https.rdf')->end()
                             ->scalarNode('format')->defaultNull()->info('RDF vocabulary format')->example('rdfxml')->end()
                             ->booleanNode('allTypes')->defaultNull()->info('Generate all types for this vocabulary, even if an explicit configuration exists. If allTypes is enabled globally, it can be disabled for this particular vocabulary')->end()
+                            ->arrayNode('apiResourceArguments')
+                                ->info('Arguments to add to ApiResource for all the classes generated for this vocabulary')
+                                ->variablePrototype()->end()
+                                ->beforeNormalization()
+                                    ->ifArray()
+                                    ->then($transformOmap)
+                                ->end()
+                            ->end()
                         ->end()
                     ->end()
                 ->end()
@@ -84,7 +95,7 @@ static function ($rdf) {
                     ->info('OWL relation files containing cardinality information in the GoodRelations format')
                     ->example(self::GOOD_RELATIONS_URI)
                     ->defaultValue([self::GOOD_RELATIONS_URI])
-                    ->prototype('scalar')->end()
+                    ->scalarPrototype()->end()
                 ->end()
                 ->booleanNode('debug')->defaultFalse()->info('Debug mode')->end()
                 ->arrayNode('id')
@@ -119,7 +130,7 @@ static function ($rdf) {
                         ->enumNode('resolveTargetEntityConfigType')->defaultValue('XML')->values(['XML', 'yaml'])->info('The Resolve Target Entity Listener config file type')->end()
                         ->arrayNode('inheritanceAttributes')
                             ->info('Doctrine inheritance attributes (if set, no other attributes are generated)')
-                            ->prototype('variable')->end()
+                            ->variablePrototype()->end()
                         ->end()
                     ->end()
                 ->end()
@@ -136,7 +147,7 @@ static function ($rdf) {
                 ->booleanNode('fluentMutatorMethods')->defaultFalse()->info('Set this flag to true to generate fluent setter, adder and remover methods')->end()
                 ->arrayNode('rangeMapping')
                     ->useAttributeAsKey('name')
-                    ->prototype('scalar')->end()
+                    ->scalarPrototype()->end()
                 ->end()
                 ->booleanNode('allTypes')->defaultFalse()->info('Generate all types, even if an explicit configuration exists')->end()
                 ->booleanNode('resolveTypes')->defaultFalse()->info('If a type is present in a vocabulary but not explicitly imported (types) or if the vocabulary is not totally imported (allTypes), it will be generated')->end()
@@ -172,17 +183,24 @@ static function ($rdf) {
                                 ->children()
                                     ->arrayNode('attributes')
                                         ->info('Doctrine attributes (if set, no other attributes are generated)')
-                                        ->prototype('variable')->end()
+                                        ->variablePrototype()->end()
                                     ->end()
                                 ->end()
                             ->end()
                             ->scalarNode('parent')->defaultFalse()->info('The parent class, set to false for a top level class')->end()
                             ->scalarNode('guessFrom')->defaultValue('Thing')->info('If declaring a custom class, this will be the class from which properties type will be guessed')->end()
                             ->arrayNode('operations')
                                 ->info('Operations for the class')
-                                ->prototype('variable')->end()
+                                ->variablePrototype()->end()
+                            ->end()
+                            ->arrayNode('apiResourceArguments')
+                                ->info('Arguments to add to ApiResource (for instance security)')
+                                ->variablePrototype()->end()
+                                ->beforeNormalization()
+                                    ->ifArray()
+                                    ->then($transformOmap)
+                                ->end()
                             ->end()
-                            ->scalarNode('security')->defaultNull()->info('Security directive for the class')->end()
                             ->booleanNode('allProperties')->defaultFalse()->info('Import all existing properties')->end()
                             ->arrayNode('properties')
                                 ->info('Properties of this type to use')
@@ -206,12 +224,19 @@ static function ($rdf) {
                                         ->arrayNode('ormColumn')
                                             ->info('The doctrine column attribute content')
                                             ->example('{type: "decimal", precision: 5, scale: 1, options: {comment: "my comment"}}')
-                                            ->prototype('variable')->end()
+                                            ->variablePrototype()->end()
+                                        ->end()
+                                        ->arrayNode('apiPropertyArguments')
+                                            ->info('Arguments to add to ApiProperty (for instance security)')
+                                            ->variablePrototype()->end()
+                                            ->beforeNormalization()
+                                                ->ifArray()
+                                                ->then($transformOmap)
+                                            ->end()
                                         ->end()
-                                        ->scalarNode('security')->defaultNull()->info('Security directive for the property')->end()
                                         ->arrayNode('groups')
                                             ->info('Symfony Serialization Groups')
-                                            ->prototype('scalar')->end()
+                                            ->scalarPrototype()->end()
                                         ->end()
                                         ->scalarNode('mappedBy')->defaultNull()->info('The doctrine mapped by attribute')->example('partOfSeason')->end()
                                         ->scalarNode('inversedBy')->defaultNull()->info('The doctrine inversed by attribute')->example('episodes')->end()
@@ -233,7 +258,7 @@ static function ($rdf) {
                     ->defaultValue([
                         PhpDocAnnotationGenerator::class,
                     ])
-                    ->prototype('scalar')->end()
+                    ->scalarPrototype()->end()
                 ->end()
                 ->arrayNode('attributeGenerators')
                     ->info('Attribute generators to use')
@@ -243,11 +268,11 @@ static function ($rdf) {
                         ConstraintAttributeGenerator::class,
                         SerializerGroupsAttributeGenerator::class,
                     ])
-                    ->prototype('scalar')->end()
+                    ->scalarPrototype()->end()
                 ->end()
                 ->arrayNode('generatorTemplates')
                     ->info('Directories for custom generator twig templates')
-                    ->prototype('scalar')->end()
+                    ->scalarPrototype()->end()
                 ->end()
             ->end();
 
diff --git a/src/TypesGenerator.php b/src/TypesGenerator.php
@@ -245,10 +245,11 @@ private function buildClass(array $graphs, array $cardinalities, string $typeNam
         }
 
         $typeConfig = $config['types'][$typeName] ?? null;
+        $vocabConfig = $config['vocabularies'][$type->getGraph()->getUri()] ?? null;
         $parent = $typeConfig['parent'] ?? null;
         $class = new SchemaClass($typeName, $type, $parent);
         $class->operations = $typeConfig['operations'] ?? [];
-        $class->security = $typeConfig['security'] ?? null;
+        $class->apiResourceArguments = array_merge($vocabConfig['apiResourceArguments'] ?? [], $typeConfig['apiResourceArguments'] ?? []);
 
         if ($class->isEnum()) {
             (new SchemaEnumClassMutator(
@@ -430,13 +431,7 @@ private function defineTypesToGenerate(array $graphs, array $config): array
         $allTypes = [];
 
         foreach ($graphs as $graph) {
-            $vocabAllTypes = $config['allTypes'];
-            foreach ($config['vocabularies'] as $vocab) {
-                if ($graph->getUri() !== $vocab['uri']) {
-                    continue;
-                }
-                $vocabAllTypes = $vocab['allTypes'] ?? $vocabAllTypes;
-            }
+            $vocabAllTypes = $config['vocabularies'][$graph->getUri()]['allTypes'] ?? $config['allTypes'];
             foreach (self::$classTypes as $classType) {
                 foreach ($graph->allOfType($classType) as $type) {
                     if ($type->isBNode()) {
diff --git a/tests/AttributeGenerator/ApiPlatformCoreAttributeGeneratorTest.php b/tests/AttributeGenerator/ApiPlatformCoreAttributeGeneratorTest.php
@@ -74,9 +74,9 @@ public function provideGenerateClassAttributesCases(): \Generator
 
         yield 'with short name' => [(new SchemaClass('WithShortName', new RdfResource('https://schema.org/DifferentLocalName', new RdfGraph()))), [new Attribute('ApiResource', ['shortName' => 'DifferentLocalName', 'iri' => 'https://schema.org/DifferentLocalName'])]];
 
-        $class = new SchemaClass('WithSecurity', new RdfResource('https://schema.org/WithSecurity', new RdfGraph()));
-        $class->security = "is_granted('ROLE_USER')";
-        yield 'with security' => [$class, [new Attribute('ApiResource', ['iri' => 'https://schema.org/WithSecurity', 'security' => "is_granted('ROLE_USER')"])]];
+        $class = new SchemaClass('WithApiResourceArguments', new RdfResource('https://schema.org/WithApiResourceArguments', new RdfGraph()));
+        $class->apiResourceArguments = ['security' => "is_granted('ROLE_USER')"];
+        yield 'with ApiResource arguments' => [$class, [new Attribute('ApiResource', ['iri' => 'https://schema.org/WithApiResourceArguments', 'security' => "is_granted('ROLE_USER')"])]];
     }
 
     /**
@@ -93,10 +93,10 @@ public function provideGeneratePropertyAttributesCases(): \Generator
         $property->resource = new RdfResource('https://schema.org/prop');
         yield 'classical' => [$property, [new Attribute('ApiProperty', ['iri' => 'https://schema.org/prop'])]];
 
-        $property = new Property('WithSecurity');
-        $property->resource = new RdfResource('https://schema.org/WithSecurity');
-        $property->security = "is_granted('ROLE_ADMIN')";
-        yield 'with security' => [$property, [new Attribute('ApiProperty', ['iri' => 'https://schema.org/WithSecurity', 'security' => "is_granted('ROLE_ADMIN')"])]];
+        $property = new Property('WithApiPropertyArguments');
+        $property->resource = new RdfResource('https://schema.org/WithApiPropertyArguments');
+        $property->apiPropertyArguments = ['security' => "is_granted('ROLE_ADMIN')"];
+        yield 'with ApiProperty arguments' => [$property, [new Attribute('ApiProperty', ['iri' => 'https://schema.org/WithApiPropertyArguments', 'security' => "is_granted('ROLE_ADMIN')"])]];
     }
 
     public function testGenerateCustomPropertyAttributes(): void
diff --git a/tests/Command/DumpConfigurationTest.php b/tests/Command/DumpConfigurationTest.php
@@ -35,17 +35,20 @@ public function testDumpConfiguration(): void
     vocabularies:
 
         # Prototype
-        -
+        uri:
 
             # RDF vocabulary to use
-            uri:                  'https://schema.org/version/latest/schemaorg-current-https.rdf' # Example: 'https://schema.org/version/latest/schemaorg-current-https.rdf'
+            uri:                  ~ # Example: 'https://schema.org/version/latest/schemaorg-current-https.rdf'
 
             # RDF vocabulary format
             format:               null # Example: rdfxml
 
             # Generate all types for this vocabulary, even if an explicit configuration exists. If allTypes is enabled globally, it can be disabled for this particular vocabulary
             allTypes:             null
 
+            # Arguments to add to ApiResource for all the classes generated for this vocabulary
+            apiResourceArguments: []
+
     # Namespace of the vocabulary to import
     vocabularyNamespace:  'https://schema.org/' # Example: 'http://www.w3.org/ns/activitystreams#'
 
@@ -180,8 +183,8 @@ interface:            null
             # Operations for the class
             operations:           []
 
-            # Security directive for the class
-            security:             null
+            # Arguments to add to ApiResource (for instance security)
+            apiResourceArguments: []
 
             # Import all existing properties
             allProperties:        false
@@ -205,8 +208,8 @@ interface:            null
                     # The doctrine column attribute content
                     ormColumn:            [] # Example: '{type: "decimal", precision: 5, scale: 1, options: {comment: "my comment"}}'
 
-                    # Security directive for the property
-                    security:             null
+                    # Arguments to add to ApiProperty (for instance security)
+                    apiPropertyArguments: []
 
                     # Symfony Serialization Groups
                     groups:               []
diff --git a/tests/Command/GenerateCommandTest.php b/tests/Command/GenerateCommandTest.php
diff --git a/tests/config/activity-streams.yaml b/tests/config/activity-streams.yaml
diff --git a/tests/e2e/schema.yml b/tests/e2e/schema.yml

Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,8 @@ public function generateClassAttributes(Class_ $class): array`
`46`	`46`	`if ($class->rdfType()) {`
`47`	`47`	`$arguments['iri'] = $class->rdfType();`
`48`	`48`	`}`
`49`		`- if ($class->security) {`
`50`		`- $arguments['security'] = $class->security;`
	`49`	`+ if ($class->apiResourceArguments) {`
	`50`	`+ $arguments = array_merge($arguments, $class->apiResourceArguments);`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`if ($class->operations) {`
`@@ -98,8 +98,8 @@ public function generatePropertyAttributes(Property $property, string $className`
`98`	`98`	`$arguments['iri'] = $property->rdfType();`
`99`	`99`	`}`
`100`	`100`
`101`		`- if ($property->security) {`
`102`		`- $arguments['security'] = $property->security;`
	`101`	`+ if ($property->apiPropertyArguments) {`
	`102`	`+ $arguments = array_merge($arguments, $property->apiPropertyArguments);`
`103`	`103`	`}`
`104`	`104`
`105`	`105`	`return $property->isCustom ? [] : [new Attribute('ApiProperty', $arguments)];`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,6 @@`
`17`	`17`
`18`	`18`	`interface ClassMutatorInterface`
`19`	`19`	`{`
`20`		`- // @phpstan-ignore-next-line`
	`20`	`+ // @phpstan-ignore-next-line dynamic context`
`21`	`21`	`public function __invoke(Class_ $class, array $context): void;`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -163,7 +163,7 @@ public function __invoke(string $name, array $config, Class_ $class, array $cont`
`163`	`163`	`$schemaProperty->mappedBy = $propertyConfig['mappedBy'] ?? null;`
`164`	`164`	`$schemaProperty->inversedBy = $propertyConfig['inversedBy'] ?? null;`
`165`	`165`	`$schemaProperty->groups = $propertyConfig['groups'] ?? [];`
`166`		`- $schemaProperty->security = $propertyConfig['security'] ?? null;`
	`166`	`+ $schemaProperty->apiPropertyArguments = $propertyConfig['apiPropertyArguments'] ?? [];`
`167`	`167`
`168`	`168`	`return $schemaProperty;`
`169`	`169`	`}`