Merge pull request #504 from DannyBen/fix/repeatable-arg-quotes

Refactor repeatable+unique args and flag args

Author: DannyBen

lib/bashly/script/command.rb

@@ -101,9 +101,10 @@ def commands
       end
 
       # Returns a flat array containing all the commands in this tree.
-      # This includes self + children + grandchildres + ...
-      def deep_commands
+      # This includes children + grandchildren (recursive), and may include self
+      def deep_commands(include_self: false)
         result = []
+        result << self if include_self
         commands.each do |command|
           result << command
           if command.commands.any?
@@ -217,6 +218,16 @@ def grouped_commands
         result
       end
 
+      # Returns true if this command, or any subcommand (deep) as any arg or
+      # flag with arg that is defined as unique
+      def has_unique_args_or_flags?
+        deep_commands(include_self: true).each do |command|
+          return true if command.args.count(&:unique).positive? ||
+            command.flags.count(&:unique).positive?
+        end
+        false
+      end
+
       # Returns a mode identifier
       def mode
         @mode ||= if global_flags?    then :global_flags

lib/bashly/views/command/parse_requirements_case_repeatable.gtx

@@ -1,30 +1,32 @@
 = view_marker
 
 condition = "if"
-args.each do |arg|
+args.each_with_index do |arg, index|
+  if index == 0
+    > escaped="$(printf '%q' "$1")"
+  end
   > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
   if arg.repeatable
-    >   args['{{ arg.name }}']="\"$1\""
-    >   shift
+    >   args['{{ arg.name }}']="$escaped"
     if arg.unique
-      > elif [[ ! "${args['{{ arg.name }}']}" =~ \"$1\" ]]; then
-      >   args['{{ arg.name }}']="${args[{{ arg.name }}]} \"$1\""
-      >   shift
-      > else
-      >   shift
+      >   unique_lookup["{{ arg.name }}:$escaped"]=1
+    end
+    if arg.unique
+      > elif [[ -z "${unique_lookup["{{ arg.name }}:$escaped"]:-}" ]]; then
+      >   args['{{ arg.name }}']="${args['{{ arg.name }}']} $escaped"
+      >   unique_lookup["{{ arg.name }}:$escaped"]=1
     else
       > else
-      >   args['{{ arg.name }}']="${args[{{ arg.name }}]} \"$1\""
-      >   shift
+      >   args['{{ arg.name }}']="${args['{{ arg.name }}']} $escaped"
     end
 
   else
-    >   args['{{ arg.name }}']=$1
-    >   shift
+    >   args['{{ arg.name }}']="$1"
 
   end
   condition = "elif"
 end
 
 > fi
-> 
+> shift
+> 

lib/bashly/views/command/run.gtx

@@ -6,6 +6,9 @@
 >   declare -a other_args=()
 >   declare -a env_var_names=()
 >   declare -a input=()
+if has_unique_args_or_flags?
+  >   declare -A unique_lookup=()
+end
 >   normalize_input "$@"
 >   parse_requirements "${input[@]}"
 if user_file_exist?('before')
@@ -29,5 +32,3 @@ if user_file_exist?('after')
 end
 
 > }
-
-

lib/bashly/views/flag/case_arg.gtx

@@ -3,15 +3,19 @@
 > if [[ -n ${2+x} ]]; then
 
 if repeatable
+  >   escaped="$(printf '%q' "$2")"
   >   if [[ -z ${args['{{ name }}']+x} ]]; then
-  >     args['{{ name }}']="\"$2\""
+  >     args['{{ name }}']="$escaped"
   if unique
-    >   elif [[ ! "${args['{{ name }}']}" =~ \"$2\" ]]; then
+    >   elif [[ -z "${unique_lookup["{{ name }}:${escaped}"]:-}" ]]; then
   else
     >   else
   end
-  >     args['{{ name }}']="${args['{{ name }}']} \"$2\""
+  >     args['{{ name }}']="${args['{{ name }}']} $escaped"
   >   fi
+  if unique
+    >   unique_lookup["{{ name }}:${escaped}"]=1
+  end
 
 else
   >   args['{{ name }}']="$2"
@@ -25,4 +29,4 @@ end
 >   exit 1
 > fi
 > ;;
-> 
+> 

spec/approvals/examples/repeatable-arg

@@ -47,7 +47,7 @@ files:
   upcase: CONTENT OF FILE1
 
 args:
-- ${args[file]} = "file1"
+- ${args[file]} = file1
 + ./upcase file1 file2
 
 files:
@@ -59,7 +59,7 @@ files:
   upcase: CONTENT OF FILE2
 
 args:
-- ${args[file]} = "file1" "file2"
+- ${args[file]} = file1 file2
 + ./upcase file1 file2 file1
 
 files:
@@ -71,4 +71,4 @@ files:
   upcase: CONTENT OF FILE2
 
 args:
-- ${args[file]} = "file1" "file2"
+- ${args[file]} = file1 file2

spec/approvals/examples/repeatable-flag

@@ -47,7 +47,7 @@ two three
 Verbosity level: 3
 
 args:
-- ${args[--data]} = "one" "two three"
+- ${args[--data]} = one two\ three
 - ${args[--path]} = file\ one file-two
 - ${args[--verbose]} = 3
 + ./download -d one --path /bin --path /usr/lib --path /bin
@@ -57,5 +57,5 @@ one
 Verbosity level: 1
 
 args:
-- ${args[--data]} = "one"
-- ${args[--path]} = "/bin" "/usr/lib"
+- ${args[--data]} = one
+- ${args[--path]} = /bin /usr/lib

spec/approvals/fixtures/repeatable-arg-validations

@@ -11,7 +11,7 @@ args: none
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
-- ${args[number]} = "1"
+- ${args[number]} = 1
 + ./cli 1.1
 validation error in NUMBER:
 must be an integer
@@ -22,7 +22,7 @@ must be an integer
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
-- ${args[number]} = "1" "2"
+- ${args[number]} = 1 2
 + ./cli 1.1 2
 validation error in NUMBER:
 must be an integer
@@ -32,3 +32,6 @@ must be an integer
 + ./cli 1 a
 validation error in NUMBER:
 must be an integer
++ ./cli 1 'bad"quote'
+validation error in NUMBER:
+must be an integer

spec/approvals/fixtures/repeatable-escaping

@@ -0,0 +1,62 @@
++ bundle exec bashly generate
+creating user files in src
+skipped src/root_command.sh (exists)
+created ./cli
+run ./cli --help to test your bash script
++ ./cli
+args: none
+
++ ./cli before 'x x' 'x x' after
+args:
+- ${args[term]} = before x\ x after
+[TERM] --> before
+[TERM] --> x x
+[TERM] --> after
+
++ ./cli before 'x "x x"' 'x "x x"' after
+args:
+- ${args[term]} = before x\ \"x\ x\" after
+[TERM] --> before
+[TERM] --> x "x x"
+[TERM] --> after
+
++ ./cli before 'x"x' 'x"x' after
+args:
+- ${args[term]} = before x\"x after
+[TERM] --> before
+[TERM] --> x"x
+[TERM] --> after
+
++ ./cli -s before -s 'x x' -s 'x x' -s after
+args:
+- ${args[--search]} = before x\ x after
+[--serach] --> before
+[--serach] --> x x
+[--serach] --> after
+
++ ./cli -s before -s 'x "x x"' -s 'x "x x"' -s after
+args:
+- ${args[--search]} = before x\ \"x\ x\" after
+[--serach] --> before
+[--serach] --> x "x x"
+[--serach] --> after
+
++ ./cli -s before -s 'x"x' -s 'x"x' -s after
+args:
+- ${args[--search]} = before x\"x after
+[--serach] --> before
+[--serach] --> x"x
+[--serach] --> after
+
++ ./cli once x once
+args:
+- ${args[term]} = once x
+[TERM] --> once
+[TERM] --> x
+
++ ./cli -s once -s x -s once
+args:
+- ${args[--search]} = once x
+[--serach] --> once
+[--serach] --> x
+

spec/approvals/fixtures/repeatable-flag-validations

@@ -11,7 +11,7 @@ args: none
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
-- ${args[--number]} = "1"
+- ${args[--number]} = 1
 + ./cli --number 1.1
 validation error in --number, -n NUMBER:
 must be an integer
@@ -22,7 +22,7 @@ must be an integer
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
-- ${args[--number]} = "1" "2"
+- ${args[--number]} = 1 2
 + ./cli --number 1.1 --number 2
 validation error in --number, -n NUMBER:
 must be an integer
@@ -32,3 +32,6 @@ must be an integer
 + ./cli --number 1 --number a
 validation error in --number, -n NUMBER:
 must be an integer
++ ./cli --number 1 --number 'bad"quote'
+validation error in --number, -n NUMBER:
+must be an integer

spec/approvals/fixtures/repeatable-whitelist

@@ -12,15 +12,17 @@ args:
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
-- ${args[--protocol]} = "ssh"
+- ${args[--protocol]} = ssh
 + ./download -p ssh -p ftp
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
-- ${args[--protocol]} = "ssh" "ftp"
+- ${args[--protocol]} = ssh ftp
 + ./download -p sftp -p https
 --protocol must be one of: ssh, ftp, sftp
 + ./download -p http -p ftp
 --protocol must be one of: ssh, ftp, sftp
 + ./download --protocol telnet
 --protocol must be one of: ssh, ftp, sftp
++ ./download --protocol telnet --protocol 'bad"quote'
+--protocol must be one of: ssh, ftp, sftp