bashly 0.7.5 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 701ac68c31b0dc916b212886b694c8aef4994aabdd703cfffe5bd592a91d1989
-  data.tar.gz: c9968bd61faf7ffc1f52e9eefc65fa54a88ee09326238618809eb66e65a17fb0
+  metadata.gz: d05f653ff5439edd7108eaff3c6265926dc4e894453fce1c59bc4727c4c98d1f
+  data.tar.gz: 39afd30e66779103285d9df99f74f4e3cc8af61220d15a6b1cb02b21a4bebe57
 SHA512:
-  metadata.gz: dd50a1a52f24a5a7989266090827f21fa4265856d9319ab1eff288bab8e3bd2b0256efec8462387fe992f2adba175bbb50b2dd9b59e580e5b4a97f2aba9849dd
-  data.tar.gz: f40b18e9876e6297a1bcb8e14d9b364a88cb05f8db1fbaff31e3746f96961db581dbda6bd33a5a9147767c62afaab7caf7541fdde02167403d17ef4ec48933ff
+  metadata.gz: 8db8291a3db5a496626676942eddcadb61f7080ab316ed17652af5f58376e40efa85473e7a665a3966dbbfdbc37b6662577a3e13b50d9f49c36a87792854cefc
+  data.tar.gz: c844bf07c523c6f04a21874a08e3c2c40fafe4562829f419f77fd17f74ebaa70b5006e61c50b430399dcca00158f9d4b4fdb7afe4dfeb2e3a425c8eb544fcc22

data/lib/bashly/commands/add.rb

@@ -9,6 +9,7 @@ module Bashly
       usage "bashly add colors [--force]"
       usage "bashly add yaml [--force]"
       usage "bashly add validations [--force]"
+      usage "bashly add test [--force]"
       usage "bashly add comp FORMAT [OUTPUT --force]"
       usage "bashly add (-h|--help)"
 
@@ -23,6 +24,7 @@ module Bashly
       command "colors", "Add standard functions for printing colorful and formatted text to the lib directory."
       command "yaml", "Add standard functions for reading YAML files to the lib directory."
       command "validations", "Add argument validation functions to the lib directory."
+      command "test", "Add approval testing."
       command "comp", "Generate a bash completions script or function."
 
       example "bashly add strings --force"
@@ -30,6 +32,7 @@ module Bashly
       example "bashly add comp script completions.bash"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
+      environment "BASHLY_LIB_DIR", "The path to use for creating the library files, relative to the source dir [default: lib]"
 
       def strings_command
         add_lib 'strings'
@@ -55,6 +58,10 @@ module Bashly
         add_lib 'validations'
       end
 
+      def test_command
+        add_lib 'test'
+      end
+
       def comp_command
         format = args['FORMAT']
         output = args['OUTPUT']

data/lib/bashly/commands/base.rb

@@ -5,6 +5,12 @@ module Bashly
   module Commands
     class Base < MisterBin::Command
       include AssetHelper
+
+      def validate_config
+        config = Config.new "#{Settings.source_dir}/bashly.yml"
+        validator = ConfigValidator.new config
+        validator.validate
+      end
     end
   end
 end

data/lib/bashly/commands/generate.rb

@@ -13,12 +13,14 @@ module Bashly
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
       environment "BASHLY_TARGET_DIR", "The path to use for creating the bash script [default: .]"
+      environment "BASHLY_LIB_DIR", "The path to use for upgrading library files, relative to the source dir [default: lib]"
       environment "BASHLY_STRICT", "When not empty, enable bash strict mode (set -euo pipefail)"
 
       example "bashly generate --force"
       example "bashly generate --wrap my_function"
 
       def run
+        validate_config
         create_user_files
         upgrade_libs if args['--upgrade']
         create_master_script

data/lib/bashly/commands/validate.rb

@@ -9,9 +9,7 @@ module Bashly
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def run
-        config = Config.new "#{Settings.source_dir}/bashly.yml"
-        validator = ConfigValidator.new config
-        validator.validate
+        validate_config
         say "!txtgrn!OK"
       end
     end

data/lib/bashly/config.rb

@@ -10,7 +10,7 @@ module Bashly
 
     def self.new(config)
       if config.is_a? String
-        YAML.load_file(config).compose
+        YAML.properly_load_file(config).compose
       else
         config
       end

data/lib/bashly/config_validator.rb

@@ -79,10 +79,13 @@ module Bashly
       assert_optional_string "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
       assert_boolean "#{key}.required", value['required']
+      assert_boolean "#{key}.repeatable", value['repeatable']
       
       assert_array "#{key}.allowed", value['allowed'], of: :string
 
       refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
+
+      refute value['required'] && value['default'], "#{key} cannot have both required and default"
     end
 
     def assert_flag(key, value)
@@ -98,10 +101,21 @@ module Bashly
       
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string
+      assert_array "#{key}.conflicts", value['conflicts'], of: :string
 
       assert value['long'].match(/^--[a-zA-Z0-9_\-]+$/), "#{key}.long must be in the form of '--name'" if value['long']
       assert value['short'].match(/^-[a-zA-Z0-9]$/), "#{key}.short must be in the form of '-n'" if value['short']
       refute value['arg'].match(/^-/), "#{key}.arg must not start with '-'" if value['arg']
+
+      refute value['required'] && value['default'], "#{key} cannot have both required and default"
+
+      if value['default']
+        assert value['arg'], "#{key}.default does not make sense without arg"
+      end
+
+      if value['allowed']
+        assert value['arg'], "#{key}.allowed does not make sense without arg"
+      end
     end
 
     def assert_env_var(key, value)
@@ -138,6 +152,16 @@ module Bashly
       assert_array "#{key}.filters", value['filters'], of: :string
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
+
+      if key == "root"
+        refute value['short'], "#{key}.short makes no sense"
+        refute value['group'], "#{key}.group makes no sense"
+        refute value['default'], "#{key}.default makes no sense"
+        refute value['private'], "#{key}.private makes no sense"
+      else
+        refute value['version'], "#{key}.version makes no sense"
+        refute value['extensible'], "#{key}.extensible makes no sense"
+      end
     end
   end
 end

data/lib/bashly/extensions/yaml.rb

@@ -0,0 +1,8 @@
+module YAML
+  # This awkward patch is due to https://bugs.ruby-lang.org/issues/17866
+  def self.properly_load_file(path)
+    YAML.load_file path, aliases: true
+  rescue ArgumentError
+    YAML.load_file path
+  end
+end

data/lib/bashly/libraries/completions_function.rb

@@ -4,7 +4,7 @@ module Bashly
       def files
         [
           {
-            path: "#{Settings.source_dir}/lib/#{function_name}.sh",
+            path: "#{Settings.full_lib_dir}/#{function_name}.sh",
             content: completions_function_code(function_name)
           }
         ]

data/lib/bashly/libraries.yml

@@ -1,38 +1,53 @@
 colors:
   files:
     - source: "templates/lib/colors.sh"
-      target: "%{user_source_dir}/lib/colors.sh"
+      target: "%{user_lib_dir}/colors.sh"
 
 config:
   files:
     - source: "templates/lib/config.sh"
-      target: "%{user_source_dir}/lib/config.sh"
+      target: "%{user_lib_dir}/config.sh"
 
 yaml:
   files:
     - source: "templates/lib/yaml.sh"
-      target: "%{user_source_dir}/lib/yaml.sh"
+      target: "%{user_lib_dir}/yaml.sh"
 
 lib:
   files:
     - source: "templates/lib/sample_function.sh"
-      target: "%{user_source_dir}/lib/sample_function.sh"
+      target: "%{user_lib_dir}/sample_function.sh"
 
 strings:
   files:
     - source: "templates/strings.yml"
       target: "%{user_source_dir}/bashly-strings.yml"
 
+test:
+  files:
+    - source: "templates/test/approvals.bash"
+      target: "%{user_target_dir}/test/approvals.bash"
+    - source: "templates/test/approve"
+      target: "%{user_target_dir}/test/approve"
+
+  post_install_message: |
+    Edit your tests in !txtgrn!test/approve!txtrst! and then run:
+
+      !txtpur!$ ./test/approve!txtrst!"
+
+    Docs: !undblu!https://github.com/DannyBen/approvals.bash
+
+
 validations:
   files:
     - source: "templates/lib/validations/validate_dir_exists.sh"
-      target: "%{user_source_dir}/lib/validations/validate_dir_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_dir_exists.sh"
     - source: "templates/lib/validations/validate_file_exists.sh"
-      target: "%{user_source_dir}/lib/validations/validate_file_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_file_exists.sh"
     - source: "templates/lib/validations/validate_integer.sh"
-      target: "%{user_source_dir}/lib/validations/validate_integer.sh"
+      target: "%{user_lib_dir}/validations/validate_integer.sh"
     - source: "templates/lib/validations/validate_not_empty.sh"
-      target: "%{user_source_dir}/lib/validations/validate_not_empty.sh"
+      target: "%{user_lib_dir}/validations/validate_not_empty.sh"
 
 completions: :CompletionsFunction
 completions_script: :CompletionsScript

data/lib/bashly/library.rb

@@ -6,7 +6,7 @@ module Bashly
       end
 
       def config
-        @config ||= YAML.load_file(config_path)
+        @config ||= YAML.properly_load_file(config_path)
       end
 
       def config_path
@@ -57,7 +57,11 @@ module Bashly
     end
 
     def target_file_args
-      { user_source_dir: Settings.source_dir }
+      {
+        user_source_dir: Settings.source_dir,
+        user_target_dir: Settings.target_dir,
+        user_lib_dir: Settings.full_lib_dir,
+      }
     end
   end
 end

data/lib/bashly/message_strings.rb

@@ -13,7 +13,7 @@ module Bashly
   private
 
     def values!
-      defaults = YAML.load_file asset("templates/strings.yml")
+      defaults = YAML.properly_load_file asset("templates/strings.yml")
       defaults.merge project_strings
     end
 
@@ -23,7 +23,7 @@ module Bashly
 
     def project_strings!
       if File.exist? project_strings_path
-        YAML.load_file project_strings_path
+        YAML.properly_load_file project_strings_path
       else
         {}
       end

data/lib/bashly/refinements/compose_refinements.rb

@@ -22,7 +22,7 @@ module ComposeRefinements
     end
 
     def safe_load_yaml(path)
-      loaded = YAML.load_file path
+      loaded = YAML.properly_load_file path
       return loaded if loaded.is_a? Array or loaded.is_a? Hash
       raise Bashly::ConfigurationError, "Cannot find a valid YAML in !txtgrn!#{path}"
 

data/lib/bashly/script/base.rb

@@ -10,6 +10,7 @@ module Bashly
         arg
         catch_all
         completions
+        conflicts
         default
         dependencies
         description
@@ -25,6 +26,7 @@ module Bashly
         name
         parent_name
         private
+        repeatable
         required
         short
         validate
@@ -34,7 +36,6 @@ module Bashly
       def initialize(options)
         raise Error, "Invalid options provided" unless options.respond_to? :keys
         @options = options
-        validate_options if respond_to? :validate_options
       end
 
       def optional

data/lib/bashly/script/command.rb

@@ -125,13 +125,7 @@ module Bashly
       # This is meant to provide the user with the ability to add custom
       # functions
       def user_lib
-        @user_lib ||= Dir["#{Settings.source_dir}/lib/**/*.sh"].sort
-      end
-
-      # Raise an exception if there are some serious issues with the command
-      # definition. This is called by Base#initialize.
-      def validate_options
-        Bashly::ConfigValidator.new(options).validate
+        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.sh"].sort
       end
 
     end

data/lib/bashly/script/flag.rb

@@ -19,6 +19,7 @@ module Bashly
         result = [aliases.join(", ")]
         result << arg.upcase if arg
         result << strings[:required] if required and extended
+        result << strings[:repeatable] if repeatable and extended
         result.join " "
       end
     end

data/lib/bashly/settings.rb

@@ -1,7 +1,7 @@
 module Bashly
   class Settings
     class << self
-      attr_writer :source_dir, :target_dir
+      attr_writer :source_dir, :target_dir, :lib_dir, :strict
 
       def source_dir
         @source_dir ||= ENV['BASHLY_SOURCE_DIR'] || 'src'
@@ -10,6 +10,18 @@ module Bashly
       def target_dir
         @target_dir ||= ENV['BASHLY_TARGET_DIR'] || '.'
       end
+
+      def lib_dir
+        @lib_dir ||= ENV['BASHLY_LIB_DIR'] || 'lib'
+      end
+
+      def strict
+        @strict ||= ENV['BASHLY_STRICT']
+      end
+
+      def full_lib_dir
+        "#{source_dir}/#{lib_dir}"
+      end
     end
   end
 end

data/lib/bashly/templates/strings.yml

@@ -14,6 +14,7 @@ group: "%{group} Commands:"
 command_shortcut: "Shortcut: %{short}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
+repeatable: "(repeatable)"
 default: "Default: %{value}"
 allowed: "Allowed: %{values}"
 
@@ -25,6 +26,7 @@ version_flag_text: Show version number
 flag_requires_an_argument: "%{name} requires an argument: %{usage}"
 invalid_argument: "invalid argument: %s"
 invalid_flag: "invalid option: %s"
+conflicting_flags: "conflicting options: %s cannot be used with %s"
 missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"
 missing_required_flag: "missing required flag: %{usage}"
 missing_required_environment_variable: "missing required environment variable: %{var}"

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

@@ -0,0 +1,93 @@
+# approvals.bash v0.2.7
+#
+# Interactive approval testing for Bash.
+# https://github.com/DannyBen/approvals.bash
+approve() {
+  local expected approval approval_file actual cmd
+  approvals_dir=${APPROVALS_DIR:=approvals}
+  
+  cmd=$1
+  actual=$(eval "$cmd" 2>&1)  
+  last_exit_code=$?
+  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
+    echo "--- [$(blue "new: $cmd")] ---"
+    printf "%b\n" "$actual"
+    echo "--- [$(blue "new: $cmd")] ---"
+    expected="$actual"
+    user_approval "$cmd" "$actual" "$approval_file"
+    return
+  fi
+
+  if [[ "$(printf "%b" "$actual")" = "$(printf "%b" "$expected")" ]]; then
+    green "PASS $cmd"
+  else
+    echo "--- [$(blue "diff: $cmd")] ---"
+    $diff_cmd <(printf "%b" "$expected\n") <(printf "%b" "$actual\n" )  | tail -n +4
+    echo "--- [$(blue "diff: $cmd")] ---"
+    user_approval "$cmd" "$actual" "$approval_file"
+  fi
+}
+
+describe() {
+  cyan "TEST $*"
+}
+
+fail() {
+  red "FAIL $*"
+  exit 1
+}
+
+pass() {
+  green "PASS $*"
+  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
+}
+
+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
+
+user_approval() {
+  local cmd="$1"
+  local actual="$2"
+  local approval_file="$3"
+
+  if [[ -v CI || -v GITHUB_ACTIONS ]]; then
+    fail "$cmd"
+  fi
+
+  echo 
+  printf "[A]pprove? \n"
+  response=$(bash -c "read -n 1 key; echo \$key")
+  printf "\r"
+  if [[ $response =~ [Aa] ]]; then
+    printf "%b\n" "$actual" > "$approval_file"
+    pass "$cmd"
+  else
+    fail "$cmd"
+  fi
+}
+
+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/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.7.5"
+  VERSION = "0.7.8"
 end

data/lib/bashly/views/command/fixed_flags_filter.erb

@@ -1,5 +1,6 @@
 # :command.fixed_flag_filter
 case "${1:-}" in
+% if root_command?
 % if short_flag_exist? "-v"
 --version )
 % else
@@ -9,6 +10,7 @@ case "${1:-}" in
   exit
   ;;
 
+% end
 % if short_flag_exist? "-h"
 --help )
 % else

data/lib/bashly/views/command/initialize.erb

@@ -2,7 +2,7 @@
 initialize() {
   version="<%= version %>"
   long_usage=''
-  <%= ENV['BASHLY_STRICT'] ? "set -euo pipefail" : "set -e" %>
+  <%= Settings.strict ? "set -euo pipefail" : "set -e" %>
 
 <%= load_user_file("initialize.sh", placeholder: false).indent 2 %>
 }

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

@@ -7,7 +7,6 @@ parse_requirements() {
 <%= render(:fixed_flags_filter).indent 2 %>
 <%= render(:environment_variables_filter).indent 2 %>
 <%= render(:dependencies_filter).indent 2 %>
-<%= render(:user_filter).indent 2 %>
 <%= render(:command_filter).indent 2 %>
 <%= render(:parse_requirements_while).indent 2 %>
 <%= render(:required_args_filter).indent 2 %>
@@ -15,6 +14,7 @@ parse_requirements() {
 <%= render(:catch_all_filter).indent 2 %>
 <%= render(:default_assignments).indent 2 %>
 <%= render(:whitelist_filter).indent 2 %>
+<%= render(:user_filter).indent 2 %>
 }
 
 % commands.each do |command|

data/lib/bashly/views/command/whitelist_filter.erb

@@ -6,8 +6,18 @@ if [[ ! ${args[<%= arg.name %>]} =~ ^(<%= arg.allowed.join '|' %>)$ ]]; then
 fi
 % end
 % whitelisted_flags.each do |flag|
+% if flag.repeatable
+eval "input_array=(${args[<%= flag.name %>]})"
+for i in "${input_array[@]}"; do
+  if [[ ! $i =~ ^(<%= flag.allowed.join '|' %>)$ ]]; then
+    printf "%s\n" "<%= strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } %>"
+    exit 1
+  fi
+done
+% else
 if [[ ! ${args[<%= flag.name %>]} =~ ^(<%= flag.allowed.join '|' %>)$ ]]; then
   printf "%s\n" "<%= strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } %>"
   exit 1
 fi
+% end
 % end

data/lib/bashly/views/flag/case.erb

@@ -1,17 +1,30 @@
 # :flag.case
 <%= aliases.join " | " %> )
+<%= render(:conflicts).indent 2 %>
 % if arg
   if [[ -n ${2+x} ]]; then
 <%= render(:validations).indent 4 %>
+% if repeatable
+    if [[ -z ${args[<%= name %>]+x} ]]; then
+      args[<%= name %>]="\"$2\""
+    else
+      args[<%= name %>]="${args[<%= name %>]} \"$2\""
+    fi
+% else
     args[<%= name %>]="$2"
+% end
     shift
     shift
   else
     printf "%s\n" "<%= strings[:flag_requires_an_argument] % { name: name, usage: usage_string } %>"
     exit 1
   fi
+% else
+% if repeatable
+  (( args[<%= name %>]+=1 ))
 % else
   args[<%= name %>]=1
+% end
   shift
 % end
   ;;

data/lib/bashly/views/flag/conflicts.erb

@@ -0,0 +1,18 @@
+# :flag.conflicts
+% if conflicts
+% if conflicts.count == 1
+if [[ -n "${args[<%= conflicts.first %>]:-}" ]]; then
+  printf "<%= strings[:conflicting_flags] %>\n" "$key" "<%= conflicts.first %>"
+  exit 1
+fi
+
+% else
+for conflict in <%= conflicts.join ' ' %>; do
+  if [[ -n "${args[$conflict]:-}" ]]; then
+    printf "<%= strings[:conflicting_flags] %>\n" "$key" "$conflict"
+    exit 1
+  fi
+done
+
+% end
+% end

data/lib/bashly/views/wrapper/header.erb

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
-# This script was generated by bashly (https://github.com/DannyBen/bashly)
+# This script was generated by bashly <%= Bashly::VERSION %> (https://bashly.dannyb.co)
 # Modifying it manually is not recommended
 

data/lib/bashly.rb

@@ -7,6 +7,7 @@ end
 
 requires 'bashly/concerns'
 
+requires 'bashly/extensions'
 requires 'bashly/settings'
 requires 'bashly/exceptions'
 requires 'bashly/refinements'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.8
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -93,6 +93,7 @@ files:
 - lib/bashly/extensions/array.rb
 - lib/bashly/extensions/file.rb
 - lib/bashly/extensions/string.rb
+- lib/bashly/extensions/yaml.rb
 - lib/bashly/libraries.yml
 - lib/bashly/libraries/base.rb
 - lib/bashly/libraries/completions.rb
@@ -121,6 +122,7 @@ files:
 - lib/bashly/templates/lib/yaml.sh
 - lib/bashly/templates/minimal.yml
 - lib/bashly/templates/strings.yml
+- lib/bashly/templates/test/approvals.bash
 - lib/bashly/version.rb
 - lib/bashly/views/argument/usage.erb
 - lib/bashly/views/argument/validations.erb
@@ -161,6 +163,7 @@ files:
 - lib/bashly/views/command/whitelist_filter.erb
 - lib/bashly/views/environment_variable/usage.erb
 - lib/bashly/views/flag/case.erb
+- lib/bashly/views/flag/conflicts.erb
 - lib/bashly/views/flag/usage.erb
 - lib/bashly/views/flag/validations.erb
 - lib/bashly/views/wrapper/bash3_bouncer.erb
@@ -189,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator