Adding choices to usage and generated help text.

cakephp · Oct 14, 2010 · ef027f6 · ef027f6
1 parent b398877
commit ef027f6
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 0 deletions.
diff --git a/cake/console/console_input_argument.php b/cake/console/console_input_argument.php
@@ -74,6 +74,9 @@ public function help($width = 0) {
 		if (!$this->isRequired()) {
 			$optional = ' <comment>(optional)</comment>';
 		}
+		if (!empty($this->_choices)) {
+			$optional .= sprintf(' <comment>(choices: %s)</comment>', implode('|', $this->_choices));
+		}
 		return sprintf('%s%s%s', $name, $this->_help, $optional);
 	}
 
@@ -84,6 +87,9 @@ public function help($width = 0) {
  */
 	public function usage() {
 		$name = $this->_name;
+		if (!empty($this->_choices)) {
+			$name = implode('|', $this->_choices);
+		}
 		if (!$this->isRequired()) {
 			$name = '[' . $name . ']';
 		}

diff --git a/cake/console/console_input_option.php b/cake/console/console_input_option.php
@@ -75,6 +75,9 @@ public function help($width = 0) {
 		if (!empty($this->_default) && $this->_default !== true) {
 			$default = sprintf(__(' <comment>(default: %s)</comment>'), $this->_default);
 		}
+		if (!empty($this->_choices)) {
+			$default .= sprintf(' <comment>(choices: %s)</comment>', implode('|', $this->_choices));
+		}
 		if (!empty($this->_short)) {
 			$short = ', -' . $this->_short;
 		}
@@ -96,6 +99,9 @@ public function usage() {
 		if (!empty($this->_default) && $this->_default !== true) {
 			$default = ' ' . $this->_default;
 		}
+		if (!empty($this->_choices)) {
+			$default = ' ' . implode('|', $this->_choices);
+		}
 		return sprintf('[%s%s]', $name, $default);
 	}
 

diff --git a/cake/tests/cases/console/console_option_parser.test.php b/cake/tests/cases/console/console_option_parser.test.php
@@ -368,6 +368,40 @@ function testHelpWithOptionsAndArguments() {
 model         The model to make.
 other_longer  Another argument. <comment>(optional)</comment>
 
+TEXT;
+		$this->assertEquals($expected, $result, 'Help does not match');
+	}
+
+/**
+ * test help() with options and arguments that have choices.
+ *
+ * @return void
+ */
+	function testHelpWithChoices() {
+		$parser = new ConsoleOptionParser('mycommand', false);
+		$parser->addOption('test', array('help' => 'A test option.', 'choices' => array('one', 'two')))
+			->addArgument('type', array(
+				'help' => 'Resource type.',
+				'choices' => array('aco', 'aro'),
+				'required' => true
+			))
+			->addArgument('other_longer', array('help' => 'Another argument.'));
+
+		$result = $parser->help();
+		$expected = <<<TEXT
+<info>Usage:</info>
+cake mycommand [-h] [--test one|two] aco|aro [other_longer]
+
+<info>Options:</info>
+
+--help, -h  Display this help.
+--test      A test option. <comment>(choices: one|two)</comment>
+
+<info>Arguments:</info>
+
+type          Resource type. <comment>(choices: aco|aro)</comment>
+other_longer  Another argument. <comment>(optional)</comment>
+
 TEXT;
 		$this->assertEquals($expected, $result, 'Help does not match');
 	}