Add command to execute import/export from command line

Author: datlechin

src/Commands/ExportCommand.php

@@ -0,0 +1,135 @@
+<?php
+
+namespace Botble\DataSynchronize\Commands;
+
+use Botble\DataSynchronize\Exporter\Exporter;
+use Exception;
+use Illuminate\Console\Command;
+use Illuminate\Contracts\Console\PromptsForMissingInput;
+
+use function Laravel\Prompts\search;
+use function Laravel\Prompts\select;
+
+use function Laravel\Prompts\text;
+
+use SplFileInfo;
+use Symfony\Component\Console\Attribute\AsCommand;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Finder\Finder;
+
+#[AsCommand(name: 'data-synchronize:export', description: 'Export data from database to Excel/Csv file')]
+class ExportCommand extends Command implements PromptsForMissingInput
+{
+    public function handle(): void
+    {
+        $exporter = $this->argument('exporter') ?: search(
+            label: 'Which exporter do you want to use?',
+            options: fn (string $value) => array_filter(
+                $this->possibleExporters(),
+                fn (string $exporter) => str_contains(strtolower($exporter), strtolower($value))
+            ),
+        );
+        $path = $this->argument('path') ?: text(
+            'Where do you want to save the file?',
+            'E.g. storage/app/exports'
+        );
+        $format = $this->option('format') ?: select(
+            label: 'Which format do you want to export?',
+            options: ['csv' => 'CSV', 'xlsx' => 'XLSX'],
+            default: 'csv',
+        );
+
+        if (! class_exists($exporter)) {
+            $this->components->error('Exporter class does not exist');
+
+            exit(self::FAILURE);
+        }
+
+        $exporter = new $exporter();
+
+        if (! $exporter instanceof Exporter) {
+            $this->components->error('Exporter class must be an instance of ' . Exporter::class);
+
+            exit(self::FAILURE);
+        }
+
+        $exporter->format($format);
+
+        $this->components->info("Exporting {$exporter->getLabel()} to <comment>{$path}</comment>");
+
+        try {
+            $exporter->export()
+                ->getFile()
+                ->move($path, $exporter->getExportFileName());
+        } catch (Exception $e) {
+            $this->components->error($e->getMessage());
+
+            exit(self::FAILURE);
+        }
+
+        $this->components->info(
+            "{$exporter->getLabel()} has been exported to <comment>{$path}/{$exporter->getExportFileName()}</comment>"
+        );
+
+        exit(self::SUCCESS);
+    }
+
+    protected function getOptions(): array
+    {
+        return [
+            ['format', null, InputOption::VALUE_OPTIONAL, 'The format of the file (csv, xls, xlsx)'],
+        ];
+    }
+
+    protected function getArguments(): array
+    {
+        return [
+            ['exporter', InputArgument::OPTIONAL, 'The exporter class name'],
+            ['path', InputArgument::OPTIONAL, 'The path to save the file'],
+        ];
+    }
+
+    protected function promptForMissingArgumentsUsing(): array
+    {
+        return [
+            'exporter' => ['What is the exporter class name?', 'E.g. Botble\Blog\Exporters\PostExporter'],
+            'path' => ['Where do you want to save the file?', 'E.g. storage/app/exports'],
+        ];
+    }
+
+    protected function possibleExporters(): array
+    {
+        $exporters = [];
+
+        collect(
+            Finder::create()
+                ->files()
+                ->in(platform_path())
+                ->name('*.php')
+                ->contains(Exporter::class)
+        )
+            ->map(function (SplFileInfo $file) use (&$exporters) {
+                $class = $this->resolveExporterNamespace($file->getPathname());
+
+                if (
+                    class_exists($class)
+                    && is_subclass_of($class, Exporter::class)
+                ) {
+                    $exporters[] = $class;
+                }
+            });
+
+        return $exporters;
+    }
+
+    protected function resolveExporterNamespace(string $path): string
+    {
+        $content = file_get_contents($path);
+        $namespace = str($content)->after('namespace ')->before(';')->trim();
+        $basename = basename($path, '.php');
+
+        return $namespace . '\\' . $basename;
+    }
+}

src/Exporter/Exporter.php

@@ -6,7 +6,9 @@
 use Botble\Base\Facades\BaseHelper;
 use Botble\DataSynchronize\Concerns\Exporter\HasEmptyState;
 use Botble\DataSynchronize\Enums\ExportColumnType;
+use Carbon\Carbon;
 use Illuminate\Contracts\View\View;
+use Illuminate\Support\Str;
 use Maatwebsite\Excel\Concerns\FromCollection;
 use Maatwebsite\Excel\Concerns\ShouldAutoSize;
 use Maatwebsite\Excel\Concerns\WithColumnFormatting;
@@ -173,7 +175,12 @@ public function getColumns(): array
 
     public function getExportFileName(): string
     {
-        return str_replace(' ', '-', $this->getLabel());
+        return sprintf(
+            '%s-%s.%s',
+            Str::slug($this->getLabel()),
+            BaseHelper::formatDateTime(Carbon::now(), 'Y-m-d-H-i-s'),
+            $this->format
+        );
     }
 
     public function render(): View
@@ -201,7 +208,7 @@ public function export(): BinaryFileResponse
             },
         ];
 
-        return ExcelFacade::download($this, "{$this->getExportFileName()}.{$this->format}", $writeType, $headers);
+        return ExcelFacade::download($this, $this->getExportFileName(), $writeType, $headers);
     }
 
     public function acceptedColumns(?array $columns): self

src/Providers/DataSynchronizeServiceProvider.php

@@ -7,6 +7,7 @@
 use Botble\Base\Supports\ServiceProvider;
 use Botble\Base\Traits\LoadAndPublishDataTrait;
 use Botble\DataSynchronize\Commands\ClearChunksCommand;
+use Botble\DataSynchronize\Commands\ExportCommand;
 use Botble\DataSynchronize\Commands\ExportControllerMakeCommand;
 use Botble\DataSynchronize\Commands\ExporterMakeCommand;
 use Botble\DataSynchronize\Commands\ImportControllerMakeCommand;
@@ -38,6 +39,7 @@ public function boot(): void
                 ImportControllerMakeCommand::class,
                 ExportControllerMakeCommand::class,
                 ClearChunksCommand::class,
+                ExportCommand::class,
             ]);
 
             $this->app->afterResolving(Schedule::class, function (Schedule $schedule) {