Merge pull request #110 from enesaktay/fix-excel-cli-export

Fix CLI Excel export creating files with zero bytes

.gitignore

@@ -8,4 +8,6 @@
 !/etc/build/.gitkeep
 
 /tests/Application/yarn.lock
-/tests/Behat/Resources/fixtures/countries_export.csv
+
+/tests/Behat/Resources/fixtures/export/*
+!/tests/Behat/Resources/fixtures/export/.gitkeep

spec/Writer/CsvWriterSpec.php

@@ -36,4 +36,12 @@ function it_delegates_the_data_to_the_wrapped_writer(Writer $csvWriter)
         $csvWriter->writeItem($data)->shouldBeCalled();
         $this->write($data);
     }
+
+    function it_finishes_the_file_creation_when_we_get_the_contents(Writer $csvWriter)
+    {
+        $csvWriter->setCloseStreamOnFinish(true)->shouldBeCalled();
+        $csvWriter->getStream()->willReturn(fopen('php://memory', 'w'));
+        $csvWriter->finish()->shouldBeCalled();
+        $this->getFileContent();
+    }
 }

spec/Writer/ExcelWriterSpec.php

@@ -36,6 +36,8 @@ function it_delegates_the_data_to_the_wrapped_writer(\Port\Excel\ExcelWriter $ex
         ];
         $excelWriter->prepare()->shouldBeCalled();
         $excelWriter->writeItem($data)->shouldBeCalled();
+        $excelWriter->finish()->shouldBeCalled();
         $this->write($data);
+        $this->finish();
     }
 }

src/Command/ExportDataCommand.php

@@ -92,6 +92,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $service->setExportFile($file);
 
         $service->export($idsToExport);
+        $service->finish();
 
         $message = sprintf(
             "<info>Exported %d item(s) to '%s' via the %s exporter</info>",

src/Exporter/JsonResourceExporter.php

@@ -64,4 +64,12 @@ public function setExportFile(string $filename): void
     {
         $this->filename = $filename;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function finish(): void
+    {
+        // no finish needed
+    }
 }

src/Exporter/ResourceExporter.php

@@ -107,4 +107,12 @@ protected function getDataForId(string $id): array
 
         return $data;
     }
+
+    /**
+     * Wrap up the writer after all items have been written
+     */
+    public function finish(): void
+    {
+        $this->writer->finish();
+    }
 }

src/Exporter/ResourceExporterInterface.php

@@ -20,4 +20,9 @@ public function setExportFile(string $filename): void;
      * @return string
      */
     public function getExportedData(): string;
+
+    /**
+     * Wrap up the writer after all items have been written
+     */
+    public function finish(): void;
 }

src/Writer/CsvWriter.php

@@ -52,8 +52,16 @@ public function getFileContent(): string
         rewind($this->writer->getStream());
         $contents = stream_get_contents($this->writer->getStream());
 
-        $this->writer->finish();
+        $this->finish();
 
         return $contents;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function finish(): void
+    {
+        $this->writer->finish();
+    }
 }

src/Writer/ExcelWriter.php

@@ -66,7 +66,7 @@ public function setFile(string $filename): void
      */
     public function getFileContent(): string
     {
-        $this->writer->finish();
+        $this->finish();
 
         $contents = file_get_contents($this->filename);
 
@@ -86,4 +86,12 @@ private function prepare(): void
             $this->writer->prepare();
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function finish(): void
+    {
+        $this->writer->finish();
+    }
 }

src/Writer/WriterInterface.php

@@ -20,4 +20,9 @@ public function setFile(string $filename): void;
      * @return string
      */
     public function getFileContent(): string;
+
+    /**
+     * Wrap up the writer after all items have been written
+     */
+    public function finish(): void;
 }

tests/Behat/Context/CliBaseContext.php

@@ -133,6 +133,6 @@ public function iExportDataToSpecificFiletypeFileWithTheCliCommand($exporterType
         $this->application->add($command);
         $this->command = $this->application->find('sylius:export');
         $this->tester = new CommandTester($this->command);
-        $this->tester->execute(['command' => 'sylius:export', 'exporter' => $exporterType, 'file' => $this->filePath . '/' . $filename, '--format' => $format]);
+        $this->tester->execute(['command' => 'sylius:export', 'exporter' => $exporterType, 'file' => $this->filePath . '/export/' . $filename, '--format' => $format]);
     }
 }