bashly 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 701ac68c31b0dc916b212886b694c8aef4994aabdd703cfffe5bd592a91d1989
-  data.tar.gz: c9968bd61faf7ffc1f52e9eefc65fa54a88ee09326238618809eb66e65a17fb0
+  metadata.gz: 98fc7fa0a703a1bdef30afdd0e4ff4b5a4d5cc6025380e4aa952aeb77c0b9aa8
+  data.tar.gz: 2d148783f32363862d4039b424ef8ddd5fa050c849bbe742f7195096cdf78830
 SHA512:
-  metadata.gz: dd50a1a52f24a5a7989266090827f21fa4265856d9319ab1eff288bab8e3bd2b0256efec8462387fe992f2adba175bbb50b2dd9b59e580e5b4a97f2aba9849dd
-  data.tar.gz: f40b18e9876e6297a1bcb8e14d9b364a88cb05f8db1fbaff31e3746f96961db581dbda6bd33a5a9147767c62afaab7caf7541fdde02167403d17ef4ec48933ff
+  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/config_validator.rb

@@ -79,6 +79,7 @@ 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
 
@@ -98,6 +99,7 @@ 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']

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

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

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/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.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 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
@@ -161,6 +162,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