Merge pull request #19 from DirectoryTree/make-metrics-table-command

Add `metrics:table` command to generate metric table migrations

Author: stevebauman

composer.json

@@ -11,6 +11,7 @@
     "require-dev": {
         "laravel/pint": "^1.0",
         "pestphp/pest": "^1.0|^2.0|^3.0",
+        "pestphp/pest-plugin-laravel": "^1.0|^2.0|^3.0",
         "orchestra/testbench": "^7.0|^8.0|^9.0|^10.0"
     },
     "license": "MIT",

src/Commands/MakeMetricsTable.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace DirectoryTree\Metrics\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Filesystem\Filesystem;
+
+class MakeMetricsTable extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'metrics:table {name : The name of the metrics table}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new metrics table migration';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(Filesystem $files): int
+    {
+        $table = $this->argument('name');
+
+        $this->writeMigration($files, $table);
+
+        $this->components->info(sprintf('Migration [%s] created successfully.', $this->getMigrationFileName($table)));
+
+        return self::SUCCESS;
+    }
+
+    /**
+     * Write the migration file to disk.
+     */
+    protected function writeMigration(Filesystem $files, string $table): void
+    {
+        $file = $this->getMigrationPath($table);
+
+        $files->ensureDirectoryExists(dirname($file));
+
+        $files->put($file, $this->populateStub($table));
+    }
+
+    /**
+     * Populate the stub with the table name.
+     */
+    protected function populateStub(string $table): string
+    {
+        $stub = $this->getStub();
+
+        return str_replace('{{ table }}', $table, $stub);
+    }
+
+    /**
+     * Get the migration file path.
+     */
+    protected function getMigrationPath(string $table): string
+    {
+        return database_path('migrations/'.$this->getMigrationFileName($table));
+    }
+
+    /**
+     * Get the migration file name.
+     */
+    protected function getMigrationFileName(string $table): string
+    {
+        return date('Y_m_d_His').'_create_'.$table.'_table.php';
+    }
+
+    /**
+     * Get the stub file contents.
+     */
+    protected function getStub(): string
+    {
+        return file_get_contents(__DIR__.'/../../stubs/metrics.table.stub');
+    }
+}

src/MetricServiceProvider.php

@@ -3,6 +3,7 @@
 namespace DirectoryTree\Metrics;
 
 use DirectoryTree\Metrics\Commands\CommitMetrics;
+use DirectoryTree\Metrics\Commands\MakeMetricsTable;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Queue;
@@ -36,7 +37,10 @@ public function register(): void
     public function boot(): void
     {
         if ($this->app->runningInConsole()) {
-            $this->commands(CommitMetrics::class);
+            $this->commands([
+                CommitMetrics::class,
+                MakeMetricsTable::class,
+            ]);
         }
 
         if ($this->app->make('config')->get('metrics.auto_commit', true)) {

stubs/metrics.table.stub

@@ -0,0 +1,38 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('{{ table }}', function (Blueprint $table) {
+            $table->id();
+            $table->string('name')->index();
+            $table->string('category')->nullable()->index();
+            $table->nullableMorphs('measurable');
+            $table->unsignedSmallInteger('year');
+            $table->unsignedTinyInteger('month');
+            $table->unsignedTinyInteger('day');
+            $table->unsignedTinyInteger('hour')->nullable();
+            $table->unsignedInteger('value');
+            $table->timestamps();
+
+            $table->index(['year', 'month', 'day', 'hour']);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('{{ table }}');
+    }
+};
+

tests/Commands/CommitMetricsTest.php

@@ -11,6 +11,8 @@
 use Illuminate\Support\Facades\Queue;
 use Illuminate\Support\Facades\Redis;
 
+use function Pest\Laravel\artisan;
+
 beforeEach(function () {
     Queue::fake();
     Redis::flushdb();
@@ -19,7 +21,7 @@
 });
 
 it('displays message when no metrics to commit', function () {
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('No metrics to commit.')
         ->assertSuccessful();
 
@@ -34,7 +36,7 @@
 
     expect(Metric::count())->toBe(0);
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 2 metric(s).')
         ->assertSuccessful();
 
@@ -52,7 +54,7 @@
     Metrics::record(new MetricData('page_views'));
     Metrics::record(new MetricData('api_calls'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 2 metric(s).')
         ->assertSuccessful();
 
@@ -65,7 +67,7 @@
     Metrics::capture();
     Metrics::record(new MetricData('page_views'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 1 metric(s).')
         ->assertSuccessful();
 
@@ -78,7 +80,7 @@
     Metrics::record(new MetricData('api_calls'));
     Metrics::record(new MetricData('logins'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 3 metric(s).')
         ->assertSuccessful();
 
@@ -89,13 +91,13 @@
     Metrics::capture();
     Metrics::record(new MetricData('page_views'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->assertSuccessful();
 
     expect(Metric::count())->toBe(1);
 
     // Running again should show no metrics
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('No metrics to commit.')
         ->assertSuccessful();
 
@@ -108,7 +110,7 @@
     Metrics::record(new MetricData('page_views', 'analytics'));
     Metrics::record(new MetricData('api_calls'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 3 metric(s).')
         ->assertSuccessful();
 
@@ -127,7 +129,7 @@
     Metrics::record(new MetricData('logins', measurable: $user2));
     Metrics::record(new MetricData('logins'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 3 metric(s).')
         ->assertSuccessful();
 
@@ -144,7 +146,7 @@
         Metrics::record(new MetricData('page_views'));
     }
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 1 metric(s).')
         ->assertSuccessful();
 
@@ -156,13 +158,13 @@
     Metrics::capture();
     Metrics::record(new MetricData('page_views'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 1 metric(s).')
         ->assertSuccessful();
 
     Metrics::record(new MetricData('api_calls'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 1 metric(s).')
         ->assertSuccessful();
 
@@ -173,7 +175,7 @@
     // Record without capturing
     Metrics::record(new MetricData('page_views'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('No metrics to commit.')
         ->assertSuccessful();
 
@@ -187,7 +189,7 @@
     Metrics::record(new MetricData('revenue', value: 250));
     Metrics::record(new MetricData('revenue', value: 50));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 1 metric(s).')
         ->assertSuccessful();
 
@@ -203,7 +205,7 @@
     Metrics::record(new MetricData('page_views', date: $today));
     Metrics::record(new MetricData('page_views', date: $yesterday));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 2 metric(s).')
         ->assertSuccessful();
 
@@ -217,7 +219,7 @@
     Metrics::capture();
     Metrics::record(new MetricData('page_views', 'marketing', value: 5, date: $date, measurable: $user));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 1 metric(s).')
         ->assertSuccessful();
 
@@ -242,7 +244,7 @@
     Metrics::record(new MetricData('page_views'));
     Metrics::record(new MetricData('api_calls'));
 
-    $this->artisan(CommitMetrics::class)
+    artisan(CommitMetrics::class)
         ->expectsOutput('Committed 2 metric(s).')
         ->assertSuccessful();