Implemented a basic scheduler for managing crontab and repeating task…

…s on the server

composer.json

@@ -15,7 +15,8 @@
         "nyholm/psr7-server": "dev-master",
         "psr/http-server-handler": "^1.0@dev",
         "psr/http-server-middleware": "^1.0@dev",
-        "vlucas/phpdotenv": "^4.1@dev"
+        "vlucas/phpdotenv": "^4.1@dev",
+        "dragonmantank/cron-expression": "dev-master"
     },
     "autoload": {
       "psr-4": {

src/Console/Input/ConsoleInput.php

@@ -11,16 +11,6 @@
  */
 class ConsoleInput extends Input
 {
-    /**
-     * @var array $rawArguments
-     */
-    private $rawArguments = [];
-
-    /**
-     * @var array $missingArguments
-     */
-    private $missingArguments = [];
-
     /**
      * @param Signature $signature
      */
@@ -52,64 +42,7 @@ private function parse()
 
         array_shift($this->rawArguments);
 
-        // First we check if any subcommand was requested
-        if (isset($this->rawArguments[0])) {
-            foreach ($this->getSignature()->getSubCommands() as $command) {
-                if ($this->rawArguments[0] === $command->getName()) {
-                    $this->setSubCommand($command->getName());
-                    break;
-                }
-            }
-        }
-
-        // Then we parse out the options
-        foreach ($this->getSignature()->getOptions() as $option) {
-
-            $definitions = [
-                '-'.$option->getName(),
-                '--'.$option->getName(),
-            ];
-
-            if ($alias = $option->getAlias()) {
-                $definitions[] = '-'.$alias;
-                $definitions[] = '--'.$alias;
-            }
-
-            foreach ($definitions as $definition) {
-                $optionPosition = array_search($definition, $this->rawArguments);
-
-                if ($optionPosition !== false) {
-
-                    // We found the option in the list of given arguments
-                    if (
-                        isset($this->rawArguments[$optionPosition + 1]) &&
-                        substr($this->rawArguments[$optionPosition + 1], 0, strlen('-')) !== '-'
-                    ) {
-                        // We also found a value for the option
-                        // We remove the value of the option from the argument list
-                        $optionValue = $this->rawArguments[$optionPosition + 1];
-                        $this->setOption($option->getName(), $optionValue);
-                        array_splice($this->rawArguments, $optionPosition + 1, 1);
-
-                    } else {
-
-                        $this->setOption($option->getName(), $option->getDefault());
-                    }
-
-                    array_splice($this->rawArguments, $optionPosition, 1);
-                    break;
-                }
-            }
-        }
-
-        // Now we loop all arguments and make sure they are present
-        foreach ($this->getSignature()->getArguments() as $position => $argument) {
-            if (isset($this->rawArguments[$position])) {
-                $this->setArgument($argument->getName(), $this->rawArguments[$position]);
-            } else {
-                $this->missingArguments[] = $argument->getName();
-            }
-        }
+        $this->parseRawArguments();
     }
 
     /**

src/Console/Input/Input.php

@@ -11,6 +11,16 @@
  */
 abstract class Input implements InputInterface
 {
+    /**
+     * @var array $rawArguments
+     */
+    protected $rawArguments = [];
+
+    /**
+     * @var array $missingArguments
+     */
+    protected $missingArguments = [];
+
     /**
      * Holds the given arguments
      *
@@ -161,4 +171,69 @@ public function getSignature(): Signature
     {
         return $this->signature;
     }
+
+    /**
+     * Parse the raw arguments
+     */
+    protected function parseRawArguments()
+    {
+        // First we check if any subcommand was requested
+        if (isset($this->rawArguments[0])) {
+            foreach ($this->getSignature()->getSubCommands() as $command) {
+                if ($this->rawArguments[0] === $command->getName()) {
+                    $this->setSubCommand($command->getName());
+                    break;
+                }
+            }
+        }
+
+        // Then we parse out the options
+        foreach ($this->getSignature()->getOptions() as $option) {
+
+            $definitions = [
+                '-'.$option->getName(),
+                '--'.$option->getName(),
+            ];
+
+            if ($alias = $option->getAlias()) {
+                $definitions[] = '-'.$alias;
+                $definitions[] = '--'.$alias;
+            }
+
+            foreach ($definitions as $definition) {
+                $optionPosition = array_search($definition, $this->rawArguments);
+
+                if ($optionPosition !== false) {
+
+                    // We found the option in the list of given arguments
+                    if (
+                        isset($this->rawArguments[$optionPosition + 1]) &&
+                        substr($this->rawArguments[$optionPosition + 1], 0, strlen('-')) !== '-'
+                    ) {
+                        // We also found a value for the option
+                        // We remove the value of the option from the argument list
+                        $optionValue = $this->rawArguments[$optionPosition + 1];
+                        $this->setOption($option->getName(), $optionValue);
+                        array_splice($this->rawArguments, $optionPosition + 1, 1);
+
+                    } else {
+
+                        $this->setOption($option->getName(), $option->getDefault());
+                    }
+
+                    array_splice($this->rawArguments, $optionPosition, 1);
+                    break;
+                }
+            }
+        }
+
+        // Now we loop all arguments and make sure they are present
+        foreach ($this->getSignature()->getArguments() as $position => $argument) {
+            if (isset($this->rawArguments[$position])) {
+                $this->setArgument($argument->getName(), $this->rawArguments[$position]);
+            } else {
+                $this->missingArguments[] = $argument->getName();
+            }
+        }
+    }
 }

src/Contracts/Console/InputInterface.php

@@ -10,22 +10,22 @@
  */
 interface InputInterface
 {
-	public function setSignature(Signature $signature);
-	public function getSignature(): Signature;
+    public function setSignature(Signature $signature);
+    public function getSignature(): Signature;
 
-	public function validate();
+    public function validate();
 
-	public function getArguments();
-	public function getArgument(string $name);
+    public function getArguments();
+    public function getArgument(string $name);
 
-	public function hasArgument(string $name): bool;
-	public function setArgument(string $name, $value);
+    public function hasArgument(string $name): bool;
+    public function setArgument(string $name, $value);
 
-	public function getOptions();
-	public function getOption(string $name);
-	public function setOption(string $name, $value);
+    public function getOptions();
+    public function getOption(string $name);
+    public function setOption(string $name, $value);
 
-	public function hasSubCommand(): bool;
-	public function getSubCommand();
-	public function setSubCommand(string $name);
+    public function hasSubCommand(): bool;
+    public function getSubCommand();
+    public function setSubCommand(string $name);
 }

src/Contracts/Scheduler/JobInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Oak\Contracts\Scheduler;
+
+interface JobInterface
+{
+    /**
+     * @return string
+     */
+    public function getCronExpression(): string;
+
+    /**
+     * @return string
+     */
+    public function getCommand(): string;
+
+    /**
+     * @return string
+     */
+    public function execute(): string;
+}

src/Contracts/Scheduler/SchedulerInterface.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Oak\Contracts\Scheduler;
+
+use Oak\Contracts\Console\OutputInterface;
+
+interface SchedulerInterface
+{
+    /**
+     * @param string $command
+     * @return JobInterface
+     */
+    public function run(string $command): JobInterface;
+
+    /**
+     * @param JobInterface $job
+     * @return mixed
+     */
+    public function isDue(JobInterface $job);
+
+    /**
+     * @param OutputInterface $output
+     * @return mixed
+     */
+    public function runSchedule(OutputInterface $output);
+}

src/Scheduler/Console/SchedulerCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Oak\Scheduler\Console;
+
+use Oak\Console\Command\Command;
+use Oak\Console\Command\Signature;
+use Oak\Contracts\Console\InputInterface;
+use Oak\Contracts\Console\OutputInterface;
+use Oak\Contracts\Container\ContainerInterface;
+use Oak\Contracts\Scheduler\SchedulerInterface;
+
+class SchedulerCommand extends Command
+{
+    /**
+     * @var SchedulerInterface $scheduler
+     */
+    private $scheduler;
+
+    /**
+     * SchedulerCommand constructor.
+     * @param SchedulerInterface $scheduler
+     * @param ContainerInterface $app
+     */
+    public function __construct(SchedulerInterface $scheduler, ContainerInterface $app)
+    {
+        $this->scheduler = $scheduler;
+
+        parent::__construct($app);
+    }
+
+    /**
+     * @param Signature $signature
+     * @return Signature
+     */
+    protected function createSignature(Signature $signature): Signature
+    {
+        return $signature
+            ->setName('scheduler')
+            ->addSubCommand(TickCommand::class)
+        ;
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output)
+    {
+        $this->scheduler->runSchedule($output);
+    }
+}

src/Scheduler/Console/TickCommand.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Oak\Scheduler\Console;
+
+use Oak\Console\Command\Command;
+use Oak\Console\Command\Signature;
+use Oak\Contracts\Console\InputInterface;
+use Oak\Contracts\Console\OutputInterface;
+use Oak\Contracts\Container\ContainerInterface;
+use Oak\Contracts\Scheduler\SchedulerInterface;
+
+class TickCommand extends Command
+{
+    /**
+     * @var SchedulerInterface $scheduler
+     */
+    private $scheduler;
+
+    /**
+     * SchedulerCommand constructor.
+     * @param SchedulerInterface $scheduler
+     * @param ContainerInterface $app
+     */
+    public function __construct(SchedulerInterface $scheduler, ContainerInterface $app)
+    {
+        $this->scheduler = $scheduler;
+
+        parent::__construct($app);
+    }
+
+    /**
+     * @param Signature $signature
+     * @return Signature
+     */
+    protected function createSignature(Signature $signature): Signature
+    {
+        return $signature
+            ->setName('tick')
+        ;
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output)
+    {
+        while (true) {
+            $this->scheduler->runSchedule($output);
+            sleep(60);
+        }
+    }
+}