bashly 0.7.2 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0f901e6eab10987e6daf0042b18e097b172f3d54babc286b9fb2f5e83452612
-  data.tar.gz: 4dc2043674ce9c5d1c3be9bfd8ec72f2cf0f18ac121b909e939dc9dd4ca3ea79
+  metadata.gz: 98fc7fa0a703a1bdef30afdd0e4ff4b5a4d5cc6025380e4aa952aeb77c0b9aa8
+  data.tar.gz: 2d148783f32363862d4039b424ef8ddd5fa050c849bbe742f7195096cdf78830
 SHA512:
-  metadata.gz: f00b5c1afcb6349e7fdcc3e60adc23d2d6aa3d22a31b6375c3a2129adcb4434b9e2885449fdd8ede13dca7d56b0c1b6387681b6428db6028da0208cea82fe0a2
-  data.tar.gz: 5350aa76e39d2cee1d3ef2eb722e22f10e3d28772917d6b66cd5d11b0fb331a45e6fa2dd006f1096468b6189735ccffbf2650c27cb8a6a8d70b92c9c63803625
+  metadata.gz: 309afb5a2c73c170fafacf9ab02066bd1e4d29934c6a94f6518328dbfd246a8679fc0e8ffc51e00a3359adc90cc25d1d9433e8944db7def0cf806ac5dd99d89d
+  data.tar.gz: fd16952f25275a54d0aaaf990b00575a19fc5d38cab3206918722240466df9e1ae7f55f439ccfc1129ca5d8733181583fbd4280bf18cb42615119a9122f666d8

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"
@@ -55,6 +57,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/generate.rb

@@ -1,8 +1,6 @@
 module Bashly
   module Commands
     class Generate < Base
-      using ComposeRefinements
-
       help "Generate the bash script and required files"
 
       usage "bashly generate [--force --quiet --upgrade --wrap FUNCTION]"
@@ -82,7 +80,7 @@ module Bashly
       end
 
       def create_root_command_file
-        create_file "#{Settings.source_dir}/root_command.sh", command.render(:default_root_script)
+        create_file "#{Settings.source_dir}/#{command.filename}", command.render(:default_root_script)
       end
 
       def create_all_command_files
@@ -98,7 +96,7 @@ module Bashly
         if File.exist? file and !args['--force']
           quiet_say "!txtblu!skipped!txtrst! #{file} (exists)"
         else
-          File.write file, content
+          File.deep_write file, content
           quiet_say "!txtgrn!created!txtrst! #{file}"
         end
       end
@@ -118,7 +116,7 @@ module Bashly
       end
 
       def config
-        @config ||= Config.new("#{Settings.source_dir}/bashly.yml").compose
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
       end
 
       def command

data/lib/bashly/config.rb

@@ -4,11 +4,13 @@ module Bashly
   # A convenience class to use either a hash or a filename as a configuration
   # source
   class Config
+    using ComposeRefinements
+
     attr_reader :config
 
     def self.new(config)
       if config.is_a? String
-        YAML.load_file config
+        YAML.load_file(config).compose
       else
         config
       end

data/lib/bashly/config_validator.rb

@@ -79,8 +79,11 @@ 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 '-'"
     end
 
     def assert_flag(key, value)
@@ -96,6 +99,11 @@ 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']
     end
 
     def assert_env_var(key, value)
@@ -117,6 +125,7 @@ module Bashly
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.footer", value['footer']
       assert_optional_string "#{key}.group", value['group']
+      assert_optional_string "#{key}.filename", value['filename']
 
       assert_boolean "#{key}.default", value['default']
       assert_version "#{key}.version", value['version']
@@ -128,6 +137,7 @@ module Bashly
       assert_array "#{key}.commands", value['commands'], of: :command
       assert_array "#{key}.completions", value['completions'], of: :string
       assert_array "#{key}.dependencies", value['dependencies'], of: :string
+      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
     end

data/lib/bashly/libraries/completions.rb

@@ -7,7 +7,7 @@ module Bashly
       end
 
       def config
-        @config ||= Bashly::Config.new "#{Settings.source_dir}/bashly.yml"
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
       end
     end
   end

data/lib/bashly/libraries.yml

@@ -23,6 +23,21 @@ strings:
     - 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"

data/lib/bashly/library.rb

@@ -57,7 +57,10 @@ 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
+      }
     end
   end
 end

data/lib/bashly/script/base.rb

@@ -10,12 +10,14 @@ module Bashly
         arg
         catch_all
         completions
+        conflicts
         default
         dependencies
         description
         environment_variables
         examples
         extensible
+        filters
         flags
         footer
         group
@@ -24,6 +26,7 @@ module Bashly
         name
         parent_name
         private
+        repeatable
         required
         short
         validate
@@ -53,9 +56,9 @@ module Bashly
         respond_to?(method_name) ? options[key] : super
       end
 
-      def respond_to?(method_name, include_private = false)
+      def respond_to_missing?(method_name, include_private = false)
         OPTION_KEYS.include?(method_name) || super
       end
     end
   end
-end
+end

data/lib/bashly/script/command.rb

@@ -55,7 +55,7 @@ module Bashly
       # Returns the bash filename that is expected to hold the user code
       # for this command
       def filename
-        "#{action_name.to_underscore}_command.sh"
+        options["filename"] || "#{action_name.to_underscore}_command.sh"
       end
 
       # Returns an array of Flags

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/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.2"
+  VERSION = "0.7.6"
 end

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

@@ -1,3 +1,3 @@
-echo "# this file is located in '<%= Settings.source_dir %>/root_command.sh'"
+echo "# this file is located in '<%= "#{Settings.source_dir}/#{filename}" %>'"
 echo "# you can edit it freely and regenerate (it will not be overwritten)"
 inspect_args

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

@@ -14,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/root_command.erb

@@ -1,4 +1,4 @@
 # :command.root_command
 root_command() {
-<%= load_user_file("root_command.sh").indent 2 %>
+<%= load_user_file(filename).indent 2 %>
 }

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

@@ -0,0 +1,11 @@
+# :command.user_filter
+% if filters
+% filters.each do |filter|
+filter_error=$(filter_<%= filter %>)
+if [[ -n $filter_error ]]; then
+  echo "$filter_error"
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.6
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -121,6 +121,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
@@ -155,11 +156,13 @@ files:
 - lib/bashly/views/command/usage_examples.erb
 - lib/bashly/views/command/usage_fixed_flags.erb
 - lib/bashly/views/command/usage_flags.erb
+- lib/bashly/views/command/user_filter.erb
 - lib/bashly/views/command/user_lib.erb
 - lib/bashly/views/command/version_command.erb
 - 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
@@ -188,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator