Update

Author: nasrulhazim

composer.json

@@ -17,8 +17,9 @@
     ],
     "require": {
         "php": "^8.1",
-        "spatie/laravel-package-tools": "^1.13.0",
-        "illuminate/contracts": "^9.0"
+        "doctrine/dbal": "^3.4",
+        "illuminate/contracts": "^9.0",
+        "spatie/laravel-package-tools": "^1.13.0"
     },
     "require-dev": {
         "laravel/pint": "^1.0",
@@ -68,4 +69,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

src/Commands/LaravelDbDocCommand.php

@@ -12,7 +12,7 @@ class LaravelDbDocCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'db:schema {--database=} {--format=md} {--path=} {--emoji}';
+    protected $signature = 'db:schema {--database=} {--format=markdown}';
 
     /**
      * The console command description.

src/Contracts/Presenter.php

@@ -17,4 +17,6 @@ public function getStub();
     public function write();
 
     public function read();
+
+    public function connection(string $connection): self;
 }

src/LaravelDbDoc.php

@@ -2,6 +2,7 @@
 
 namespace Bekwoh\LaravelDbDoc;
 
+use Illuminate\Support\Facades\Gate;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Facades\Storage;
 use Illuminate\Support\Str;
@@ -12,15 +13,11 @@ public static function routes()
     {
         if (app()->environment() != 'production') {
             Route::get('doc/db-schema', function () {
-                $format = request()->query('format', 'markdown');
+                // Todo: define role
 
-                $filename = self::filename($format);
+                $format = request()->query('format', 'markdown');
                 $content = self::content($format);
 
-                $filepath = config('database.doc_schema_path').DIRECTORY_SEPARATOR.$filename;
-
-                abort_if(! file_exists($filepath), 404, 'Database schema document not yet generated. Do run php artisan db:schema to generate the schema document.');
-
                 if ($format == 'json') {
                     return response()->json([
                         'content' => json_decode($content),
@@ -32,7 +29,7 @@ public static function routes()
                         $content
                     ),
                 ]);
-            });
+            })->middleware('auth', 'verified')->name('doc.db-schema');
         }
     }
 
@@ -58,11 +55,4 @@ public static function filename($format)
 
         return config('app.name')." Database Schema.$extension";
     }
-
-    public static function view($format)
-    {
-        throw_if(! in_array($format, ['json', 'markdown']));
-
-        return config("db-doc.presentations.$format.view");
-    }
 }

src/LaravelDbDocServiceProvider.php

@@ -3,6 +3,7 @@
 namespace Bekwoh\LaravelDbDoc;
 
 use Bekwoh\LaravelDbDoc\Commands\LaravelDbDocCommand;
+use Bekwoh\LaravelDbDoc\Facades\LaravelDbDoc;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -21,4 +22,9 @@ public function configurePackage(Package $package): void
             ->hasViews()
             ->hasCommand(LaravelDbDocCommand::class);
     }
+
+    public function bootingPackage()
+    {
+        LaravelDbDoc::routes();
+    }
 }

src/Presentation/AbstractPresenter.php

@@ -8,32 +8,31 @@
 
 abstract class AbstractPresenter implements Presenter
 {
+    protected string $connection;
+
     abstract public function getContents();
 
     public function __construct(protected array $contents)
     {
     }
 
-    public static function make(array $contents): self
-    {
-        return new self($contents);
-    }
-
     public function getDisk()
     {
-        return LaravelDbDoc::disk(strtolower(basename(__CLASS__)));
+        return LaravelDbDoc::disk(strtolower(class_basename($this)));
     }
 
     public function getFilename()
     {
-        return LaravelDbDoc::filename(strtolower(basename(__CLASS__)));
+        return LaravelDbDoc::filename(strtolower(class_basename($this)));
     }
 
     public function getStub()
     {
-        return file_get_contents(
+        $path = file_exists(
             base_path('stubs/db-doc.stub')
-        );
+        ) ? base_path('stubs/db-doc.stub') : __DIR__ . '/../../stubs/db-doc.stub';
+
+        return file_get_contents($path);
     }
 
     public function write()
@@ -50,4 +49,11 @@ public function read()
         return Storage::disk($this->getDisk())
             ->get($this->getFilename());
     }
+
+    public function connection(string $connection): self
+    {
+        $this->connection = $connection;
+
+        return $this;
+    }
 }

src/Presentation/Json.php

@@ -6,6 +6,11 @@
 
 class Json extends AbstractPresenter implements Presenter
 {
+    public static function make(array $contents): self
+    {
+        return new self($contents);
+    }
+    
     public function getContents()
     {
         return json_encode($this->contents, JSON_PRETTY_PRINT);

src/Presentation/Markdown.php

@@ -7,6 +7,11 @@
 
 class Markdown extends AbstractPresenter implements Presenter
 {
+    public static function make(array $contents): self
+    {
+        return new self($contents);
+    }
+    
     public function getContents()
     {
         $contents = $this->contents;
@@ -28,7 +33,7 @@ public function getContents()
 
         $schema = implode('', $output);
         $stub = $this->getStub();
-        $database_config = config('database.connections.'.$this->database_connection);
+        $database_config = config('database.connections.'.$this->connection);
         $host = isset($database_config['host']) ? $database_config['host'] : null;
         $port = isset($database_config['port']) ? $database_config['port'] : null;
 
@@ -38,7 +43,7 @@ public function getContents()
             'SCHEMA_CONTENT',
         ], [
             config('app.name'),
-            $this->database_connection, $host, $port, $database_config['database'],
+            $this->connection, $host, $port, $database_config['database'],
             $schema,
         ], $stub);
     }

src/Processor.php

@@ -10,7 +10,7 @@ class Processor
 {
     protected array $data;
 
-    protected Presenter $presenter;
+    protected string $presenter;
 
     public function __construct()
     {
@@ -36,15 +36,19 @@ public function process()
 
     public function render()
     {
-        $this->presenter::make($this->data)->write();
+        throw_if(! in_array(Presenter::class, class_implements($this->presenter)));
+
+        $this->presenter::make($this->data)
+            ->connection($this->database_connection)
+            ->write();
     }
 
     public function connect(string $connection, string $format): self
     {
         $this->database_connection = $connection;
         $this->presenter = config('db-doc.presentations.'.$format.'.class');
 
-        throw_if(! class_exists($this->format), 'RuntimeException', "$this->format not exists.");
+        throw_if(! class_exists($this->presenter), 'RuntimeException', "$this->presenter not exists.");
 
         $this->connection = DB::connection($this->database_connection)->getDoctrineConnection();
         $this->schema = $this->connection->getSchemaManager();

tests/LaravelDbDocTest.php

@@ -1,7 +1,34 @@
 <?php
 
+use Bekwoh\LaravelDbDoc\Facades\LaravelDbDoc;
 use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Route;
+use Illuminate\Support\Facades\Storage;
 
 it('has db:schema command', function () {
     $this->assertTrue(in_array('db:schema', array_keys(Artisan::all())));
 });
+
+it('can generate db doc schema - markdown', function () {
+    Artisan::call('db:schema');
+    
+    $this->assertTrue(
+        Storage::disk(LaravelDbDoc::disk('markdown'))
+            ->exists(LaravelDbDoc::filename('markdown'))
+    );
+});
+
+it('can generate db doc schema - json', function () {
+    Artisan::call('db:schema --format=json');
+    
+    $this->assertTrue(
+        Storage::disk(LaravelDbDoc::disk('json'))
+            ->exists(LaravelDbDoc::filename('json'))
+    );
+});
+
+it('has doc/db-schema route', function () {
+    $this->assertTrue(
+        Route::has('doc.db-schema')
+    );
+});