bashly 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d7c552cf8d73f90e7dbeb030acef7a6b329db3b0cd48e9436845c900aa26c03
-  data.tar.gz: 5bfb9b67eab6bec13a43b97967822eee9fa6f24c0faf013d36e4670ab747f48a
+  metadata.gz: 17cea196efbe1bc65a6639258fe902503b75656c6a759ea5434a12d6a53d4529
+  data.tar.gz: 5e86d08e594250889bc351d5d6113bcfc40f8ec04ba39f72a7f19eec8329c7af
 SHA512:
-  metadata.gz: 6b00ae3f396edb6550a49d950cbb18c3a02ea7c972dcb3e3be9fe964c9185c53ae33924870f27a3f12b235dc7390d0b95f1ef66036f7ed2e1cb34d6796091937
-  data.tar.gz: d12b41db4937a0267615a54cfe8c7b6062c798e83c48261a74cc3d88678e7046d81fd35ae0f0c1e5481f9754347dce9f95871bb37f61b379d8da022f572c5227
+  metadata.gz: ade5312408fc08533dc6992673744920e941e142c09c9f05e58e66a08a6dfccfab100707cee319cb2ec388e60f9a73ae8ff735e8217c8f91820fc5e2e22af886
+  data.tar.gz: cf7f6da0438551ba2a10ed5c224d7ad6ac6b02d8675dca57c8ac01eb465e705a19bd2c3d1812b61b54ab52a433b5ce228b7f3b579e9de24f71c6f512caad1202

data/lib/bashly/commands/render.rb

@@ -4,7 +4,7 @@ require 'tty-markdown'
 module Bashly
   module Commands
     class Render < Base
-      help 'Render the bashly data structure using cutsom templates'
+      help 'Render the bashly data structure using custom templates'
 
       usage 'bashly render SOURCE TARGET [--watch --show PATH]'
       usage 'bashly render SOURCE --about'

data/lib/bashly/concerns/validation_helpers.rb

@@ -31,7 +31,7 @@ module Bashly
       return unless of
 
       value.each_with_index do |val, i|
-        send "assert_#{of}".to_sym, "#{key}[#{i}]", val
+        send :"assert_#{of}", "#{key}[#{i}]", val
       end
     end
 

data/lib/bashly/config_validator.rb

@@ -91,7 +91,7 @@ module Bashly
       assert_hash key, value, keys: Script::Argument.option_keys
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
-      assert_optional_string "#{key}.default", value['default']
+      assert_string_or_array "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.repeatable", value['repeatable']
@@ -106,6 +106,10 @@ module Bashly
       if value['unique']
         assert value['repeatable'], "#{key}.unique does not make sense without nub`repeatable`"
       end
+
+      if value['default'].is_a? Array
+        assert value['repeatable'], "#{key}.default array does not make sense without nub`repeatable`"
+      end
     end
 
     def assert_flag(key, value)
@@ -118,7 +122,7 @@ module Bashly
       assert_optional_string "#{key}.short", value['short']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.arg", value['arg']
-      assert_optional_string "#{key}.default", value['default']
+      assert_string_or_array "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
 
       assert_boolean "#{key}.private", value['private']
@@ -148,7 +152,12 @@ module Bashly
       end
 
       if value['unique']
-        assert value['arg'] && value['repeatable'], "#{key}.unique does not make sense without nub`arg` and nub`repeatable`"
+        assert value['arg'] && value['repeatable'],
+          "#{key}.unique does not make sense without nub`arg` and nub`repeatable`"
+      end
+
+      if value['default'].is_a? Array
+        assert value['repeatable'], "#{key}.default array does not make sense without nub`repeatable`"
       end
     end
 
@@ -159,6 +168,9 @@ module Bashly
       assert_optional_string "#{key}.default", value['default']
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.private", value['private']
+      assert_array "#{key}.allowed", value['allowed'], of: :string
+
+      refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
     end
 
     def assert_command(key, value)

data/lib/bashly/libraries/strings/strings.yml

@@ -34,5 +34,6 @@ missing_required_environment_variable: "missing required environment variable: %
 missing_dependency: "missing dependency: %{dependency}"
 disallowed_flag: "%{name} must be one of: %{allowed}"
 disallowed_argument: "%{name} must be one of: %{allowed}"
+disallowed_environment_variable: "%{name} environment variable must be one of: %{allowed}"
 unsupported_bash_version: "bash version 4 or higher is required"
 validation_error: "validation error in %s:\\n%s"

data/lib/bashly/render_context.rb

@@ -1,4 +1,4 @@
-require 'date'    # for use by template render scripts
+require 'date' # for use by template render scripts
 require 'colsole'
 
 module Bashly

data/lib/bashly/script/argument.rb

@@ -1,3 +1,5 @@
+require 'shellwords'
+
 module Bashly
   module Script
     class Argument < Base
@@ -9,6 +11,16 @@ module Bashly
         end
       end
 
+      def default_string
+        if default.is_a?(Array)
+          Shellwords.shelljoin default
+        elsif default.is_a?(String) && repeatable
+          Shellwords.shellescape default
+        else
+          default
+        end
+      end
+
       def usage_string
         required ? label : "[#{label}]"
       end

data/lib/bashly/script/command.rb

@@ -327,6 +327,11 @@ module Bashly
         args.select(&:allowed)
       end
 
+      # Returns an array of all the environemnt_variables with a whitelist arg
+      def whitelisted_environment_variables
+        environment_variables.select(&:allowed)
+      end
+
       # Returns an array of all the flags with a whitelist arg
       def whitelisted_flags
         flags.select(&:allowed)

data/lib/bashly/script/environment_variable.rb

@@ -3,7 +3,7 @@ module Bashly
     class EnvironmentVariable < Base
       class << self
         def option_keys
-          @option_keys ||= %i[default help name required private]
+          @option_keys ||= %i[allowed default help name required private]
         end
       end
 

data/lib/bashly/script/flag.rb

@@ -22,6 +22,16 @@ module Bashly
         end
       end
 
+      def default_string
+        if default.is_a?(Array)
+          Shellwords.shelljoin default
+        elsif default.is_a?(String) && repeatable
+          Shellwords.shellescape default
+        else
+          default
+        end
+      end
+
       def name
         long || short
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.1.4'
+  VERSION = '1.1.5'
 end

data/lib/bashly/views/argument/usage.gtx

@@ -8,7 +8,11 @@ if allowed
 end
 
 if default
-  > printf "    {{ strings[:default] % { value: default } }}\n"
+  if default.is_a? Array
+    > printf "    {{ strings[:default] % { value: default.join(', ') } }}\n"
+  else
+    > printf "    {{ strings[:default] % { value: default } }}\n"
+  end
 end
 
 > echo

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

@@ -2,11 +2,11 @@ if default_args.any? or default_flags.any?
   = view_marker
 
   default_args.each do |arg|
-    > [[ -n ${args['{{ arg.name }}']:-} ]] || args['{{ arg.name }}']="{{ arg.default }}"
+    > [[ -n ${args['{{ arg.name }}']:-} ]] || args['{{ arg.name }}']="{{ arg.default_string }}"
   end
 
   default_flags.each do |flag|
-    > [[ -n ${args['{{ flag.name }}']:-} ]] || args['{{ flag.name }}']="{{ flag.default }}"
+    > [[ -n ${args['{{ flag.name }}']:-} ]] || args['{{ flag.name }}']="{{ flag.default_string }}"
   end
 
   >

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

@@ -1,13 +1,26 @@
-if default_environment_variables.any? or required_environment_variables.any?
-  = view_marker 
+if environment_variables.any?
+  = view_marker
   = render(:environment_variables_default)
 
-  if required_environment_variables.any?
-    required_environment_variables.each do |env_var|
-      > if [[ -z "${<%= env_var.name.upcase %>:-}" ]]; then
-      >   printf "{{ strings[:missing_required_environment_variable] % { var: env_var.name.upcase } }}\n" >&2
-      >   exit 1
-      > fi
-    end
+  environment_variables.each do |env_var|
+    > env_var_names+=("{{ env_var.name.upcase }}")
   end
-end
+end
+
+if required_environment_variables.any?
+  required_environment_variables.each do |env_var|
+    > if [[ -z "${<%= env_var.name.upcase %>:-}" ]]; then
+    >   printf "{{ strings[:missing_required_environment_variable] % { var: env_var.name.upcase } }}\n" >&2
+    >   exit 1
+    > fi
+  end
+end
+
+if whitelisted_environment_variables.any?
+  whitelisted_environment_variables.each do |env_var|
+    > if [[ -n "${<%= env_var.name.upcase %>:-}" ]] && [[ ! ${<%= env_var.name.upcase %>:-} =~ ^({{ env_var.allowed.join '|' }})$ ]]; then
+    >   printf "%s\n" "{{ strings[:disallowed_environment_variable] % { name: env_var.name.upcase, allowed: env_var.allowed.join(', ') } }}" >&2
+    >   exit 1
+    > fi
+  end
+end

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

@@ -4,7 +4,9 @@
 >   if ((${#args[@]})); then
 >     readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
 >     echo args:
->     for k in "${sorted_keys[@]}"; do echo "- \${args[$k]} = ${args[$k]}"; done
+>     for k in "${sorted_keys[@]}"; do
+>       echo "- \${args[$k]} = ${args[$k]}"
+>     done
 >   else
 >     echo args: none
 >   fi
@@ -22,8 +24,18 @@
 >     readarray -t sorted_keys < <(printf '%s\n' "${!deps[@]}" | sort)
 >     echo
 >     echo deps:
->     for k in "${sorted_keys[@]}"; do echo "- \${deps[$k]} = ${deps[$k]}"; done
+>     for k in "${sorted_keys[@]}"; do
+>       echo "- \${deps[$k]} = ${deps[$k]}"
+>     done
 >   fi
 >
+>   if ((${#env_var_names[@]})); then
+>     readarray -t sorted_names < <(printf '%s\n' "${env_var_names[@]}" | sort)
+>     echo
+>     echo "environment variables:"
+>     for k in "${sorted_names[@]}"; do
+>       echo "- \$$k = ${!k:-}"
+>     done
+>   fi
 > }
 > 

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

@@ -4,6 +4,7 @@
 >   declare -A args=()
 >   declare -A deps=()
 >   declare -a other_args=()
+>   declare -a env_var_names=()
 >   declare -a input=()
 >   normalize_input "$@"
 >   parse_requirements "${input[@]}"

data/lib/bashly/views/environment_variable/usage.gtx

@@ -3,6 +3,10 @@
 > printf "  %s\n" "{{ usage_string(extended: true).color(:environment_variable) }}"
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
+if allowed
+  > printf "    {{ strings[:allowed] % { values: allowed.join(', ') } }}\n"
+end
+
 if default
   > printf "    {{ strings[:default] % { value: default } }}\n"
 end

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

@@ -4,11 +4,15 @@
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
 if allowed
-> printf "    {{ strings[:allowed] % { values: allowed.join(', ') } }}\n"
+  > printf "    {{ strings[:allowed] % { values: allowed.join(', ') } }}\n"
 end
 
 if default
-> printf "    {{ strings[:default] % { value: default } }}\n"
+  if default.is_a? Array
+    > printf "    {{ strings[:default] % { value: default.join(', ') } }}\n"
+  else
+    > printf "    {{ strings[:default] % { value: default } }}\n"
+  end
 end
 
 > echo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-09 00:00:00.000000000 Z
+date: 2023-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole