- Add support for repeatableflags

Author: DannyBen

examples/README.md

@@ -24,6 +24,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [extensible](extensible#readme) - letting your script's users extend the script
 - [extensible-delegate](extensible-delegate#readme) - extending your script by delegating commands to an external executable
 - [whitelist](whitelist#readme) - arguments and flags with a predefined allowed list of values
+- [repeatable](repeatable#readme) - allowing flags to be provided multiple times
 - [command-private](command-private#readme) - hiding commands from the command list
 - [stdin](stdin#readme) - reading input from stdin
 - [filters](filters#readme) - preventing commands from running unless custom conditions are met

examples/repeatable/.gitignore

@@ -0,0 +1 @@
+download

examples/repeatable/README.md

@@ -0,0 +1,123 @@
+# Repeatable Example
+
+Demonstrates the use of repeatable flags that allow users to run commands such
+as `download -d one -d "two three" -vvv`.
+
+This example was generated with:
+
+```bash
+$ bashly init --minimal
+# ... now edit src/bashly.yml to match the example ...
+# ... now edit src/root_command.sh to match the example ...
+$ bashly generate
+```
+
+<!-- include: src/root_command.sh -->
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: download
+help: Sample application to demonstrate the use of repeatable flags
+version: 0.1.0
+
+flags:
+- long: --data
+  short: -d
+  arg: data
+  help: Provide data values
+  required: true
+
+  # Setting this to true on a flag with an argument means the user can type it
+  # multiple times, like --data a --data b.
+  # The argument will be received as a quoted and space-delimited string which
+  # needs to be converted to an array with `eval "data=(${args[--data]})"`
+  repeatable: true
+
+- long: --verbose
+  short: -v
+  help: Set verbosity level
+
+  # Setting this to true on a regular flag means the user can type it multiple
+  # times, in the form of -vvv or -v -v -v.
+  # The argument's value will hold the number of times it was entered.
+  repeatable: true
+
+examples:
+  - download -d one -d "two three" -vvv
+```
+
+## `src/root_command.sh`
+
+```bash
+# Convert the space delimited string to an array
+eval "data=(${args[--data]})"
+
+echo "Data elements:"
+for i in "${data[@]}"; do
+  echo "$i"
+done
+
+# The --verbose arg will contain the number of times it was used by the user
+verbose=${args[--verbose]}
+echo ""
+echo "Verbosity level: $verbose"
+echo ""
+
+inspect_args
+
+```
+
+
+## Generated script output
+
+### `$ ./download -h`
+
+```shell
+download - Sample application to demonstrate use of repeatable flags
+
+Usage:
+  download [options]
+  download --help | -h
+  download --version
+
+Options:
+  --help, -h
+    Show this help
+
+  --version
+    Show version number
+
+  --data, -d DATA (required) (repeatable)
+    Provide data values
+
+  --verbose, -v (repeatable)
+    Set verbosity level
+
+Examples:
+  download -d one -d "two three" -vvv
+
+
+
+```
+
+### `$ ./download -d one -d "two three" -vvv`
+
+```shell
+Data elements:
+one
+two three
+
+Verbosity level: 3
+
+args:
+- ${args[--data]} = "one" "two three"
+- ${args[--verbose]} = 3
+
+
+```
+
+
+

examples/repeatable/src/bashly.yml

@@ -0,0 +1,29 @@
+name: download
+help: Sample application to demonstrate the use of repeatable flags
+version: 0.1.0
+
+flags:
+- long: --data
+  short: -d
+  arg: data
+  help: Provide data values
+  required: true
+
+  # Setting this to true on a flag with an argument means the user can type it
+  # multiple times, like --data a --data b.
+  # The argument will be received as a quoted and space-delimited string which
+  # needs to be converted to an array with `eval "data=(${args[--data]})"`
+  repeatable: true
+
+- long: --verbose
+  short: -v
+  help: Set verbosity level
+
+  # Setting this to true on a regular flag means the user can type it multiple
+  # times, in the form of -vvv or -v -v -v.
+  # The argument's value will hold the number of times it was entered.
+  repeatable: true
+
+examples:
+  - download -d one -d "two three" -vvv
+

examples/repeatable/src/initialize.sh

@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment vairables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.

examples/repeatable/src/root_command.sh

@@ -0,0 +1,15 @@
+# Convert the space delimited string to an array
+eval "data=(${args[--data]})"
+
+echo "Data elements:"
+for i in "${data[@]}"; do
+  echo "$i"
+done
+
+# The --verbose arg will contain the number of times it was used by the user
+verbose=${args[--verbose]}
+echo ""
+echo "Verbosity level: $verbose"
+echo ""
+
+inspect_args

examples/repeatable/test.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./download -h
+./download -d one -d "two three" -vvv

lib/bashly/config_validator.rb

@@ -79,6 +79,7 @@ def assert_arg(key, value)
       assert_optional_string "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
       assert_boolean "#{key}.required", value['required']
+      assert_boolean "#{key}.repeatable", value['repeatable']
 
       assert_array "#{key}.allowed", value['allowed'], of: :string
 

lib/bashly/script/base.rb

@@ -25,6 +25,7 @@ class Base
         name
         parent_name
         private
+        repeatable
         required
         short
         validate

lib/bashly/script/flag.rb

@@ -19,6 +19,7 @@ def usage_string(extended: false)
         result = [aliases.join(", ")]
         result << arg.upcase if arg
         result << strings[:required] if required and extended
+        result << strings[:repeatable] if repeatable and extended
         result.join " "
       end
     end