Adding epilog and description to the generate help.

cakephp · Oct 14, 2010 · d3c95bc · d3c95bc
1 parent 501e63e
commit d3c95bc
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 2 deletions.
diff --git a/cake/console/console_option_parser.php b/cake/console/console_option_parser.php
@@ -270,6 +270,10 @@ public function parse($argv) {
  */
 	public function help() {
 		$out = array();
+		if (!empty($this->_description)) {
+			$out[] = $this->_description;
+			$out[] = '';
+		}
 		$out[] = '<info>Usage:</info>';
 		$out[] = $this->_generateUsage();
 		$out[] = '';
@@ -299,6 +303,9 @@ public function help() {
 			}
 			$out[] = '';
 		}
+		if (!empty($this->_epilog)) {
+			$out[] = $this->_epilog;
+		}
 		return implode("\n", $out);
 	}
 

diff --git a/cake/tests/cases/console/console_option_parser.test.php b/cake/tests/cases/console/console_option_parser.test.php
@@ -228,7 +228,7 @@ function testPositionalArgNotEnough() {
  *
  * @return void
  */
-	function testGetHelpWithOptions() {
+	function testHelpWithOptions() {
 		$parser = new ConsoleOptionParser('mycommand', false);
 		$parser->addOption('test', array('help' => 'A test option.'))
 			->addOption('connection', array(
@@ -255,7 +255,7 @@ function testGetHelpWithOptions() {
  *
  * @return void
  */
-	function testGetHelpWithOptionsAndArguments() {
+	function testHelpWithOptionsAndArguments() {
 		$parser = new ConsoleOptionParser('mycommand', false);
 		$parser->addOption('test', array('help' => 'A test option.'))
 			->addArgument('model', array('help' => 'The model to make.', 'required' => true))
@@ -279,4 +279,37 @@ function testGetHelpWithOptionsAndArguments() {
 TEXT;
 		$this->assertEquals($expected, $result, 'Help does not match');
 	}
+
+/**
+ * test description and epilog in the help
+ *
+ * @return void
+ */
+	function testDescriptionAndEpilog() {
+		$parser = new ConsoleOptionParser('mycommand', false);
+		$parser->description('Description text')
+			->epilog('epilog text')
+			->addOption('test', array('help' => 'A test option.'))
+			->addArgument('model', array('help' => 'The model to make.', 'required' => true));
+
+		$result = $parser->help();
+		$expected = <<<TEXT
+Description text
+
+<info>Usage:</info>
+cake mycommand [-h] [--test] model
+
+<info>Options:</info>
+
+--help, -h  Display this help.
+--test      A test option.
+
+<info>Arguments:</info>
+
+model  The model to make.
+
+epilog text
+TEXT;
+		$this->assertEquals($expected, $result, 'Help is wrong.');
+	}
 }