Merge pull request #134 from php-api-clients/introduce-internal-configuration-objects

Introduce internal configuration objects

Author: WyriHaximus

bin/openapi-client-generator.source

@@ -1,7 +1,9 @@
 #!/usr/bin/php
 <?php declare(strict_types=1);
 
+use ApiClients\Tools\OpenApiClientGenerator\Configuration;
 use ApiClients\Tools\OpenApiClientGenerator\Generator;
+use EventSauce\ObjectHydrator\ObjectMapperUsingReflection;
 use Symfony\Component\Yaml\Yaml;
 
 (function(): void {
@@ -15,9 +17,9 @@ use Symfony\Component\Yaml\Yaml;
     /**
      * Create and boot up the application
      */
-    exit((function (string $configuration): int {
-        $yaml = Yaml::parseFile($configuration);
-        (new Generator($yaml['spec']))->generate($yaml['namespace'] . '\\', dirname($configuration) . DIRECTORY_SEPARATOR . $yaml['destination'], $yaml['schemas'] ?? [], $yaml['voter'] ?? []);
+    exit((function (string $configurationFile): int {
+        $configuration = (new ObjectMapperUsingReflection())->hydrateObject(Configuration::class, Yaml::parseFile($configurationFile));
+        (new Generator($configuration->spec))->generate($configuration->namespace . '\\', dirname($configurationFile) . DIRECTORY_SEPARATOR . $configuration->destination, $configuration);
 
         return 0;
     })($configuration));

src/Configuration.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace ApiClients\Tools\OpenApiClientGenerator;
+
+use ApiClients\Tools\OpenApiClientGenerator\Configuration\Voter;
+use ApiClients\Tools\OpenApiClientGenerator\Configuration\Schemas;
+
+final readonly class Configuration
+{
+    public function __construct(
+        public string $spec,
+        public string $namespace,
+        public string $destination,
+        public ?Schemas $schemas,
+        public ?Voter $voter,
+    ) {
+    }
+}

src/Configuration/Schemas.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace ApiClients\Tools\OpenApiClientGenerator\Configuration;
+
+use EventSauce\ObjectHydrator\MapFrom;
+
+final readonly class Schemas
+{
+    public function __construct(
+        #[MapFrom('allowDuplication')]
+        public bool $allowDuplication,
+    ) {
+    }
+}

src/Configuration/Voter.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace ApiClients\Tools\OpenApiClientGenerator\Configuration;
+
+use ApiClients\Tools\OpenApiClientGenerator\Contract\Voter as VoterContract;
+use EventSauce\ObjectHydrator\MapFrom;
+
+final readonly class Voter
+{
+    /**
+     * @param array<class-string<VoterContract\ListOperation>>|null $listOperation
+     * @param array<class-string<VoterContract\StreamOperation>>|null $streamOperation
+     */
+    public function __construct(
+        #[MapFrom('listOperation')]
+        public ?array $listOperation,
+        #[MapFrom('streamOperation')]
+        public ?array $streamOperation,
+    ) {
+    }
+}

src/Gatherer/Path.php

@@ -2,22 +2,19 @@
 
 namespace ApiClients\Tools\OpenApiClientGenerator\Gatherer;
 
-use ApiClients\Tools\OpenApiClientGenerator\Contract\Voter\StreamOperation;
+use ApiClients\Tools\OpenApiClientGenerator\Configuration\Voter;
 use ApiClients\Tools\OpenApiClientGenerator\Utils;
 use ApiClients\Tools\OpenApiClientGenerator\Registry\Schema as SchemaRegistry;
 use cebe\openapi\spec\PathItem;
 
 final class Path
 {
-    /**
-     * @param array{streamOperation: array<StreamOperation>} $voters
-     */
     public static function gather(
         string $className,
         string $path,
         PathItem $pathItem,
         SchemaRegistry $schemaRegistry,
-        array $voters,
+        ?Voter $voters,
     ): \ApiClients\Tools\OpenApiClientGenerator\Representation\Path {
         $className = Utils::fixKeyword($className);
         $operations = [];
@@ -38,9 +35,9 @@ public static function gather(
                 $schemaRegistry,
             );
 
-            if (array_key_exists('listOperation', $voters)) {
+            if ($voters !== null && is_array($voters->listOperation)) {
                 $shouldStream = false;
-                foreach ($voters['listOperation'] as $voter) {
+                foreach ($voters->listOperation as $voter) {
                     if ($voter::list($opp)) {
                         $shouldStream = true;
                         break;
@@ -65,9 +62,9 @@ public static function gather(
                 }
             }
 
-            if (array_key_exists('streamOperation', $voters)) {
+            if ($voters !== null && is_array($voters->streamOperation)) {
                 $shouldStream = false;
-                foreach ($voters['streamOperation'] as $voter) {
+                foreach ($voters->streamOperation as $voter) {
                     if ($voter::stream($opp)) {
                         $shouldStream = true;
                         break;

src/Generator.php

@@ -30,13 +30,13 @@ public function __construct(string $specUrl)
         $this->spec = Reader::readFromYamlFile($specUrl);
     }
 
-    public function generate(string $namespace, string $destinationPath, array $schemas, array $voters)
+    public function generate(string $namespace, string $destinationPath, Configuration $configuration)
     {
         $existingFiles = iterator_to_array(Files::listExistingFiles($destinationPath . DIRECTORY_SEPARATOR));
         $namespace = Utils::cleanUpNamespace($namespace);
         $codePrinter = new Standard();
 
-        foreach ($this->all($namespace, $destinationPath . DIRECTORY_SEPARATOR, $schemas, $voters) as $file) {
+        foreach ($this->all($namespace, $destinationPath . DIRECTORY_SEPARATOR, $configuration) as $file) {
             $fileName = $destinationPath . DIRECTORY_SEPARATOR . str_replace('\\', DIRECTORY_SEPARATOR, substr($file->fqcn, strlen($namespace))) . '.php';
             if ($file->contents instanceof Node\Stmt\Namespace_) {
                 array_unshift($file->contents->stmts, ...[
@@ -102,11 +102,11 @@ public function generate(string $namespace, string $destinationPath, array $sche
     /**
      * @return iterable<File>
      */
-    private function all(string $namespace, string $rootPath, array $schemas, array $voters): iterable
+    private function all(string $namespace, string $rootPath, Configuration $configuration): iterable
     {
         $schemaRegistry = new SchemaRegistry();
-        if (array_key_exists('allowDuplication', $schemas)) {
-            $schemaRegistry->setAllowDuplicatedSchemas($schemas['allowDuplication']);
+        if ($configuration->schemas !== null && $configuration->schemas->allowDuplication !== null) {
+            $schemaRegistry->setAllowDuplicatedSchemas($configuration->schemas->allowDuplication);
         }
         $schemas = [];
         $throwableSchemaRegistry = new ThrowableSchema();
@@ -141,7 +141,7 @@ private function all(string $namespace, string $rootPath, array $schemas, array
                     continue;
                 }
 
-                $paths[] = \ApiClients\Tools\OpenApiClientGenerator\Gatherer\Path::gather($pathClassName, $path, $pathItem, $schemaRegistry, $voters);
+                $paths[] = \ApiClients\Tools\OpenApiClientGenerator\Gatherer\Path::gather($pathClassName, $path, $pathItem, $schemaRegistry, $configuration->voter);
 
             }
         }