bashly 1.3.5 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 429df4c59ef5a1dc0f1f9e332ab0b32b702fe5b83124c5ab04d784ef7d82bbc2
-  data.tar.gz: fdef11f71141111dea60129f9a9b855c669129010f5ec6e046fc0cdfafd9907f
+  metadata.gz: 895095279e0e8793275a7f5c0e982b5ea9277881d73195d98212dab3303f682b
+  data.tar.gz: b7513cf9828698db23b417b7bff2941fc57045c28bc4968d5b33da2734834934
 SHA512:
-  metadata.gz: 17dcbf38797ebdd77898a53e09271cf7e0522c53af2f223910edc205f02d6ccd254eb4bcd11307f76656f14edaef253472efe0a9f699b9490f2ed3ef90746c85
-  data.tar.gz: 347ec4aebc9be7dcbcaef970db0465edf422b828361d3a37cfaa09337c372a1940a611b24a190af81dbb9857feeb8acc9c2d5662a39eac54df1f4504129c3424
+  metadata.gz: e8eb40deb329c675f94bf1ec65d8832709c60dbdc15c76d7a3419c780852ccbb9d18110fb7fbda29d9f197a7329ffec49ae8781bd332f91ed8e49c379e5c98e7
+  data.tar.gz: 31fe31dbfb2445633b367210c415b9764ff7614b257ebcc4116b2128152cbdd2df0a528c3b8a44029f96b473e0528911e09339fca10ff6292af61ad8c0559664

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/commands/generate.rb

@@ -1,5 +1,3 @@
-require 'filewatcher'
-
 module Bashly
   module Commands
     class Generate < Base
@@ -41,7 +39,7 @@ module Bashly
       def watch
         quiet_say "g`watching` #{Settings.source_dir}\n"
 
-        Filewatcher.new([Settings.source_dir]).watch do
+        Watch.new(Settings.source_dir).on_change do
           reset
           generate
         rescue Bashly::ConfigurationError => e

data/lib/bashly/commands/render.rb

@@ -1,4 +1,3 @@
-require 'filewatcher'
 require 'tty-markdown'
 
 module Bashly
@@ -75,7 +74,7 @@ module Bashly
       def watch
         say "g`watching`\n"
 
-        Filewatcher.new(watchables).watch do
+        Watch.new(*watchables).on_change do
           render
           say "g`waiting`\n"
         end

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

@@ -159,6 +159,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/script/introspection/commands.rb

@@ -7,6 +7,11 @@ module Bashly
           deep_commands(include_self: true).any? { |x| x.catch_all.enabled? }
         end
 
+        # Returns true if the command or any of its descendants has `argfile`
+        def argfile_used_anywhere?
+          deep_commands(include_self: true).any?(&:argfile)
+        end
+
         # Returns a full list of the Command names and aliases combined
         def command_aliases
           commands.map(&:aliases).flatten

data/lib/bashly/settings.rb

@@ -28,9 +28,15 @@ 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 commands_dir
         @commands_dir ||= get :commands_dir
       end
@@ -89,6 +95,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 +126,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 +176,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.5'
+  VERSION = '1.3.7'
 end

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

@@ -0,0 +1,5 @@
+= view_marker
+
+> load_command_argfile "{{ argfile }}" "$@"
+> set -- "${argfile_input[@]}"
+>

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

@@ -0,0 +1,36 @@
+= view_marker
+
+> load_command_argfile() {
+>   local argfile_path line arg
+>   argfile_path="$1"
+>   shift
+>   argfile_input=()
+>
+>   if [[ ! -f "$argfile_path" ]]; then
+>     argfile_input=("$@")
+>     return
+>   fi
+>
+>   while IFS= read -r line || [[ -n "$line" ]]; do
+>     line="${line#"${line%%[![:space:]]*}"}"
+>     line="${line%"${line##*[![:space:]]}"}"
+>
+>     [[ -z "$line" || "${line:0:1}" == "#" ]] && continue
+>
+>     if [[ "$line" =~ ^(-{1,2}[^[:space:]]+)[[:space:]]+(.+)$ ]]; then
+>       for arg in "${BASH_REMATCH[1]}" "${BASH_REMATCH[2]}"; do
+>         arg="${arg#"${arg%%[![:space:]]*}"}"
+>         arg="${arg%"${arg##*[![:space:]]}"}"
+>         [[ "$arg" =~ ^\"(.*)\"$ || "$arg" =~ ^\'(.*)\'$ ]] && arg="${BASH_REMATCH[1]}"
+>         argfile_input+=("$arg")
+>       done
+>     else
+>       arg="$line"
+>       [[ "$arg" =~ ^\"(.*)\"$ || "$arg" =~ ^\'(.*)\'$ ]] && arg="${BASH_REMATCH[1]}"
+>       argfile_input+=("$arg")
+>     fi
+>   done <"$argfile_path"
+>
+>   argfile_input+=("$@")
+> }
+>

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

@@ -4,6 +4,7 @@
 = render :version_command
 = render :usage
 = render :normalize_input
+= render :argfile_helpers if argfile_used_anywhere?
 = render :inspect_args if Settings.enabled? :inspect_args
 = render :user_lib if user_lib.any?
 = render :command_functions

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

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

data/lib/bashly/watch.rb

@@ -0,0 +1,68 @@
+require 'listen'
+
+module Bashly
+  # File system watcher - an ergonomic wrapper around the Listen gem
+  class Watch
+    attr_reader :dirs, :options
+
+    def initialize(*dirs, **options)
+      @options = default_options.merge(options).freeze
+      @dirs = dirs.empty? ? ['.'] : dirs
+    end
+
+    def on_change(&)
+      start(&)
+      wait
+    ensure
+      stop
+    end
+
+  private
+
+    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)
+      raise ArgumentError, 'block required' unless block
+
+      @listener = build_listener(&block)
+      @listener.start
+    end
+
+    def stop
+      @listener&.stop
+      @listener = nil
+    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'
@@ -12,7 +7,7 @@ module Bashly
 
   autoloads 'bashly', %i[
     CLI Config ConfigValidator Library LibrarySource LibrarySourceConfig
-    MessageStrings RenderContext RenderSource Settings VERSION
+    MessageStrings RenderContext RenderSource Settings VERSION Watch
   ]
 
   autoloads 'bashly/concerns', %i[

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.7
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -38,33 +38,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: filewatcher
+  name: gtx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: gtx
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: lp
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: requires
   requirement: !ruby/object:Gem::Requirement
@@ -125,42 +125,16 @@ dependencies:
   name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: ostruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.7'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables:
@@ -232,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
@@ -274,6 +246,8 @@ 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/argfile_helpers.gtx
 - lib/bashly/views/command/catch_all_filter.gtx
 - lib/bashly/views/command/command_fallback.gtx
 - lib/bashly/views/command/command_filter.gtx
@@ -336,6 +310,7 @@ files:
 - lib/bashly/views/wrapper/bash3_bouncer.gtx
 - lib/bashly/views/wrapper/header.gtx
 - lib/bashly/views/wrapper/wrapper.gtx
+- lib/bashly/watch.rb
 homepage: https://github.com/bashly-framework/bashly
 licenses:
 - MIT
@@ -359,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.0
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Bash Command Line Tool Generator
 test_files: []

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...