bashly 1.1.6 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 412b8737b7f30c9851116b020bafbb220bb001fcf148d4baf3bc383a32ad3e0d
-  data.tar.gz: 0b4595b01191d2899f50ab7d74f6f7f9d0ec4901f17daebf57304d197b8e8ccd
+  metadata.gz: d11d229ff42dc84aa910ee8292e145b63641c5520315583e92d5aa0747e6e578
+  data.tar.gz: 61a2ddcb970af41f7a086da0a75d0452a637e3fe650569e2768f1a0eefe49849
 SHA512:
-  metadata.gz: 9af37fd9a1a5883e8c05ff88d3fd1de2b0689586e9717072b17e15dcb55a9c8f228e963e2131aa8828a1fd1d12a51c8373bdf28f650f8e13369dcf84bec3a68a
-  data.tar.gz: 51a9db127eb74ebbe7e3d55aa8fb6e7f17479c587e632061d62330503103dbed7ca7c405f01d3090036459aaf5a529960156c66d6248849f936aff5be0bcd6d7
+  metadata.gz: b9ffdaa7a7a862b11d932e6533d4b7e1b1e76407292bbaf5ca8afdc192249b0f51ea504adfc459e37b712074291ef612fc5b29965700043676bc94709062e696
+  data.tar.gz: 629b81b7ef43fa64523a465968828d74192fbd17440e9f20f724a6ef040ebe0c805bed339f899ca6047f53043c29d88537829075bd60be2f752a69e09eaaee55

data/README.md

@@ -27,15 +27,6 @@ usually handled by a framework in any other programming language.
 It is available both as a [ruby gem](https://rubygems.org/gems/bashly) and as
 a [docker image](https://hub.docker.com/r/dannyben/bashly).
 
-## Bashly is Sponsored By
-
-<table>
-   <tr>
-      <td><a href="https://rhodecode.com/"><img src='support/img/RhodeCode-logo.png' width=240></a></td>
-   </tr>
-</table>
-
-
 ## Documentation
 
 - [Bashly Homepage][docs]

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/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.0
+# approvals.bash v0.5.0
 #
 # 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}
@@ -9,8 +12,8 @@ approve() {
   cmd=$1
   last_exit_code=0
   actual=$(eval "$cmd" 2>&1) || last_exit_code=$?
-  if [[ "$allow_diff_regex" ]]; then
-    actual=$(echo "$actual" | sed "s/$allow_diff_regex/*/g")
+  if [[ -v allow_diff_regex && "$allow_diff_regex" ]]; then
+    actual=$(echo "$actual" | sed -E "s/$allow_diff_regex/*/g")
     unset allow_diff_regex
   fi
   approval=$(printf "%b" "$cmd" | tr -s -c "[:alnum:]" _)
@@ -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,20 @@ allow_diff() {
 }
 
 describe() {
-  echo
-  blue "= $*"
+  printf "$describe_string\n" "$*"
 }
 
 context() {
-  echo
-  magenta "= $*"
+  printf "$context_string\n" "$*"
 }
 
 fail() {
-  red "  FAILED: $*"
+  printf "$fail_string\n" "$*"
   exit 1
 }
 
 pass() {
-  green "  approved: $*"
+  printf "$pass_string\n" "$*"
   return 0
 }
 
@@ -67,15 +68,17 @@ 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" "$*"; }
+bold() { printf "\e[1m%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" "$*"; }
+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
 
@@ -89,9 +92,9 @@ user_approval() {
   fi
 
   echo
-  printf "[A]pprove? \n"
+  printf "$approval_string"
   response=$(bash -c "read -n 1 key; echo \$key")
-  printf "\r"
+  printf "\b%.s" $(seq 1 $((${#approval_string} + 1)))
   if [[ $response =~ [Aa] ]]; then
     printf "%b\n" "$actual" >"$approval_file"
     pass "$cmd"
@@ -103,21 +106,32 @@ 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="$(blue ▌ describe)   %s"
+context_string="$(magenta ▌ context)    %s"
+fail_string="  $(red 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)) ├────"
+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

@@ -322,12 +322,17 @@ module Bashly
         @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.#{Settings.partials_extension}"]
       end
 
+      # Returns a mixed array of Argument and Flag objects that have validations
+      def validatables
+        @validatables ||= args.select(&:validate) + flags.select(&:validate)
+      end
+
       # Returns an array of all the args with a whitelist
       def whitelisted_args
         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.6'
+  VERSION = '1.1.8'
 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/validations.gtx

@@ -1,11 +1,22 @@
 if validate
+  = view_marker
 
-= view_marker
-
-> if [[ -n $(validate_{{ validate }} "$1") ]]; then
->   printf "{{ strings[:validation_error] }}\n" "{{ name.upcase }}" "$(validate_{{ validate }} "$1")" >&2
->   exit 1
-> fi
-> 
+  if repeatable
+    > if [[ -v args['{{ name }}'] ]]; then
+    >   eval "values=(${args['{{ name }}']})"
+    >   for value in "${values[@]}"; do
+    >     if [[ -n $(validate_{{ validate }} "$value") ]]; then
+    >       printf "{{ strings[:validation_error] }}\n" "{{ name.upcase }}" "$(validate_{{ validate }} "$value")" >&2
+    >       exit 1
+    >     fi
+    >   done
+    > fi
+  else
+    > if [[ -v args['{{ name }}'] && -n $(validate_{{ validate }} "${args['{{ name }}']:-}") ]]; then
+    >   printf "{{ strings[:validation_error] }}\n" "{{ name.upcase }}" "$(validate_{{ validate }} "${args['{{ name }}']:-}")" >&2
+    >   exit 1
+    > fi
+    >
+  end
 
 end

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

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

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

@@ -15,6 +15,7 @@ end
 = render(:required_flags_filter).indent 2
 = render(:catch_all_filter).indent 2
 = render(:default_assignments).indent 2
+= render(:validations).indent 2
 = render(:whitelist_filter).indent 2
 = render(:user_filter).indent 2
 

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

@@ -4,7 +4,6 @@ if args.any?
   condition = "if"
   args.each do |arg|
     > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
-    =   arg.render(:validations).indent 2
     >   args['{{ arg.name }}']=$1
     >   shift
     

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

@@ -2,7 +2,6 @@
 
 condition = "if"
 args.each do |arg|
-  = arg.render(:validations)
   > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
   if arg.repeatable
     >   args['{{ arg.name }}']="\"$1\""

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

@@ -4,7 +4,6 @@ if args.any?
   condition = "if"
   args.each do |arg|
     > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
-    > {{ arg.render(:validations).indent 2 }}
     >   args['{{ arg.name }}']=$1
     >   shift
 

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

@@ -0,0 +1,7 @@
+if validatables.any?
+  = view_marker
+
+  validatables.each do |arg_or_flag|
+    = arg_or_flag.render(:validations)
+  end
+end

data/lib/bashly/views/flag/case_arg.gtx

@@ -1,7 +1,6 @@
 = view_marker
 
 > if [[ -n ${2+x} ]]; then
-= render(:validations).indent 2
 
 if repeatable
   >   if [[ -z ${args['{{ name }}']+x} ]]; then

data/lib/bashly/views/flag/validations.gtx

@@ -1,11 +1,22 @@
 if validate
-
   = view_marker
 
-  > if [[ -n $(validate_{{ validate }} "$2") ]]; then
-  >   printf "{{ strings[:validation_error] }}\n" "{{ usage_string }}" "$(validate_{{ validate }} "$2")" >&2
-  >   exit 1
-  > fi
-  > 
+  if repeatable
+    > if [[ -v args['{{ long }}'] ]]; then
+    >   eval "values=(${args['{{ long }}']})"
+    >   for value in "${values[@]}"; do
+    >     if [[ -n $(validate_{{ validate }} "$value") ]]; then
+    >       printf "{{ strings[:validation_error] }}\n" "{{ usage_string }}" "$(validate_{{ validate }} "$value")" >&2
+    >       exit 1
+    >     fi
+    >   done
+    > fi
+  else
+    > if [[ -v args['{{ long }}'] && -n $(validate_{{ validate }} "${args['{{ long }}']:-}") ]]; then
+    >   printf "{{ strings[:validation_error] }}\n" "{{ usage_string }}" "$(validate_{{ validate }} "${args['{{ long }}']:-}")" >&2
+    >   exit 1
+    > fi
+    >
+  end
 
 end

data/lib/bashly.rb

@@ -1,5 +1,5 @@
-if ENV['BYEBUG']
-  require 'byebug'
+if ENV['DEBUGGER']
+  require 'debug'
   require 'lp'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.8
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-29 00:00:00.000000000 Z
+date: 2024-03-02 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
@@ -265,6 +266,7 @@ files:
 - lib/bashly/views/command/user_filter.gtx
 - lib/bashly/views/command/user_hooks.gtx
 - lib/bashly/views/command/user_lib.gtx
+- lib/bashly/views/command/validations.gtx
 - lib/bashly/views/command/version_command.gtx
 - lib/bashly/views/command/whitelist_filter.gtx
 - lib/bashly/views/environment_variable/usage.gtx
@@ -301,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Bash Command Line Tool Generator