bashly 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0b8832beb94705ec8b978035bdb131203cffd49fe5e17f772804dd89c148d9
-  data.tar.gz: afbaf3411cbb6430aabe64e91bde45ab5df428b3bff31d45f59ba8adf9e8d0b9
+  metadata.gz: 0d80ba9b8ae35371153a3610de0d3d76e64a7a18e3fcc3500c112634b38ec13e
+  data.tar.gz: 908bd0775b5568471da0fe0b113fcddfefa1d1063ecafdd12019eacae8392e3d
 SHA512:
-  metadata.gz: 9e249dae5a1be6e3110344411a175ba4169c2e7a47f817783316b181b64471a561f701bc896327782378e95647f8f5b76d57afc64709d1589f0557b7d221e4e2
-  data.tar.gz: 69f9baac8426a5f4bce2c44f5b127e8651d2ad1f6112fb9c0a9202730e9ebd01fce34c9fcf67aa765899342a4cdd77b858b78ebf2f5efa066b8cf99bc83e7309
+  metadata.gz: f11a315e7d68230adedb9b73916619b30893871711cb5716f119b53621813eae23ac9c72a76248d13349924343cc3e77834f0b12c3699130309ecd0c0b9b699d
+  data.tar.gz: 3a19eada91503c3535b47643e18bb43b4c04d5548f5f18aac0195b8b14f3e18fb548f60a81cccf59d76ed714f8684dcdc9eec3a413b73b1e63d71d8c2d4cf875

data/lib/bashly/config_validator.rb

@@ -92,7 +92,7 @@ module Bashly
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
       assert_string_or_array "#{key}.default", value['default']
-      assert_optional_string "#{key}.validate", value['validate']
+      assert_string_or_array "#{key}.validate", value['validate']
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.repeatable", value['repeatable']
       assert_boolean "#{key}.unique", value['unique']
@@ -123,7 +123,7 @@ module Bashly
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.arg", value['arg']
       assert_string_or_array "#{key}.default", value['default']
-      assert_optional_string "#{key}.validate", value['validate']
+      assert_string_or_array "#{key}.validate", value['validate']
 
       assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.repeatable", value['repeatable']
@@ -169,6 +169,7 @@ module Bashly
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.private", value['private']
       assert_array "#{key}.allowed", value['allowed'], of: :string
+      assert_string_or_array "#{key}.validate", value['validate']
 
       refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
     end

data/lib/bashly/libraries/settings/settings.yml

@@ -1,14 +1,41 @@
-# All settings are optional (with their default values provided below), and
-# can also be set with an environment variable with the same name, capitalized
-# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
+#-------------------------------------------------------------------------------
+# BASHLY SETTINGS
+#-------------------------------------------------------------------------------
 #
-# When setting environment variables, you can use:
-# - "0", "false" or "no" to represent false
-# - "1", "true" or "yes" to represent true
+### Default Values
+#
+#   All settings are optional, with their default values provided below
+#
+### Environment Variables
+#
+#   Values can also be set using an environment variable with the same name,
+#   capitalized and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
+#
+#   When setting environment variables, you can use:
+#   - "0", "false" or "no" to represent false
+#   - "1", "true" or "yes" to represent true
+#
+#   Environment variables take precedence over values in the config file.
+#
+### File Location:
+#
+#   Bashly looks for the settings file in these locations.
+#   - The path defined in the `BASHLY_SETTINGS_PATH` environment variable.
+#   - A file named `bashly-settings.yml` in the working directory.
+#   - A file named `settings.yml` in the working directory.
+#
+### Environment Overrides:
+#
+#   All options (except `env`) may be specified with an environment suffix in 
+#   order to override its value for a given environment.
+#
+#   For example, when defining `formatter_production: shfmt --minify`, then 
+#   this will be the formatter used when generating the script with
+#   `bashly generate --env production`
+#
+#   Since these values take precedence over the standard values, you can define
+#   both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
 #
-# If you wish to change the path to this file, set the environment variable
-# BASHLY_SETTINGS_PATH.
-
 
 #-------------------------------------------------------------------------------
 # PATH OPTIONS
@@ -52,12 +79,12 @@ strict: false
 tab_indent: false
 
 # Choose a post-processor for the generated script:
-# formatter: internal     # Use Bashly's internal formatter (compacts newlines)
+# formatter: internal     # Use Bashly’s built-in formatter (removes extra newlines)
 # formatter: external     # Run the external command `shfmt --case-indent --indent 2`
 # formatter: none         # Disable formatting entirely
-# formatter: <string>     # Use a custom shell command to format the script.
-#                         # The command will receive the script via stdin and
-#                         # must output the result to stdout.
+# formatter: <string>     # Provide a custom shell command to format the script.
+#                         # The command receives the script via stdin and must
+#                         # write the result to stdout.
 #                         # Example: shfmt --minify
 formatter: internal
 
@@ -102,10 +129,10 @@ usage_colors:
 #-------------------------------------------------------------------------------
 
 # Set to 'production' or 'development'.
-# Determines which features are enabled in the rendered script.
+# Determines which features are enabled in the generated script.
 # Use the `enable_*` options below to adjust settings for each environment.
 # It is recommended to leave this set to 'development' and run
-# `bashly generate --production` when the slimmer production script is needed.
+# `bashly generate --env production` when the production version is needed.
 env: development
 
 # Tweak the script output by enabling or disabling some script output.

data/lib/bashly/script/argument.rb

@@ -3,6 +3,8 @@ require 'shellwords'
 module Bashly
   module Script
     class Argument < Base
+      include Introspection::Validate
+
       class << self
         def option_keys
           @option_keys ||= %i[
@@ -21,13 +23,13 @@ module Bashly
         end
       end
 
-      def usage_string
-        required ? label : "[#{label}]"
-      end
-
       def label
         repeatable ? "#{name.upcase}..." : name.upcase
       end
+
+      def usage_string
+        required ? label : "[#{label}]"
+      end
     end
   end
 end

data/lib/bashly/script/command.rb

@@ -158,7 +158,7 @@ module Bashly
 
       # Returns a mixed array of Argument and Flag objects that have validations
       def validatables
-        @validatables ||= args.select(&:validate) + flags.select(&:validate)
+        @validatables ||= args.select(&:validate?) + flags.select(&:validate?)
       end
 
     private

data/lib/bashly/script/environment_variable.rb

@@ -2,11 +2,12 @@ module Bashly
   module Script
     class EnvironmentVariable < Base
       include Introspection::Visibility
+      include Introspection::Validate
 
       class << self
         def option_keys
           @option_keys ||= %i[
-            allowed default help name required private validate
+            allowed default help name private required validate
           ]
         end
       end

data/lib/bashly/script/flag.rb

@@ -5,12 +5,13 @@ module Bashly
     class Flag < Base
       include Completions::Flag
       include Introspection::Visibility
+      include Introspection::Validate
 
       class << self
         def option_keys
           @option_keys ||= %i[
             allowed arg completions conflicts default help long needs
-            repeatable required short unique validate private
+            private repeatable required short unique validate
           ]
         end
       end

data/lib/bashly/script/introspection/environment_variables.rb

@@ -28,7 +28,7 @@ module Bashly
 
         # Returns an array of all the environment_variables with a validation
         def validated_environment_variables
-          environment_variables.select(&:validate)
+          environment_variables.select(&:validate?)
         end
 
         # Returns only public environment variables, or both public and private

data/lib/bashly/script/introspection/validate.rb

@@ -0,0 +1,18 @@
+module Bashly
+  module Script
+    module Introspection
+      module Validate
+        # Returns an array of validations
+        def validate
+          return [] unless options['validate']
+
+          result = options['validate']
+          result.is_a?(Array) ? result : [result]
+        end
+
+        # Returns true if there are any validations defined
+        def validate? = validate.any?
+      end
+    end
+  end
+end

data/lib/bashly/settings.rb

@@ -160,20 +160,31 @@ module Bashly
     private
 
       def get(key)
-        case env_value key
-        when nil                 then config[key.to_s]
-        when '0', 'false', 'no'  then false
-        when '1', 'true', 'yes'  then true
-        else                     env_value key
-        end
+        ENV.has_key?(env_var_name(key)) ? value_from_env(key) : value_from_config(key)
+      end
+
+      def env_var_name(key)
+        "BASHLY_#{key.upcase}"
       end
 
-      def env_value(key)
-        ENV["BASHLY_#{key.upcase}"]
+      def value_from_config(key)
+        return config[key.to_s] if key == :env
+
+        result = config["#{key}_#{env}"]
+        result.nil? ? config[key.to_s] : result
+      end
+
+      def value_from_env(key)
+        result = ENV[env_var_name(key)]
+        case result&.strip&.downcase
+        when '0', 'false', 'no' then false
+        when '1', 'true', 'yes' then true
+        else result
+        end
       end
 
       def config
-        @config ||= defsult_settings.merge user_settings
+        @config ||= default_settings.merge user_settings
       end
 
       def user_settings
@@ -190,8 +201,8 @@ module Bashly
         end
       end
 
-      def defsult_settings
-        @defsult_settings ||= Config.new default_settings_path
+      def default_settings
+        @default_settings ||= Config.new default_settings_path
       end
 
       def default_settings_path

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.3.2'
+  VERSION = '1.3.3'
 end

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

@@ -1,4 +1,4 @@
-if validate
+if validate?
   = view_marker
 
   if repeatable
@@ -6,18 +6,24 @@ if validate
     >   values=''
     >   eval "values=(${args['{{ name }}']})"
     >   for value in "${values[@]}"; do
-    >     validation_output="$(validate_{{ validate }} "$value")"
+    validate.each do |funcname|
+    >     validation_output="$(validate_{{ funcname }} "$value")"
     >     if [[ -n "$validation_output" ]]; then
     >       printf "{{ strings[:validation_error] }}\n" "{{ name.upcase }}" "$validation_output" >&2
     >       exit 1
     >     fi
+    end
     >   done
     > fi
   else
-    > validation_output="$(validate_{{ validate }} "${args['{{ name }}']:-}")"
-    > if [[ -v args['{{ name }}'] && -n "$validation_output" ]]; then
-    >   printf "{{ strings[:validation_error] }}\n" "{{ name.upcase }}" "$validation_output" >&2
-    >   exit 1
+    > if [[ -v args['{{ name }}'] ]]; then
+    validate.each do |funcname|
+    >   validation_output="$(validate_{{ funcname }} "${args['{{ name }}']:-}")"
+    >   if [[ -n "$validation_output" ]]; then
+    >     printf "{{ strings[:validation_error] }}\n" "{{ name.upcase }}" "$validation_output" >&2
+    >     exit 1
+    >   fi
+    end
     > fi
     >
   end

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

@@ -1,9 +1,14 @@
-if validate
+if validate?
   = view_marker
 
-  > if [[ -v {{ name.upcase }} && -n $(validate_{{ validate }} "${{ name.upcase }}") ]]; then
-  >   printf "{{ strings[:environment_variable_validation_error] }}\n" "{{ usage_string }}" "$(validate_{{ validate }} "${{ name.upcase }}")" >&2
-  >   exit 1
+  > if [[ -v {{ name.upcase }} ]]; then
+  validate.each do |funcname|
+  >   validation_output="$(validate_{{ funcname }} "${{ name.upcase }}")"
+  >   if [[ -n "${validation_output}" ]]; then
+  >     printf "{{ strings[:environment_variable_validation_error] }}\n" "{{ usage_string }}" "$validation_output" >&2
+  >     exit 1
+  >   fi
+  end
   > fi
   >
 end

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

@@ -1,4 +1,4 @@
-if validate
+if validate?
   = view_marker
 
   if repeatable
@@ -6,20 +6,24 @@ if validate
     >   values=''
     >   eval "values=(${args['{{ long }}']})"
     >   for value in "${values[@]}"; do
-    >     validation_output="$(validate_{{ validate }} "$value")"
+    validate.each do |funcname|
+    >     validation_output="$(validate_{{ funcname }} "$value")"
     >     if [[ -n "$validation_output" ]]; then
     >       printf "{{ strings[:validation_error] }}\n" "{{ usage_string }}" "$validation_output" >&2
     >       exit 1
     >     fi
     >   done
+    end
     > fi
   else
     > if [[ -v args['{{ long }}'] ]]; then
-    >   validation_output="$(validate_{{ validate }} "${args['{{ long }}']:-}")"
+    validate.each do |funcname|
+    >   validation_output="$(validate_{{ funcname }} "${args['{{ long }}']:-}")"
     >   if [[ -n "${validation_output}" ]]; then
     >     printf "{{ strings[:validation_error] }}\n" "{{ usage_string }}" "$validation_output" >&2
     >     exit 1
     >   fi
+    end
     > fi
     >
   end

data/lib/bashly.rb

@@ -28,7 +28,7 @@ module Bashly
     module Introspection
       autoloads 'bashly/script/introspection', %i[
         Arguments Commands Dependencies EnvironmentVariables Examples Flags
-        Variables Visibility
+        Validate Variables Visibility
       ]
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -260,6 +260,7 @@ files:
 - lib/bashly/script/introspection/environment_variables.rb
 - lib/bashly/script/introspection/examples.rb
 - lib/bashly/script/introspection/flags.rb
+- lib/bashly/script/introspection/validate.rb
 - lib/bashly/script/introspection/variables.rb
 - lib/bashly/script/introspection/visibility.rb
 - lib/bashly/script/variable.rb