feat: add resolveTypes and allTypes parameters (#374)

The allTypes parameter can be set on a specific vocabulary to generate
all its types on top of the explicit types you have provided.
If the allTypes parameter is enabled globally, you can also use it to
disable it on a specific vocabulary (but you can explicitly define
types for this vocabulary).
If resolveTypes is enabled, if a type is present in a vocabulary but not
explicitly imported or if the vocabulary is not totally imported
(allTypes), it will be generated.

Author: alanpoulain

composer.json

@@ -59,7 +59,8 @@
         "symfony/serializer": "^5.2 || ^6.0",
         "symfony/validator": "^5.2 || ^6.0",
         "phpspec/prophecy-phpunit": "^2.0",
-        "phpstan/phpstan": "^1.2.0"
+        "phpstan/phpstan": "^1.2.0",
+        "symfony/finder": "^5.2 || ^6.0"
     },
     "bin": [
         "bin/schema"

composer.lock

@@ -41,7 +41,7 @@ parameters:
         '''
         Configuration: '''
             array{
-                 vocabularies: array{uri: string, format: string}[],
+                 vocabularies: array{uri: string, format: string, allTypes: ?boolean}[],
                  vocabularyNamespace: string,
                  relations: string[],
                  debug: boolean,
@@ -58,6 +58,7 @@ parameters:
                  fluentMutatorMethods: boolean,
                  rangeMapping: array<string, string>,
                  allTypes: boolean,
+                 resolveTypes: boolean,
                  types: array<string, TypeConfiguration>,
                  annotationGenerators: class-string<ApiPlatform\SchemaGenerator\AnnotationGenerator\AnnotationGeneratorInterface>[],
                  attributeGenerators: class-string<ApiPlatform\SchemaGenerator\AttributeGenerator\AttributeGeneratorInterface>[],

phpstan.neon

@@ -32,31 +32,25 @@ class CardinalitiesExtractor
     public const CARDINALITY_N_N = '(*..*)';
     public const CARDINALITY_UNKNOWN = 'unknown';
 
-    /**
-     * @var RdfGraph[]
-     */
-    private array $graphs;
     private GoodRelationsBridge $goodRelationsBridge;
 
-    /**
-     * @param RdfGraph[] $graphs
-     */
-    public function __construct(array $graphs, GoodRelationsBridge $goodRelationsBridge)
+    public function __construct(GoodRelationsBridge $goodRelationsBridge)
     {
-        $this->graphs = $graphs;
         $this->goodRelationsBridge = $goodRelationsBridge;
     }
 
     /**
      * Extracts cardinality of properties.
      *
+     * @param RdfGraph[] $graphs
+     *
      * @return array<string, string>
      */
-    public function extract(): array
+    public function extract(array $graphs): array
     {
         $properties = [];
 
-        foreach ($this->graphs as $graph) {
+        foreach ($graphs as $graph) {
             foreach (TypesGenerator::$propertyTypes as $propertyType) {
                 /** @var RdfResource $property */
                 foreach ($graph->allOfType($propertyType) as $property) {

src/CardinalitiesExtractor.php

@@ -39,7 +39,10 @@ public function __construct(array $classes, array $annotationGenerators, array $
         $this->typesToGenerate = $typesToGenerate;
     }
 
-    public function __invoke(Class_ $class): void
+    /**
+     * @param array{} $context
+     */
+    public function __invoke(Class_ $class, array $context): void
     {
         $this->generateClassUses($class);
         $this->generateClassAnnotations($class);

src/ClassMutator/AnnotationsAppender.php

@@ -34,7 +34,10 @@ public function __construct(array $classes, array $attributeGenerators)
         $this->classes = $classes;
     }
 
-    public function __invoke(Class_ $class): void
+    /**
+     * @param array{} $context
+     */
+    public function __invoke(Class_ $class, array $context): void
     {
         $this->generateClassUses($class);
         $this->generateClassAttributes($class);

src/ClassMutator/AttributeAppender.php

@@ -31,7 +31,10 @@ public function __construct(IdPropertyGeneratorInterface $idPropertyGenerator, a
         $this->config = $config;
     }
 
-    public function __invoke(Class_ $class): void
+    /**
+     * @param array{} $context
+     */
+    public function __invoke(Class_ $class, array $context): void
     {
         if (
             $class->isEnum()

src/ClassMutator/ClassIdAppender.php

@@ -25,7 +25,10 @@ public function __construct(string $desiredNamespace)
         $this->desiredNamespace = $desiredNamespace;
     }
 
-    public function __invoke(Class_ $class): void
+    /**
+     * @param array{} $context
+     */
+    public function __invoke(Class_ $class, array $context): void
     {
         $class->interface = new Interface_(sprintf('%sInterface', $class->name()), $this->desiredNamespace);
     }

src/ClassMutator/ClassInterfaceMutator.php

@@ -17,5 +17,6 @@
 
 interface ClassMutatorInterface
 {
-    public function __invoke(Class_ $class): void;
+    // @phpstan-ignore-next-line
+    public function __invoke(Class_ $class, array $context): void;
 }

src/ClassMutator/ClassMutatorInterface.php

@@ -36,7 +36,10 @@ public function __construct(array $config, PhpTypeConverterInterface $phpTypeCon
         $this->config = $config;
     }
 
-    public function __invoke(Class_ $class): void
+    /**
+     * @param array{} $context
+     */
+    public function __invoke(Class_ $class, array $context): void
     {
         if (!$class instanceof SchemaClass) {
             return;
@@ -47,7 +50,7 @@ public function __invoke(Class_ $class): void
 
         if (null === $class->parent() && $subclassOf = $class->getSubClassOf()) {
             if (\count($subclassOf) > 1) {
-                $this->logger ? $this->logger->warning(sprintf('The type "%s" has several supertypes. Using the first one.', $class->rdfType())) : null;
+                $this->logger ? $this->logger->info(sprintf('The type "%s" has several supertypes. Using the first one.', $class->rdfType())) : null;
             }
 
             $class->withParent($this->phpTypeConverter->escapeIdentifier($subclassOf[0]->localName()));