Merge pull request nategood#63 from NeoVance/38-option-repetition-and…

…-grouping

38 option repetition and grouping

.gitignore

@@ -1,2 +1,3 @@
 vendor
 composer.lock
+.c9

README.md

@@ -64,10 +64,19 @@ $hello_cmd->option('c')
     ->aka('cap')
     ->describedAs('Always capitalize the words in a name')
     ->boolean();
+
+// Define an incremental flag "-e" aka "--educate"
+$hello_cmd->option('e')
+    ->aka('educate')
+    ->map(function($value) {
+        $postfix = array('', 'Jr', 'esq', 'PhD');
+        return $postfix[$value] === '' ? '' : " {$postfix[$value]}";
+    })
+    ->count(4);
 
 $name = $hello_cmd['capitalize'] ? ucwords($hello_cmd[0]) : $hello_cmd[0];
 
-echo "Hello {$hello_cmd['title']}$name!", PHP_EOL;
+echo "Hello {$hello_cmd['title']}$name{$hello_cmd['educate']}!", PHP_EOL;
 ```
 
 Running it:
@@ -80,6 +89,9 @@ Running it:
 
     > php hello.php -c -t Mr 'nate good'
     Hello, Mr. Nate Good!
+
+    > php hello.php -ceet Mr 'nate good'
+    Hello, Mr. Nate Good esq!
 
 Things to note:
 
@@ -203,6 +215,12 @@ Aliases: _N/A_
 
 Specifices that the flag is a boolean type flag.
 
+### `increment (int $max)`
+
+Aliases: `i`, `count`, `repeats`, `repeatable`
+
+Specifies that the flag is a counter type flag. The value of the flag will be incremented up to the value of `$max` for each time the flag is used in the command. Options that are set to `increment` or `boolean` types can be grouped together.
+
 ### `default (mixed $defaultValue)`
 
 Aliases: `defaultsTo`

examples/greet.php

@@ -15,11 +15,14 @@
  * > php green.php -c 'nate good'
  * Hello Nate Good!
  *
- * > php greet.php -c -s Mr 'nate good'
+ * > php greet.php -cs Mr 'nate good'
  * Hello Mr. Nate Good!
  *
- * > php greet.php -c -s Mister 'nate good'
+ * > php greet.php -cs Mister 'nate good'
  * Hello Mr. Nate Good!
+ * 
+ * php greet.php -ceet Mr 'nate good'
+ * Hello Mr. Nate Good esq!
  *
  * > php greet.php
  * # Throws an Exception because the command requires at least one
@@ -57,8 +60,16 @@
     ->aka('capitalize')
     ->aka('cap')
     ->describedAs('Always capitalize the words in a name')
-    ->boolean();
+    ->boolean()
+
+  ->option('e')
+    ->aka('educate')
+    ->map(function($value) {
+        $postfix = array('', 'Jr', 'esq', 'PhD');
+        return $postfix[$value] === '' ? '' : " {$postfix[$value]}";
+    })
+    ->count(4);
 
 $name = $hello_cmd['capitalize'] ? ucwords($hello_cmd[0]) : $hello_cmd[0];
 
-echo "Hello {$hello_cmd['title']}$name!", PHP_EOL;
+echo "Hello {$hello_cmd['title']}$name{$hello_cmd['educate']}!", PHP_EOL;

src/Commando/Command.php

@@ -100,6 +100,12 @@ class Command implements \ArrayAccess, \Iterator
         'mapTo' => 'map',
         'cast' => 'map',
         'castWith' => 'map',
+
+        'increment' => 'increment',
+        'repeatable' => 'increment',
+        'repeats' => 'increment',
+        'count' => 'increment',
+        'i' => 'increment',
 
         'must' => 'must',
         // mustBeNumeric
@@ -308,6 +314,16 @@ private function _map(Option $option, \Closure $callback)
     {
         return $option->setMap($callback);
     }
+
+    /**
+     * @param Option $option
+     * @param integer $max
+     * @return Option
+     */
+    private function _increment(Option $option, $max = 0)
+    {
+        return $option->setIncrement($max);
+    }
 
     /**
      * @return Option
@@ -375,6 +391,21 @@ public function parse()
                 $token = array_shift($tokens);
 
                 list($name, $type) = $this->_parseOption($token);
+
+                // We allow short groups
+                if (strlen($name) > 1 && $type === self::OPTION_TYPE_SHORT) {
+
+                    $group = str_split($name);
+                    // correct option name
+                    $name = array_shift($group);
+
+                    // Iterate in reverse order to keep the option order correct
+                    // options that don't require an argument can be mixed.
+                    foreach(array_reverse($group) as $nextShort) {
+                        // put it back into $tokens for another loop
+                        array_unshift($tokens, "-{$nextShort}");
+                    }
+                }
 
                 if ($type === self::OPTION_TYPE_ARGUMENT) {
                     // its an argument, use an int as the index
@@ -398,6 +429,12 @@ public function parse()
                     $option = $this->getOption($name);
                     if ($option->isBoolean()) {
                         $keyvals[$name] = !$option->getDefault();// inverse of the default, as expected
+                    } elseif ($option->isIncrement()) {
+                        if (!isset($keyvals[$name])) {
+                            $keyvals[$name] = $option->getDefault() + 1;
+                        } else {
+                            $keyvals[$name]++;
+                        }
                     } else {
                         // the next token MUST be an "argument" and not another flag/option
                         $token = array_shift($tokens);

src/Commando/Option.php

@@ -51,6 +51,8 @@ class Option
         $type = 0, /* int see constants */
         $rule, /* closure */
         $map, /* closure */
+        $increment = false, /* bool */
+        $max_value = 0, /* int max value for increment */
         $default, /* mixed default value for this option when no value is specified */
         $file = false, /* bool */
         $file_require_exists, /* bool require that the file path is valid */
@@ -115,6 +117,20 @@ public function setBoolean($bool = true)
         $this->boolean = $bool;
         return $this;
     }
+
+    /**
+     * @param int $max
+     * @return Option
+     */
+    public function setIncrement($max = 0)
+    {
+        if($this->default === null) {
+            $this->setDefault(0);
+        }
+        $this->increment = true;
+        $this->max_value = $max;
+        return $this;
+    }
 
     /**
      * Require that the argument is a file.  This will
@@ -313,6 +329,14 @@ public function isBoolean()
         // $this->value = false; // ?
         return $this->boolean;
     }
+
+    /**
+     * @return bool is this option an incremental option
+     */
+    public function isIncrement()
+    {
+        return $this->increment;
+    }
 
     /**
      * @return bool is this option a boolean
@@ -368,6 +392,14 @@ public function setValue($value)
         if (!$this->validate($value)) {
             throw new \Exception(sprintf('Invalid value, %s, for option %s', $value, $this->name));
         }
+        if ($this->isIncrement()) {
+            if (!is_int($value)) {
+                throw new \Exception(sprintf('Integer expected as value for %s, received %s instead', $this->name, $value));
+            }
+            if ($value > $this->max_value && $this->max_value > 0) {
+                $value = $this->max_value;
+            }
+        }
         if ($this->isFile()) {
             $file_path = $this->parseFilePath($value);
             if (empty($file_path)) {

tests/Commando/CommandTest.php

@@ -139,6 +139,30 @@ public function testBooleanOption()
             ->boolean();
         $this->assertTrue($cmd['b']);
     }
+
+    public function testIncrementOption()
+    {
+        $tokens = array('filename', '-vvvv');
+        $cmd = new Command($tokens);
+        $cmd
+            ->flag('v')
+            ->aka('verbosity')
+            ->increment();
+
+        $this->assertEquals(4, $cmd['verbosity']);
+    }
+
+    public function testIncrementOptionMaxValue()
+    {
+        $tokens = array('filename', '-vvvv');
+        $cmd = new Command($tokens);
+        $cmd
+            ->flag('v')
+            ->aka('verbosity')
+            ->increment(3);
+
+        $this->assertEquals(3, $cmd['verbosity']);
+    }
 
     public function testGetValues()
     {