From dc9a05d49c55a9e6e3c87795819ce12bbaaeb689 Mon Sep 17 00:00:00 2001
From: mark_story <mark@mark-story.com>
Date: Sun, 10 Oct 2010 14:50:20 -0400
Subject: [PATCH] Extracting subcommand as a separate object.

This allows the internals of ConsoleOptionParser to be more uniform and consistent.
---
 cake/console/console_input_subcommand.php | 84 +++++++++++++++++++++++
 cake/console/console_option_parser.php    | 30 ++------
 2 files changed, 91 insertions(+), 23 deletions(-)
 create mode 100644 cake/console/console_input_subcommand.php

diff --git a/cake/console/console_input_subcommand.php b/cake/console/console_input_subcommand.php
new file mode 100644
index 000000000..6ee2ddfd4
--- /dev/null
+++ b/cake/console/console_input_subcommand.php
@@ -0,0 +1,84 @@
+<?php
+/**
+ * ConsoleInputSubcommand file
+ *
+ * PHP 5
+ *
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @package       cake
+ * @subpackage    cake.cake.console
+ * @since         CakePHP(tm) v 2.0
+ * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+
+/**
+ * An object to represent a single subcommand used in the command line.
+ * ConsoleOptionParser creates these when you use addSubcommand()
+ *
+ * @see ConsoleOptionParser::addSubcommand()
+ * @package cake.console
+ */
+class ConsoleInputSubcommand {
+
+/**
+ * Make a new Subcommand
+ *
+ * @param mixed $name The long name of the subcommand, or an array with all the properites.
+ * @param string $help The help text for this option
+ * @param ConsoleOptionParser $parser A parser for this subcommand.
+ * @return void
+ */
+	public function __construct($name, $help = '', $parser = null) {
+		if (is_array($name) && isset($name['name'])) {
+			foreach ($name as $key => $value) {
+				$this->{$key} = $value;
+			}
+		} else {
+			$this->name = $name;
+			$this->help = $help;
+			$this->parser = $parser;
+		}
+	}
+
+/**
+ * Get the name of the subcommand
+ *
+ * @return string
+ */
+	public function name() {
+		return $this->name;
+	}
+
+/**
+ * Generate the help for this this subcommand.
+ *
+ * @param int $width The width to make the name of the subcommand.
+ * @return string 
+ */
+	public function help($width = 0) {
+		$name = $this->name;
+		if (strlen($name) < $width) {
+			$name = str_pad($name, $width, ' ');
+		}
+		return $name . $this->help;
+	}
+
+/**
+ * Get the usage value for this option
+ *
+ * @return string
+ */
+	public function parser() {
+		if ($this->parser instanceof ConsoleOptionParser) {
+			return $this->parser;
+		}
+		return false;
+	}
+}
diff --git a/cake/console/console_option_parser.php b/cake/console/console_option_parser.php
index 0e95e2349..ccc1670cc 100644
--- a/cake/console/console_option_parser.php
+++ b/cake/console/console_option_parser.php
@@ -19,6 +19,7 @@
  */
 require_once 'console_input_option.php';
 require_once 'console_input_argument.php';
+require_once 'console_input_subcommand.php';
 
 /**
  * Handles parsing the ARGV in the command line and provides support 
@@ -297,7 +298,7 @@ class ConsoleOptionParser {
 			'parser' => null
 		);
 		$options = array_merge($defaults, $params);
-		$this->_subcommands[$name] = $options;
+		$this->_subcommands[$name] = new ConsoleInputSubcommand($options);
 		return $this;
 	}
 
@@ -361,9 +362,9 @@ class ConsoleOptionParser {
 	public function help($subcommand = null) {
 		if (
 			isset($this->_subcommands[$subcommand]) && 
-			$this->_subcommands[$subcommand]['parser'] instanceof self
+			$this->_subcommands[$subcommand]->parser() instanceof self
 		) {
-			$subparser = $this->_subcommands[$subcommand]['parser'];
+			$subparser = $this->_subcommands[$subcommand]->parser();
 			$subparser->command($this->command() . ' ' . $subparser->command());
 			return $subparser->help();
 		}
@@ -378,13 +379,9 @@ class ConsoleOptionParser {
 		if (!empty($this->_subcommands)) {
 			$out[] = '<info>Subcommands:</info>';
 			$out[] = '';
-			$max = 0;
-			foreach ($this->_subcommands as $description) {
-				$max = (strlen($description['name']) > $max) ? strlen($description['name']) : $max;
-			}
-			$max += 2;
-			foreach ($this->_subcommands as $description) {
-				$out[] = $this->_subcommandHelp($description, $max);
+			$max = $this->_getMaxLength($this->_subcommands) + 2;
+			foreach ($this->_subcommands as $command) {
+				$out[] = $command->help($max);
 			}
 			$out[] = '';
 		}
@@ -434,19 +431,6 @@ class ConsoleOptionParser {
 		return implode(' ', $usage);
 	}
 
-/**
- * Generate help for a single subcommand.
- *
- * @return string
- */
-	protected function _subcommandHelp($definition, $width) {
-		$name = $definition['name'];
-		if (strlen($name) < $width) {
-			$name = str_pad($name, $width, ' ');
-		}
-		return $name . $definition['help'];
-	}
-
 /**
  * Parse the value for a long option out of $this->_tokens.  Will handle
  * options with an `=` in them.