bashly 1.1.8 → 1.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d11d229ff42dc84aa910ee8292e145b63641c5520315583e92d5aa0747e6e578
-  data.tar.gz: 61a2ddcb970af41f7a086da0a75d0452a637e3fe650569e2768f1a0eefe49849
+  metadata.gz: '0857ce9cc52b919c113242568610ed9abbd447221b6d473bbf05f1cd8f29de69'
+  data.tar.gz: 3eb8279ffdbf23a69a5c7eb52d98f2f0c3ca1730f54eb6a18b4957038b69810a
 SHA512:
-  metadata.gz: b9ffdaa7a7a862b11d932e6533d4b7e1b1e76407292bbaf5ca8afdc192249b0f51ea504adfc459e37b712074291ef612fc5b29965700043676bc94709062e696
-  data.tar.gz: 629b81b7ef43fa64523a465968828d74192fbd17440e9f20f724a6ef040ebe0c805bed339f899ca6047f53043c29d88537829075bd60be2f752a69e09eaaee55
+  metadata.gz: 2aa95822cebdc83d0e3a1af47a2d75886994a7d79976188049b8ea6732ca3d6a83003bfea48c3789e8d3a4db562e16f8f9ed169da414065567c7abf2d2d4c40b
+  data.tar.gz: 3cf237064dfe7f9cfb2523c85d838141f9869e246619b9ed2bf9862499a0345ea1da12178802ee6d7a654e1ad8fec674b751442566b8b8ca1e22b77055105fd1

data/lib/bashly/concerns/renderable.rb

@@ -2,7 +2,10 @@ require 'gtx'
 
 module Bashly
   module Renderable
-    def render(view)
+    attr_reader :render_options
+
+    def render(view, render_options = {})
+      @render_options = render_options
       GTX.render_file view_path(view), context: binding, filename: "#{views_subfolder}.#{view}"
     end
 

data/lib/bashly/extensions/string.rb

@@ -1,6 +1,6 @@
 class String
   def sanitize_for_print
-    gsub("\n", '\\n').gsub('"', '\"').gsub('`', '\\\\`')
+    gsub("\n", '\\n').gsub('"', '\"').gsub('`', '\\\\`').gsub('%', '%%')
   end
 
   def for_markdown

data/lib/bashly/libraries/settings/settings.yml

@@ -42,6 +42,11 @@ tab_indent: false
 # `-abc` as if it is `-a -b -c`.
 compact_short_flags: true
 
+# When true, the generated script will consider any argument in the form of
+# `--flag=value` and `-f=value` as if it is `--flag value` and `-f value`
+# respectively.
+conjoined_flag_args: true
+
 # Set to 'production' or 'development':
 # env: production    Generate a smaller script, without file markers
 # env: development   Generate with file markers

data/lib/bashly/libraries/test/approvals.bash

@@ -1,4 +1,4 @@
-# approvals.bash v0.5.0
+# approvals.bash v0.5.1
 #
 # Interactive approval testing for Bash.
 # https://github.com/DannyBen/approvals.bash
@@ -54,6 +54,10 @@ context() {
   printf "$context_string\n" "$*"
 }
 
+it() {
+  printf "$it_string\n" "$*"
+}
+
 fail() {
   printf "$fail_string\n" "$*"
   exit 1
@@ -72,29 +76,57 @@ expect_exit_code() {
   fi
 }
 
-bold() { printf "\e[1m%b\e[0m\n" "$*"; }
-blue() { printf "\e[34m%b\e[0m\n" "$*"; }
-cyan() { printf "\e[36m%b\e[0m\n" "$*"; }
-green() { printf "\e[32m%b\e[0m\n" "$*"; }
-magenta() { printf "\e[35m%b\e[0m\n" "$*"; }
-red() { printf "\e[31m%b\e[0m\n" "$*"; }
-yellow() { printf "\e[33m%b\e[0m\n" "$*"; }
-
 # Private
 
+print_in_color() {
+  local color="$1"
+  shift
+  if [[ -z ${NO_COLOR+x} ]]; then
+    printf "$color%b\e[0m\n" "$*"
+  else
+    printf "%b\n" "$*"
+  fi
+}
+
+red() { print_in_color "\e[31m" "$*"; }
+green() { print_in_color "\e[32m" "$*"; }
+yellow() { print_in_color "\e[33m" "$*"; }
+blue() { print_in_color "\e[34m" "$*"; }
+magenta() { print_in_color "\e[35m" "$*"; }
+cyan() { print_in_color "\e[36m" "$*"; }
+bold() { print_in_color "\e[1m" "$*"; }
+underlined() { print_in_color "\e[4m" "$*"; }
+red_bold() { print_in_color "\e[1;31m" "$*"; }
+green_bold() { print_in_color "\e[1;32m" "$*"; }
+yellow_bold() { print_in_color "\e[1;33m" "$*"; }
+blue_bold() { print_in_color "\e[1;34m" "$*"; }
+magenta_bold() { print_in_color "\e[1;35m" "$*"; }
+cyan_bold() { print_in_color "\e[1;36m" "$*"; }
+red_underlined() { print_in_color "\e[4;31m" "$*"; }
+green_underlined() { print_in_color "\e[4;32m" "$*"; }
+yellow_underlined() { print_in_color "\e[4;33m" "$*"; }
+blue_underlined() { print_in_color "\e[4;34m" "$*"; }
+magenta_underlined() { print_in_color "\e[4;35m" "$*"; }
+cyan_underlined() { print_in_color "\e[4;36m" "$*"; }
+
 user_approval() {
   local cmd="$1"
   local actual="$2"
   local approval_file="$3"
 
-  if [[ -v CI || -v GITHUB_ACTIONS ]]; then
+  if [[ -v CI || -v GITHUB_ACTIONS ]] && [[ -z "${AUTO_APPROVE+x}" ]]; then
     fail "$cmd"
   fi
 
-  echo
-  printf "$approval_string"
-  response=$(bash -c "read -n 1 key; echo \$key")
-  printf "\b%.s" $(seq 1 $((${#approval_string} + 1)))
+  if [[ -v AUTO_APPROVE ]]; then
+    response=a
+  else
+    echo
+    printf "$approval_string"
+    response=$(bash -c "read -n 1 key; echo \$key")
+    printf "\b%.s" $(seq 1 $((${#approval_string} + 1)))
+  fi
+
   if [[ $response =~ [Aa] ]]; then
     printf "%b\n" "$actual" >"$approval_file"
     pass "$cmd"
@@ -122,14 +154,15 @@ set -e
 trap 'onexit' EXIT
 trap 'onerror' ERR
 
-describe_string="$(blue ▌ describe)   %s"
-context_string="$(magenta ▌ context)    %s"
-fail_string="  $(red FAILED)     %s"
+describe_string="$(bold ▌ describe)   %s"
+context_string="$(bold ▌ context)    %s"
+it_string="$(bold ▌ it)         %s"
+fail_string="  $(red_bold failed)     %s"
 pass_string="  $(green approved)   %s"
 exit_success_string="$(green ▌ exit)       $(bold %s finished successfully)"
-exit_failed_string="$(red ▌ exit)       $(bold %s finished with errors)"
-new_diff_string="────┤ $(yellow new): $(bold %s)) ├────"
-changed_diff_string="────┤ $(cyan changed): $(bold %s)) ├────"
+exit_failed_string="$(red_bold ▌ exit)       $(bold %s finished with errors)"
+new_diff_string="────┤ $(yellow new): $(bold %s) ├────"
+changed_diff_string="────┤ $(blue changed): $(bold %s) ├────"
 approval_string="[A]pprove? "
 
 if diff --help | grep -- --color >/dev/null 2>&1; then

data/lib/bashly/script/base.rb

@@ -29,7 +29,7 @@ module Bashly
         options['help'] ||= ''
       end
 
-      def method_missing(method_name, *arguments, &block)
+      def method_missing(method_name, *arguments, &)
         key = method_name.to_s
         respond_to?(method_name) ? options[key] : super
       end

data/lib/bashly/script/catch_all.rb

@@ -48,7 +48,7 @@ module Bashly
       def usage_string
         return nil unless enabled?
 
-        required? ? label : "[#{label}]"
+        required? ? "[--] #{label}" : "[--] [#{label}]"
       end
     end
   end

data/lib/bashly/script/command.rb

@@ -101,9 +101,10 @@ module Bashly
       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 @@ module Bashly
         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

data/lib/bashly/settings.rb

@@ -6,6 +6,7 @@ module Bashly
       attr_writer(
         :commands_dir,
         :compact_short_flags,
+        :conjoined_flag_args,
         :config_path,
         :lib_dir,
         :partials_extension,
@@ -24,6 +25,10 @@ module Bashly
         @compact_short_flags ||= get :compact_short_flags
       end
 
+      def conjoined_flag_args
+        @conjoined_flag_args ||= get :conjoined_flag_args
+      end
+
       def config_path
         @config_path ||= get(:config_path) % { source_dir: source_dir }
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.1.8'
+  VERSION = '1.1.10'
 end

data/lib/bashly/views/argument/case.gtx

@@ -0,0 +1,6 @@
+= view_marker
+
+condition = render_options[:index].zero? ? 'if' : 'elif'
+> {{ condition }} [[ -z ${args['{{ name }}']+x} ]]; then
+>   args['{{ name }}']=$1
+>   shift

data/lib/bashly/views/argument/case_repeatable.gtx

@@ -0,0 +1,25 @@
+= view_marker
+
+condition = render_options[:index].zero? ? 'if' : 'elif'
+
+if render_options[:index] == 0
+  > escaped="$(printf '%q' "$1")"
+end
+
+> {{ condition }} [[ -z ${args['{{ name }}']+x} ]]; then
+if repeatable
+  >   args['{{ name }}']="$escaped"
+  if unique
+    >   unique_lookup["{{ name }}:$escaped"]=1
+    > elif [[ -z "${unique_lookup["{{ name }}:$escaped"]:-}" ]]; then
+    >   args['{{ name }}']="${args['{{ name }}']} $escaped"
+    >   unique_lookup["{{ name }}:$escaped"]=1
+  else
+    > else
+    >   args['{{ name }}']="${args['{{ name }}']} $escaped"
+  end
+
+else
+  >   args['{{ name }}']="$1"
+
+end

data/lib/bashly/views/command/normalize_input.gtx

@@ -1,30 +1,7 @@
 = view_marker
 
-> normalize_input() {
->   local arg flags
-> 
->   while [[ $# -gt 0 ]]; do
->     arg="$1"
->     if [[ $arg =~ ^(--[a-zA-Z0-9_\-]+)=(.+)$ ]]; then
->       input+=("${BASH_REMATCH[1]}")
->       input+=("${BASH_REMATCH[2]}")
->     elif [[ $arg =~ ^(-[a-zA-Z0-9])=(.+)$ ]]; then
->       input+=("${BASH_REMATCH[1]}")
->       input+=("${BASH_REMATCH[2]}")
-
-if Settings.compact_short_flags
->     elif [[ $arg =~ ^-([a-zA-Z0-9][a-zA-Z0-9]+)$ ]]; then
->       flags="${BASH_REMATCH[1]}"
->       for ((i = 0; i < ${#flags}; i++)); do
->         input+=("-${flags:i:1}")
->       done
+if Settings.compact_short_flags || Settings.conjoined_flag_args
+  = render :normalize_input_function
+else
+  = render :normalize_input_simple
 end
-
->     else
->       input+=("$arg")
->     fi
-> 
->     shift
->   done
-> }
->

data/lib/bashly/views/command/normalize_input_function.gtx

@@ -0,0 +1,39 @@
+= view_marker
+
+> normalize_input() {
+>   local arg flags passthru
+>   passthru=false
+> 
+>   while [[ $# -gt 0 ]]; do
+>     arg="$1"
+>     if [[ $passthru == true ]]; then
+>       input+=("$arg")
+
+if Settings.conjoined_flag_args
+>     elif [[ $arg =~ ^(--[a-zA-Z0-9_\-]+)=(.+)$ ]]; then
+>       input+=("${BASH_REMATCH[1]}")
+>       input+=("${BASH_REMATCH[2]}")
+>     elif [[ $arg =~ ^(-[a-zA-Z0-9])=(.+)$ ]]; then
+>       input+=("${BASH_REMATCH[1]}")
+>       input+=("${BASH_REMATCH[2]}")
+end
+
+if Settings.compact_short_flags
+>     elif [[ $arg =~ ^-([a-zA-Z0-9][a-zA-Z0-9]+)$ ]]; then
+>       flags="${BASH_REMATCH[1]}"
+>       for ((i = 0; i < ${#flags}; i++)); do
+>         input+=("-${flags:i:1}")
+>       done
+end
+
+>     elif [[ "$arg" == "--" ]]; then
+>       passthru=true
+>       input+=("$arg")
+>     else
+>       input+=("$arg")
+>     fi
+> 
+>     shift
+>   done
+> }
+>

data/lib/bashly/views/command/normalize_input_simple.gtx

@@ -0,0 +1,6 @@
+= view_marker
+
+> normalize_input() {
+>   input=("$@")
+> }
+>

data/lib/bashly/views/command/parse_requirements_case_catch_all.gtx

@@ -1,13 +1,8 @@
 = view_marker
 
 if args.any?
-  condition = "if"
-  args.each do |arg|
-    > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
-    >   args['{{ arg.name }}']=$1
-    >   shift
-    
-    condition = "elif"
+  args.each_with_index do |arg, index|
+    = arg.render :case, index: index
   end
 
   > else

data/lib/bashly/views/command/parse_requirements_case_repeatable.gtx

@@ -1,30 +1,9 @@
 = view_marker
 
-condition = "if"
-args.each do |arg|
-  > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
-  if arg.repeatable
-    >   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
-    >   shift
-
-  end
-  condition = "elif"
+args.each_with_index do |arg, index|
+  = arg.render :case_repeatable, index: index
 end
 
 > fi
-> 
+> shift
+> 

data/lib/bashly/views/command/parse_requirements_case_simple.gtx

@@ -1,13 +1,8 @@
 = view_marker
 
 if args.any?
-  condition = "if"
-  args.each do |arg|
-    > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
-    >   args['{{ arg.name }}']=$1
-    >   shift
-
-    condition = "elif"
+  args.each_with_index do |arg, index|
+    = arg.render :case, index: index
   end
 
   > else

data/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
 
 > }
-
-

data/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
 > ;;
-> 
+> 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.10
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
+date: 2024-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -226,6 +226,8 @@ files:
 - lib/bashly/templates/minimal.yml
 - lib/bashly/version.rb
 - lib/bashly/views/README.md
+- lib/bashly/views/argument/case.gtx
+- lib/bashly/views/argument/case_repeatable.gtx
 - lib/bashly/views/argument/usage.gtx
 - lib/bashly/views/argument/validations.gtx
 - lib/bashly/views/command/catch_all_filter.gtx
@@ -246,6 +248,8 @@ files:
 - lib/bashly/views/command/long_usage.gtx
 - lib/bashly/views/command/master_script.gtx
 - lib/bashly/views/command/normalize_input.gtx
+- lib/bashly/views/command/normalize_input_function.gtx
+- lib/bashly/views/command/normalize_input_simple.gtx
 - lib/bashly/views/command/parse_requirements.gtx
 - lib/bashly/views/command/parse_requirements_case.gtx
 - lib/bashly/views/command/parse_requirements_case_catch_all.gtx
@@ -296,7 +300,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="