fix(parameters) : add compileParameters method to Task to convert parameter string to proper parameters while executing the command programmaticaly or from schedule

Author: roshangautam

README.md

@@ -88,6 +88,15 @@ protected $hidden = true;
 
 From L5.5 onwards all commands are auto registered, so this wouldn't be a problem.
 
+#### Command Parameters
+
+If your command requires arguments or options please use the optional command parameters field. You can provide parameters to your command as a string in the following manner
+
+```text
+name=john.doe --greetings='Welcome to the new world'
+```
+In the example above, name is an argument while greetings is an option
+
 #### Console Command
 
 In addition to the dashboard, Totem provides an artisan command to view a list of scheduled task.

public/js/app.js

@@ -7,7 +7,7 @@
             <div class="uk-modal-header">
                 <h3>Output</h3>
             </div>
-            <div class="uk-modal-body">
+            <div class="uk-modal-body uk-overflow-auto uk-height-max-large">
                 <div v-html="output"></div>
             </div>
             <div class="uk-modal-footer">

resources/assets/js/tasks/components/TaskOutput.vue

@@ -31,6 +31,7 @@ public function all()
      */
     protected function commands()
     {
+        // TODO: remove this method while 5.5 branching
         if (method_exists($this, 'load')) {
             $this->load(base_path('app/Console/Commands'));
         }

src/Console/Kernel.php

@@ -14,9 +14,10 @@ class ConsoleServiceProvider extends ServiceProvider
      *
      * @return void
      */
-    public function register()
+    public function boot()
     {
-        $this->app->booted(function () {
+        // TODO: refactor this to resolving callback while 5.5 branching
+         $this->app->booted(function () {
             if ($this->app->runningInConsole()) {
                 $this->schedule($this->app->make(Schedule::class));
             }
@@ -33,7 +34,8 @@ public function schedule(Schedule $schedule)
         $tasks = app('totem.tasks')->findAllActive();
 
         $tasks->each(function ($task) use ($schedule) {
-            $event = $schedule->command($task->command.' '.$task->parameters);
+
+            $event = $schedule->command($task->command, $task->compileParameters(true));
 
             $event->cron($task->getCronExpression())
                 ->name($task->description)

src/Providers/ConsoleServiceProvider.php

@@ -176,17 +176,10 @@ public function deactivate($id)
     public function execute($id)
     {
         $task = $this->find($id);
-
         $start = microtime(true);
-
         try {
-            $parameters = collect(explode(' ', $task->parameters))->mapWithKeys(function ($parameter) {
-                $param = explode('=', $parameter);
-
-                return count($param) > 1 ? [$param[0] => $param[1]] : $param;
-            })->toArray();
+            Artisan::call($task->command, $task->compileParameters());
 
-            Artisan::call($task->command, $parameters);
             file_put_contents(storage_path($task->getMutexName()), Artisan::output());
         } catch (\Exception $e) {
             file_put_contents(storage_path($task->getMutexName()), $e->getMessage());

src/Repositories/EloquentTaskRepository.php

@@ -60,6 +60,30 @@ public function getUpcomingAttribute()
         return CronExpression::factory($this->getCronExpression())->getNextRunDate()->format('Y-m-d H:i:s');
     }
 
+    /**
+     * Convert a string of command arguments and options to an array.
+     *
+     * @param bool $console if true will convert arguments to non associative array
+     * @return array
+     */
+    public function compileParameters($console = false)
+    {
+        if ($this->parameters) {
+            $regex = '/(?=\S)[^\'"\s]*(?:\'[^\']*\'[^\'"\s]*|"[^"]*"[^\'"\s]*)*/';
+            preg_match_all($regex, $this->parameters, $matches, PREG_SET_ORDER, 0);
+
+            $parameters = collect($matches)->mapWithKeys(function ($parameter) use ($console) {
+                $param = explode('=', $parameter[0]);
+
+                return count($param) > 1 ? ($console ? ((starts_with($param[0], '--') ? [$param[0] => $param[1]] : [$param[1]])) : [$param[0] => $param[1]]) : $param;
+            })->toArray();
+
+            return $parameters;
+        }
+
+        return [];
+    }
+
     /**
      * Results Relation.
      *