Merge pull request #37 from connectstudios/cleanup-autoloading_etc

Cleanup autoloading and comments

Author: jlogsdon

README.md

@@ -10,38 +10,38 @@ Requirements
 Function List
 -------------
 
- * `\cli\out($msg, ...)`
- * `\cli\out_padded($msg, ...)`
- * `\cli\err($msg, ...)`
- * `\cli\line($msg = '', ...)`
- * `\cli\input()`
- * `\cli\prompt($question, $default = false, $marker = ':')`
- * `\cli\choose($question, $choices = 'yn', $default = 'n')`
- * `\cli\menu($items, $default = false, $title = 'Choose an Item')`
+ * `cli\out($msg, ...)`
+ * `cli\out_padded($msg, ...)`
+ * `cli\err($msg, ...)`
+ * `cli\line($msg = '', ...)`
+ * `cli\input()`
+ * `cli\prompt($question, $default = false, $marker = ':')`
+ * `cli\choose($question, $choices = 'yn', $default = 'n')`
+ * `cli\menu($items, $default = false, $title = 'Choose an Item')`
 
 Progress Indicators
 -------------------
 
- * `\cli\notifier\Dots($msg, $dots = 3, $interval = 100)`
- * `\cli\notifier\Spinner($msg, $interval = 100)`
- * `\cli\progress\Bar($msg, $total, $interval = 100)`
+ * `cli\notifier\Dots($msg, $dots = 3, $interval = 100)`
+ * `cli\notifier\Spinner($msg, $interval = 100)`
+ * `cli\progress\Bar($msg, $total, $interval = 100)`
 
 Tabular Display
 ---------------
 
- * `\cli\Table::__construct(array $headers = null, array $rows = null)`
- * `\cli\Table::setHeaders(array $headers)`
- * `\cli\Table::setRows(array $rows)`
- * `\cli\Table::setRenderer(\cli\table\Renderer $renderer)`
- * `\cli\Table::addRow(array $row)`
- * `\cli\Table::sort($column)`
- * `\cli\Table::display()`
+ * `cli\Table::__construct(array $headers = null, array $rows = null)`
+ * `cli\Table::setHeaders(array $headers)`
+ * `cli\Table::setRows(array $rows)`
+ * `cli\Table::setRenderer(cli\table\Renderer $renderer)`
+ * `cli\Table::addRow(array $row)`
+ * `cli\Table::sort($column)`
+ * `cli\Table::display()`
 
 The display function will detect if output is piped and, if it is, render a tab delimited table instead of the ASCII
 table rendered for visual display.
 
-You can also explicitly set the renderer used by calling `\cli\Table::setRenderer()` and giving it an instance of one
-of the concrete `\cli\table\Renderer` classes.
+You can also explicitly set the renderer used by calling `cli\Table::setRenderer()` and giving it an instance of one
+of the concrete `cli\table\Renderer` classes.
 
 Argument Parser
 ---------------

composer.json

@@ -16,7 +16,11 @@
         "php": ">= 5.3.0"
     },
     "autoload": {
-        "psr-0": {"cli": "lib/"},
-        "files": ["lib/cli/cli.php"]
+        "psr-0": {
+            "cli": "lib/"
+        },
+        "files": [
+            "lib/cli/cli.php"
+        ]
     }
 }

examples/common.php

@@ -9,10 +9,9 @@
 ini_set('log_errors', 0);
 ini_set('html_errors', 0);
 
-require 'lib/cli/cli.php';
-\cli\register_autoload();
+require_once __DIR__ . '/../vendor/autoload.php';
 
-function test_notify(\cli\Notify $notify, $cycle = 1000000, $sleep = null) {
+function test_notify(cli\Notify $notify, $cycle = 1000000, $sleep = null) {
 	for ($i = 0; $i <= $cycle; $i++) {
 		$notify->tick();
 		if ($sleep) usleep($sleep);

http-console.php

@@ -3,16 +3,14 @@
  * An example application using php-cli-tools and Buzz
  */
 
+require_once __DIR__ . '/vendor/autoload.php';
+
 define('BUZZ_PATH', realpath('../Buzz'));
-define('TOOL_PATH', realpath('./'));
 define('SCRIPT_NAME', array_shift($argv));
 
 require_once BUZZ_PATH . '/lib/Buzz/ClassLoader.php';
 Buzz\ClassLoader::register();
 
-require_once TOOL_PATH . '/lib/cli/cli.php';
-\cli\register_autoload();
-
 class HttpConsole {
     protected $_host;
     protected $_prompt;

lib/cli/Arguments.php

@@ -12,11 +12,10 @@
 
 namespace cli;
 
-require 'lib/cli/Memoize.php';
-require 'lib/cli/arguments/Argument.php';
-require 'lib/cli/arguments/HelpScreen.php';
-require 'lib/cli/arguments/InvalidArguments.php';
-require 'lib/cli/arguments/Lexer.php';
+use cli\arguments\Argument;
+use cli\arguments\HelpScreen;
+use cli\arguments\InvalidArguments;
+use cli\arguments\Lexer;
 
 /**
  * Parses command line arguments.
@@ -69,7 +68,7 @@ public function getArguments() {
 	}
 
 	public function getHelpScreen() {
-		return new \cli\arguments\HelpScreen($this);
+		return new HelpScreen($this);
 	}
 
 	/**
@@ -88,7 +87,7 @@ public function asJSON() {
 	 * @return bool
 	 */
 	public function offsetExists($offset) {
-		if ($offset instanceOf \cli\arguments\Argument) {
+		if ($offset instanceOf Argument) {
 			$offset = $offset->key;
 		}
 
@@ -102,7 +101,7 @@ public function offsetExists($offset) {
 	 * @return mixed
 	 */
 	public function offsetGet($offset) {
-		if ($offset instanceOf \cli\arguments\Argument) {
+		if ($offset instanceOf Argument) {
 			$offset = $offset->key;
 		}
 
@@ -118,7 +117,7 @@ public function offsetGet($offset) {
 	 * @param mixed  $value   The value to set
 	 */
 	public function offsetSet($offset, $value) {
-		if ($offset instanceOf \cli\arguments\Argument) {
+		if ($offset instanceOf Argument) {
 			$offset = $offset->key;
 		}
 
@@ -131,7 +130,7 @@ public function offsetSet($offset, $value) {
 	 * @param mixed  $offset  An Argument object or the name of the argument.
 	 */
 	public function offsetUnset($offset) {
-		if ($offset instanceOf \cli\arguments\Argument) {
+		if ($offset instanceOf Argument) {
 			$offset = $offset->key;
 		}
 
@@ -197,7 +196,7 @@ public function addFlags($flags) {
 	/**
 	 * Adds an option (string argument) to the argument list.
 	 *
-	 * @param mixed  $flag  A string representing the option, or an array of strings.
+	 * @param mixed  $option  A string representing the option, or an array of strings.
 	 * @param array  $settings  An array of settings for this option.
 	 * @setting string  description  A description to be shown in --help.
 	 * @setting bool    default  The default value for this option.
@@ -280,7 +279,7 @@ public function getInvalidArguments() {
 	 * @return array
 	 */
 	public function getFlag($flag) {
-		if ($flag instanceOf \cli\arguments\Argument) {
+		if ($flag instanceOf Argument) {
 			$obj  = $flag;
 			$flag = $flag->value;
 		}
@@ -341,7 +340,7 @@ public function isStackable($flag) {
 	 * @return array
 	 */
 	public function getOption($option) {
-		if ($option instanceOf \cli\arguments\Argument) {
+		if ($option instanceOf Argument) {
 			$obj = $option;
 			$option = $option->value;
 		}
@@ -386,11 +385,12 @@ public function isOption($argument) {
 	 * if a long name is not given.
 	 *
 	 * @return array
+	 * @throws arguments\InvalidArguments
 	 */
 	public function parse() {
 		$this->_invalid = array();
 		$this->_parsed = array();
-		$this->_lexer = new \cli\arguments\Lexer($this->_input);
+		$this->_lexer = new Lexer($this->_input);
 
 		foreach ($this->_lexer as $argument) {
 			if ($this->_parseFlag($argument)) {
@@ -404,7 +404,7 @@ public function parse() {
 		}
 
 		if ($this->_strict && !empty($this->_invalid)) {
-			throw new \cli\arguments\InvalidArguments($this->_invalid);
+			throw new InvalidArguments($this->_invalid);
 		}
 	}
 

lib/cli/Colors.php

@@ -74,6 +74,7 @@ static public function shouldColorize($colored = null) {
 	 * Set the color.
 	 *
 	 * @param string  $color  The name of the color or style to set.
+     * @return string
 	 */
 	static public function color($color) {
 		if (!is_array($color)) {
@@ -105,7 +106,9 @@ static public function color($color) {
 	 * Colorize a string using helpful string formatters. If the `Streams::$out` points to a TTY coloring will be enabled,
 	 * otherwise disabled. You can control this check with the `$colored` parameter.
 	 *
+     * @param string   $string
 	 * @param boolean  $colored  Force enable or disable the colorized output. If left as `null` the TTY will control coloring.
+     * @return string
 	 */
 	static public function colorize($string, $colored = null) {
 		static $conversions = array(
@@ -161,6 +164,7 @@ static public function colorize($string, $colored = null) {
 	 * Return the length of the string without color codes.
 	 *
 	 * @param string  $string  the string to measure
+     * @return string
 	 */
 	static public function length($string) {
 		return strlen(self::colorize($string, false));
@@ -171,6 +175,7 @@ static public function length($string) {
 	 *
 	 * @param string  $string  the string to pad
 	 * @param integer  $length  the display length
+     * @return string
 	 */
 	static public function pad($string, $length) {
 		$real_length = strlen($string);

lib/cli/Notify.php

@@ -12,6 +12,8 @@
 
 namespace cli;
 
+use cli\Streams;
+
 /**
  * The `Notify` class is the basis of all feedback classes, such as Indicators
  * and Progress meters. The default behaviour is to refresh output after 100ms
@@ -117,8 +119,6 @@ public function speed() {
 	 * @return string  The formatted time span.
 	 */
 	public function formatTime($time) {
-		$minutes = $time / 60;
-		$seconds = $time % 60;
 		return floor($time / 60) . ':' . str_pad($time % 60, 2, 0, STR_PAD_LEFT);
 	}
 
@@ -129,9 +129,9 @@ public function formatTime($time) {
 	 * @see cli\Notify::display()
 	 */
 	public function finish() {
-		\cli\out("\r");
+		Streams::out("\r");
 		$this->display(true);
-		\cli\line();
+		Streams::line();
 	}
 
 	/**
@@ -178,7 +178,7 @@ public function tick($increment = 1) {
 		$this->increment($increment);
 
 		if ($this->shouldUpdate()) {
-			\cli\out("\r");
+			Streams::out("\r");
 			$this->display();
 		}
 	}

lib/cli/Shell.php

@@ -24,10 +24,10 @@ class Shell {
 	 * @todo Test on more systems.
 	 */
 	static public function columns() {
-		if( strpos( $_SERVER['OS'], 'indows' ) !== false )
+		if (stripos(PHP_OS, 'indows') === false) {
 			return exec('/usr/bin/env tput cols');
-		else
-			return 80; // default width of cmd window on Windows OS, maybe force using MODE CON COLS=XXX?
+		}
+		return 80; // default width of cmd window on Windows OS, maybe force using MODE CON COLS=XXX?
 	}
 
 	/**

lib/cli/Streams.php

@@ -144,7 +144,7 @@ public static function input( $format = null ) {
 	 * @return string  The users input.
 	 * @see cli\input()
 	 */
-	public static function prompt( $question, $default = false, $marker = ': ' ) {
+	public static function prompt( $question, $default = null, $marker = ': ' ) {
 		if( $default && strpos( $question, '[' ) === false ) {
 			$question .= ' [' . $default . ']';
 		}
@@ -165,8 +165,7 @@ public static function prompt( $question, $default = false, $marker = ': ' ) {
 	 * questions (which this public static function defaults too).
 	 *
 	 * @param string  $question  The question to ask the user.
-	 * @param string  $valid     A string of characters allowed as a response. Case
-	 *                           is ignored.
+	 * @param string  $choice    A string of characters allowed as a response. Case is ignored.
 	 * @param string  $default   The default choice. NULL if a default is not allowed.
 	 * @return string  The users choice.
 	 * @see cli\prompt()
@@ -206,7 +205,7 @@ public static function choose( $question, $choice = 'yn', $default = 'n' ) {
 	 * @see cli\input()
 	 * @see cli\err()
 	 */
-	public static function menu( $items, $default = false, $title = 'Choose an item' ) {
+	public static function menu( $items, $default = null, $title = 'Choose an item' ) {
 		$map = array_values( $items );
 
 		if( $default && strpos( $title, '[' ) === false && isset( $items[$default] ) ) {