Added CSV Presentation

Author: nasrulhazim

config/db-doc.php

@@ -2,6 +2,7 @@
 
 // config for Bekwoh/LaravelDbDoc
 
+use Bekwoh\LaravelDbDoc\Presentation\Csv;
 use Bekwoh\LaravelDbDoc\Presentation\Json;
 use Bekwoh\LaravelDbDoc\Presentation\Markdown;
 
@@ -18,6 +19,11 @@
             'disk' => env('LARAVEL_DB_DOC_JSON_DISK', 'local'),
             'view' => null,
         ],
+        'csv' => [
+            'class' => Csv::class,
+            'disk' => env('LARAVEL_DB_DOC_CSV_DISK', 'local'),
+            'view' => null,
+        ],
     ],
     'middleware' => [
         'auth',

src/LaravelDbDoc.php

@@ -20,6 +20,15 @@ public static function routes()
                 ]);
             }
 
+            if ($format == 'csv') {
+                $filename = date('Ymd').self::filename($format);
+
+                return response($content, 200, [
+                    'Content-Type' => 'text/csv',
+                    'Content-Disposition' => 'attachment; filename="' . $filename . '"',
+                ]);
+            }
+
             return view('laravel-db-doc::markdown', [
                 'content' => Str::markdown(
                     $content
@@ -32,23 +41,27 @@ public static function routes()
 
     public static function content($format)
     {
-        throw_if(! in_array($format, ['json', 'markdown']));
+        throw_if(! in_array($format, ['json', 'markdown', 'csv']));
 
         return Storage::disk(self::disk($format))->get(self::filename($format));
     }
 
     public static function disk($format)
     {
-        throw_if(! in_array($format, ['json', 'markdown']));
+        throw_if(! in_array($format, ['json', 'markdown', 'csv']));
 
         return config("db-doc.presentations.$format.disk");
     }
 
     public static function filename($format)
     {
-        throw_if(! in_array($format, ['json', 'markdown']));
+        throw_if(! in_array($format, ['json', 'markdown', 'csv']));
 
-        $extension = $format != 'markdown' ? 'json' : 'md';
+        $extension = match ($format) {
+             'markdown' => 'md',
+             'csv' => 'csv',
+             default => 'json',
+        };
 
         return config('app.name')." Database Schema.$extension";
     }

src/Presentation/Csv.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Bekwoh\LaravelDbDoc\Presentation;
+
+use Bekwoh\LaravelDbDoc\Contracts\Presenter;
+use Illuminate\Support\Str;
+
+class Csv extends AbstractPresenter implements Presenter
+{
+    public static function make(array $contents): self
+    {
+        return new self($contents);
+    }
+
+    public function getContents()
+    {
+        $contents = $this->contents;
+        $output = [];
+
+        foreach ($contents as $table => $properties) {
+
+            $output[] = $table;
+            $output[] = 'Column,Type,Length,Default,Nullable,Comment';
+            foreach ($properties as $key => $value) {
+                $fields = [];
+                foreach ($value as $k => $v) {
+                    $fields[] = "{$v}";
+                }
+                $output[] = implode(',', $fields);
+            }
+            $output[] = PHP_EOL;
+        }
+
+        $schema = implode('', $output);
+        $stub = $this->getStub();
+        $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;
+
+        return str_replace([
+            'APP_NAME',
+            'DB_CONNECTION', 'DB_HOST', 'DB_PORT', 'DB_DATABASE',
+            'SCHEMA_CONTENT',
+        ], [
+            config('app.name'),
+            $this->connection, $host, $port, $database_config['database'],
+            $schema,
+        ], $stub);
+    }
+}

tests/LaravelDbDocTest.php

@@ -27,6 +27,15 @@
     );
 });
 
+it('can generate db doc schema - csv', function () {
+    Artisan::call('db:schema --format=csv');
+
+    $this->assertTrue(
+        Storage::disk(LaravelDbDoc::disk('csv'))
+            ->exists(LaravelDbDoc::filename('csv'))
+    );
+});
+
 it('has doc/db-schema route', function () {
     $this->assertTrue(
         Route::has('doc.db-schema')