GH-Issue #10 : Added "help" to command line (and additionally removed…

… the need for silly things like "true" onb --quiet
enygma · Oct 27, 2010 · b02fa1e · b02fa1e
1 parent 53322ab
commit b02fa1e
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 5 deletions.
diff --git a/frisk b/frisk
@@ -31,9 +31,16 @@ set_include_path(get_include_path().
 	PATH_SEPARATOR.__DIR__.'/lib/Exceptions'.
 	PATH_SEPARATOR.__DIR__.'/tests');
 
+HelperArguments::execute($_SERVER['argv']);
+
+// See if they just need help
+if(HelperArguments::getArgument('help')){
+	HelperArguments::displayArgumentHelp();
+	die();
+}
+
 $runner = new Runner();
 try{
-	HelperArguments::execute($_SERVER['argv']);
 	HelperConfig::execute(null);
 
 	ob_start();

diff --git a/lib/Helper/HelperArguments.php b/lib/Helper/HelperArguments.php
@@ -8,6 +8,23 @@
 class HelperArguments extends Helper
 {
 
+	/**
+	 * Details for current arguments (spit out on call to --help)
+	 * @var array
+	 */
+	static $argumentDetails = array(
+		'quiet'	  => array('','Suppresses all output, nothing returned'),
+		'output'  => array('[type]','Controls output format (ex. XML, JSON, CSV, etc)'),
+		'config'  => array('[file path]','Path to the configuration file to use'),
+		'test'	  => array('[test name]','Run a single test with this name'),
+		'verbose' => array('','Add more verbose reporting to testing output'),
+		'help'	  => array('','Display this message')
+	);
+
+	/**
+	 * Arguments currently defined on execution
+	 * @var array
+	 */
 	static $currentArguments = array();
 
 	/**
@@ -20,10 +37,9 @@ public function execute($arguments)
 		if(!empty($arguments)){
 			foreach($arguments as $argument){
 				$argumentParts	= explode('=',$argument);
-				if(count($argumentParts)>1){
-					$argumentKey	= str_replace('--','',$argumentParts[0]);
-					self::$currentArguments[$argumentKey]=$argumentParts[1];
-				}
+				$argumentKey    = str_replace('--','',$argumentParts[0]);
+
+				self::$currentArguments[$argumentKey] = (count($argumentParts)>1) ? $argumentParts[1] : true;
 			}
 		}
 	}
@@ -70,6 +86,31 @@ public static function getArgument($name)
 		return (isset(self::$currentArguments[$name])) ? self::$currentArguments[$name] : null;
 	}
 
+	/**
+	 * Display the contents of the argument detail from above
+	 *
+	 * @return void
+	 */
+	public static function displayArgumentHelp()
+	{
+		echo "Frisk command-line parameters:\n";
+		echo "=======================================\n";
+
+		// find the longest argument info
+		$longestParameter = 0;
+		foreach(self::$argumentDetails as $argumentName => $argumentDetail){
+			$argumentString='--'.$argumentName.((!empty($argumentDetail[0])) ? ' = '.$argumentDetail[0] :  '');
+			if(strlen($argumentString)>$longestParameter){ $longestParameter=strlen($argumentString); }
+		}
+
+		foreach(self::$argumentDetails as $argumentName => $argumentDetail){
+			$argumentString="--".$argumentName.' ';
+			if(!empty($argumentDetail[0])){ $argumentString.='= '.$argumentDetail[0]; }
+
+			echo str_pad($argumentString,$longestParameter+3,' ').$argumentDetail[1]."\n";
+		}
+		echo "\n\n";
+	}
 }
 
 ?>