Fix most of the namespaces and phpdocs

Author: Ryan

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,12 +12,6 @@
 
 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';
-
 /**
  * Parses command line arguments.
  */
@@ -69,7 +63,7 @@ public function getArguments() {
 	}
 
 	public function getHelpScreen() {
-		return new \cli\arguments\HelpScreen($this);
+		return new arguments\HelpScreen($this);
 	}
 
 	/**
@@ -88,7 +82,7 @@ public function asJSON() {
 	 * @return bool
 	 */
 	public function offsetExists($offset) {
-		if ($offset instanceOf \cli\arguments\Argument) {
+		if ($offset instanceOf arguments\Argument) {
 			$offset = $offset->key;
 		}
 
@@ -102,7 +96,7 @@ public function offsetExists($offset) {
 	 * @return mixed
 	 */
 	public function offsetGet($offset) {
-		if ($offset instanceOf \cli\arguments\Argument) {
+		if ($offset instanceOf arguments\Argument) {
 			$offset = $offset->key;
 		}
 
@@ -118,7 +112,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 arguments\Argument) {
 			$offset = $offset->key;
 		}
 
@@ -131,7 +125,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 arguments\Argument) {
 			$offset = $offset->key;
 		}
 
@@ -197,7 +191,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.
@@ -341,7 +335,7 @@ public function isStackable($flag) {
 	 * @return array
 	 */
 	public function getOption($option) {
-		if ($option instanceOf \cli\arguments\Argument) {
+		if ($option instanceOf arguments\Argument) {
 			$obj = $option;
 			$option = $option->value;
 		}
@@ -386,11 +380,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 arguments\Lexer($this->_input);
 
 		foreach ($this->_lexer as $argument) {
 			if ($this->_parseFlag($argument)) {
@@ -404,7 +399,7 @@ public function parse() {
 		}
 
 		if ($this->_strict && !empty($this->_invalid)) {
-			throw new \cli\arguments\InvalidArguments($this->_invalid);
+			throw new arguments\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

@@ -117,8 +117,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);
 	}
 

lib/cli/arguments/Argument.php

@@ -12,10 +12,12 @@
 
 namespace cli\arguments;
 
+use cli\Memoize;
+
 /**
  * Represents an Argument or a value and provides several helpers related to parsing an argument list.
  */
-class Argument extends \cli\Memoize {
+class Argument extends Memoize {
 	/**
 	 * The canonical name of this argument, used for aliasing.
 	 *

lib/cli/arguments/HelpScreen.php

@@ -12,6 +12,8 @@
 
 namespace cli\arguments;
 
+use cli\Arguments;
+
 /**
  * Arguments help screen renderer
  */
@@ -21,27 +23,27 @@ class HelpScreen {
 	protected $_options = array();
 	protected $_maxOption = 0;
 
-	public function __construct(\cli\Arguments $arguments) {
+	public function __construct(Arguments $arguments) {
 		$this->setArguments($arguments);
 	}
 
 	public function __toString() {
 		return $this->render();
 	}
 
-	public function setArguments(\cli\Arguments $arguments) {
+	public function setArguments(Arguments $arguments) {
 		$this->consumeArgumentFlags($arguments);
 		$this->consumeArgumentOptions($arguments);
 	}
 
-	public function consumeArgumentFlags(\cli\Arguments $arguments) {
+	public function consumeArgumentFlags(Arguments $arguments) {
 		$data = $this->_consume($arguments->getFlags());
 
 		$this->_flags = $data[0];
 		$this->_flagMax = $data[1];
 	}
 
-	public function consumeArgumentOptions(\cli\Arguments $arguments) {
+	public function consumeArgumentOptions(Arguments $arguments) {
 		$data = $this->_consume($arguments->getOptions());
 
 		$this->_options = $data[0];

lib/cli/arguments/Lexer.php

@@ -12,7 +12,9 @@
 
 namespace cli\arguments;
 
-class Lexer extends \cli\Memoize implements \Iterator {
+use cli\Memoize;
+
+class Lexer extends Memoize implements \Iterator {
 	private $_items = array();
 	private $_index = 0;
 	private $_length = 0;
@@ -37,10 +39,10 @@ public function current() {
 	/**
 	 * Peek ahead to the next token without moving the cursor.
 	 *
-	 * @return cli\arguments\Argument
+	 * @return Argument
 	 */
 	public function peek() {
-		return new \cli\arguments\Argument($this->_items[0]);
+		return new Argument($this->_items[0]);
 	}
 
 	/**
@@ -103,7 +105,7 @@ public function end() {
 	}
 
 	private function _shift() {
-		$this->_item = new \cli\arguments\Argument(array_shift($this->_items));
+		$this->_item = new Argument(array_shift($this->_items));
 		$this->_index += 1;
 		$this->_explode();
 		$this->_unmemo('peek');

lib/cli/notify/Dots.php

@@ -12,10 +12,12 @@
 
 namespace cli\notify;
 
+use cli\Notify;
+
 /**
  * A Notifer that displays a string of periods.
  */
-class Dots extends \cli\Notify {
+class Dots extends Notify {
 	protected $_dots;
 	protected $_format = '{:msg}{:dots}  ({:elapsed}, {:speed}/s)';
 	protected $_iteration;
@@ -26,6 +28,7 @@ class Dots extends \cli\Notify {
 	 * @param string  $msg       The text to display next to the Notifier.
 	 * @param int     $dots      The number of dots to iterate through.
 	 * @param int     $interval  The interval in milliseconds between updates.
+     * @throws \InvalidArgumentException
 	 */
 	public function __construct($msg, $dots = 3, $interval = 100) {
 		parent::__construct($msg, $interval);

lib/cli/notify/Spinner.php

@@ -12,10 +12,12 @@
 
 namespace cli\notify;
 
+use cli\Notify;
+
 /**
  * The `Spinner` Notifier displays an ASCII spinner.
  */
-class Spinner extends \cli\Notify {
+class Spinner extends Notify {
 	protected $_chars = '-\|/';
 	protected $_format = '{:msg} {:char}  ({:elapsed}, {:speed}/s)';
 	protected $_iteration = 0;

lib/cli/progress/Bar.php

@@ -12,14 +12,16 @@
 
 namespace cli\progress;
 
+use cli;
+
 /**
  * Displays a progress bar spanning the entire shell.
  *
  * Basic format:
  *
  *   ^MSG  PER% [=======================            ]  00:00 / 00:00$
  */
-class Bar extends \cli\Progress {
+class Bar extends Progress {
 	protected $_bars = '=>';
 	protected $_formatMessage = '{:msg}  {:percent}% [';
 	protected $_formatTiming = '] {:elapsed} / {:estimated}';
@@ -43,19 +45,19 @@ public function display($finish = false) {
 
 		$percent = str_pad(floor($_percent * 100), 3);;
 		$msg = $this->_message;
-		$msg = \cli\render($this->_formatMessage, compact('msg', 'percent'));
+		$msg = cli\render($this->_formatMessage, compact('msg', 'percent'));
 
 		$estimated = $this->formatTime($this->estimated());
 		$elapsed   = str_pad($this->formatTime($this->elapsed()), strlen($estimated));
-		$timing    = \cli\render($this->_formatTiming, compact('elapsed', 'estimated'));
+		$timing    = cli\render($this->_formatTiming, compact('elapsed', 'estimated'));
 
-		$size = \cli\Shell::columns();
+		$size = cli\Shell::columns();
 		$size -= strlen($msg . $timing);
 
 		$bar = str_repeat($this->_bars[0], floor($_percent * $size)) . $this->_bars[1];
 		// substr is needed to trim off the bar cap at 100%
 		$bar = substr(str_pad($bar, $size, ' '), 0, $size);
 
-		\cli\out($this->_format, compact('msg', 'bar', 'timing'));
+		cli\out($this->_format, compact('msg', 'bar', 'timing'));
 	}
 }

lib/cli/table/Ascii.php

@@ -11,6 +11,7 @@
  */
 
 namespace cli\table;
+use cli\Colors;
 
 /**
  * The ASCII renderer renders tables with ASCII borders.
@@ -63,10 +64,10 @@ public function row(array $row) {
 		array_unshift($row, ''); // First border
 		array_push($row, ''); // Last border
 
-	return join($this->_characters['border'], $row);
+	    return join($this->_characters['border'], $row);
 	}
 
 	private function padColumn($content, $column) {
-		return ' ' . \cli\Colors::pad($content, $this->_widths[$column]) . ' ';
+		return ' ' . Colors::pad($content, $this->_widths[$column]) . ' ';
 	}
 }