Merge pull request #139 from DannyBen/fix/required-arg-filter

Allow required args to appear after flags

Author: DannyBen

lib/bashly/views/command/parse_requirements.erb

@@ -8,9 +8,9 @@ parse_requirements() {
 <%= render(:environment_variables_filter).indent 2 %>
 <%= render(:dependencies_filter).indent 2 %>
 <%= render(:command_filter).indent 2 %>
+<%= render(:parse_requirements_while).indent 2 %>
 <%= render(:required_args_filter).indent 2 %>
 <%= render(:required_flags_filter).indent 2 %>
-<%= render(:parse_requirements_while).indent 2 %>
 <%= render(:catch_all_filter).indent 2 %>
 <%= render(:default_assignments).indent 2 %>
 <%= render(:whitelist_filter).indent 2 %>

lib/bashly/views/command/required_args_filter.erb

@@ -1,12 +1,7 @@
 # :command.required_args_filter
 % required_args.each do |arg|
-if [[ -n ${1+x} && $1 != -* ]]; then
-<%= arg.render(:validations).indent 2 %>
-  args[<%= arg.name %>]=$1
-  shift
-else
+if [[ -z ${args[<%= arg.name %>]+x} ]]; then
   printf "<%= strings[:missing_required_argument] % { arg: arg.name.upcase, usage: usage_string } %>\n"
   exit 1
 fi
-
 % end

lib/bashly/views/command/required_flags_filter.erb

@@ -1,9 +1,6 @@
 # :command.required_flags_filter
-% if required_flags.any?
-argstring="$*"
-% end
 % required_flags.each do |flag|
-if [[ <%= flag.aliases.map { |a| %Q["$argstring" != *#{a}*] }.join " && " %> ]]; then
+if [[ -z ${args[<%= flag.long %>]+x} ]]; then
   printf "<%= strings[:missing_required_flag] % { usage: flag.usage_string } %>\n"
   exit 1
 fi

spec/approvals/examples/required-args-order

@@ -0,0 +1,45 @@
++ bundle exec bashly generate
+creating user files in src
+created src/initialize.sh
+created src/root_command.sh
+created ./download
+run ./download --help to test your bash script
++ ./download
+missing required argument: PROTOCOL
+usage: download PROTOCOL PORT [BODY] [options]
++ ./download http
+missing required argument: PORT
+usage: download PROTOCOL PORT [BODY] [options]
++ ./download http 3000
+missing required flag: --method NAME
++ ./download http 3000 --method GET
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--method]} = GET
+- ${args[port]} = 3000
+- ${args[protocol]} = http
++ ./download http 3000 --method GET --role admin
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--method]} = GET
+- ${args[port]} = 3000
+- ${args[protocol]} = http
+- ${args[--role]} = admin
++ ./download http --role admin --method GET 3000
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--method]} = GET
+- ${args[port]} = 3000
+- ${args[protocol]} = http
+- ${args[--role]} = admin
++ ./download --role admin --method GET http 3000
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--method]} = GET
+- ${args[port]} = 3000
+- ${args[protocol]} = http
+- ${args[--role]} = admin

spec/fixtures/workspaces/required-args-order/.gitignore

@@ -0,0 +1,2 @@
+download
+src/*.sh

spec/fixtures/workspaces/required-args-order/README.md

@@ -0,0 +1,3 @@
+This fixture ensures that required args and flags are allowed to appear after
+the optional flags.
+Reference issue: https://github.com/DannyBen/bashly/issues/124

spec/fixtures/workspaces/required-args-order/src/bashly.yml

@@ -0,0 +1,20 @@
+name: download
+
+args:
+- name: protocol
+  help: Protocol to use
+  required: true
+- name: port
+  help: Port to use
+  required: true
+- name: body
+  help: Message body
+
+flags:
+- long: --method
+  help: HTTP method
+  arg: name
+  required: true
+- long: --role
+  help: role
+  arg: name

spec/fixtures/workspaces/required-args-order/test.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+# This fixture ensures that required args and flags are allowed to appear after
+# the optional flags.
+# Reference issue: https://github.com/DannyBen/bashly/issues/124
+
+rm -f ./src/*.sh
+rm -f ./download
+
+set -x
+
+bundle exec bashly generate
+
+./download
+./download http
+./download http 3000
+./download http 3000 --method GET
+./download http 3000 --method GET --role admin
+./download http --role admin --method GET  3000
+./download --role admin --method GET http 3000
+