feature ( command-filters) : add command filter config to avoid loading all available commands

Author: qschmick

README.md

@@ -83,6 +83,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`.

config/totem.php

@@ -222,4 +222,7 @@
     'api' => [
         'middleware' => env('TOTEM_API_MIDDLEWARE', 'api'),
     ],
+    'artisan' => [
+        'command_filter' => [],
+    ],
 ];

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(),
         ]);

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();
+        });
+    }
 }