From fedf7309dbf83f8d5755b4a1f7e44f51d26e8b40 Mon Sep 17 00:00:00 2001 From: Hassan Khan Date: Sun, 16 Feb 2014 22:16:37 +0000 Subject: [PATCH] Updated ``Zepto\Console`` and changed all method signatures to use snake case, fitting in more with my liking --- library/Zepto/Console.php | 38 +++++++++--------- tests/Zepto/ConsoleTest.php | 80 ++++++++++++++++++------------------- 2 files changed, 59 insertions(+), 59 deletions(-) diff --git a/library/Zepto/Console.php b/library/Zepto/Console.php index 8565dd8..364e16c 100644 --- a/library/Zepto/Console.php +++ b/library/Zepto/Console.php @@ -71,7 +71,7 @@ public function __construct($inputs = null) */ public function option($flags, $help_text, $required = FALSE) { - $options = $this->parseOption($flags); + $options = $this->parse_option($flags); $options["help"] = $flags . ' ' . $help_text; @@ -79,7 +79,7 @@ public function option($flags, $help_text, $required = FALSE) $options["required"] = TRUE; } - $this->setOption($options["short"], $options); + $this->set_option($options["short"], $options); } @@ -107,7 +107,7 @@ public function param($param, $help_text, $required = FALSE) $options["required"] = FALSE; } - $this->setParam($options); + $this->set_param($options); } /** @@ -116,7 +116,7 @@ public function param($param, $help_text, $required = FALSE) * @param string $string * @return array */ - private function parseOption($string) + private function parse_option($string) { $output = array(); $exploded = explode(",", $string); @@ -146,20 +146,20 @@ public function parse() { // check if a help flag is set try { - $key = $this->checkInputs("-h", "--help"); + $key = $this->check_inputs("-h", "--help"); if ($key !== FALSE) { throw new \Exception("Help flag is set"); } } catch (\Exception $e) { - $this->outputHelp(); + $this->output_help(); return FALSE; } // loop through options and see if they are in the inputs foreach ($this->options as $option => $info) { // if option is in inputs - $key = $this->checkInputs($info["short"], $info["long"]); + $key = $this->check_inputs($info["short"], $info["long"]); if ($key === FALSE) { $this->processed_inputs[$info["short"]] = FALSE; $this->processed_inputs[$info["long"]] = FALSE; @@ -200,10 +200,10 @@ public function parse() // check required inputs try { - $this->checkRequired(); + $this->check_required(); } catch (\Exception $e) { echo $e->getMessage() . PHP_EOL . PHP_EOL; - $this->outputHelp(TRUE); + $this->output_help(TRUE); return FALSE; } @@ -217,7 +217,7 @@ public function parse() * @param string $long * @return bool|mixed */ - private function checkInputs($short, $long) + private function check_inputs($short, $long) { $key = array_search($short, $this->inputs); if ($key === FALSE) { @@ -237,7 +237,7 @@ private function checkInputs($short, $long) * * @throws \Exception if required param or option is not present */ - private function checkRequired() + private function check_required() { // Loop through all params foreach ($this->params as $param) { @@ -267,7 +267,7 @@ private function checkRequired() * @param string $name * @param $options */ - public function setOption($name, $options) + public function set_option($name, $options) { $this->options[$name] = $options; } @@ -277,7 +277,7 @@ public function setOption($name, $options) * * @param $options */ - public function setParam($options) + public function set_param($options) { $this->params[] = $options; } @@ -287,7 +287,7 @@ public function setParam($options) * * @return array */ - public function getOptions() + public function get_options() { return $this->options; } @@ -297,7 +297,7 @@ public function getOptions() * * @return array of params */ - public function getParams() + public function get_params() { return $this->params; } @@ -307,7 +307,7 @@ public function getParams() * * @return array */ - public function getInputs() + public function get_inputs() { return $this->processed_inputs; } @@ -317,7 +317,7 @@ public function getInputs() * * @return mixed */ - public function getName() + public function get_name() { return $this->name; } @@ -414,9 +414,9 @@ public static function out($msg) * * @param bool $short */ - public function outputHelp($short = FALSE) + public function output_help($short = FALSE) { - echo PHP_EOL . "Usage: {$this->getName()} "; + echo PHP_EOL . "Usage: {$this->get_name()} "; if (!empty($this->params)) { foreach ($this->params as $param) { if ($param["required"] === TRUE) { diff --git a/tests/Zepto/ConsoleTest.php b/tests/Zepto/ConsoleTest.php index 19c9814..dc9cd8e 100644 --- a/tests/Zepto/ConsoleTest.php +++ b/tests/Zepto/ConsoleTest.php @@ -9,7 +9,7 @@ class ConsoleTest extends \PHPUnit_Framework_TestCase /** * @covers Zepto\Console::__construct() - * @covers Zepto\Console::getName() + * @covers Zepto\Console::get_name() */ public function testGetName() { $zep = new Console(array( @@ -19,12 +19,12 @@ public function testGetName() { $zep->parse(); - $this->assertEquals('zep', $zep->getName()); + $this->assertEquals('zep', $zep->get_name()); } /** * @covers Zepto\Console::__construct() - * @covers Zepto\Console::getInputs() + * @covers Zepto\Console::get_inputs() */ public function testGetInputs() { $zep = new Console(array( @@ -39,14 +39,14 @@ public function testGetInputs() { ); $zep->parse(); - $this->assertEquals($expected, $zep->getInputs()); + $this->assertEquals($expected, $zep->get_inputs()); } /** * @covers Zepto\Console::option() - * @covers Zepto\Console::checkInputs() + * @covers Zepto\Console::check_inputs() * @covers Zepto\Console::parse() - * @covers Zepto\Console::checkRequired() + * @covers Zepto\Console::check_required() */ public function testParse() { $zep = new Console(array( @@ -73,9 +73,9 @@ public function testParse() { /** * @covers Zepto\Console::param() - * @covers Zepto\Console::setParam() + * @covers Zepto\Console::set_param() * @covers Zepto\Console::parse() - * @covers Zepto\Console::checkRequired() + * @covers Zepto\Console::check_required() */ public function testParseWithParam() { $zep = new Console(array( @@ -94,9 +94,9 @@ public function testParseWithParam() { /** * @covers Zepto\Console::param() - * @covers Zepto\Console::setParam() + * @covers Zepto\Console::set_param() * @covers Zepto\Console::parse() - * @covers Zepto\Console::checkRequired() + * @covers Zepto\Console::check_required() */ public function testParseWithRequiredParam() { $zep = new Console(array( @@ -113,9 +113,9 @@ public function testParseWithRequiredParam() { /** * @covers Zepto\Console::param() - * @covers Zepto\Console::setParam() + * @covers Zepto\Console::set_param() * @covers Zepto\Console::parse() - * @covers Zepto\Console::checkRequired() + * @covers Zepto\Console::check_required() */ public function testParseWithRequiredParamWhenNotGiven() { $zep = new Console(array( @@ -134,10 +134,10 @@ public function testParseWithRequiredParamWhenNotGiven() { /** * @covers Zepto\Console::option() - * @covers Zepto\Console::parseOption() - * @covers Zepto\Console::setOption() + * @covers Zepto\Console::parse_option() + * @covers Zepto\Console::set_option() * @covers Zepto\Console::parse() - * @covers Zepto\Console::checkRequired() + * @covers Zepto\Console::check_required() */ public function testParseWithOption() { $zep = new Console(array('zep')); @@ -145,7 +145,7 @@ public function testParseWithOption() { $zep->option('-c, --cheese [type]', 'Add a cheese'); $zep->parse(); - $options = $zep->getOptions(); + $options = $zep->get_options(); $this->assertCount(2, $options); $this->assertArrayHasKey('-p', $options); @@ -155,9 +155,9 @@ public function testParseWithOption() { /** * @covers Zepto\Console::option() - * @covers Zepto\Console::checkInputs() + * @covers Zepto\Console::check_inputs() * @covers Zepto\Console::parse() - * @covers Zepto\Console::checkRequired() + * @covers Zepto\Console::check_required() */ public function testParseWithNonOptions() { $zep = new Console(array( @@ -187,10 +187,10 @@ public function testParseWithNonOptions() { /** * @covers Zepto\Console::option() - * @covers Zepto\Console::parseOption() - * @covers Zepto\Console::setOption() + * @covers Zepto\Console::parse_option() + * @covers Zepto\Console::set_option() * @covers Zepto\Console::parse() - * @covers Zepto\Console::checkRequired() + * @covers Zepto\Console::check_required() */ public function testParseWithRequiredOption() { $zep = new Console(array( @@ -214,10 +214,10 @@ public function testParseWithRequiredOption() { /** * @covers Zepto\Console::option() - * @covers Zepto\Console::parseOption() - * @covers Zepto\Console::setOption() + * @covers Zepto\Console::parse_option() + * @covers Zepto\Console::set_option() * @covers Zepto\Console::parse() - * @covers Zepto\Console::checkRequired() + * @covers Zepto\Console::check_required() */ public function testParseWithRequiredOptionNotGiven() { $zep = new Console(array( @@ -240,8 +240,8 @@ public function testParseWithRequiredOptionNotGiven() { /** * @covers Zepto\Console::parse() - * @covers Zepto\Console::checkInputs() - * @covers Zepto\Console::outputHelp() + * @covers Zepto\Console::check_inputs() + * @covers Zepto\Console::output_help() */ public function testParseWithHelpFlagSet() { $zep = new Console(array( @@ -255,7 +255,7 @@ public function testParseWithHelpFlagSet() { } /** - * @covers Zepto\Console::getParams() + * @covers Zepto\Console::get_params() */ public function testGetParams() { @@ -281,11 +281,11 @@ public function testGetParams() ), ); - $this->assertEquals($expected, $zep->getParams()); + $this->assertEquals($expected, $zep->get_params()); } /** - * @covers Zepto\Console::getOptions() + * @covers Zepto\Console::get_options() */ public function testGetOptions() { @@ -311,7 +311,7 @@ public function testGetOptions() ) ); - $this->assertEquals($expected, $zep->getOptions()); + $this->assertEquals($expected, $zep->get_options()); } /** @@ -373,11 +373,11 @@ public function testOutAsStaticMethod() /** * @covers Zepto\Console::option() - * @covers Zepto\Console::parseOption() - * @covers Zepto\Console::setOption() + * @covers Zepto\Console::parse_option() + * @covers Zepto\Console::set_option() * @covers Zepto\Console::param() - * @covers Zepto\Console::setParam() - * @covers Zepto\Console::outputHelp() + * @covers Zepto\Console::set_param() + * @covers Zepto\Console::output_help() */ public function testOutputHelp() { $zep = new Console(array( @@ -394,18 +394,18 @@ public function testOutputHelp() { $zep->param('client', 'Name of client', true); $zep->param('locale', 'Client locale'); - $zep->outputHelp(); + $zep->output_help(); $this->expectOutputString(PHP_EOL . "Usage: zep [locale] [options]\n\nParameters:\n\t Name of client\n\t[locale] Client locale\n\nOptions:\n\t-p, --peppers Add peppers\n\t-c, --cheese [type] Add a cheese\n\t-m, --mayo Add mayonaise\n\t-b, --bread [type] Type of bread [required]\n\t-h, --help Output usage information\n"); } /** * @covers Zepto\Console::option() - * @covers Zepto\Console::parseOption() - * @covers Zepto\Console::setOption() + * @covers Zepto\Console::parse_option() + * @covers Zepto\Console::set_option() * @covers Zepto\Console::param() - * @covers Zepto\Console::setParam() - * @covers Zepto\Console::outputHelp() + * @covers Zepto\Console::set_param() + * @covers Zepto\Console::output_help() */ public function testOutputHelpShortened() { $zep = new Console(array( @@ -422,7 +422,7 @@ public function testOutputHelpShortened() { $zep->param('client', 'Name of client', true); $zep->param('locale', 'Client locale'); - $zep->outputHelp(TRUE); + $zep->output_help(TRUE); $this->expectOutputString("\nUsage: zep [locale] [options]\n"); }