Merge pull request #663 from bashly-framework/add/validations-as-array

Add array syntax support to `validate`

Author: DannyBen

examples/validations/src/bashly.yml

@@ -15,9 +15,12 @@ commands:
     # Bashly will look for a function named `validate_integer` in your
     # script, you can use any name as long as it has a matching function.
     validate: integer
+  
   - name: second
     help: Second number
-    validate: integer
+
+    # Multiple validations can be provided as an array.
+    validate: [not_empty, integer]
 
   flags:
   - long: --save

examples/validations/test.sh

@@ -12,6 +12,7 @@ bashly generate
 
 ./validate calc 1 2 --save README.md
 ./validate calc A
+./validate calc 1 ''
 ./validate calc 1 B
 ./validate calc 1 2 --save no-such-file.txt
 

lib/bashly.rb

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

lib/bashly/config_validator.rb

@@ -92,7 +92,7 @@ def assert_arg(key, value)
       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 @@ def assert_flag(key, value)
       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,7 +169,7 @@ def assert_env_var(key, value)
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.private", value['private']
       assert_array "#{key}.allowed", value['allowed'], of: :string
-      assert_optional_string "#{key}.validate", value['validate']
+      assert_string_or_array "#{key}.validate", value['validate']
 
       refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
     end

lib/bashly/script/argument.rb

@@ -3,6 +3,8 @@
 module Bashly
   module Script
     class Argument < Base
+      include Introspection::Validate
+
       class << self
         def option_keys
           @option_keys ||= %i[

lib/bashly/script/command.rb

@@ -158,7 +158,7 @@ def user_lib
 
       # 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

lib/bashly/script/environment_variable.rb

@@ -2,6 +2,7 @@ module Bashly
   module Script
     class EnvironmentVariable < Base
       include Introspection::Visibility
+      include Introspection::Validate
 
       class << self
         def option_keys

lib/bashly/script/flag.rb

@@ -5,6 +5,7 @@ module Script
     class Flag < Base
       include Completions::Flag
       include Introspection::Visibility
+      include Introspection::Validate
 
       class << self
         def option_keys

lib/bashly/script/introspection/environment_variables.rb

@@ -28,7 +28,7 @@ def required_environment_variables
 
         # 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

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