feat: Implement ExportJsonsCommand to export JSONs from models using HasJsonExports trait

Author: promatik

src/app/Console/Commands/ExportJsonsCommand.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace App\Console\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\File;
+use ReflectionClass;
+
+class ExportJsonsCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'export:jsons';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Export all JSONs defined in HasJsonExports trait';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): void
+    {
+        $modelsPath = app_path('Models');
+
+        if (! File::exists($modelsPath)) {
+            $this->error('Models directory not found.');
+
+            return;
+        }
+
+        $modelFiles = File::allFiles($modelsPath);
+
+        foreach ($modelFiles as $file) {
+            $className = 'App\\Models\\'.$file->getFilenameWithoutExtension();
+
+            if (! class_exists($className)) {
+                continue;
+            }
+
+            $reflection = new ReflectionClass($className);
+            if (! $reflection->isInstantiable() || ! $reflection->isSubclassOf(Model::class)) {
+                continue;
+            }
+
+            $traits = class_uses_recursive($className);
+            $usesHasJsonExports = false;
+
+            foreach ($traits as $trait) {
+                if (str_ends_with($trait, 'HasJsonExports')) {
+                    $usesHasJsonExports = true;
+                    break;
+                }
+            }
+
+            if ($usesHasJsonExports) {
+                $this->info("Exporting for model: $className");
+
+                /** @var Model */
+                $model = new $className;
+                $this->exportModel($model);
+            }
+        }
+    }
+
+    protected function exportModel(Model $targetModel): void
+    {
+        // @phpstan-ignore method.notFound
+        foreach ($targetModel->getJsonExportMethods() as $name => $method) {
+            $this->line("  - Generating $name.json");
+
+            $data = $targetModel->$method();
+
+            $path = config('gemadigital.jsonExports.path', storage_path('data'))."/{$name}.json";
+
+            if (! file_exists(dirname($path))) {
+                mkdir(dirname($path), 0755, true);
+            }
+
+            file_put_contents(
+                $path,
+                $data->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES),
+            );
+        }
+    }
+}

src/app/Models/Traits/HasJsonExports.php

@@ -10,18 +10,33 @@
 /** @phpstan-ignore trait.unused */
 trait HasJsonExports
 {
-    public static function bootHasJsonExports(): void
+    /**
+     * @return array<string, string>
+     */
+    public function getJsonExportMethods(): array
     {
-        $exportHelper = function (Model $targetModel): void {
-            foreach (get_class_methods($targetModel) as $method) {
-                if (! str_starts_with($method, 'export') || ! str_ends_with($method, 'Json')) {
-                    continue;
-                }
+        $methods = [];
+
+        foreach (get_class_methods($this) as $method) {
+            if (! str_starts_with($method, 'export') || ! str_ends_with($method, 'Json')) {
+                continue;
+            }
+
+            $name = Str::of($method)
+                ->substr(6, -4)
+                ->snake();
 
-                $name = Str::of($method)
-                    ->substr(6, -4)
-                    ->snake();
+            $methods[(string) $name] = $method;
+        }
 
+        return $methods;
+    }
+
+    public static function bootHasJsonExports(): void
+    {
+        $exportHelper = function (Model $targetModel): void {
+            // @phpstan-ignore method.notFound
+            foreach ($targetModel->getJsonExportMethods() as $name => $method) {
                 $data = $targetModel->$method();
 
                 $path = config('gemadigital.jsonExports.path', storage_path('data'))."/{$name}.json";