bashly 1.3.6 → 1.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c216518e1752d66966dfa1b8efad9a24afb5d55119a350ac9ad460abea748be0
-  data.tar.gz: 8626f99cfc41d424363969bbe46474fc86f8998f44c17d8196c03044281fbf6e
+  metadata.gz: 411dc6262c3232175e5a968a31ad90b56aa59be9d9b46203c3eb2db14f35d491
+  data.tar.gz: 2ce20d069c93e1e7081984ff1fb2dd9c7bca530d6fbf127e0bb1c996c0117cc1
 SHA512:
-  metadata.gz: 7b49310fec1d05dcf12504a8be34493d4e6d8af7ef9b2e35ea57da6424ca0820ee6abb7145ea54835ac31778db0ff89e6c6999050133f5851545ac67dc7f5b6c
-  data.tar.gz: 0b443ed8497671ff9faf2c720961d3344a5bbfb670096c9a74388cb54541f782b4316a198e4b2dfc7ed17b45a83991df2894ce05f3d76f943f694a63aa090bb2
+  metadata.gz: 3bff0a363b5c52c0f54b2b1e413b909256579c0b29ef8a44e88cd73b1803c584c3de26af99fa737edac8cc103a218f418a7a5f463e38b27c416ebf26bbcfe8ef
+  data.tar.gz: 2691947ed69d6f693625be4ba66a1b9803d01e46f50768d266c5f0f27c60f74242977fb91131443f6bd29161a9810970b542ecef3d3be0e9b3a84641da8dc080

data/README.md

@@ -13,6 +13,8 @@ Create feature-rich bash scripts using simple YAML configuration
 
 </div>
 
+![repocard](https://repocard.dannyben.com/svg/bashly.svg)
+
 Bashly is a command line application (written in Ruby) that lets you
 generate feature-rich bash command line tools.
 

data/lib/bashly/config_validator.rb

@@ -193,6 +193,7 @@ module Bashly
       assert_optional_string "#{key}.group", value['group']
       assert_optional_string "#{key}.filename", value['filename']
       assert_optional_string "#{key}.function", value['function']
+      assert_optional_string "#{key}.argfile", value['argfile']
 
       assert_boolean "#{key}.private", value['private']
       assert_default_command "#{key}.default", value['default']

data/lib/bashly/libraries/colors/colors.sh

@@ -42,6 +42,7 @@ white() { print_in_color "\e[37m" "$*"; }
 
 bold() { print_in_color "\e[1m" "$*"; }
 underlined() { print_in_color "\e[4m" "$*"; }
+bold_underlined() { print_in_color "\e[1;4m" "$*"; }
 
 red_bold() { print_in_color "\e[1;31m" "$*"; }
 green_bold() { print_in_color "\e[1;32m" "$*"; }

data/lib/bashly/libraries/ini/ini.sh

@@ -47,7 +47,7 @@ ini_load() {
     elif [[ $line =~ $key_regex ]]; then
       key="${BASH_REMATCH[1]}"
       value="${BASH_REMATCH[2]}"
-      [[ $value == *\$* ]] && eval "value=\"$value\""
+      [[ $value == *\$* ]] && value=$(envsubst <<<"$value")
       ini["${section}${key}"]="$value"
     fi
   done <"$ini_file"

data/lib/bashly/libraries/libraries.yml

@@ -121,21 +121,6 @@ strings:
     - source: "strings/strings.yml"
       target: "%{user_source_dir}/bashly-strings.yml"
 
-test:
-  help: Add approval testing.
-  files:
-    - source: "test/approvals.bash"
-      target: "%{user_target_dir}/test/approvals.bash"
-    - source: "test/approve"
-      target: "%{user_target_dir}/test/approve"
-
-  post_install_message: |
-    Edit your tests in g`test/approve` and then run:
-
-      m`$ test/approve`
-
-    Docs: bu`https://github.com/DannyBen/approvals.bash`
-
 validations:
   help: Add argument validation functions to the lib directory.
   files:

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

@@ -120,6 +120,12 @@ show_examples_on_error: false
 # all the private elements in the usage texts, as if they were public.
 private_reveal_key: ~
 
+# When enabling argfile for any command, this setting controls the name of the
+# environment variable that can override or disable argfile loading at runtime.
+# Set the variable to `0`, `off`, `no` or `false` to disable argfile loading,
+# or to a different path to load another argfile instead.
+argfile_var: ARGFILE
+
 # Display various usage elements in color by providing the name of the color
 # function. The value for each property is a name of a function that is
 # available in your script, for example: `green` or `bold`.
@@ -159,6 +165,17 @@ enable_env_var_names_array: always
 enable_sourcing: development
 
 
+#-------------------------------------------------------------------------------
+# DEVELOPER OPTIONS
+#-------------------------------------------------------------------------------
+
+# When true, use filesystem evented watching instead of polling
+watch_evented: false
+
+# File change detection latency (seconds)
+watch_latency: 1.0
+
+
 #-------------------------------------------------------------------------------
 # SCRIPTING OPTIONS
 #-------------------------------------------------------------------------------

data/lib/bashly/script/command.rb

@@ -14,7 +14,7 @@ module Bashly
       class << self
         def option_keys
           @option_keys ||= %i[
-            alias args catch_all commands completions
+            alias argfile args catch_all commands completions
             default dependencies environment_variables examples
             extensible expose filename filters flags
             footer function group help help_header_override name

data/lib/bashly/settings.rb

@@ -4,6 +4,7 @@ module Bashly
       include AssetHelper
 
       attr_writer(
+        :argfile_var,
         :commands_dir,
         :compact_short_flags,
         :conjoined_flag_args,
@@ -28,9 +29,19 @@ module Bashly
         :target_dir,
         :usage_colors,
         :var_aliases,
+        :watch_evented,
+        :watch_latency,
         :word_wrap
       )
 
+      def all_lib_dirs
+        @all_lib_dirs = [full_lib_dir] + extra_lib_dirs
+      end
+
+      def argfile_var
+        @argfile_var ||= get :argfile_var
+      end
+
       def commands_dir
         @commands_dir ||= get :commands_dir
       end
@@ -89,6 +100,17 @@ module Bashly
         @env = value&.to_sym
       end
 
+      def extra_lib_dirs
+        @extra_lib_dirs ||= begin
+          dirs = get :extra_lib_dirs
+          case dirs
+          when Array then dirs
+          when String then dirs.split(',').map(&:strip)
+          else []
+          end
+        end
+      end
+
       def formatter
         @formatter ||= get :formatter
       end
@@ -109,21 +131,6 @@ module Bashly
         @lib_dir ||= get :lib_dir
       end
 
-      def extra_lib_dirs
-        @extra_lib_dirs ||= begin
-          dirs = get :extra_lib_dirs
-          case dirs
-          when Array then dirs
-          when String then dirs.split(',').map(&:strip)
-          else []
-          end
-        end
-      end
-
-      def all_lib_dirs
-        @all_lib_dirs = [full_lib_dir] + extra_lib_dirs
-      end
-
       def partials_extension
         @partials_extension ||= get :partials_extension
       end
@@ -174,6 +181,14 @@ module Bashly
         @var_aliases ||= get :var_aliases
       end
 
+      def watch_evented
+        @watch_evented ||= get :watch_evented
+      end
+
+      def watch_latency
+        @watch_latency ||= get :watch_latency
+      end
+
       def word_wrap
         @word_wrap ||= get :word_wrap
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.3.6'
+  VERSION = '1.3.8'
 end

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

@@ -0,0 +1,29 @@
+= view_marker
+
+> local argfile argfile_line argfile_key argfile_value env_argfile env_argfile_var
+> argfile="{{ argfile }}"
+> env_argfile_var="{{ Settings.argfile_var }}"
+> env_argfile="${!env_argfile_var:-}"
+>
+> case "${env_argfile,,}" in
+>   0 | off | no | false)
+>     argfile=''
+>     ;;
+> esac
+>
+> [[ -n "$env_argfile" ]] && argfile="$env_argfile"
+> if [[ -f "$argfile" ]]; then
+>   while IFS= read -r argfile_line || [[ -n "$argfile_line" ]]; do
+>     [[ "$argfile_line" =~ ^[[:space:]]*(-{1,2}[^[:space:]]+)([[:space:]]+(.+))?[[:space:]]*$ ]] || continue
+>     argfile_key="${BASH_REMATCH[1]}"
+>     argfile_value="${BASH_REMATCH[3]:-}"
+>     argfile_value="${argfile_value#"${argfile_value%%[![:space:]]*}"}"
+>     argfile_value="${argfile_value%"${argfile_value##*[![:space:]]}"}"
+>     [[ "$argfile_value" =~ ^\"(.*)\"$ || "$argfile_value" =~ ^\'(.*)\'$ ]] && argfile_value="${BASH_REMATCH[1]}"
+>
+>     case "$argfile_key" in
+= flags.map { |flag| flag.render(:argfile_case) }.join.indent 6
+>     esac
+>   done <"$argfile"
+> fi
+>

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

@@ -9,6 +9,7 @@ end
 >
 
 = render(:fixed_flags_filter).indent 2
+= render(:argfile_filter).indent 2 if argfile
 = render(:environment_variables_filter).indent 2
 = render(:dependencies_filter).indent 2
 = render(:command_filter).indent 2

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

@@ -0,0 +1,6 @@
+= view_marker
+
+> {{ aliases.join " | " }})
+= render(arg ? :argfile_case_arg : :argfile_case_no_arg).indent 2
+>   ;;
+>

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

@@ -0,0 +1,23 @@
+= view_marker
+
+> if [[ -n "$argfile_value" ]]; then
+
+if repeatable
+  >   escaped="$(printf '%q' "$argfile_value")"
+  >   if [[ -z ${args['{{ name }}']+x} ]]; then
+  >     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
+  >   fi
+else
+  >   [[ -n ${args['{{ name }}']+x} ]] || args['{{ name }}']="$argfile_value"
+end
+
+> fi

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

@@ -0,0 +1,7 @@
+= view_marker
+
+if repeatable
+  > ((args['{{ name }}'] += 1))
+else
+  > [[ -n ${args['{{ name }}']+x} ]] || args['{{ name }}']=1
+end

data/lib/bashly/watch.rb

@@ -5,13 +5,8 @@ module Bashly
   class Watch
     attr_reader :dirs, :options
 
-    DEFAULT_OPTIONS = {
-      force_polling: true,
-      latency:       1.0,
-    }.freeze
-
     def initialize(*dirs, **options)
-      @options = DEFAULT_OPTIONS.merge(options).freeze
+      @options = default_options.merge(options).freeze
       @dirs = dirs.empty? ? ['.'] : dirs
     end
 
@@ -24,10 +19,20 @@ module Bashly
 
   private
 
-    def build_listener
-      listen.to(*dirs, **options) do |modified, added, removed|
-        yield changes(modified, added, removed)
-      end
+    def default_options
+      {
+        force_polling: force_polling?,
+        latency:       latency,
+      }
+    end
+
+    def force_polling?
+      !Settings.watch_evented
+    end
+
+    def latency
+      value = Settings.watch_latency.to_f
+      value.positive? ? value : 0.1
     end
 
     def start(&block)
@@ -42,16 +47,22 @@ module Bashly
       @listener = nil
     end
 
-    def changes(modified, added, removed)
-      { modified:, added:, removed: }
-    end
-
     def wait
       sleep
     rescue ::Interrupt => e
       raise Bashly::Interrupt, cause: e
     end
 
+    def build_listener
+      listen.to(*dirs, **options) do |modified, added, removed|
+        yield changes(modified, added, removed)
+      end
+    end
+
+    def changes(modified, added, removed)
+      { modified:, added:, removed: }
+    end
+
     def listen = Listen
   end
 end

data/lib/bashly.rb

@@ -1,8 +1,3 @@
-if ENV['DEBUGGER']
-  require 'debug'
-  require 'lp'
-end
-
 require 'requires'
 requires 'bashly/extensions'
 requires 'bashly/exceptions'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.3.8
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -206,8 +206,6 @@ files:
 - lib/bashly/libraries/settings/settings.yml
 - lib/bashly/libraries/stacktrace/stacktrace.sh
 - lib/bashly/libraries/strings/strings.yml
-- lib/bashly/libraries/test/approvals.bash
-- lib/bashly/libraries/test/approve
 - lib/bashly/libraries/validations/validate_dir_exists.sh
 - lib/bashly/libraries/validations/validate_file_exists.sh
 - lib/bashly/libraries/validations/validate_integer.sh
@@ -248,6 +246,7 @@ files:
 - lib/bashly/views/argument/case_repeatable.gtx
 - lib/bashly/views/argument/usage.gtx
 - lib/bashly/views/argument/validations.gtx
+- lib/bashly/views/command/argfile_filter.gtx
 - lib/bashly/views/command/catch_all_filter.gtx
 - lib/bashly/views/command/command_fallback.gtx
 - lib/bashly/views/command/command_filter.gtx
@@ -299,6 +298,9 @@ files:
 - lib/bashly/views/dependency/filter.gtx
 - lib/bashly/views/environment_variable/usage.gtx
 - lib/bashly/views/environment_variable/validations.gtx
+- lib/bashly/views/flag/argfile_case.gtx
+- lib/bashly/views/flag/argfile_case_arg.gtx
+- lib/bashly/views/flag/argfile_case_no_arg.gtx
 - lib/bashly/views/flag/case.gtx
 - lib/bashly/views/flag/case_arg.gtx
 - lib/bashly/views/flag/case_no_arg.gtx

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

@@ -1,172 +0,0 @@
-# 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}
-
-  cmd=$1
-  last_exit_code=0
-  actual=$(eval "$cmd" 2>&1) || last_exit_code=$?
-  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:]" _)
-  approval_file="$approvals_dir/${2:-"$approval"}"
-
-  [[ -d "$approvals_dir" ]] || mkdir "$approvals_dir"
-
-  if [[ -f "$approval_file" ]]; then
-    expected=$(cat "$approval_file")
-  else
-    printf -- "$new_diff_string\n" "$cmd"
-    printf "%b\n" "$actual"
-    printf -- "$new_diff_string\n" "$cmd"
-    expected="$actual"
-    user_approval "$cmd" "$actual" "$approval_file"
-    return
-  fi
-
-  if [[ "$(printf "%b" "$actual")" = "$(printf "%b" "$expected")" ]]; then
-    pass "$cmd"
-  else
-    printf -- "$changed_diff_string\n" "$cmd"
-    $diff_cmd <(printf "%b" "$expected\n") <(printf "%b" "$actual\n") | tail -n +4
-    printf -- "$changed_diff_string\n" "$cmd"
-    user_approval "$cmd" "$actual" "$approval_file"
-  fi
-}
-
-allow_diff() {
-  allow_diff_regex="$1"
-}
-
-describe() {
-  printf "$describe_string\n" "$*"
-}
-
-context() {
-  printf "$context_string\n" "$*"
-}
-
-it() {
-  printf "$it_string\n" "$*"
-}
-
-fail() {
-  printf "$fail_string\n" "$*"
-  exit 1
-}
-
-pass() {
-  printf "$pass_string\n" "$*"
-  return 0
-}
-
-expect_exit_code() {
-  if [[ $last_exit_code == "$1" ]]; then
-    pass "exit $last_exit_code"
-  else
-    fail "expected exit code $1, got $last_exit_code"
-  fi
-}
-
-# 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 ]] && [[ -z "${AUTO_APPROVE+x}" ]]; then
-    fail "$cmd"
-  fi
-
-  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"
-  else
-    fail "$cmd"
-  fi
-}
-
-onexit() {
-  exitcode=$?
-  if [[ "$exitcode" == 0 ]]; then
-    printf "$exit_success_string\n" "$0"
-  else
-    printf "$exit_failed_string\n" "$0"
-  fi
-  echo
-  exit $exitcode
-}
-
-onerror() {
-  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
-  diff_cmd="diff --unified"
-fi

data/lib/bashly/libraries/test/approve

@@ -1,25 +0,0 @@
-#!/usr/bin/env bash
-# Run this from the root directory
-
-cd ./test || exit
-source approvals.bash
-
-# Update me
-cli=./download
-
-# Tests (context, describe and indentation are optional)
-context "when DEBUG is on"
-  export DEBUG=1
-
-  describe "root command"
-    approve "$cli"
-    approve "$cli --help"
-
-context "when DEBUG is off"
-  unset DEBUG
-
-  describe "some other command"
-    approve "$cli other"
-    approve "$cli other --help"
-
-# ...more tests...