Update the console shell for easier maintenance

lib/Cake/Console/Command/ConsoleShell.php

@@ -43,6 +43,35 @@ class ConsoleShell extends AppShell {
  */
 	public $models = array();
 
+/**
+ * _finished
+ *
+ * This shell is perpetual, setting this property to true exits the process
+ *
+ * @var mixed
+ */
+	protected $_finished = false;
+
+/**
+ * _methodPatterns
+ *
+ * @var array
+ */
+	protected $_methodPatterns = array(
+		'help' => '/^(help|\?)/',
+		'_exit' => '/^(quit|exit)/',
+		'_models' => '/^models/i',
+		'_bind' => '/^(\w+) bind (\w+) (\w+)/',
+		'_unbind' => '/^(\w+) unbind (\w+) (\w+)/',
+		'_find' => '/.+->find/',
+		'_save' => '/.+->save/',
+		'_columns' => '/^(\w+) columns/',
+		'_routesReload' => '/^routes\s+reload/i',
+		'_routesShow' => '/^routes\s+show/i',
+		'_routeToString' => '/^route\s+(\(.*\))$/i',
+		'_routeToArray' => '/^route\s+(.*)$/i',
+	);
+
 /**
  * Override startup of the Shell
  *
@@ -75,6 +104,11 @@ class ConsoleShell extends AppShell {
 		}
 	}
 
+/**
+ * getOptionParser
+ *
+ * @return void
+ */
 	public function getOptionParser() {
 		$description = array(
 			'The interactive console is a tool for testing parts of your',
@@ -164,26 +198,71 @@ class ConsoleShell extends AppShell {
  * @return void
  */
 	public function main($command = null) {
-		while (true) {
+		$this->_finished = false;
+		while (!$this->_finished) {
 			if (empty($command)) {
 				$command = trim($this->in(''));
 			}
 
-			switch ($command) {
-				case 'help':
-					$this->help();
-					break;
-				case 'quit':
-				case 'exit':
-					return true;
-				case 'models':
+			$method = $this->_method($command);
+
+			if ($method) {
+				$this->$method($command);
+			} else {
+				$this->out(__d('cake_console', "Invalid command"));
+				$this->out();
+			}
+			$command = '';
+		}
+	}
+
+/**
+ * Determine the method to process the current command
+ *
+ * @param string $command
+ * @return string or false
+ */
+	protected function _method($command) {
+		foreach ($this->_methodPatterns as $method => $pattern) {
+			if (preg_match($pattern, $command)) {
+				return $method;
+			}
+		}
+
+		return false;
+	}
+
+/**
+ * Set the finiished property so that the loop in main method ends
+ *
+ * @return void
+ */
+	protected function _exit() {
+		$this->_finished = true;
+	}
+
+/**
+ * List all models
+ *
+ * @return void
+ */
+	protected function _models() {
 		$this->out(__d('cake_console', 'Model classes:'));
 		$this->hr();
 		foreach ($this->models as $model) {
 			$this->out(" - {$model}");
 		}
-					break;
-				case preg_match("/^(\w+) bind (\w+) (\w+)/", $command, $tmp):
+	}
+
+/**
+ * Bind an association
+ *
+ * @param mixed $command
+ * @return void
+ */
+	protected function _bind($command) {
+		preg_match($this->_methodPatterns[__FUNCTION__], $command, $tmp);
+
 		foreach ($tmp as $data) {
 			$data = strip_tags($data);
 			$data = str_replace($this->badCommandChars, "", $data);
@@ -200,8 +279,17 @@ class ConsoleShell extends AppShell {
 		} else {
 			$this->out(__d('cake_console', "Please verify you are using valid models and association types"));
 		}
-					break;
-				case preg_match("/^(\w+) unbind (\w+) (\w+)/", $command, $tmp):
+	}
+
+/**
+ * Unbind an association
+ *
+ * @param mixed $command
+ * @return void
+ */
+	protected function _unbind($command) {
+		preg_match($this->_methodPatterns[__FUNCTION__], $command, $tmp);
+
 		foreach ($tmp as $data) {
 			$data = strip_tags($data);
 			$data = str_replace($this->badCommandChars, "", $data);
@@ -228,9 +316,15 @@ class ConsoleShell extends AppShell {
 		} else {
 			$this->out(__d('cake_console', "Please verify you are using valid models, valid current association, and valid association types"));
 		}
-					break;
-				case (strpos($command, "->find") > 0):
-					// Remove any bad info
+	}
+
+/**
+ * Perform a find
+ *
+ * @param mixed $command
+ * @return void
+ */
+	protected function _find($command) {
 		$command = strip_tags($command);
 		$command = str_replace($this->badCommandChars, "", $command);
 
@@ -284,9 +378,15 @@ class ConsoleShell extends AppShell {
 		} else {
 			$this->out(__d('cake_console', "%s is not a valid model", $modelToCheck));
 		}
+	}
 
-					break;
-				case (strpos($command, '->save') > 0):
+/**
+ * Save a record
+ *
+ * @param mixed $command
+ * @return void
+ */
+	protected function _save($command) {
 		// Validate the model we're trying to save here
 		$command = strip_tags($command);
 		$command = str_replace($this->badCommandChars, "", $command);
@@ -302,8 +402,17 @@ class ConsoleShell extends AppShell {
 			//@codingStandardsIgnoreEnd
 			$this->out(__d('cake_console', 'Saved record for %s', $modelToSave));
 		}
-					break;
-				case preg_match("/^(\w+) columns/", $command, $tmp):
+	}
+
+/**
+ * Show the columns for a model
+ *
+ * @param mixed $command
+ * @return void
+ */
+	protected function _columns($command) {
+		preg_match($this->_methodPatterns[__FUNCTION__], $command, $tmp);
+
 		$modelToCheck = strip_tags(str_replace($this->badCommandChars, "", $tmp[1]));
 
 		if ($this->_isValidModel($modelToCheck)) {
@@ -321,33 +430,56 @@ class ConsoleShell extends AppShell {
 		} else {
 			$this->out(__d('cake_console', "Please verify that you selected a valid model"));
 		}
-					break;
-				case preg_match("/^routes\s+reload/i", $command, $tmp):
+	}
+
+/**
+ * Reload route definitions
+ *
+ * @return void
+ */
+	protected function _routesReload() {
 		if (!$this->_loadRoutes()) {
 			$this->err(__d('cake_console', "There was an error loading the routes config. Please check that the file exists and is free of parse errors."));
 			break;
 		}
 		$this->out(__d('cake_console', "Routes configuration reloaded, %d routes connected", count(Router::$routes)));
-					break;
-				case preg_match("/^routes\s+show/i", $command, $tmp):
+	}
+
+/**
+ * Show all routes
+ *
+ * @return void
+ */
+	protected function _routesShow() {
 		$this->out(print_r(Hash::combine(Router::$routes, '{n}.template', '{n}.defaults'), true));
-					break;
-				case (preg_match("/^route\s+(\(.*\))$/i", $command, $tmp) == true):
+	}
+
+/**
+ * Parse an array url and show the equivalent url as a string
+ *
+ * @param mixed $command
+ * @return void
+ */
+	protected function _routeToString($command) {
+		preg_match($this->_methodPatterns[__FUNCTION__], $command, $tmp);
+
 		//@codingStandardsIgnoreStart
 		if ($url = eval('return array' . $tmp[1] . ';')) {
 			//@codingStandardsIgnoreEnd
 			$this->out(Router::url($url));
 		}
-					break;
-				case preg_match("/^route\s+(.*)/i", $command, $tmp):
+	}
+
+/**
+ * Parse a string url and show as an array
+ *
+ * @param mixed $command
+ * @return void
+ */
+	protected function _routeToArray($command) {
+		preg_match($this->_methodPatterns[__FUNCTION__], $command, $tmp);
+
 		$this->out(var_export(Router::parse($tmp[1]), true));
-					break;
-				default:
-					$this->out(__d('cake_console', "Invalid command"));
-					$this->out();
-			}
-			$command = '';
-		}
 	}
 
 /**