bashly 1.1.7 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a7e677e8b16a4711ece6638e16e585b1bf74fca12cc6c3e9ea4810c209d4693
-  data.tar.gz: 630667bb3c3d36055a0160f05719a9561d8ec7cdbd02af80fd9c2a7a5edabd17
+  metadata.gz: 57e204b6791653f135c34bdf18a2b882d180087bbec57044db09540e342d81f0
+  data.tar.gz: ef1bc1015e325d227b3bc32d537a51fc369ea7833972f6f9a15e592d79ddc131
 SHA512:
-  metadata.gz: 7dd08f97c66d81979c68b43d356b650ec50d30b0c2d0d8663388f0fec56f881bd5b140a55719143e00d155b2f0ae321d6207bf63c7e248d324489cf7dc3b7cee
-  data.tar.gz: 754c2b4aaa9e289b04e83e10b861933b26ef3168620315a7a9655c8dc991c095d0e42037a43d379b2d1f86d6f4eb5a6e3d6ea70009642d873e7dafb1627cfffa
+  metadata.gz: 4947a104aa165d0e216a53a07908b72c290ff8e905e96acde044025bccefbab783ed5c87f3c217b674bdfb57db21c5d149827a9d8383065fef78eaac701826c0
+  data.tar.gz: 99eb5313b587980c540f22596cc8e99794cf7ed24cb0f62e06c4179a64399e80099c6cbc7d2803fe96827cdbf5734bbb9fc7364533979da45cd44973d0511748

data/lib/bashly/concerns/indentation_helper.rb

@@ -0,0 +1,45 @@
+module Bashly
+  # A helper class, used by the `Array#indent` extension.
+  # It will return the array of strings with all strings prefixed by `indentation`
+  # unless the line is within a heredoc block.
+  class IndentationHelper
+    attr_reader :marker, :indentation
+
+    def initialize(indentation)
+      @indentation = indentation
+      @marker = nil
+    end
+
+    def indent(line)
+      if inside_heredoc?
+        reset_marker if heredoc_closed?(line)
+        line
+      else
+        set_heredoc_state(line)
+        "#{indentation}#{line}"
+      end
+    end
+
+  private
+
+    def reset_marker
+      @marker = nil
+    end
+
+    def inside_heredoc?
+      !!marker
+    end
+
+    def set_heredoc_state(line)
+      @marker = extract_heredoc_marker(line)
+    end
+
+    def extract_heredoc_marker(line)
+      line =~ /<<-?\s*(\w+)/ ? $1 : nil
+    end
+
+    def heredoc_closed?(line)
+      inside_heredoc? && /^#{marker}\n?$/.match?(line)
+    end
+  end
+end

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/array.rb

@@ -1,9 +1,13 @@
+require 'bashly/concerns/indentation_helper'
+
 class Array
   def indent(offset)
     return self unless offset.positive?
 
     indentation = ' ' * offset
-    map { |line| "#{indentation}#{line}" }
+    indenter = Bashly::IndentationHelper.new indentation
+
+    map { |line| indenter.indent line }
   end
 
   def nonuniq

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

@@ -1,7 +1,10 @@
-# approvals.bash v0.4.2
+# approvals.bash v0.5.1
 #
 # Interactive approval testing for Bash.
 # https://github.com/DannyBen/approvals.bash
+#
+# shellcheck disable=SC2059
+# Disabling SC2059 (quoted format string) because we use dynamic format strings
 approve() {
   local expected approval approval_file actual cmd
   approvals_dir=${APPROVALS_DIR:=approvals}
@@ -21,9 +24,9 @@ approve() {
   if [[ -f "$approval_file" ]]; then
     expected=$(cat "$approval_file")
   else
-    echo "--- [$(blue "new: $cmd")] ---"
+    printf -- "$new_diff_string\n" "$cmd"
     printf "%b\n" "$actual"
-    echo "--- [$(blue "new: $cmd")] ---"
+    printf -- "$new_diff_string\n" "$cmd"
     expected="$actual"
     user_approval "$cmd" "$actual" "$approval_file"
     return
@@ -32,9 +35,9 @@ approve() {
   if [[ "$(printf "%b" "$actual")" = "$(printf "%b" "$expected")" ]]; then
     pass "$cmd"
   else
-    echo "--- [$(blue "diff: $cmd")] ---"
+    printf -- "$changed_diff_string\n" "$cmd"
     $diff_cmd <(printf "%b" "$expected\n") <(printf "%b" "$actual\n") | tail -n +4
-    echo "--- [$(blue "diff: $cmd")] ---"
+    printf -- "$changed_diff_string\n" "$cmd"
     user_approval "$cmd" "$actual" "$approval_file"
   fi
 }
@@ -44,22 +47,24 @@ allow_diff() {
 }
 
 describe() {
-  echo
-  blue "= $*"
+  printf "$describe_string\n" "$*"
 }
 
 context() {
-  echo
-  magenta "= $*"
+  printf "$context_string\n" "$*"
+}
+
+it() {
+  printf "$it_string\n" "$*"
 }
 
 fail() {
-  red "  FAILED: $*"
+  printf "$fail_string\n" "$*"
   exit 1
 }
 
 pass() {
-  green "  approved: $*"
+  printf "$pass_string\n" "$*"
   return 0
 }
 
@@ -67,31 +72,61 @@ expect_exit_code() {
   if [[ $last_exit_code == "$1" ]]; then
     pass "exit $last_exit_code"
   else
-    fail "Expected exit code $1, got $last_exit_code"
+    fail "expected exit code $1, got $last_exit_code"
   fi
 }
 
-red() { printf "\e[31m%b\e[0m\n" "$*"; }
-green() { printf "\e[32m%b\e[0m\n" "$*"; }
-blue() { printf "\e[34m%b\e[0m\n" "$*"; }
-magenta() { printf "\e[35m%b\e[0m\n" "$*"; }
-cyan() { printf "\e[36m%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 "[A]pprove? \n"
-  response=$(bash -c "read -n 1 key; echo \$key")
-  printf "\r"
+  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"
@@ -103,21 +138,33 @@ user_approval() {
 onexit() {
   exitcode=$?
   if [[ "$exitcode" == 0 ]]; then
-    green "\nFinished successfully"
+    printf "$exit_success_string\n" "$0"
   else
-    red "\nFinished with failures"
+    printf "$exit_failed_string\n" "$0"
   fi
+  echo
   exit $exitcode
 }
 
 onerror() {
-  fail "Caller: $(caller)"
+  fail "caller: $(caller)"
 }
 
 set -e
 trap 'onexit' EXIT
 trap 'onerror' ERR
 
+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_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
   diff_cmd="diff --unified --color=always"
 else

data/lib/bashly/refinements/compose_refinements.rb

@@ -1,41 +1,43 @@
-module ComposeRefinements
-  refine Hash do
-    def compose(keyword = 'import')
-      result = {}
-      each do |k, v|
-        if k.to_s == keyword
-          sub = safe_load_yaml(v).compose keyword
-          if sub.is_a? Array
-            result = sub
+module Bashly
+  module ComposeRefinements
+    refine Hash do
+      def compose(keyword = 'import')
+        result = {}
+        each do |k, v|
+          if k.to_s == keyword
+            sub = safe_load_yaml(v).compose keyword
+            if sub.is_a? Array
+              result = sub
+            else
+              result.merge! sub
+            end
+          elsif v.respond_to? :compose
+            result[k] = v.compose keyword
           else
-            result.merge! sub
+            result[k] = v
           end
-        elsif v.respond_to? :compose
-          result[k] = v.compose keyword
-        else
-          result[k] = v
         end
+        result
       end
-      result
-    end
 
-    def safe_load_yaml(path)
-      loaded = YAML.load_erb_file path
-      return loaded if loaded.is_a?(Array) || loaded.is_a?(Hash)
+      def safe_load_yaml(path)
+        loaded = YAML.load_erb_file path
+        return loaded if loaded.is_a?(Array) || loaded.is_a?(Hash)
 
-      raise Bashly::ConfigurationError, "Cannot find a valid YAML in g`#{path}`"
-    rescue Errno::ENOENT
-      raise Bashly::ConfigurationError, "Cannot find import file g`#{path}`"
+        raise Bashly::ConfigurationError, "Cannot find a valid YAML in g`#{path}`"
+      rescue Errno::ENOENT
+        raise Bashly::ConfigurationError, "Cannot find import file g`#{path}`"
+      end
     end
-  end
 
-  refine Array do
-    def compose(keyword = 'import')
-      map do |x|
-        if x.respond_to? :compose
-          x.compose keyword
-        else
-          x
+    refine Array do
+      def compose(keyword = 'import')
+        map do |x|
+          if x.respond_to? :compose
+            x.compose keyword
+          else
+            x
+          end
         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
@@ -332,7 +343,7 @@ module Bashly
         args.select(&:allowed)
       end
 
-      # Returns an array of all the environemnt_variables with a whitelist arg
+      # Returns an array of all the environment_variables with a whitelist arg
       def whitelisted_environment_variables
         environment_variables.select(&:allowed)
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.1.7'
+  VERSION = '1.1.9'
 end

data/lib/bashly/views/README.md

@@ -1,4 +1,4 @@
-# View Tempaltes
+# View Templates
 
 These are [GTX](https://github.com/dannyben/gtx) templates.
 

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

@@ -27,3 +27,4 @@ end
 >     shift
 >   done
 > }
+>

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.7
+  version: 1.1.9
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2024-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -161,6 +161,7 @@ files:
 - lib/bashly/completions/completely.yaml.gtx
 - lib/bashly/concerns/asset_helper.rb
 - lib/bashly/concerns/completions.rb
+- lib/bashly/concerns/indentation_helper.rb
 - lib/bashly/concerns/renderable.rb
 - lib/bashly/concerns/validation_helpers.rb
 - lib/bashly/config.rb
@@ -225,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