Merge branch 'main' of https://github.com/JhumanJ/laravel-model-stats

JhumanJ · Apr 29, 2022 · 666d259 · 666d259
2 parents 96961ac + 14b64e7
commit 666d259
Show file tree

Hide file tree

Showing 24 changed files with 199 additions and 174 deletions.
diff --git a/config/model-stats.php b/config/model-stats.php
@@ -16,8 +16,8 @@
     |
     */
 
-    'enabled' => env('MODEL_STATS_ENABLED', true),
-    'allow_custom_code' => env('MODEL_STATS_CUSTOM_CODE', true),
+    'enabled'            => env('MODEL_STATS_ENABLED', true),
+    'allow_custom_code'  => env('MODEL_STATS_CUSTOM_CODE', true),
 
     /*
     |--------------------------------------------------------------------------
@@ -29,20 +29,31 @@
     | the existing middleware. Or, you can simply stick with this list.
     |
     */
-    'middleware' => [
+    'middleware'         => [
         'web',
         \Jhumanj\LaravelModelStats\Http\Middleware\Authorize::class,
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | ModelStats table name
+    |--------------------------------------------------------------------------
+    |
+    | As PostgreSQL table names seems to use dashes instead of underscore
+    | this configures the table name based on your connection.
+    |
+    */
+    'table_name'         => 'model_stats_dashboards',
+
     /*
     |--------------------------------------------------------------------------
     | Route Prefixes
     |--------------------------------------------------------------------------
     |
-    | You can change the route where your dashboards are. By default routes will
+    | You can change the route where your dashboards are. By default, routes will
     | be starting the '/stats' prefix, and names will start with 'stats.'.
     |
     */
-    'routes_prefix' => 'stats',
+    'routes_prefix'      => 'stats',
     'route_names_prefix' => 'stats.',
 ];
diff --git a/database/factories/DashboardFactory.php b/database/factories/DashboardFactory.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Jhumanj\LaravelModelStats\Database\Factories;
+
+use Jhumanj\LaravelModelStats\Models\Dashboard;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class DashboardFactory extends Factory
+{
+    protected $model = Dashboard::class;
+
+    public function definition(): array
+    {
+        return [
+            'name'        => $this->faker->name,
+            'description' => $this->faker->sentence,
+            'body'        => '{"widgets":[]}',
+        ];
+    }
+}
diff --git a/database/factories/ModelFactory.php b/database/factories/ModelFactory.php
diff --git a/database/migrations/create_model-stats_table.php b/database/migrations/create_model-stats_table.php
@@ -1,24 +1,29 @@
 <?php
 
+use Illuminate\Support\Facades\Config;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
-    public function up()
+return new class extends Migration {
+
+    public function up(): void
     {
-        Schema::create('model-stats-dashboards', function (Blueprint $table) {
+        Schema::create(Config::get('model-stats.table_name'), function (Blueprint $table) {
             $table->id();
             $table->string('name');
             $table->text('description');
-            $table->jsonb('body')->default('{"widgets":[]}');
+            if (Config::get('database.defaults') === 'pgsql') {
+                $table->jsonb('body')->default('{"widgets":[]}');
+            } else {
+                $table->json('body');
+            }
             $table->timestamps();
         });
     }
 
-    public function down()
+    public function down(): void
     {
-        Schema::dropIfExists('model-stats-dashboards');
+        Schema::dropIfExists(Config::get('model-stats.table_name'));
     }
 };
diff --git a/src/AuthorizesRequests.php b/src/AuthorizesRequests.php
@@ -1,24 +1,27 @@
 <?php
 
-
 namespace Jhumanj\LaravelModelStats;
 
+use Closure;
+use Illuminate\Http\Request;
+
 trait AuthorizesRequests
 {
     /**
      * The callback that should be used to authenticate ModelStats users.
      *
      * @var \Closure
      */
-    public static $authUsing;
+    public static Closure $authUsing;
 
     /**
      * Register the ModelStats authentication callback.
      *
-     * @param  \Closure  $callback
+     * @param \Closure $callback
+     *
      * @return static
      */
-    public static function auth($callback)
+    public static function auth(Closure $callback): static
     {
         static::$authUsing = $callback;
 
@@ -28,13 +31,12 @@ public static function auth($callback)
     /**
      * Determine if the given request can access the ModelStats dashboard.
      *
-     * @param  \Illuminate\Http\Request  $request
+     * @param \Illuminate\Http\Request $request
+     *
      * @return bool
      */
-    public static function check($request)
+    public static function check(Request $request): bool
     {
-        return (static::$authUsing ?: function () {
-            return app()->environment('local');
-        })($request);
+        return (static::$authUsing ?: fn () => app()->environment('local'))($request);
     }
 }
diff --git a/src/Console/InstallModelStatsPackage.php b/src/Console/InstallModelStatsPackage.php
@@ -12,7 +12,7 @@ class InstallModelStatsPackage extends Command
 
     protected $description = 'Install the ModelStatsPackage';
 
-    public function handle()
+    public function handle(): void
     {
         $this->info('Installing ModelStats package...');
 
@@ -35,7 +35,7 @@ public function handle()
      *
      * @return void
      */
-    private function registerModelStatsServiceProvider()
+    private function registerModelStatsServiceProvider(): void
     {
         $namespace = Str::replaceLast('\\', '', $this->laravel->getNamespace());
 

diff --git a/src/Console/PublishCommand.php b/src/Console/PublishCommand.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Jhumanj\LaravelModelStats\Console;
 
 use Illuminate\Console\Command;
@@ -11,7 +10,7 @@ class PublishCommand extends Command
 
     protected $description = 'Publish all of the ModelStats resources';
 
-    public function handle()
+    public function handle(): void
     {
         $this->call('vendor:publish', [
             '--tag' => 'model-stats-config',

diff --git a/src/Http/Controllers/Controller.php b/src/Http/Controllers/Controller.php
@@ -1,25 +1,25 @@
 <?php
 
-
 namespace Jhumanj\LaravelModelStats\Http\Controllers;
 
 use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
 use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Routing\Controller as BaseController;
 
 class Controller extends BaseController
 {
     use ValidatesRequests;
     use AuthorizesRequests;
 
-    public function success($data = [])
+    public function success($data = []): JsonResponse
     {
         return response()->json(array_merge([
             'type' => 'success',
         ], $data));
     }
 
-    public function error($data = [], $statusCode = 400)
+    public function error($data = [], $statusCode = 400): JsonResponse
     {
         return response()->json(array_merge([
             'type' => 'error',

diff --git a/src/Http/Controllers/CustomCodeController.php b/src/Http/Controllers/CustomCodeController.php
@@ -3,14 +3,15 @@
 namespace Jhumanj\LaravelModelStats\Http\Controllers;
 
 use Carbon\Carbon;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Validation\Rule;
 use Jhumanj\LaravelModelStats\Http\Middleware\CustomCodeEnabled;
 use Jhumanj\LaravelModelStats\Services\Tinker;
 
 class CustomCodeController extends Controller
 {
-    const CHART_TYPES = ['line_chart', 'bar_chart'];
+    public const CHART_TYPES = ['line_chart', 'bar_chart'];
 
     public function __construct()
     {
@@ -20,7 +21,7 @@ public function __construct()
     /**
      * Endpoint used to test customCode when creating widgets.
      */
-    public function executeCustomCode(Request $request, Tinker $tinker)
+    public function executeCustomCode(Request $request, Tinker $tinker): JsonResponse
     {
         $validated = $request->validate([
             'code' => 'required',
@@ -35,10 +36,8 @@ public function executeCustomCode(Request $request, Tinker $tinker)
         return $this->success([
             'output' => $result,
             'code_executed' => $codeExecuted,
-            'valid_output' => $codeExecuted ? $this->isValidOutput(
-                $request->chart_type,
-                $tinker->getCustomCodeResult()
-            ) : false,
+            'valid_output' => $codeExecuted
+                              && $this->isValidOutput($request->get('chart_type'), $tinker->getCustomCodeResult()),
         ]);
     }
 
@@ -51,8 +50,8 @@ public function widgetData(Request $request, Tinker $tinker)
             'date_to' => 'required|date_format:Y-m-d|after:date_from',
         ]);
 
-        $dateFrom = Carbon::createFromFormat('Y-m-d', $request->date_from);
-        $dateTo = Carbon::createFromFormat('Y-m-d', $request->date_to);
+        $dateFrom = Carbon::createFromFormat('Y-m-d', $request->get('date_from'));
+        $dateTo = Carbon::createFromFormat('Y-m-d', $request->get('date_to'));
 
         $result = $tinker->injectDates($dateFrom, $dateTo)
             ->readonly()
@@ -61,33 +60,28 @@ public function widgetData(Request $request, Tinker $tinker)
         $codeExecuted = $tinker->lastExecSuccess();
         $dataResult = $tinker->getCustomCodeResult();
 
-        if ($codeExecuted && $this->isValidOutput($request->chart_type, $dataResult)) {
+        if ($codeExecuted && $this->isValidOutput($request->get('chart_type'), $dataResult)) {
             return $tinker->getCustomCodeResult();
-        } else {
-            return $this->error([
-                'output' => $result,
-                'code_executed' => $codeExecuted,
-                'valid_output' => $codeExecuted ? $this->isValidOutput(
-                    $request->chart_type,
-                    $tinker->getCustomCodeResult()
-                ) : false,
-            ]);
         }
+
+        return $this->error([
+            'output' => $result,
+            'code_executed' => $codeExecuted,
+            'valid_output' => $codeExecuted
+                              && $this->isValidOutput($request->get('chart_type'), $tinker->getCustomCodeResult()),
+        ]);
     }
 
-    private function isValidOutput(string $chartType, $data)
+    private function isValidOutput(string $chartType, $data): bool
     {
-        switch ($chartType) {
-            case 'bar_chart':
-                return $this->validateBarChartData($data);
-            case 'line_chart':
-                return $this->validateLineChartData($data);
-        }
-
-        return false;
+        return match ($chartType) {
+            'bar_chart' => $this->validateBarChartData($data),
+            'line_chart' => $this->validateLineChartData($data),
+            default => false,
+        };
     }
 
-    private function validateBarChartData($data)
+    private function validateBarChartData($data): bool
     {
         if (! is_array($data)) {
             return false;
@@ -101,7 +95,7 @@ private function validateBarChartData($data)
         return true;
     }
 
-    private function validateLineChartData($data)
+    private function validateLineChartData($data): bool
     {
         if (! is_array($data)) {
             return false;

diff --git a/src/Http/Controllers/DashboardController.php b/src/Http/Controllers/DashboardController.php
@@ -2,35 +2,39 @@
 
 namespace Jhumanj\LaravelModelStats\Http\Controllers;
 
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Http\JsonResponse;
 use Jhumanj\LaravelModelStats\Http\Requests\Dashboard\StoreRequest;
 use Jhumanj\LaravelModelStats\Http\Requests\Dashboard\UpdateRequest;
 use Jhumanj\LaravelModelStats\Models\Dashboard;
 
 class DashboardController extends Controller
 {
-    public function index()
+    public function index(): Collection|array
     {
         return Dashboard::all();
     }
 
-    public function show(Dashboard $dashboard)
+    public function show(Dashboard $dashboard): Dashboard
     {
         return $dashboard;
     }
 
-    public function store(StoreRequest $request)
+    public function store(StoreRequest $request): Model|Builder
     {
-        return Dashboard::create($request->validated());
+        return Dashboard::query()->create($request->validated());
     }
 
-    public function update(Dashboard $dashboard, UpdateRequest $request)
+    public function update(Dashboard $dashboard, UpdateRequest $request): Dashboard
     {
         $dashboard->update($request->validated());
 
         return $dashboard;
     }
 
-    public function destroy(Dashboard $dashboard)
+    public function destroy(Dashboard $dashboard): JsonResponse
     {
         $dashboard->delete();