feat: add defaultCardinality configuration for relations (#383)

Author: alanpoulain

phpstan.neon

@@ -42,7 +42,7 @@ parameters:
             array{
                  vocabularies: array{uri: string, format: string, allTypes: ?boolean, attributes: array<string, (int|bool|null|string|string[]|string[][]|\Nette\PhpGenerator\Literal)[]|null>}[],
                  vocabularyNamespace: string,
-                 relations: string[],
+                 relations: array{uris: string[], defaultCardinality: string},
                  debug: boolean,
                  apiPlatformOldAttributes: boolean,
                  id: array{generate: boolean, generationStrategy: string, writable: boolean},

src/Schema/Generator.php

@@ -46,7 +46,7 @@ public function generate(array $configuration, OutputInterface $output, SymfonyS
         }
 
         $relations = [];
-        foreach ($configuration['relations'] as $relation) {
+        foreach ($configuration['relations']['uris'] as $relation) {
             $relations[] = new \SimpleXMLElement($relation, 0, true);
         }
 

src/Schema/PropertyGenerator/PropertyGenerator.php

@@ -71,7 +71,7 @@ public function __invoke(string $name, array $config, Class_ $class, array $cont
 
         $cardinality = $propertyConfig['cardinality'] ?? false;
         if (!$cardinality || CardinalitiesExtractor::CARDINALITY_UNKNOWN === $cardinality) {
-            $cardinality = $cardinalities[$propertyUri] ?? CardinalitiesExtractor::CARDINALITY_1_1;
+            $cardinality = $cardinalities[$propertyUri] ?? $config['relations']['defaultCardinality'];
         }
 
         $isArray = \in_array($cardinality, [

src/SchemaGeneratorConfiguration.php

@@ -97,10 +97,17 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->end()
                 ->scalarNode('vocabularyNamespace')->defaultValue(self::SCHEMA_ORG_NAMESPACE)->info('Namespace of the vocabulary to import')->example('http://www.w3.org/ns/activitystreams#')->end()
                 ->arrayNode('relations')
-                    ->info('OWL relation files containing cardinality information in the GoodRelations format')
-                    ->example(self::GOOD_RELATIONS_URI)
-                    ->defaultValue([self::GOOD_RELATIONS_URI])
-                    ->scalarPrototype()->end()
+                    ->addDefaultsIfNotSet()
+                    ->info('Relations configuration')
+                    ->children()
+                        ->arrayNode('uris')
+                            ->info('OWL relation URIs containing cardinality information in the GoodRelations format')
+                            ->example(self::GOOD_RELATIONS_URI)
+                            ->defaultValue([self::GOOD_RELATIONS_URI])
+                            ->scalarPrototype()->end()
+                        ->end()
+                        ->enumNode('defaultCardinality')->defaultValue('(1..1)')->values(['(0..1)', '(0..*)', '(1..1)', '(1..*)', '(*..0)', '(*..1)', '(*..*)'])->info('The default cardinality to use when it cannot be extracted')->end()
+                    ->end()
                 ->end()
                 ->booleanNode('debug')->defaultFalse()->info('Debug mode')->end()
                 ->booleanNode('apiPlatformOldAttributes')->defaultFalse()->info('Use old API Platform attributes (API Platform < 2.7)')->end()

tests/Command/DumpConfigurationTest.php

@@ -52,11 +52,17 @@ public function testDumpConfiguration(): void
     # Namespace of the vocabulary to import
     vocabularyNamespace:  'https://schema.org/' # Example: 'http://www.w3.org/ns/activitystreams#'
 
-    # OWL relation files containing cardinality information in the GoodRelations format
-    relations:            # Example: 'https://archive.org/services/purl/goodrelations/v1.owl'
+    # Relations configuration
+    relations:
 
-        # Default:
-        - https://archive.org/services/purl/goodrelations/v1.owl
+        # OWL relation URIs containing cardinality information in the GoodRelations format
+        uris:                 # Example: 'https://archive.org/services/purl/goodrelations/v1.owl'
+
+            # Default:
+            - https://archive.org/services/purl/goodrelations/v1.owl
+
+        # The default cardinality to use when it cannot be extracted
+        defaultCardinality:   (1..1) # One of "(0..1)"; "(0..*)"; "(1..1)"; "(1..*)"; "(*..0)"; "(*..1)"; "(*..*)"
 
     # Debug mode
     debug:                false