Merge pull request #4 from DutchCodingCompany/feature/add-cache

Add caching option

Author: dododedodonl

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 2.2.0 - 2025-08-05
+- Add caching option
+
 ## 2.1.0 - 2025-08-05
 - Add `JsonSchemaAttributeRule`
 

config/json-schema.php

@@ -13,6 +13,8 @@
 
     'directory' => env('JSON_SCHEMA_DIRECTORY', 'schema'),
 
+    'auto-cache' => (bool) env('JSON_SCHEMA_AUTO_CACHE', true),
+
     /*
     |--------------------------------------------------------------------------
     | Filter for file match

src/Commands/Optimize.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace DutchCodingCompany\LaravelJsonSchema\Commands;
+
+use DutchCodingCompany\LaravelJsonSchema\JsonSchemaRepository;
+use Illuminate\Console\Command;
+use Illuminate\Contracts\Filesystem\Factory as FilesystemFactory;
+use Illuminate\Contracts\Filesystem\Filesystem;
+use Illuminate\Support\Facades\App;
+
+class Optimize extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'json-schema:optimize';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Caches available json schemas.';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(FilesystemFactory $filesystem, JsonSchemaRepository $repository): int
+    {
+        $this->call('json-schema:optimize-clear');
+
+        $filesystem->disk('local')->put(
+            $repository->fullCachePath(),
+            '<?php return '.var_export($repository->schemaFiles(true), true).';'.PHP_EOL,
+        );
+
+        $this->outputComponents()->info('Json schemas cached successfully!');
+
+        return static::SUCCESS;
+    }
+}

src/Commands/OptimizeClear.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace DutchCodingCompany\LaravelJsonSchema\Commands;
+
+use DutchCodingCompany\LaravelJsonSchema\JsonSchemaRepository;
+use Illuminate\Console\Command;
+use Illuminate\Contracts\Filesystem\Factory as FilesystemFactory;
+
+class OptimizeClear extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'json-schema:optimize-clear';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Clear json schemas cache.';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(FilesystemFactory $filesystem, JsonSchemaRepository $repository): int
+    {
+        $filesystem->disk('local')->delete($repository->fullCachePath());
+
+        $this->outputComponents()->info('Json schemas cache cleared successfully!');
+
+        return static::SUCCESS;
+    }
+}

src/JsonSchemaRepository.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Contracts\Filesystem\Factory as FilesystemFactory;
 use Illuminate\Contracts\Filesystem\Filesystem;
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Str;
 use JsonException;
 use LogicException;
@@ -60,11 +61,20 @@ protected function disk(): Filesystem
         );
     }
 
+    final public function fullCachePath(): string
+    {
+        return App::bootstrapPath('cache/json_schemas.php');
+    }
+
     /**
      * @return array<string, string>
      */
     protected function findSchemaFiles(): array
     {
+        if ($this->filesystem->disk('local')->exists($path = $this->fullCachePath())) {
+            return include $path;
+        }
+
         // Grab files
         $files = $this->disk()->files(
             $directory = $this->getConfig('directory'),

src/ServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace DutchCodingCompany\LaravelJsonSchema;
 
+use DutchCodingCompany\LaravelJsonSchema\Commands;
 use DutchCodingCompany\LaravelJsonSchema\Contracts\JsonSchemaValidator;
 use Illuminate\Contracts\Filesystem\Factory as FilesystemFactory;
 use Illuminate\Support\ServiceProvider as LaravelServiceProvider;
@@ -30,6 +31,21 @@ public function register(): void
 
     public function bootForConsole(): void
     {
+        // Register commands
+        $this->commands([
+            Commands\Optimize::class,
+            Commands\OptimizeClear::class,
+        ]);
+
+        if (config('json-schema.auto-cache')) {
+            // When enabled, auto-cache json schema paths
+            $this->optimizes(
+                optimize: 'json-schema:optimize',
+                clear: 'json-schema:optimize-clear',
+                key: 'json-schema',
+            );
+        }
+
         $this->publishes([
             __DIR__.'/../config/json-schema.php' => config_path('json-schema.php'),
         ], 'json-schema.config');