feat: fully regenerate src directory during client generation (#65)

* feat: fully regenerate src directory during client generation

* fix: codestyle

* fix: phpstan issue

* doc: update changelog

Co-authored-by: Jason Benedetti <[email protected]>

Author: JasonBenett

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [9.0.0] - 2022.02.24
+### Changed
+- API Client Generation triggers a full regeneration of src folder.
+
 ## [8.1.0] - 2021-12-15
 ### Added
 - Basic Authentication strategy added

composer.json

@@ -35,6 +35,7 @@
   },
   "require-dev": {
     "composer/composer": "^2.1",
+    "mikey179/vfsstream": "^1.6",
     "php-coveralls/php-coveralls": "^2.2",
     "phpstan/phpstan": "^0.12.32",
     "phpunit/phpunit": "^9.2",

composer.lock

@@ -16,6 +16,7 @@
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\JsonContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\VdnApiJsonContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\XmlContentTypeSerializer;
+use DoclerLabs\ApiClientGenerator\Output\DirectoryPrinter;
 use DoclerLabs\ApiClientGenerator\Output\Meta\MetaFileCollection;
 use DoclerLabs\ApiClientGenerator\Output\MetaFilePrinter;
 use DoclerLabs\ApiClientGenerator\Output\Php\PhpFileCollection;
@@ -30,6 +31,7 @@
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Finder\Finder;
+use Throwable;
 
 class GenerateCommand extends Command
 {
@@ -38,6 +40,7 @@ class GenerateCommand extends Command
     private FileReader          $fileReader;
     private Parser              $parser;
     private PhpFilePrinter      $phpPrinter;
+    private DirectoryPrinter    $directoryPrinter;
     private MetaTemplateFacade  $metaTemplate;
     private MetaFilePrinter     $templatePrinter;
     private Finder              $fileFinder;
@@ -51,6 +54,7 @@ public function __construct(
         Parser $parser,
         CodeGeneratorFacade $codeGenerator,
         PhpFilePrinter $phpPrinter,
+        DirectoryPrinter $directoryPrinter,
         MetaTemplateFacade $metaTemplate,
         MetaFilePrinter $templatePrinter,
         Finder $fileFinder,
@@ -64,6 +68,7 @@ public function __construct(
         $this->parser           = $parser;
         $this->codeGenerator    = $codeGenerator;
         $this->phpPrinter       = $phpPrinter;
+        $this->directoryPrinter = $directoryPrinter;
         $this->metaTemplate     = $metaTemplate;
         $this->templatePrinter  = $templatePrinter;
         $this->fileFinder       = $fileFinder;
@@ -93,10 +98,19 @@ public function execute(InputInterface $input, OutputInterface $output): int
 
         $ss = new SymfonyStyle($input, $output);
 
-        $this->generatePhpFiles($ss, $specification);
-        $this->copySpecification($ss);
-        $this->generateMetaFiles($ss, $specification);
-        $this->copyStaticPhpFiles($ss, $specification);
+        $this->backup($ss);
+
+        try {
+            $this->generatePhpFiles($ss, $specification);
+            $this->copyStaticPhpFiles($ss, $specification);
+            $this->copySpecification($ss);
+            $this->generateMetaFiles($ss, $specification);
+        } catch (Throwable $throwable) {
+            $this->restoreBackup($ss);
+            return Command::FAILURE;
+        }
+
+        $this->removeBackup($ss);
 
         return Command::SUCCESS;
     }
@@ -192,6 +206,55 @@ private function copySpecification(StyleInterface $ss): void
         );
     }
 
+    private function backup(StyleInterface $ss): void
+    {
+        $ss->text('<info>Backup original source.</info>');
+
+        $originalPath = sprintf(
+            '%s/%s',
+            $this->configuration->getOutputDirectory(),
+            $this->configuration->getSourceDirectory()
+        );
+
+        $backupPath = $originalPath . '_old';
+
+        $this->directoryPrinter->move(
+            $backupPath,
+            $originalPath
+        );
+    }
+
+    private function restoreBackup(StyleInterface $ss): void
+    {
+        $ss->text('<error>Restore original source from backup.</error>');
+
+        $originalPath = sprintf(
+            '%s/%s',
+            $this->configuration->getOutputDirectory(),
+            $this->configuration->getSourceDirectory()
+        );
+
+        $backupPath = $originalPath . '_old';
+
+        $this->directoryPrinter->move(
+            $originalPath,
+            $backupPath
+        );
+    }
+
+    private function removeBackup(StyleInterface $ss): void
+    {
+        $ss->text('<info>Delete backup.</info>');
+
+        $backupPath = sprintf(
+            '%s/%s_old',
+            $this->configuration->getOutputDirectory(),
+            $this->configuration->getSourceDirectory()
+        );
+
+        $this->directoryPrinter->delete($backupPath);
+    }
+
     private function initWarningPrinting(InputInterface $input): void
     {
         if ($input->getOption('quiet')) {

src/Command/GenerateCommand.php

@@ -18,4 +18,40 @@ public function ensureDirectoryExists(string $directoryPath): void
             throw new RuntimeException(sprintf('Directory "%s" could not be created', $directoryPath));
         }
     }
+
+    public function move(string $destinationPath, string $sourcePath): void
+    {
+        $this->ensureDirectoryExists($sourcePath);
+        $this->delete($destinationPath);
+
+        rename($sourcePath, $destinationPath);
+    }
+
+    public function delete(string $path): bool
+    {
+        if (!file_exists($path)) {
+            return true;
+        }
+
+        if (!is_dir($path)) {
+            return unlink($path);
+        }
+
+        $directoryContent = scandir($path);
+        if ($directoryContent === false) {
+            return true;
+        }
+
+        foreach ($directoryContent as $item) {
+            if ($item === '.' || $item === '..') {
+                continue;
+            }
+
+            if (!$this->delete($path . DIRECTORY_SEPARATOR . $item)) {
+                return false;
+            }
+        }
+
+        return rmdir($path);
+    }
 }

src/Output/DirectoryPrinter.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace DoclerLabs\ApiClientGenerator;
@@ -96,6 +97,7 @@ public function register(Container $pimple): void
             $container[OpenApiParser::class],
             $container[CodeGeneratorFacade::class],
             $container[PhpFilePrinter::class],
+            $container[DirectoryPrinter::class],
             $container[MetaTemplateFacade::class],
             $container[MetaFilePrinter::class],
             $container[Finder::class],

src/ServiceProvider.php

@@ -0,0 +1,91 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientGenerator\Test\Unit\Output;
+
+use DoclerLabs\ApiClientGenerator\Output\DirectoryPrinter;
+use org\bovigo\vfs\vfsStream;
+use org\bovigo\vfs\vfsStreamDirectory;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \DoclerLabs\ApiClientGenerator\Output\DirectoryPrinter
+ */
+class DirectoryPrinterTest extends TestCase
+{
+    private DirectoryPrinter   $sut;
+    private vfsStreamDirectory $directory;
+
+    protected function setUp(): void
+    {
+        $this->sut       = new DirectoryPrinter();
+        $this->directory = vfsStream::setup();
+    }
+
+    public function testCreationDuringEnsureDirectoryExists(): void
+    {
+        $directory = 'my-dir';
+
+        $this->sut->ensureDirectoryExists(
+            $this->directory->url() . DIRECTORY_SEPARATOR . $directory
+        );
+
+        self::assertTrue($this->directory->hasChild($directory));
+    }
+
+    public function testExistingDuringEnsureDirectoryExists(): void
+    {
+        $directory = 'existing';
+
+        vfsStream::newDirectory($directory)->at($this->directory);
+
+        $this->sut->ensureDirectoryExists(
+            $this->directory->url() . DIRECTORY_SEPARATOR . $directory
+        );
+
+        self::assertTrue($this->directory->hasChild($directory));
+    }
+
+    public function testMove(): void
+    {
+        $source      = 'old';
+        $destination = 'new';
+
+        vfsStream::newDirectory($source)->at($this->directory);
+
+        $this->sut->move(
+            $this->directory->url() . DIRECTORY_SEPARATOR . $destination,
+            $this->directory->url() . DIRECTORY_SEPARATOR . $source
+        );
+
+        self::assertTrue($this->directory->hasChild($destination));
+        self::assertFalse($this->directory->hasChild($source));
+    }
+
+    public function testDeleteFolder(): void
+    {
+        $pathToKeep = 'to-keep';
+
+        $pathToRemove      = 'to-remove';
+        $fileToRemove      = 'file-to-remove';
+        $subFolderToRemove = 'sub-folder';
+        $subFileToRemove   = 'subfile-to-remove';
+
+        vfsStream::newDirectory($pathToKeep)->at($this->directory);
+
+        $toRemove = vfsStream::newDirectory($pathToRemove)->at($this->directory);
+        vfsStream::newFile($fileToRemove)->at($toRemove);
+        $toRemoveSubFolder = vfsStream::newDirectory($subFolderToRemove)->at($toRemove);
+        vfsStream::newFile($subFileToRemove)->at($toRemoveSubFolder);
+
+        self::assertTrue(
+            $this->sut->delete(
+                $this->directory->url() . DIRECTORY_SEPARATOR . $pathToRemove,
+            )
+        );
+
+        self::assertTrue($this->directory->hasChild($pathToKeep));
+        self::assertFalse($this->directory->hasChild($pathToRemove));
+    }
+}