Merge branch '2.0' of https://github.com/codestudiohq/laravel-totem into 2.0

qschmick · qschmick · commit 96f13abf35a5 · 2017-11-14T22:56:26.000-05:00
diff --git a/README.md b/README.md
@@ -50,6 +50,10 @@ php artisan migrate
 php artisan totem:assets
 ```
 
+##### Table Prefix
+
+Totems' tables use generic names which may conflict with existing tables in a project. To alleviate this the `.env` param `TOTEM_TABLE_PREFIX` can be set which will apply a prefix to all of Totems tables and their models.
+
 #### Updating
 
 Please republish totem assets after updating totem to a new version
@@ -83,6 +87,22 @@ Totem::auth(function($request) {
 
 By default Totem's dashboard only works in local environment. To view the dashboard point your browser to /totem of your app. For e.g. laravel.dev/totem.
 
+##### Filter Commands Dropdown
+
+By default `Totem` outputs all Artisan commands on the Create/Edit tasks. To make this dropdown more concise there is a filter config feature that can be set in the `totem.php` config file.
+
+Example filters
+```php
+'artisan' => [
+    'command_filter' => [
+        'stats:*',
+        'email:daily-reports'
+    ],
+],
+```
+
+This feature uses [fnmatch](http://php.net/manual/en/function.fnmatch.php) syntax to filter displayed commands. `stats:*` will match all Artisan commands that start with `stats:` while `email:daily-reports` will only match the command named `email:daily-reports`.
+
 #### Middleware
 
 `Laravel Totem` uses the default web and api middleware but if customization is required the middleware can be changed by setting the appropriate `.env` value. These values can be found in `config/totem.php`.
diff --git a/config/totem.php b/config/totem.php
@@ -222,4 +222,8 @@
     'api' => [
         'middleware' => env('TOTEM_API_MIDDLEWARE', 'api'),
     ],
+    'table_prefix' => env('TOTEM_TABLE_PREFIX', ''),
+    'artisan' => [
+        'command_filter' => [],
+    ],
 ];
diff --git a/database/factories/ModelFactory.php b/database/factories/ModelFactory.php
@@ -32,3 +32,14 @@
         'expression'   => '* * * * *',
     ];
 });
+
+$factory->define(Studio\Totem\Result::class, function (Faker\Generator $faker) {
+    return [
+        'task_id'     => $faker->randomDigit,
+        'ran_at'      => $faker->dateTimeBetween('-1 hour'),
+        'duration'    => (string) $faker->randomFloat(11, 0, 8000000),
+        'result'      => $faker->sentence,
+        'created_at'  => $faker->dateTimeBetween('-1 year', '-6 months'),
+        'updated_at'  => $faker->dateTimeBetween('-6 months'),
+    ];
+});
diff --git a/database/migrations/2017_08_05_194349_create_tasks_table.php b/database/migrations/2017_08_05_194349_create_tasks_table.php
@@ -13,7 +13,7 @@ class CreateTasksTable extends Migration
      */
     public function up()
     {
-        Schema::create('tasks', function (Blueprint $table) {
+        Schema::create(config('totem.table_prefix').'tasks', function (Blueprint $table) {
             $table->increments('id');
             $table->string('description');
             $table->string('command');
@@ -35,6 +35,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('tasks');
+        Schema::dropIfExists(config('totem.table_prefix').'tasks');
     }
 }
diff --git a/database/migrations/2017_08_05_195539_create_task_frequencies_table.php b/database/migrations/2017_08_05_195539_create_task_frequencies_table.php
@@ -13,7 +13,7 @@ class CreateTaskFrequenciesTable extends Migration
      */
     public function up()
     {
-        Schema::create('task_frequencies', function (Blueprint $table) {
+        Schema::create(config('totem.table_prefix').'task_frequencies', function (Blueprint $table) {
             $table->increments('id');
             $table->unsignedInteger('task_id');
             $table->string('label');
@@ -29,6 +29,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('task_frequencies');
+        Schema::dropIfExists(config('totem.table_prefix').'task_frequencies');
     }
 }
diff --git a/database/migrations/2017_08_05_201914_create_task_results_table.php b/database/migrations/2017_08_05_201914_create_task_results_table.php
@@ -13,7 +13,7 @@ class CreateTaskResultsTable extends Migration
      */
     public function up()
     {
-        Schema::create('task_results', function (Blueprint $table) {
+        Schema::create(config('totem.table_prefix').'task_results', function (Blueprint $table) {
             $table->increments('id');
             $table->unsignedInteger('task_id');
             $table->timestamp('ran_at')->useCurrent();
@@ -30,6 +30,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('task_results');
+        Schema::dropIfExists(config('totem.table_prefix').'task_results');
     }
 }
diff --git a/database/migrations/2017_08_24_085132_create_frequency_parameters_table.php b/database/migrations/2017_08_24_085132_create_frequency_parameters_table.php
@@ -13,7 +13,7 @@ class CreateFrequencyParametersTable extends Migration
      */
     public function up()
     {
-        Schema::create('frequency_parameters', function (Blueprint $table) {
+        Schema::create(config('totem.table_prefix').'frequency_parameters', function (Blueprint $table) {
             $table->increments('id');
             $table->unsignedInteger('frequency_id');
             $table->string('name');
@@ -29,6 +29,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('frequency_parameters');
+        Schema::dropIfExists(config('totem.table_prefix').'frequency_parameters');
     }
 }
diff --git a/database/migrations/2017_08_26_083622_alter_tasks_table_add_notifications_fields.php b/database/migrations/2017_08_26_083622_alter_tasks_table_add_notifications_fields.php
@@ -13,7 +13,7 @@ class AlterTasksTableAddNotificationsFields extends Migration
      */
     public function up()
     {
-        Schema::table('tasks', function (Blueprint $table) {
+        Schema::table(config('totem.table_prefix').'tasks', function (Blueprint $table) {
             $table->string('notification_phone_number')->nullable()->after('notification_email_address');
             $table->string('notification_slack_webhook')->nullable()->after('notification_phone_number');
         });
@@ -26,11 +26,11 @@ public function up()
      */
     public function down()
     {
-        Schema::table('tasks', function (Blueprint $table) {
+        Schema::table(config('totem.table_prefix').'tasks', function (Blueprint $table) {
             $table->dropColumn('notification_phone_number');
         });
 
-        Schema::table('tasks', function (Blueprint $table) {
+        Schema::table(config('totem.table_prefix').'tasks', function (Blueprint $table) {
             $table->dropColumn('notification_slack_webhook');
         });
     }
diff --git a/resources/views/tasks/index.blade.php b/resources/views/tasks/index.blade.php
@@ -36,10 +36,10 @@
                         <span class="uk-float-right uk-hidden@s uk-text-muted">Command</span>
                     </td>
                     <td>
-                        {{  $task->results->count() > 0 ? number_format(  $task->results->sum('duration') / (1000 * $task->results->count()) , 2) : '0' }} seconds
+                        {{ number_format(  $task->averageRuntime / 1000 , 2 ) }} seconds
                         <span class="uk-float-right uk-hidden@s uk-text-muted">Avg. Runtime</span>
                     </td>
-                    @if($last = $task->results->last())
+                    @if($last = $task->lastResult)
                         <td>
                             {{$last->ran_at->toDateTimeString()}}
                             <span class="uk-float-right uk-hidden@s uk-text-muted">Last Run</span>
diff --git a/src/Frequency.php b/src/Frequency.php
@@ -3,9 +3,8 @@
 namespace Studio\Totem;
 
 use Studio\Totem\Traits\HasParameters;
-use Illuminate\Database\Eloquent\Model;
 
-class Frequency extends Model
+class Frequency extends TotemModel
 {
     use HasParameters;
 
diff --git a/src/Http/Controllers/TasksController.php b/src/Http/Controllers/TasksController.php
@@ -4,7 +4,6 @@
 
 use Studio\Totem\Task;
 use Studio\Totem\Totem;
-use Illuminate\Support\Facades\Artisan;
 use Studio\Totem\Contracts\TaskInterface;
 use Studio\Totem\Http\Requests\TaskRequest;
 
@@ -48,9 +47,7 @@ public function create()
     {
         return view('totem::tasks.form', [
             'task'          => new Task,
-            'commands'      => collect(Artisan::all())->sortBy(function ($command) {
-                return $command->getDescription();
-            }),
+            'commands'      => Totem::getCommands(),
             'timezones'     => timezone_identifiers_list(),
             'frequencies'   => Totem::frequencies(),
         ]);
@@ -94,9 +91,7 @@ public function edit($task)
     {
         return view('totem::tasks.form', [
             'task'          => $task,
-            'commands'      => collect(Artisan::all())->sortBy(function ($command) {
-                return $command->getDescription();
-            }),
+            'commands'      => Totem::getCommands(),
             'timezones'     => timezone_identifiers_list(),
             'frequencies'   => Totem::frequencies(),
         ]);
diff --git a/src/Parameter.php b/src/Parameter.php
@@ -2,9 +2,7 @@
 
 namespace Studio\Totem;
 
-use Illuminate\Database\Eloquent\Model;
-
-class Parameter extends Model
+class Parameter extends TotemModel
 {
     protected $table = 'frequency_parameters';
 
diff --git a/src/Result.php b/src/Result.php
@@ -2,9 +2,7 @@
 
 namespace Studio\Totem;
 
-use Illuminate\Database\Eloquent\Model;
-
-class Result extends Model
+class Result extends TotemModel
 {
     protected $table = 'task_results';
 
diff --git a/src/Task.php b/src/Task.php
@@ -3,11 +3,10 @@
 namespace Studio\Totem;
 
 use Cron\CronExpression;
-use Illuminate\Database\Eloquent\Model;
 use Studio\Totem\Traits\HasFrequencies;
 use Illuminate\Notifications\Notifiable;
 
-class Task extends Model
+class Task extends TotemModel
 {
     use Notifiable, HasFrequencies;
 
@@ -96,6 +95,24 @@ public function results()
         return $this->hasMany(Result::class, 'task_id', 'id');
     }
 
+    /**
+     * Returns the most recent result entry for this task.
+     *
+     * @return Model|null
+     */
+    public function getLastResultAttribute()
+    {
+        return $this->results()->orderBy('id', 'desc')->first();
+    }
+
+    /**
+     * @return float
+     */
+    public function getAverageRuntimeAttribute()
+    {
+        return $this->results()->avg('duration') ?? 0.00;
+    }
+
     /**
      * Route notifications for the mail channel.
      *
diff --git a/src/Totem.php b/src/Totem.php
@@ -3,6 +3,7 @@
 namespace Studio\Totem;
 
 use Closure;
+use Illuminate\Support\Facades\Artisan;
 
 class Totem
 {
@@ -48,4 +49,31 @@ public static function frequencies()
     {
         return config('totem.frequencies');
     }
+
+    /**
+     * Return collection of Artisan commands filtered if needed.
+     *
+     * @return \Illuminate\Support\Collection
+     */
+    public static function getCommands()
+    {
+        $command_filter = config('totem.artisan.command_filter');
+        $all_commands = collect(Artisan::all());
+
+        if (! empty($command_filter)) {
+            $all_commands = $all_commands->filter(function ($command) use ($command_filter) {
+                foreach ($command_filter as $filter) {
+                    if (fnmatch($filter, $command->getName())) {
+                        return true;
+                    }
+                }
+
+                return false;
+            });
+        }
+
+        return $all_commands->sortBy(function ($command) {
+            return $command->getDescription();
+        });
+    }
 }
diff --git a/src/TotemModel.php b/src/TotemModel.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Studio\Totem;
+
+use Illuminate\Database\Eloquent\Model;
+
+class TotemModel extends Model
+{
+    /**
+     * @return mixed
+     */
+    public function getTable()
+    {
+        return config('totem.table_prefix').parent::getTable();
+    }
+}
diff --git a/tests/Feature/ViewDashboardTest.php b/tests/Feature/ViewDashboardTest.php

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class CreateTasksTable extends Migration`
`13`	`13`	`*/`
`14`	`14`	`public function up()`
`15`	`15`	`{`
`16`		`- Schema::create('tasks', function (Blueprint $table) {`
	`16`	`+ Schema::create(config('totem.table_prefix').'tasks', function (Blueprint $table) {`
`17`	`17`	`$table->increments('id');`
`18`	`18`	`$table->string('description');`
`19`	`19`	`$table->string('command');`
`@@ -35,6 +35,6 @@ public function up()`
`35`	`35`	`*/`
`36`	`36`	`public function down()`
`37`	`37`	`{`
`38`		`- Schema::dropIfExists('tasks');`
	`38`	`+ Schema::dropIfExists(config('totem.table_prefix').'tasks');`
`39`	`39`	`}`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class CreateTaskFrequenciesTable extends Migration`
`13`	`13`	`*/`
`14`	`14`	`public function up()`
`15`	`15`	`{`
`16`		`- Schema::create('task_frequencies', function (Blueprint $table) {`
	`16`	`+ Schema::create(config('totem.table_prefix').'task_frequencies', function (Blueprint $table) {`
`17`	`17`	`$table->increments('id');`
`18`	`18`	`$table->unsignedInteger('task_id');`
`19`	`19`	`$table->string('label');`
`@@ -29,6 +29,6 @@ public function up()`
`29`	`29`	`*/`
`30`	`30`	`public function down()`
`31`	`31`	`{`
`32`		`- Schema::dropIfExists('task_frequencies');`
	`32`	`+ Schema::dropIfExists(config('totem.table_prefix').'task_frequencies');`
`33`	`33`	`}`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class CreateTaskResultsTable extends Migration`
`13`	`13`	`*/`
`14`	`14`	`public function up()`
`15`	`15`	`{`
`16`		`- Schema::create('task_results', function (Blueprint $table) {`
	`16`	`+ Schema::create(config('totem.table_prefix').'task_results', function (Blueprint $table) {`
`17`	`17`	`$table->increments('id');`
`18`	`18`	`$table->unsignedInteger('task_id');`
`19`	`19`	`$table->timestamp('ran_at')->useCurrent();`
`@@ -30,6 +30,6 @@ public function up()`
`30`	`30`	`*/`
`31`	`31`	`public function down()`
`32`	`32`	`{`
`33`		`- Schema::dropIfExists('task_results');`
	`33`	`+ Schema::dropIfExists(config('totem.table_prefix').'task_results');`
`34`	`34`	`}`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class CreateFrequencyParametersTable extends Migration`
`13`	`13`	`*/`
`14`	`14`	`public function up()`
`15`	`15`	`{`
`16`		`- Schema::create('frequency_parameters', function (Blueprint $table) {`
	`16`	`+ Schema::create(config('totem.table_prefix').'frequency_parameters', function (Blueprint $table) {`
`17`	`17`	`$table->increments('id');`
`18`	`18`	`$table->unsignedInteger('frequency_id');`
`19`	`19`	`$table->string('name');`
`@@ -29,6 +29,6 @@ public function up()`
`29`	`29`	`*/`
`30`	`30`	`public function down()`
`31`	`31`	`{`
`32`		`- Schema::dropIfExists('frequency_parameters');`
	`32`	`+ Schema::dropIfExists(config('totem.table_prefix').'frequency_parameters');`
`33`	`33`	`}`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,8 @@`
`3`	`3`	`namespace Studio\Totem;`
`4`	`4`
`5`	`5`	`use Studio\Totem\Traits\HasParameters;`
`6`		`-use Illuminate\Database\Eloquent\Model;`
`7`	`6`
`8`		`-class Frequency extends Model`
	`7`	`+class Frequency extends TotemModel`
`9`	`8`	`{`
`10`	`9`	`use HasParameters;`
`11`	`10`