Merge pull request #462 from DannyBen/add/default-array-support

Allow `flag.default` and `arg.default` to be an array if `repeatable` is true

Author: DannyBen

examples/repeatable-arg/README.md

@@ -26,17 +26,22 @@ version: 0.1.0
 args:
 - name: file
   help: One or more files to process
-  required: true
 
   # Setting repeatable to true means that the user can provide multiple arguments
   # for it.
   # The argument will be received as a quoted and space-delimited string which
-  # needs to be converted to an array with `eval "data=(${args[file]})"`
+  # needs to be converted to an array with `eval "data=(${args[file]})"`.
   repeatable: true
 
-  # Setting unique to true will ignore non-unique repeating values
+  # Setting unique to true will ignore non-unique repeating values.
   unique: true
 
+  # Setting default value(s) for a repeatable argument may be done in an array
+  # form (or a string form if it is a single default value only).
+  default:
+  - file1
+  - file2
+
 examples:
 - upcase README.md LICENSE
 - upcase *.md
@@ -47,7 +52,7 @@ examples:
 ````bash
 # Convert the space delimited string to an array
 files=''
-eval "files=(${args[file]})"
+eval "files=(${args[file]:-})"
 
 echo
 echo "files:"
@@ -72,7 +77,7 @@ inspect_args
 upcase - Sample application to demonstrate the use of repeatable arguments
 
 Usage:
-  upcase FILE...
+  upcase [FILE...]
   upcase --help | -h
   upcase --version | -v
 
@@ -86,13 +91,32 @@ Options:
 Arguments:
   FILE...
     One or more files to process
+    Default: file1, file2
 
 Examples:
   upcase README.md LICENSE
   upcase *.md
 
 
 
+````
+
+### `$ ./upcase`
+
+````shell
+
+files:
+  path: file1:
+  content: content of file1
+  upcase: CONTENT OF FILE1
+  path: file2:
+  content: content of file2
+  upcase: CONTENT OF FILE2
+
+args:
+- ${args[file]} = file1 file2
+
+
 ````
 
 ### `$ ./upcase file1`

examples/repeatable-arg/src/bashly.yml

@@ -5,17 +5,22 @@ version: 0.1.0
 args:
 - name: file
   help: One or more files to process
-  required: true
 
   # Setting repeatable to true means that the user can provide multiple arguments
   # for it.
   # The argument will be received as a quoted and space-delimited string which
-  # needs to be converted to an array with `eval "data=(${args[file]})"`
+  # needs to be converted to an array with `eval "data=(${args[file]})"`.
   repeatable: true
 
-  # Setting unique to true will ignore non-unique repeating values
+  # Setting unique to true will ignore non-unique repeating values.
   unique: true
 
+  # Setting default value(s) for a repeatable argument may be done in an array
+  # form (or a string form if it is a single default value only).
+  default:
+  - file1
+  - file2
+
 examples:
 - upcase README.md LICENSE
 - upcase *.md

examples/repeatable-arg/src/root_command.sh

@@ -1,6 +1,6 @@
 # Convert the space delimited string to an array
 files=''
-eval "files=(${args[file]})"
+eval "files=(${args[file]:-})"
 
 echo
 echo "files:"

examples/repeatable-arg/test.sh

@@ -7,6 +7,7 @@ bashly generate
 ### Try Me ###
 
 ./upcase -h
+./upcase
 ./upcase file1
 ./upcase file*
 ./upcase file1 file2 file1

examples/repeatable-flag/README.md

@@ -28,12 +28,11 @@ flags:
   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]})"`
+  # needs to be converted to an array with `eval "data=(${args[--data]})"`.
   repeatable: true
 
 - long: --path
@@ -42,9 +41,15 @@ flags:
   help: Specify one or more paths
   repeatable: true
 
-  # Setting this to true will ignore repeating arguments that are not unique
+  # Setting this to true will ignore repeating arguments that are not unique.
   unique: true
 
+  # Setting default value(s) for a repeatable flag argument may be done in an
+  # array form (or a string form if it is a single default value only).
+  default:
+  - file one
+  - file-two
+
 - long: --verbose
   short: -v
   help: Set verbosity level
@@ -63,7 +68,7 @@ examples:
 
 ````bash
 # Convert the space delimited string to an array
-eval "data=(${args[--data]})"
+eval "data=(${args[--data]:-})"
 
 echo "Data elements:"
 for i in "${data[@]}"; do
@@ -94,11 +99,12 @@ Usage:
   download --version
 
 Options:
-  --data, -d DATA (required) (repeatable)
+  --data, -d DATA (repeatable)
     Provide data values
 
   --path, -p LOCATION (repeatable)
     Specify one or more paths
+    Default: file one, file-two
 
   --verbose, -v (repeatable)
     Set verbosity level
@@ -115,6 +121,19 @@ Examples:
 
 
 
+````
+
+### `$ ./download`
+
+````shell
+Data elements:
+
+Verbosity level: 1
+
+args:
+- ${args[--path]} = file\ one file-two
+
+
 ````
 
 ### `$ ./download -d one -d "two three" -vvv`
@@ -128,6 +147,7 @@ Verbosity level: 3
 
 args:
 - ${args[--data]} = "one" "two three"
+- ${args[--path]} = file\ one file-two
 - ${args[--verbose]} = 3
 
 

examples/repeatable-flag/src/bashly.yml

@@ -7,12 +7,11 @@ flags:
   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]})"`
+  # needs to be converted to an array with `eval "data=(${args[--data]})"`.
   repeatable: true
 
 - long: --path
@@ -21,9 +20,15 @@ flags:
   help: Specify one or more paths
   repeatable: true
 
-  # Setting this to true will ignore repeating arguments that are not unique
+  # Setting this to true will ignore repeating arguments that are not unique.
   unique: true
 
+  # Setting default value(s) for a repeatable flag argument may be done in an
+  # array form (or a string form if it is a single default value only).
+  default:
+  - file one
+  - file-two
+
 - long: --verbose
   short: -v
   help: Set verbosity level

examples/repeatable-flag/src/root_command.sh

@@ -1,5 +1,5 @@
 # Convert the space delimited string to an array
-eval "data=(${args[--data]})"
+eval "data=(${args[--data]:-})"
 
 echo "Data elements:"
 for i in "${data[@]}"; do

examples/repeatable-flag/test.sh

@@ -7,5 +7,6 @@ bashly generate
 ### Try Me ###
 
 ./download -h
+./download
 ./download -d one -d "two three" -vvv
 ./download -d one --path /bin --path /usr/lib --path /bin

lib/bashly/concerns/validation_helpers.rb

@@ -31,7 +31,7 @@ def assert_array(key, value, of: nil)
       return unless of
 
       value.each_with_index do |val, i|
-        send "assert_#{of}".to_sym, "#{key}[#{i}]", val
+        send :"assert_#{of}", "#{key}[#{i}]", val
       end
     end
 

lib/bashly/config_validator.rb

@@ -91,7 +91,7 @@ def assert_arg(key, value)
       assert_hash key, value, keys: Script::Argument.option_keys
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
-      assert_optional_string "#{key}.default", value['default']
+      assert_string_or_array "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.repeatable", value['repeatable']
@@ -106,6 +106,10 @@ def assert_arg(key, value)
       if value['unique']
         assert value['repeatable'], "#{key}.unique does not make sense without nub`repeatable`"
       end
+
+      if value['default'].is_a? Array
+        assert value['repeatable'], "#{key}.default array does not make sense without nub`repeatable`"
+      end
     end
 
     def assert_flag(key, value)
@@ -118,7 +122,7 @@ def assert_flag(key, value)
       assert_optional_string "#{key}.short", value['short']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.arg", value['arg']
-      assert_optional_string "#{key}.default", value['default']
+      assert_string_or_array "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
 
       assert_boolean "#{key}.private", value['private']
@@ -148,7 +152,12 @@ def assert_flag(key, value)
       end
 
       if value['unique']
-        assert value['arg'] && value['repeatable'], "#{key}.unique does not make sense without nub`arg` and nub`repeatable`"
+        assert value['arg'] && value['repeatable'],
+          "#{key}.unique does not make sense without nub`arg` and nub`repeatable`"
+      end
+
+      if value['default'].is_a? Array
+        assert value['repeatable'], "#{key}.default array does not make sense without nub`repeatable`"
       end
     end