Remove generated code before new generation (#198)

Remove generated code before new generation
janephp · Dec 9, 2019 · 1f6bfb9 · 1f6bfb9
2 parents af91fb1 + 6f8a939
commit 1f6bfb9
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 31 deletions.
diff --git a/composer.json b/composer.json
@@ -26,6 +26,7 @@
         "psr/http-client": "^1.0",
         "psr/http-factory": "^1.0",
         "symfony/console": "^3.1 || ^4.0 || ^5.0",
+        "symfony/filesystem": "^3.1 || ^4.0 || ^5.0",
         "symfony/options-resolver": "^3.1 || ^4.0 || ^5.0",
         "symfony/property-access": "^3.1 || ^4.0 || ^5.0",
         "symfony/property-info": "^3.4 || ^4.0 || ^5.0",

diff --git a/documentation/JsonSchema/generate.rst b/documentation/JsonSchema/generate.rst
@@ -57,6 +57,7 @@ Other options are available to customize the generated code:
  * ``date-format``: A date format to specify how the generated code should encode and decode ``\DateTime`` object to string
  * ``use-fixer``: A boolean which indicate if we make a first cs-fix after code generation, is disabled by default.
  * ``fixer-config-file``: A string to specify where to find the custom configuration for the cs-fixer after code generation, will remove all Jane default cs-fixer default configuration.
+ * ``clean-generated``: A boolean which indicate if we clean generated output before generating new files, is enabled by default.
  * ``use-cacheable-supports-method``: A boolean which indicate if we use ``CacheableSupportsMethodInterface`` interface to improve caching performances when used with Symfony Serializer.
 
 Multi schemas

diff --git a/documentation/OpenAPI/generate.rst b/documentation/OpenAPI/generate.rst
@@ -60,6 +60,7 @@ Other options are available to customize the generated code:
    not respecting some standards (nullable field as an example) client.
  * ``use-fixer``: A boolean which indicate if we make a first cs-fix after code generation, is disabled by default.
  * ``fixer-config-file``: A string to specify where to find the custom configuration for the cs-fixer after code generation, will remove all Jane default cs-fixer default configuration.
+ * ``clean-generated``: A boolean which indicate if we clean generated output before generating new files, is enabled by default.
  * ``use-cacheable-supports-method``: A boolean which indicate if we use ``CacheableSupportsMethodInterface`` interface to improve caching performances when used with Symfony Serializer.
 
 .. _`JSON Reference`: https://tools.ietf.org/id/draft-pbryan-zyp-json-ref-03.html
diff --git a/src/JsonSchema/Command/GenerateCommand.php b/src/JsonSchema/Command/GenerateCommand.php
@@ -2,6 +2,7 @@
 
 namespace Jane\JsonSchema\Command;
 
+use Jane\JsonSchema\Jane;
 use Jane\JsonSchema\Printer;
 use Jane\JsonSchema\Registry;
 use Jane\JsonSchema\Schema;
@@ -54,7 +55,7 @@ public function execute(InputInterface $input, OutputInterface $output)
             }
         }
 
-        $jane = \Jane\JsonSchema\Jane::build($options);
+        $jane = Jane::build($options);
         $fixerConfigFile = '';
 
         if (\array_key_exists('fixer-config-file', $options) && null !== $options['fixer-config-file']) {
@@ -63,8 +64,11 @@ public function execute(InputInterface $input, OutputInterface $output)
 
         $printer = new Printer(new Standard(), $fixerConfigFile);
 
-        if (\array_key_exists('use-fixer', $options) && false === $options['use-fixer']) {
-            $printer->setUseFixer(false);
+        if (\array_key_exists('use-fixer', $options) && \is_bool($options['use-fixer'])) {
+            $printer->setUseFixer($options['use-fixer']);
+        }
+        if (\array_key_exists('clean-generated', $options) && \is_bool($options['clean-generated'])) {
+            $printer->setCleanGenerated($options['clean-generated']);
         }
 
         $jane->generate($registry);
@@ -82,6 +86,7 @@ protected function resolveConfiguration(array $options = [])
             'date-format' => \DateTime::RFC3339,
             'use-fixer' => false,
             'fixer-config-file' => null,
+            'clean-generated' => true,
             'use-cacheable-supports-method' => null,
         ]);
 
@@ -113,6 +118,7 @@ protected function resolveSchema($schema, array $options = [])
             'strict',
             'use-fixer',
             'fixer-config-file',
+            'clean-generated',
             'use-cacheable-supports-method',
         ]);
 

diff --git a/src/JsonSchema/Printer.php b/src/JsonSchema/Printer.php
@@ -7,29 +7,44 @@
 use PhpParser\PrettyPrinterAbstract;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\NullOutput;
+use Symfony\Component\Filesystem\Filesystem;
 
 class Printer
 {
     private $prettyPrinter;
 
     private $fixerConfig;
 
-    private $useFixer;
+    private $useFixer = false;
 
-    public function __construct(PrettyPrinterAbstract $prettyPrinter, string $fixerConfig = '', bool $useFixer = false)
+    private $cleanGenerated = true;
+
+    public function __construct(PrettyPrinterAbstract $prettyPrinter, string $fixerConfig = '')
     {
         $this->prettyPrinter = $prettyPrinter;
         $this->fixerConfig = $fixerConfig;
-        $this->useFixer = $useFixer;
     }
 
     public function setUseFixer(bool $useFixer): void
     {
         $this->useFixer = $useFixer;
     }
 
+    public function setCleanGenerated(bool $cleanGenerated): void
+    {
+        $this->cleanGenerated = $cleanGenerated;
+    }
+
     public function output(Registry $registry): void
     {
+        if ($this->cleanGenerated) {
+            $fs = new Filesystem();
+            foreach ($registry->getOutputDirectories() as $directory) {
+                $fs->remove($directory);
+                $fs->mkdir($directory);
+            }
+        }
+
         foreach ($registry->getSchemas() as $schema) {
             foreach ($schema->getFiles() as $file) {
                 if (!file_exists(\dirname($file->getFilename()))) {

diff --git a/src/JsonSchema/Tests/JaneBaseTest.php b/src/JsonSchema/Tests/JaneBaseTest.php
@@ -6,7 +6,6 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\NullOutput;
-use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
 
@@ -17,24 +16,15 @@ class JaneBaseTest extends TestCase
      */
     public function testRessources($name, SplFileInfo $testDirectory)
     {
-        // 1. Cleanup generated
-        $filesystem = new Filesystem();
-
-        if ($filesystem->exists($testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . 'generated')) {
-            $filesystem->remove($testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . 'generated');
-        }
-
-        $filesystem->mkdir($testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . 'generated');
-
-        // 2. Generate
+        // 1. Generate
         $command = new GenerateCommand();
         $inputArray = new ArrayInput([
             '--config-file' => $testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . '.jane',
         ], $command->getDefinition());
 
         $command->execute($inputArray, new NullOutput());
 
-        // 3. Compare
+        // 2. Compare
         $expectedFinder = new Finder();
         $expectedFinder->in($testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . 'expected');
         $generatedFinder = new Finder();

diff --git a/src/JsonSchema/Tests/LibraryTest.php b/src/JsonSchema/Tests/LibraryTest.php
@@ -24,7 +24,9 @@ public function setUp()
             'reference' => true,
             'strict' => false,
         ]);
-        $this->printer = new Printer(new Standard(), '', true);
+        $this->printer = new Printer(new Standard(), '');
+        $this->printer->setUseFixer(true);
+        $this->printer->setCleanGenerated(false);
     }
 
     /**

diff --git a/src/JsonSchema/composer.json b/src/JsonSchema/composer.json
@@ -19,6 +19,7 @@
         "jane-php/json-schema-runtime": "^5.0",
         "nikic/php-parser": "^4.0",
         "symfony/console": "^3.1 || ^4.0 || ^5.0",
+        "symfony/filesystem": "^3.1 || ^4.0 || ^5.0",
         "symfony/options-resolver": "^3.1 || ^4.0 || ^5.0",
         "symfony/property-access": "^3.1 || ^4.0 || ^5.0",
         "symfony/yaml": "^3.1 || ^4.0 || ^5.0"

diff --git a/src/OpenApi/Command/GenerateCommand.php b/src/OpenApi/Command/GenerateCommand.php
@@ -67,6 +67,9 @@ public function execute(InputInterface $input, OutputInterface $output)
         if (\array_key_exists('use-fixer', $options) && \is_bool($options['use-fixer'])) {
             $printer->setUseFixer($options['use-fixer']);
         }
+        if (\array_key_exists('clean-generated', $options) && \is_bool($options['clean-generated'])) {
+            $printer->setCleanGenerated($options['clean-generated']);
+        }
 
         $janeOpenApi->generate($registry);
         $printer->output($registry);
@@ -84,6 +87,7 @@ protected function resolveConfiguration(array $options = [])
             'strict' => true,
             'use-fixer' => false,
             'fixer-config-file' => null,
+            'clean-generated' => true,
             'use-cacheable-supports-method' => null,
             'client' => JaneOpenApi::CLIENT_HTTPLUG,
         ]);
@@ -123,6 +127,7 @@ protected function resolveSchema($schema, array $options = [])
             'strict',
             'use-fixer',
             'fixer-config-file',
+            'clean-generated',
             'use-cacheable-supports-method',
             'client',
         ]);

diff --git a/src/OpenApi/Tests/JaneOpenApiResourceTest.php b/src/OpenApi/Tests/JaneOpenApiResourceTest.php
@@ -6,7 +6,6 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\NullOutput;
-use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
 
@@ -17,21 +16,12 @@ class JaneOpenApiResourceTest extends TestCase
      */
     public function testRessources($name, SplFileInfo $testDirectory)
     {
-        // 1. Cleanup generated
-        $filesystem = new Filesystem();
-
-        if ($filesystem->exists($testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . 'generated')) {
-            $filesystem->remove($testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . 'generated');
-        }
-
-        $filesystem->mkdir($testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . 'generated');
-
-        // 2. Generate
+        // 1. Generate
         $command = new GenerateCommand();
         $input = new ArrayInput(['--config-file' => $testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . '.jane-openapi'], $command->getDefinition());
         $command->execute($input, new NullOutput());
 
-        // 3. Compare
+        // 2. Compare
         $expectedFinder = new Finder();
         $expectedFinder->in($testDirectory->getRealPath() . \DIRECTORY_SEPARATOR . 'expected');