Adding ability to define a subcommand parser as an array.

This makes defining subcommands a bit easier as you don't have to build a pile of objects first.
cakephp · Oct 14, 2010 · 7a31eb4 · 7a31eb4
1 parent 1fec75e
commit 7a31eb4
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 0 deletions.
diff --git a/cake/console/console_input_subcommand.php b/cake/console/console_input_subcommand.php
@@ -49,6 +49,10 @@ public function __construct($name, $help = '', $parser = null) {
 			$this->_help = $help;
 			$this->_parser = $parser;
 		}
+		if (is_array($this->_parser)) {
+			$this->_parser['command'] = $this->_name;
+			$this->_parser = ConsoleOptionParser::buildFromArray($this->_parser);
+		}
 	}
 
 /**

diff --git a/cake/console/console_option_parser.php b/cake/console/console_option_parser.php
@@ -136,6 +136,37 @@ public function __construct($command = null, $defaultOptions = true) {
 		}
 	}
 
+/**
+ * Static factory method for creating new OptionParsers so you can chain methods off of them.
+ *
+ * @return ConsoleOptionParser
+ */
+	public static function create($command, $defaultOptions = true) {
+		return new ConsoleOptionParser($command, $defaultOptions);
+	}
+
+/**
+ * Build a parser from an array.
+ *
+ * @return ConsoleOptionParser
+ */
+	public static function buildFromArray($spec) {
+		$parser = new ConsoleOptionParser($spec['command']);
+		if (!empty($spec['arguments'])) {
+			$parser->addArguments($spec['arguments']);
+		}
+		if (!empty($spec['options'])) {
+			$parser->addOptions($spec['options']);
+		}
+		if (!empty($spec['description'])) {
+			$parser->description($spec['description']);
+		}
+		if (!empty($spec['epilog'])) {
+			$parser->epilog($spec['epilog']);
+		}
+		return $parser;
+	}
+
 /**
  * Get or set the command name for shell/task
  *

diff --git a/cake/tests/cases/console/console_option_parser.test.php b/cake/tests/cases/console/console_option_parser.test.php
@@ -496,4 +496,36 @@ function testHelpSubcommandHelp() {
 TEXT;
 		$this->assertEquals($expected, $result, 'Help is not correct.');
 	}
+
+/**
+ * test building a parser from an array.
+ *
+ * @return void
+ */
+	function testBuildFromArray() {
+		$spec = array(
+			'command' => 'test',
+			'arguments' => array(
+				'name' => array('help' => 'The name'),
+				'other' => array('help' => 'The other arg')
+			),
+			'options' => array(
+				'name' => array('help' => 'The name'),
+				'other' => array('help' => 'The other arg')
+			),
+			'description' => 'description text',
+			'epilog' => 'epilog text'
+		);
+		$parser = ConsoleOptionParser::buildFromArray($spec);
+
+		$this->assertEquals($spec['description'], $parser->description());
+		$this->assertEquals($spec['epilog'], $parser->epilog());
+
+		$options = $parser->options();
+		$this->assertTrue(isset($options['name']));
+		$this->assertTrue(isset($options['other']));
+
+		$args = $parser->arguments();
+		$this->assertEquals(2, count($args));
+	}
 }