Added annotations for action definition, Help Task

All changes in this commit revolve around building a useful help task,
Annotation engine addition means that we can define more without the
need for hooks or functions. Although every action needs an "@action"
annotation now it creates a better, more defined environment.

docs/Formats.md

@@ -18,6 +18,7 @@ The above format can be used by wrapping your string in `<Name></Name>`, since t
 The class sets up 3 default formats that you can use, or overwrite if you wish:
 
 	<Question></Question> 		- Foreground Cyan
+	<Info></Info>				- Foreground Cyan
 	<Comment></Comment>			- Foreground Yellow
 	<Error></Error>				- Foreground White, Background Red
 

docs/InputOutput.md

@@ -36,4 +36,7 @@ The output writes your strings to the console, it only has 2 methods and works i
 	// Write a line
 	$this->output->writeln("This will have a new line at the end");
 
+	// Draw a horizontal line
+	$this->output->hr($length, '-');
+
 You can replace your own Output class by using the DI in the same fashion as the Input, if you are doing this though, just remember to include the format class unless you dont need/want it. 

docs/Writing Tasks.md

@@ -14,12 +14,18 @@ As if you was using regular Phalcon CLI tools the tasks must have Task appended
 		 * Every task should have a main method, it will be the default
 		 * action that is called if no other is specified.
 		 *
+		 * We use the Annotation engine to specify which commands are actions. Make sure you include it on every action!
+		 *
+		 * @Action
 		 */
 		public function main() 
 		{
 			$this->output->writeln("This is the main action");	
 		}
 
+		/**
+		 * @Action
+		 */
 		public function other()
 		{
 			$this->output->writeln("This is the other action");

src/Application.php

@@ -169,6 +169,7 @@ public function start($args = Array())
 			$this->dispatcher->setParams($arg['params']);
 		}
 
+		$this->di->setShared('library', $this->library);
 		$this->dispatcher->setDI($this->di);
 
 		return $this->dispatcher->dispatch();

src/Format/FormatCollection.php

@@ -112,6 +112,9 @@ public function addGeneric()
 		// Comments
 		$this->add('comment', Array('foreground' => 'yellow'));
 
+		// Info
+		$this->add('info', Array('foreground' => 'cyan'));
+
 		// Errors
 		$this->add('error', Array('foreground' => 'white', 'background' => 'red'));
 	}

src/Output/Output.php

@@ -53,6 +53,17 @@ public function writeln($str)
 		fputs($this->output, Format::format($str)."\n");
 	}
 
+	/**
+	 * Draws a line with a given length and character
+	 *
+	 * @return String
+	 * @author Dan Cox
+	 */
+	public function hr($length, $char = '_')
+	{
+		$this->writeln(str_pad('', $length, $char));
+	}
+
 	/**
 	 * Read the output
 	 *

src/Tasks/TaskLibrary.php

@@ -37,7 +37,11 @@ public function __construct()
 	 */
 	public function add($tasks)
 	{
-		$this->library[$tasks['task']['name']] = Array('actions' => $tasks['task']['actions'], 'class' => $tasks['class']);		
+		$this->library[$tasks['task']['name']] = Array(
+			'actions' => $tasks['task']['actions'], 
+			'description' => $tasks['task']['description'],
+			'class' => $tasks['class']
+		);		
 	}
 
 	/**
@@ -64,5 +68,16 @@ public function find($name)
 		throw new Exceptions\CommandNotFoundException($name);
 	}
 
+	/**
+	 * Returns all the registered commands
+	 *
+	 * @return Array
+	 * @author Dan Cox
+	 */
+	public function getAll()
+	{
+		return $this->library;
+	}
+
 
 } // END class TaskLibrary

src/Tasks/TaskPrepper.php

@@ -1,6 +1,7 @@
 <?php namespace Danzabar\CLI\Tasks;
 
 use Danzabar\CLI\Input\InputArgument,
+	Phalcon\Annotations\Adapter\Memory,
 	Danzabar\CLI\Input\InputOption;
 
 
@@ -33,6 +34,20 @@ class TaskPrepper
 	 * @var Object
 	 */
 	protected $di;
+
+	/**
+	 * Instance of the Memory Annotation Engine
+	 *
+	 * @var Object
+	 */
+	protected $annotation;
+
+	/**
+	 * Current instance of the annotation reader
+	 *
+	 * @var Object
+	 */
+	protected $reader;
 
 	/**
 	 * An Array of arguments given
@@ -59,6 +74,9 @@ public function __construct($di)
 		// DI
 		$this->di = $di;
 
+		// Annotations
+		$this->annotation = new Memory;
+
 		// Add input class to the di
 		$this->di->setShared('argument', new InputArgument);
 	   	$this->di->setShared('option', new InputOption);
@@ -79,6 +97,9 @@ public function load($className)
 		// Create reflection
 		$this->reflection = new \ReflectionClass($className);
 
+		// Read annotations
+		$this->reader = $this->annotation->get($className);
+
 		// Save the class name
 		$this->className = $className;
 
@@ -94,13 +115,23 @@ public function load($className)
 	public function describe()
 	{
 		$methods = Array();
+		$methodAnnotations = $this->reader->getMethodsAnnotations();
 
 		foreach($this->reflection->getMethods() as $method)
 		{
-			$methods[] = $method->getName();
+			$name = $method->getName();
+
+			if(isset($methodAnnotations[$name]))
+			{
+				if($methodAnnotations[$name]->has('Action') || $methodAnnotations[$name]->has('action'))
+				{
+					$methods[] = $method->getName();
+				}
+			}
 		}
 
 		$name = $this->className;
+		$description = '';
 
 		if($this->reflection->hasProperty('name'))
 		{
@@ -109,7 +140,14 @@ public function describe()
 			$name = $prop->getValue($this->reflection->newInstance());
 		}
 
-		return Array('name' => $name, 'class' => $this->className, 'actions'  => $methods);
+		if($this->reflection->hasProperty('description'))
+		{
+			$prop = $this->reflection->getProperty('description');
+			$prop->setAccessible(TRUE);
+			$description = $prop->getValue($this->reflection->newInstance());
+		}
+
+		return Array('name' => $name, 'description' => $description, 'class' => $this->className, 'actions'  => $methods);
 	}
 
 	/**

src/Tasks/Utility/Help.php

@@ -28,12 +28,38 @@ class Help extends Task
 	/**
 	 * The main action
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
 	public function main()
 	{
+		$this->listCommands();	
+	}
 
+	/**
+	 * Lists out command names and descriptions
+	 *
+	 * @return void
+	 * @author Dan Cox
+	 */
+	public function listCommands()
+	{
+		$commands = $this->library->getAll();
+
+		foreach($commands as $name => $details)
+		{
+			$this->output->writeln(ucwords($name) .' - '.$details['description']);		
+			$this->output->hr(strlen($name . ' - '. $details['description']), '-');
+
+			foreach($details['actions'] as $action)
+			{
+				$this->output->writeln($action);	
+			}
+
+			// Just for padding
+			$this->output->writeln('');
+		}	
 	}
 
 } // END class Help extends Task

tests/Commands/FakeTask.php

@@ -41,6 +41,7 @@ public function setup($action)
 	/**
 	 * The main action for this command
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -52,6 +53,7 @@ public function main()
 	/**
 	 * Test action, no output
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -62,6 +64,7 @@ public function output()
 	/**
 	 * Task that tests basic question
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -76,6 +79,7 @@ public function askMe()
 	/**
 	 * A double question task
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -95,6 +99,7 @@ public function advAsk()
 	/**
 	 * Task that asks a choice question
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -120,6 +125,7 @@ public function choiceQ()
 	/**
 	 * Multiple Choice question
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -143,6 +149,7 @@ public function multiChoice()
 	/**
 	 * The confirmation test action
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -164,6 +171,7 @@ public function confirmation()
 	/**
 	 * A confirmation with explicit set and values changed
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */

tests/Commands/InputTask.php

@@ -31,6 +31,7 @@ class InputTask extends Task
 	/**
 	 * Setup required arguments and options
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -50,6 +51,7 @@ public function setup($action)
 	/**
 	 * Setup function specifically for the main action
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -62,6 +64,7 @@ public function setupMain()
 	/**
 	 * The main action
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -79,6 +82,7 @@ public function main()
 	/**
 	 * Another action
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -90,6 +94,7 @@ public function required()
 	/**
 	 * Action to test validation
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -106,6 +111,7 @@ public function validation()
 	/**
 	 * Setup function specific to options action
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -117,6 +123,7 @@ public function setupOptions()
 	/**
 	 * Action to test options
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -126,4 +133,3 @@ public function options()
 	}
 
 } // END class InputTask extends Command
-

tests/Commands/UtilityTask.php

@@ -28,6 +28,7 @@ class UtilityTask extends Task
 	/**
 	 * The main action
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */
@@ -39,6 +40,7 @@ public function main()
 	/**
 	 * Draws a table
 	 *
+	 * @Action
 	 * @return void
 	 * @author Dan Cox
 	 */