Merge pull request #61 from DannyBen/change/flag-arg-eager-consumption

DannyBen · web-flow · commit 91ccdc62163d · 2021-02-20T12:35:06.000+02:00
Change flag arguments (--flag ARG) to allow argument that starts with a dash
diff --git a/Dockerfile b/Dockerfile
@@ -3,6 +3,6 @@ FROM dannyben/alpine-ruby
 ENV PS1 "\n\n>> bashly \W \$ "
 WORKDIR /app
 
-RUN gem install bashly --version 0.4.0
+RUN gem install bashly --version 0.4.1rc1
 
 ENTRYPOINT ["bashly"]
diff --git a/examples/commands/cli b/examples/commands/cli
@@ -354,7 +354,7 @@ cli_upload_parse_requirements() {
     case "$key" in
     # :flag.case
     --user | -u )
-      if [[ $2 && $2 != -* ]]; then
+      if [[ $2 ]]; then
         args[--user]="$2"
         shift
         shift
@@ -366,7 +366,7 @@ cli_upload_parse_requirements() {
   
     # :flag.case
     --password | -p )
-      if [[ $2 && $2 != -* ]]; then
+      if [[ $2 ]]; then
         args[--password]="$2"
         shift
         shift
diff --git a/examples/custom-strings/download b/examples/custom-strings/download
@@ -109,7 +109,7 @@ parse_requirements() {
     case "$key" in
     # :flag.case
     --out | -o )
-      if [[ $2 && $2 != -* ]]; then
+      if [[ $2 ]]; then
         args[--out]="$2"
         shift
         shift
diff --git a/examples/default-values/convert b/examples/default-values/convert
@@ -107,7 +107,7 @@ parse_requirements() {
     case "$key" in
     # :flag.case
     --format | -f )
-      if [[ $2 && $2 != -* ]]; then
+      if [[ $2 ]]; then
         args[--format]="$2"
         shift
         shift
diff --git a/examples/git-like/git b/examples/git-like/git
@@ -276,7 +276,7 @@ git_commit_parse_requirements() {
     case "$key" in
     # :flag.case
     --message | -m )
-      if [[ $2 && $2 != -* ]]; then
+      if [[ $2 ]]; then
         args[--message]="$2"
         shift
         shift
diff --git a/examples/minus-v/cli b/examples/minus-v/cli
@@ -101,7 +101,7 @@ parse_requirements() {
   
     # :flag.case
     --host | -h )
-      if [[ $2 && $2 != -* ]]; then
+      if [[ $2 ]]; then
         args[--host]="$2"
         shift
         shift
diff --git a/examples/yaml/yaml b/examples/yaml/yaml
@@ -170,7 +170,7 @@ parse_requirements() {
     case "$key" in
     # :flag.case
     --prefix | -p )
-      if [[ $2 && $2 != -* ]]; then
+      if [[ $2 ]]; then
         args[--prefix]="$2"
         shift
         shift
diff --git a/lib/bashly/version.rb b/lib/bashly/version.rb
@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.4.0"
+  VERSION = "0.4.1rc1"
 end
diff --git a/lib/bashly/views/flag/case.erb b/lib/bashly/views/flag/case.erb
@@ -1,7 +1,7 @@
 # :flag.case
 <%= aliases.join " | " %> )
   <%- if arg -%>
-  if [[ $2 && $2 != -* ]]; then
+  if [[ $2 ]]; then
     args[<%= name %>]="$2"
     shift
     shift
diff --git a/spec/approvals/examples/flag-args-with-dash b/spec/approvals/examples/flag-args-with-dash
@@ -0,0 +1,19 @@
++ bashly generate
+creating user files in src
+created src/initialize.sh
+created src/root_command.sh
+created ./argflag
+run ./argflag --help to test your bash script
++ ./argflag -f -o
+--options requires an argument: --options, -o LIST
++ ./argflag -o -f
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--options]} = -f
++ ./argflag -o '--verbose --anything' -f
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--force]} = 1
+- ${args[--options]} = --verbose --anything
diff --git a/spec/fixtures/workspaces/flag-args-with-dash/.gitignore b/spec/fixtures/workspaces/flag-args-with-dash/.gitignore
@@ -0,0 +1,2 @@
+argflag
+src/*.sh
diff --git a/spec/fixtures/workspaces/flag-args-with-dash/README.md b/spec/fixtures/workspaces/flag-args-with-dash/README.md
@@ -0,0 +1,8 @@
+This fixture tests that flags with arguments also work when the argument
+starts with a dash - for example:
+
+```
+--options '--verbose -v'
+```
+
+Reference issue: https://github.com/DannyBen/bashly/issues/58
diff --git a/spec/fixtures/workspaces/flag-args-with-dash/argflag b/spec/fixtures/workspaces/flag-args-with-dash/argflag
@@ -0,0 +1,162 @@
+#!/usr/bin/env bash
+# This script was generated by bashly (https://github.com/DannyBen/bashly)
+# Modifying it manually is not recommended
+
+# :command.root_command
+root_command() {
+  # :src/root_command.sh
+  echo "# this file is located in 'src/root_command.sh'"
+  echo "# you can edit it freely and regenerate (it will not be overwritten)"
+  inspect_args
+}
+
+# :command.version_command
+version_command() {
+  echo "$version"
+}
+
+# :command.usage
+argflag_usage() {
+  if [[ -n $long_usage ]]; then
+    printf "argflag - Personal package manager\n"
+    echo 
+  else
+    printf "argflag - Personal package manager\n"
+    echo 
+  fi
+
+  printf "Usage:\n"
+  printf "  argflag [options]\n"
+  printf "  argflag --help | -h\n"
+  printf "  argflag --version | -v\n"
+  echo
+
+  if [[ -n $long_usage ]]; then
+    printf "Options:\n"
+    # :command.usage_fixed_flags
+    echo "  --help, -h"
+    printf "    Show this help\n"
+    echo
+    echo "  --version, -v"
+    printf "    Show version number\n"
+    echo
+    # :command.usage_flags
+    # :flag.usage
+    echo "  --force, -f"
+    printf "    Force\n"
+    echo
+    
+    # :flag.usage
+    echo "  --options, -o LIST"
+    printf "    Options\n"
+    echo
+
+  fi
+}
+
+# :command.inspect_args
+inspect_args() {
+  readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
+  if (( ${#args[@]} )); then
+    echo args:
+    for k in "${sorted_keys[@]}"; do echo "- \${args[$k]} = ${args[$k]}"; done
+  else
+    echo args: none
+  fi
+}
+
+# :command.command_functions
+
+# :command.parse_requirements
+parse_requirements() {
+  # :command.fixed_flag_filter
+  case "$1" in
+  --version | -v )
+    version_command
+    exit
+    ;;
+  
+  --help | -h )
+    long_usage=yes
+    argflag_usage
+    exit 1
+    ;;
+  
+  esac
+  # :command.environment_variables_filter
+  # :command.dependencies_filter
+  # :command.command_filter
+  action="root"
+  # :command.required_args_filter
+  # :command.required_flags_filter
+  # :command.parse_requirements_while
+  while [[ $# -gt 0 ]]; do
+    key="$1"
+    case "$key" in
+    # :flag.case
+    --force | -f )
+      args[--force]=1
+      shift
+      ;;
+  
+    # :flag.case
+    --options | -o )
+      if [[ $2 ]]; then
+        args[--options]="$2"
+        shift
+        shift
+      else
+        printf "%s\n" "--options requires an argument: --options, -o LIST"
+        exit 1
+      fi
+      ;;
+  
+  
+    -* )
+      printf "invalid option: %s\n" "$key"
+      exit 1
+      ;;
+  
+    * )
+      # :command.parse_requirements_case
+      printf "invalid argument: %s\n" "$key"
+      exit 1
+      ;;
+  
+    esac
+  done
+  # :command.default_assignments
+}
+
+# :command.initialize
+initialize() {
+  version="0.1.0"
+  long_usage=''
+  set -e  
+
+  # :src/initialize.sh
+  # 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.
+}
+
+# :command.run
+run() {
+  declare -A args
+  parse_requirements "$@"
+
+  if [[ ${args[--version]} ]]; then
+    version_command
+  elif [[ ${args[--help]} ]]; then
+    long_usage=yes
+    argflag_usage
+  elif [[ $action == "root" ]]; then
+    root_command
+  fi
+}
+
+initialize
+run "$@"
diff --git a/spec/fixtures/workspaces/flag-args-with-dash/src/bashly.yml b/spec/fixtures/workspaces/flag-args-with-dash/src/bashly.yml
@@ -0,0 +1,13 @@
+name: argflag
+help: Personal package manager
+version: 0.1.0
+
+flags:
+- long: --force
+  short: -f
+  help: Force
+
+- long: --options
+  short: -o
+  arg: list
+  help: Options
diff --git a/spec/fixtures/workspaces/flag-args-with-dash/test.sh b/spec/fixtures/workspaces/flag-args-with-dash/test.sh
@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# This fixture tests that short command codes work properly
+# It is executed as part of the Runfile examples test
+# Reference issue: https://github.com/DannyBen/bashly/issues/16
+
+rm -f ./src/*.sh
+rm -f ./argflag
+
+set -x
+
+bashly generate
+
+./argflag -f -o
+./argflag -o -f
+./argflag -o '--verbose --anything' -f
