Merge pull request #456 from DannyBen/add/unique-repeatable-arg

Add support for `unique` in repeatable args

Author: DannyBen

examples/repeatable-arg/README.md

@@ -34,6 +34,9 @@ args:
   # needs to be converted to an array with `eval "data=(${args[file]})"`
   repeatable: true
 
+  # Setting unique to true will ignore non-unique repeating values
+  unique: true
+
 examples:
 - upcase README.md LICENSE
 - upcase *.md
@@ -125,5 +128,23 @@ args:
 
 ````
 
+### `$ ./upcase file1 file2 file1`
+
+````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"
+
+
+````
+
 
 

examples/repeatable-arg/src/bashly.yml

@@ -13,6 +13,9 @@ args:
   # needs to be converted to an array with `eval "data=(${args[file]})"`
   repeatable: true
 
+  # Setting unique to true will ignore non-unique repeating values
+  unique: true
+
 examples:
 - upcase README.md LICENSE
 - upcase *.md

examples/repeatable-arg/test.sh

@@ -9,3 +9,4 @@ bashly generate
 ./upcase -h
 ./upcase file1
 ./upcase file*
+./upcase file1 file2 file1

lib/bashly/config_validator.rb

@@ -95,12 +95,17 @@ def assert_arg(key, value)
       assert_optional_string "#{key}.validate", value['validate']
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.repeatable", value['repeatable']
+      assert_boolean "#{key}.unique", value['unique']
 
       assert_array "#{key}.allowed", value['allowed'], of: :string
 
       refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
 
       refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
+
+      if value['unique']
+        assert value['repeatable'], "#{key}.unique does not make sense without nub`repeatable`"
+      end
     end
 
     def assert_flag(key, value)
@@ -143,8 +148,7 @@ def assert_flag(key, value)
       end
 
       if value['unique']
-        condition = value['arg'] && value['repeatable']
-        assert condition, "#{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
     end
 

lib/bashly/script/argument.rb

@@ -4,7 +4,7 @@ class Argument < Base
       class << self
         def option_keys
           @option_keys ||= %i[
-            allowed default help name repeatable required validate
+            allowed default help name repeatable required unique validate
           ]
         end
       end

lib/bashly/views/command/parse_requirements_case_repeatable.gtx

@@ -7,9 +7,17 @@ args.each do |arg|
   if arg.repeatable
     >   args['{{ arg.name }}']="\"$1\""
     >   shift
-    > else
-    >   args['{{ arg.name }}']="${args[{{ arg.name }}]} \"$1\""
-    >   shift
+    if arg.unique
+      > elif [[ ! "${args['{{ arg.name }}']}" =~ \"$1\" ]]; then
+      >   args['{{ arg.name }}']="${args[{{ arg.name }}]} \"$1\""
+      >   shift
+      > else
+      >   shift
+    else
+      > else
+      >   args['{{ arg.name }}']="${args[{{ arg.name }}]} \"$1\""
+      >   shift
+    end
 
   else
     >   args['{{ arg.name }}']=$1

spec/approvals/examples/repeatable-arg

@@ -47,3 +47,15 @@ files:
 
 args:
 - ${args[file]} = "file1" "file2"
++ ./upcase file1 file2 file1
+
+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"

spec/approvals/validations/arg_unique_without_repeatable

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.args[0].unique does not make sense without nub`repeatable`>

spec/fixtures/script/validations.yml

@@ -42,6 +42,14 @@
   - name: target
     help: Target filename
 
+:arg_unique_without_repeatable:
+  name: invalid
+  help: arg must be repeatable when using unique
+  args:
+  - name: target
+    help: Target filename
+    unique: true
+
 :command_catch_all_type:
   name: invalid
   help: catch_all must be boolean, string, or hash