Add settings.

Author: dereuromark

docs/README.md

@@ -78,17 +78,17 @@ Run the following using the CakePHP shell:
 
 * Display Help message:
 
-		bin/cake Queue.Queue
+		bin/cake queue
 
 * Try to call the cli add() function on a task:
 
-		bin/cake Queue.Queue add <TaskName>
+		bin/cake queue add <TaskName>
 
 	Tasks may or may not provide this functionality.
 
 * Run a queue worker, which will look for a pending task it can execute:
 
-		bin/cake Queue.Queue runworker
+		bin/cake queue runworker
 
 	The worker will always try to find jobs matching its installed Tasks.
 
@@ -159,7 +159,7 @@ to start a new worker.
 
 The following example uses "crontab":
 
-	*/10  *    *    *    *  cd /full/path/to/app && bin/cake Queue.Queue runworker
+	*/10  *    *    *    *  cd /full/path/to/app && bin/cake queue runworker
 
 Make sure you use `crontab -e -u www-data` to set it up as `www-data` user, and not as root etc.
 
@@ -225,3 +225,9 @@ is useful when dealing with emails which serialization would overflow database `
 ### Killing workers
 //TODO
 
+## Contributing
+I am looking forward to your contributions.
+
+There are a few guidelines that I need contributors to follow:
+* Coding standards (`./sniff` to check and `./sniff -f` to fix)
+* Passing tests (`php phpunit.phar`)

sniff

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# Make sure this file is executable
+# chmod +x sniff
+
+if [ `echo "$@" | grep '\-\-fix'` ] || [ `echo "$@" | grep '\-f'` ]; then
+    FIX=1
+else
+    FIX=0
+fi
+
+if [ "$FIX" = 1 ]; then
+	# Sniff and fix
+	vendor/bin/phpcbf --standard=vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml --ignore=cakephp-queue/vendor/,tmp/,logs/,tests/test_files/,config/Migrations/ --extensions=php -v -f ./
+else
+	# Sniff only
+	vendor/bin/phpcs --standard=vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml --ignore=cakephp-queue/vendor/,tmp/,logs/,tests/test_files/,config/Migrations/ --extensions=php -v ./
+fi

src/Shell/QueueShell.php

@@ -30,14 +30,14 @@ class QueueShell extends Shell {
 	public $modelClass = 'Queue.QueuedJobs';
 
 	/**
-	 * @var array
+	 * @var array|null
 	 */
 	protected $_taskConf;
 
 	/**
 	 * @var bool
 	 */
-	protected $_exit;
+	protected $_exit = false;
 
 	/**
 	 * Overwrite shell initialize to dynamically load all Queue Related Tasks.
@@ -74,31 +74,22 @@ public function initialize() {
 	}
 
 	/**
-	 * Output some basic usage Info.
-	 *
-	 * @return void
+	 * @return string
 	 */
-	public function main() {
-		$this->out('CakePHP Queue Plugin:');
-		$this->hr();
-		$this->out('Usage:');
-		$this->out('	cake Queue.Queue help');
-		$this->out('		-> Display this Help message');
-		$this->out('	cake Queue.Queue add <taskname>');
-		$this->out('		-> Try to call the cli add() function on a task');
-		$this->out('		-> tasks may or may not provide this functionality.');
-		$this->out('	cake Queue.Queue runworker');
-		$this->out('		-> run a queue worker, which will look for a pending task it can execute.');
-		$this->out('		-> the worker will always try to find jobs matching its installed Tasks');
-		$this->out('		-> see "Available Tasks" below.');
-		$this->out('	cake Queue.Queue stats');
-		$this->out('		-> Display some general Statistics.');
-		$this->out('	cake Queue.Queue clean');
-		$this->out('		-> Manually call cleanup function to delete task data of completed tasks.');
-		$this->out('Notes:');
-		$this->out('	<taskname> may either be the complete class name (eg. QueueExample)');
-		$this->out('	or the shorthand without the leading "Queue" (eg. Example)');
-		$this->_displayAvailableTasks();
+	public function _getDescription() {
+		$tasks = [];
+		foreach ($this->taskNames as $loadedTask) {
+			$tasks[] = "\t" . '* ' . $this->_taskName($loadedTask);
+		}
+		$tasks = implode(PHP_EOL, $tasks);
+
+		$text = <<<TEXT
+Simple and minimalistic job queue (or deferred-task) system.
+
+Available Tasks:
+$tasks
+TEXT;
+		return $text;
 	}
 
 	/**
@@ -110,7 +101,7 @@ public function main() {
 	public function add() {
 		if (count($this->args) < 1) {
 			$this->out('Please call like this:');
-			$this->out('       cake Queue.Queue add <taskname>');
+			$this->out('       bin/cake queue add <taskname>');
 			$this->_displayAvailableTasks();
 
 			return;
@@ -209,11 +200,13 @@ public function runworker() {
 
 				try {
 					$data = json_decode($queuedTask['data'], true);
-					$return = $this->{$taskname}->run((array)$data, $queuedTask['id']);
+					/* @var \Queue\Shell\Task\QueueTask $task */
+					$task = $this->{$taskname};
+					$return = $task->run((array)$data, $queuedTask['id']);
 
 					$failureMessage = null;
-					if (!empty($this->{$taskname}->failureMessage)) {
-						$failureMessage = $this->{$taskname}->failureMessage;
+					if ($task->failureMessage) {
+						$failureMessage = $task->failureMessage;
 					}
 				} catch (Exception $e) {
 					$return = false;
@@ -297,6 +290,12 @@ public function settings() {
 		$this->out('Current Settings:');
 		$conf = (array)Configure::read('Queue');
 		foreach ($conf as $key => $val) {
+			if ($val === false) {
+				$val = 'no';
+			}
+			if ($val === true) {
+				$val = 'yes';
+			}
 			$this->out('* ' . $key . ': ' . print_r($val, true));
 		}
 	}
@@ -334,7 +333,7 @@ public function stats() {
 	 * @return void
 	 */
 	public function install() {
-		$this->out('Run `cake Schema create -p Queue`');
+		$this->out('Run `cake Migrations.migrate -p Queue`');
 	}
 
 	/**
@@ -343,7 +342,7 @@ public function install() {
 	 * @return void
 	 */
 	public function uninstall() {
-		$this->out('Remove all workers and then delete the two tables.');
+		$this->out('Remove all workers and cronjobs and then delete the Queue plugin tables.');
 	}
 
 	/**
@@ -376,7 +375,7 @@ public function getOptionParser() {
 		];
 
 		return parent::getOptionParser()
-			->description('Simple and minimalistic job queue (or deferred-task) system.')
+			->description($this->_getDescription())
 			->addSubcommand('clean', [
 				'help' => 'Remove old jobs (cleanup)',
 				'parser' => $subcommandParser,
@@ -397,8 +396,12 @@ public function getOptionParser() {
 				'help' => 'Stats',
 				'parser' => $subcommandParserFull,
 			])
+			->addSubcommand('settings', [
+				'help' => 'Settings',
+				'parser' => $subcommandParserFull,
+			])
 			->addSubcommand('reset', [
-				'help' => 'Stats',
+				'help' => 'Manually reset (failed) jobs for re-run.',
 				'parser' => $subcommandParserFull,
 			])
 			->addSubcommand('runworker', [

src/Shell/Task/QueueExampleTask.php

@@ -26,13 +26,6 @@ class QueueExampleTask extends QueueTask {
 	 */
 	public $retries = 1;
 
-	/**
-	 * Stores any failure messages triggered during run()
-	 *
-	 * @var string
-	 */
-	public $failureMessage = '';
-
 	/**
 	 * Example add functionality.
 	 * Will create one example job in the queue, which later will be executed using run();
@@ -47,7 +40,7 @@ public function add() {
 		$this->out('This job will only produce some console output on the worker that it runs on.');
 		$this->out(' ');
 		$this->out('To run a Worker use:');
-		$this->out('	cake Queue.Queue runworker');
+		$this->out('	bin/cake queue runworker');
 		$this->out(' ');
 		$this->out('You can find the sourcecode of this task in: ');
 		$this->out(__FILE__);

src/Shell/Task/QueueExecuteTask.php

@@ -26,13 +26,6 @@ class QueueExecuteTask extends QueueTask {
 	 */
 	public $retries = 1;
 
-	/**
-	 * Stores any failure messages triggered during run()
-	 *
-	 * @var string
-	 */
-	public $failureMessage = '';
-
 	/**
 	 * Add functionality.
 	 * Will create one example job in the queue, which later will be executed using run();

src/Shell/Task/QueueLongExampleTask.php

@@ -28,13 +28,6 @@ class QueueLongExampleTask extends QueueTask {
 	 */
 	public $retries = 1;
 
-	/**
-	 * Stores any failure messages triggered during run()
-	 *
-	 * @var string
-	 */
-	public $failureMessage = '';
-
 	/**
 	 * Example add functionality.
 	 * Will create one example job in the queue, which later will be executed using run();
@@ -49,7 +42,7 @@ public function add() {
 		$this->out('This job will need at least 2 minutes to complete.');
 		$this->out(' ');
 		$this->out('To run a Worker use:');
-		$this->out('	cake Queue.Queue runworker');
+		$this->out('	bin/cake queue runworker');
 		$this->out(' ');
 		$this->out('You can find the sourcecode of this task in:');
 		$this->out(__FILE__);

src/Shell/Task/QueueRetryExampleTask.php

@@ -28,13 +28,6 @@ class QueueRetryExampleTask extends QueueTask {
 	 */
 	public $retries = 5;
 
-	/**
-	 * Stores any failure messages triggered during run()
-	 *
-	 * @var string
-	 */
-	public $failureMessage = '';
-
 	/**
 	 * Constructs this Shell instance.
 	 *
@@ -60,7 +53,7 @@ public function add() {
 		$this->out('This job will only produce some console output on the worker that it runs on.');
 		$this->out(' ');
 		$this->out('To run a Worker use:');
-		$this->out('	cake Queue.Queue runworker');
+		$this->out('	bin/cake queue runworker');
 		$this->out(' ');
 		$this->out('You can find the sourcecode of this task in: ');
 		$this->out(__FILE__);

src/Shell/Task/QueueSuperExampleTask.php

@@ -26,13 +26,6 @@ class QueueSuperExampleTask extends QueueTask {
 	 */
 	public $retries = 1;
 
-	/**
-	 * Stores any failure messages triggered during run()
-	 *
-	 * @var string
-	 */
-	public $failureMessage = '';
-
 	/**
 	 * SuperExample add functionality.
 	 * Will create one example job in the queue, which later will be executed using run();
@@ -48,7 +41,7 @@ public function add() {
 		$this->out('This job will only produce some console output on the worker that it runs on.');
 		$this->out(' ');
 		$this->out('To run a Worker use:');
-		$this->out('	cake Queue.Queue runworker');
+		$this->out('	bin/cake queue runworker');
 		$this->out(' ');
 		$this->out('You can find the sourcecode of this task in: ');
 		$this->out(__FILE__);

src/Shell/Task/QueueTask.php

@@ -41,6 +41,13 @@ class QueueTask extends Shell {
 	 */
 	public $retries = 4;
 
+	/**
+	 * Stores any failure messages triggered during run()
+	 *
+	 * @var string|null
+	 */
+	public $failureMessage = null;
+
 	/**
 	 * @param \Cake\Console\ConsoleIo|null $io IO
 	 */