Add support for generating a standalone package (#1484)

* Extract the resolution of the directory for a given namespace

This avoids duplicating the logic in the 2 writers (with slightly
different implementation) and will allow swapping the resolver for
standalone packages.

* Refactor the entrypoint of the runner

The generate.php script in the code generator does not make sense as an
executable as it defaults to reading the manifest and generating the
code in the code generator folder itself, which is not the actual use
case.
Configuring it through environment variables also makes it harder to
configure objects like the directory resolver.

* Implement a directory resolver for standalone packages

This resolver supports the use case of generating a standalone package
containing only one service, where the package is at the root of the
repository.

Author: stof

generate

@@ -1,32 +1,23 @@
 #!/usr/bin/env php
 <?php
 
+use AsyncAws\CodeGenerator\File\Location\AsyncAwsMonoRepoResolver;
+use AsyncAws\CodeGenerator\Runner;
 use AsyncAws\Core\EnvVar;
 
-$generatorDir = __DIR__ . '/src/CodeGenerator';
-if (!file_exists($generatorDir . '/generate.php')) {
-    echo "Unable to find the `generate.php` script in `/src/CodeGenerator/`.\n";
-    exit(1);
-}
-
 if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
     echo "Run `composer install` before you run the `generate` script.\n";
     exit(1);
 }
 
 require __DIR__ . '/vendor/autoload.php';
 
-if (null === EnvVar::get('ASYNC_AWS_GENERATE_MANIFEST')) {
-    $_SERVER['ASYNC_AWS_GENERATE_MANIFEST'] = __DIR__ . '/manifest.json';
-}
-if (null === EnvVar::get('ASYNC_AWS_GENERATE_CACHE')) {
-    $_SERVER['ASYNC_AWS_GENERATE_CACHE'] = __DIR__ . '/.cache/generate';
-}
-if (null === EnvVar::get('ASYNC_AWS_GENERATE_SRC')) {
-    $_SERVER['ASYNC_AWS_GENERATE_SRC'] = __DIR__ . '/src';
-}
 if (null === EnvVar::get('SYMFONY_PATCH_TYPE_DECLARATIONS')) {
     $_SERVER['SYMFONY_PATCH_TYPE_DECLARATIONS'] = 'deprecations=1';
 }
 
-require $generatorDir . '/generate.php';
+Runner::create(
+    __DIR__ . '/manifest.json',
+    new AsyncAwsMonoRepoResolver(__DIR__ . '/src'),
+    __DIR__ . '/.cache/generate'
+)->run();

src/CodeGenerator/generate

@@ -4,6 +4,7 @@
 
 namespace AsyncAws\CodeGenerator\File;
 
+use AsyncAws\CodeGenerator\File\Location\DirectoryResolver;
 use AsyncAws\CodeGenerator\Generator\PhpGenerator\ClassBuilder;
 
 /**
@@ -16,9 +17,9 @@
 class ClassWriter
 {
     /**
-     * @var string
+     * @var DirectoryResolver
      */
-    private $srcDirectory;
+    private $directoryResolver;
 
     /**
      * @var FileDumper
@@ -30,44 +31,31 @@ class ClassWriter
      */
     private $printer;
 
-    public function __construct(string $srcDirectory, FileDumper $fileDumper)
+    public function __construct(DirectoryResolver $directoryResolver, FileDumper $fileDumper)
     {
-        $this->srcDirectory = $srcDirectory;
         $this->fileDumper = $fileDumper;
         $this->printer = new Printer();
+        $this->directoryResolver = $directoryResolver;
     }
 
     public function write(ClassBuilder $classBuilder): void
     {
         $content = $this->printer->printNamespace($classBuilder->build());
 
         $className = $classBuilder->getClassName();
-        // Remove AsyncAws\
-        $fqcn = substr($className->getNamespace(), 9);
 
+        $namespace = $className->getNamespace();
         $className = $className->getName();
-        $directory = $this->resolveDirectory($fqcn);
+        $directory = $this->resolveDirectory($namespace);
 
         $filename = sprintf('%s/%s.php', $directory, $className);
 
         $this->fileDumper->dump($filename, $content);
     }
 
-    private function resolveDirectory(string $fqcn): string
+    private function resolveDirectory(string $namespace): string
     {
-        $parts = explode('\\', $fqcn);
-        $service = array_shift($parts); // Lambda, S3, Sqs etc
-        if (isset($parts[0]) && 'Tests' === $parts[0]) {
-            array_shift($parts); // Tests
-            array_unshift($parts, $service, 'tests');
-        } else {
-            array_unshift($parts, $service, 'src');
-        }
-        if ('Core' !== $service) {
-            array_unshift($parts, 'Service');
-        }
-
-        $directory = sprintf('%s/%s', $this->srcDirectory, implode('/', $parts));
+        $directory = $this->directoryResolver->resolveDirectory($namespace);
         if (!is_dir($directory)) {
             if (false === mkdir($directory, 0777, true)) {
                 throw new \RuntimeException(sprintf('Could not create directory "%s"', $directory));

src/CodeGenerator/generate.php

@@ -4,6 +4,8 @@
 
 namespace AsyncAws\CodeGenerator\File;
 
+use AsyncAws\CodeGenerator\File\Location\DirectoryResolver;
+
 /**
  * Update composer.json requirements.
  *
@@ -14,13 +16,13 @@
 class ComposerWriter
 {
     /**
-     * @var string
+     * @var DirectoryResolver
      */
-    private $srcDirectory;
+    private $directoryResolver;
 
-    public function __construct(string $srcDirectory)
+    public function __construct(DirectoryResolver $directoryResolver)
     {
-        $this->srcDirectory = $srcDirectory;
+        $this->directoryResolver = $directoryResolver;
     }
 
     /**
@@ -55,31 +57,11 @@ public function setRequirements(string $namespace, array $requirements, bool $cl
 
     private function findFile(string $namespace): string
     {
-        $dir = $this->resolveDirectory($namespace);
+        $dir = $this->directoryResolver->resolveDirectory($namespace);
         while (!file_exists($dir . '/composer.json')) {
             $dir = \dirname($dir);
         }
 
         return $dir . '/composer.json';
     }
-
-    private function resolveDirectory(string $fqcn): string
-    {
-        $parts = explode('\\', $fqcn);
-        array_shift($parts); // AsyncAws
-        $service = array_shift($parts); // Lambda, S3, Sqs etc
-        array_unshift($parts, $service, 'src');
-        if ('Core' !== $service) {
-            array_unshift($parts, 'Service');
-        }
-
-        $directory = sprintf('%s/%s', $this->srcDirectory, implode('/', $parts));
-        if (!is_dir($directory)) {
-            if (false === mkdir($directory, 0777, true)) {
-                throw new \RuntimeException(sprintf('Could not create directory "%s"', $directory));
-            }
-        }
-
-        return $directory;
-    }
 }

src/CodeGenerator/src/File/ClassWriter.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace AsyncAws\CodeGenerator\File\Location;
+
+/**
+ * @internal
+ */
+class AsyncAwsMonoRepoResolver implements DirectoryResolver
+{
+    /**
+     * @var string
+     */
+    private $srcDirectory;
+
+    public function __construct(string $srcDirectory)
+    {
+        $this->srcDirectory = $srcDirectory;
+    }
+
+    public function resolveDirectory(string $namespace): string
+    {
+        $relativeNamespace = substr($namespace, \strlen('AsyncAws\\'));
+
+        $parts = explode('\\', $relativeNamespace);
+        $service = array_shift($parts); // Lambda, S3, Sqs etc
+        if (isset($parts[0]) && 'Tests' === $parts[0]) {
+            array_shift($parts); // Tests
+            array_unshift($parts, $service, 'tests');
+        } else {
+            array_unshift($parts, $service, 'src');
+        }
+        if ('Core' !== $service) {
+            array_unshift($parts, 'Service');
+        }
+
+        return sprintf('%s/%s', $this->srcDirectory, implode('/', $parts));
+    }
+}

src/CodeGenerator/src/File/ComposerWriter.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace AsyncAws\CodeGenerator\File\Location;
+
+interface DirectoryResolver
+{
+    /**
+     * Resolves the directory in which files should be written for this namespace.
+     */
+    public function resolveDirectory(string $namespace): string;
+}

src/CodeGenerator/src/File/Location/AsyncAwsMonoRepoResolver.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace AsyncAws\CodeGenerator\File\Location;
+
+class StandalonePackageResolver implements DirectoryResolver
+{
+    /**
+     * @var string
+     */
+    private $rootDirectory;
+
+    /**
+     * @var string
+     */
+    private $rootNamespace;
+
+    public function __construct(string $rootDirectory, string $rootNamespace)
+    {
+        $this->rootDirectory = $rootDirectory;
+        $this->rootNamespace = $rootNamespace;
+    }
+
+    public function resolveDirectory(string $namespace): string
+    {
+        if ($namespace === $this->rootNamespace) {
+            return $this->rootDirectory . '/src';
+        }
+
+        if (0 !== strpos($namespace, $this->rootNamespace . '\\')) {
+            throw new \InvalidArgumentException('The namespace must belong to the generated package.');
+        }
+
+        $relativeNamespace = substr($namespace, \strlen($this->rootNamespace . '\\'));
+
+        $parts = explode('\\', $relativeNamespace);
+        if (isset($parts[0]) && 'Tests' === $parts[0]) {
+            array_shift($parts); // Tests
+            array_unshift($parts, 'tests');
+        } else {
+            array_unshift($parts, 'src');
+        }
+
+        return sprintf('%s/%s', $this->rootDirectory, implode('/', $parts));
+    }
+}

src/CodeGenerator/src/File/Location/DirectoryResolver.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace AsyncAws\CodeGenerator;
+
+use AsyncAws\CodeGenerator\Command\GenerateCommand;
+use AsyncAws\CodeGenerator\File\Cache;
+use AsyncAws\CodeGenerator\File\CachedFileDumper;
+use AsyncAws\CodeGenerator\File\ClassWriter;
+use AsyncAws\CodeGenerator\File\ComposerWriter;
+use AsyncAws\CodeGenerator\File\Location\DirectoryResolver;
+use AsyncAws\CodeGenerator\Generator\ApiGenerator;
+use Symfony\Component\Console\Application;
+
+final class Runner
+{
+    public static function create(string $manifest, DirectoryResolver $directoryResolver, string $cacheDirectory): Application
+    {
+        $application = new Application('AsyncAws', '0.1.0');
+
+        $cache = new Cache($cacheDirectory);
+        $command = new GenerateCommand($manifest, $cache, new ClassWriter($directoryResolver, new CachedFileDumper($cache)), new ComposerWriter($directoryResolver), new ApiGenerator());
+        $application->add($command);
+        $application->setDefaultCommand($command->getName(), true);
+
+        return $application;
+    }
+}