Merge pull request #194 from DannyBen/update/config-validator

Add more friendly errors on invalid configuration

Author: DannyBen

lib/bashly/commands/base.rb

@@ -5,6 +5,12 @@ module Bashly
   module Commands
     class Base < MisterBin::Command
       include AssetHelper
+
+      def validate_config
+        config = Config.new "#{Settings.source_dir}/bashly.yml"
+        validator = ConfigValidator.new config
+        validator.validate
+      end
     end
   end
 end

lib/bashly/commands/generate.rb

@@ -20,6 +20,7 @@ class Generate < Base
       example "bashly generate --wrap my_function"
 
       def run
+        validate_config
         create_user_files
         upgrade_libs if args['--upgrade']
         create_master_script

lib/bashly/commands/validate.rb

@@ -9,9 +9,7 @@ class Validate < Base
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def run
-        config = Config.new "#{Settings.source_dir}/bashly.yml"
-        validator = ConfigValidator.new config
-        validator.validate
+        validate_config
         say "!txtgrn!OK"
       end
     end

lib/bashly/config_validator.rb

@@ -84,6 +84,8 @@ def assert_arg(key, value)
       assert_array "#{key}.allowed", value['allowed'], of: :string
 
       refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
+
+      refute value['required'] && value['default'], "#{key} cannot have both required and default"
     end
 
     def assert_flag(key, value)
@@ -104,6 +106,16 @@ def assert_flag(key, value)
       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']
+
+      refute value['required'] && value['default'], "#{key} cannot have both required and default"
+
+      if value['default']
+        assert value['arg'], "#{key}.default does not make sense without arg"
+      end
+
+      if value['allowed']
+        assert value['arg'], "#{key}.allowed does not make sense without arg"
+      end
     end
 
     def assert_env_var(key, value)
@@ -140,6 +152,16 @@ def assert_command(key, value)
       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
+
+      if key == "root"
+        refute value['short'], "#{key}.short makes no sense"
+        refute value['group'], "#{key}.group makes no sense"
+        refute value['default'], "#{key}.default makes no sense"
+        refute value['private'], "#{key}.private makes no sense"
+      else
+        refute value['version'], "#{key}.version makes no sense"
+        refute value['extensible'], "#{key}.extensible makes no sense"
+      end
     end
   end
 end

lib/bashly/script/base.rb

@@ -36,7 +36,6 @@ class Base
       def initialize(options)
         raise Error, "Invalid options provided" unless options.respond_to? :keys
         @options = options
-        validate_options if respond_to? :validate_options
       end
 
       def optional

lib/bashly/script/command.rb

@@ -128,12 +128,6 @@ def user_lib
         @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.sh"].sort
       end
 
-      # Raise an exception if there are some serious issues with the command
-      # definition. This is called by Base#initialize.
-      def validate_options
-        Bashly::ConfigValidator.new(options).validate
-      end
-
     end
   end
 end

spec/approvals/cli/error

@@ -1,3 +1,2 @@
 Errno::ENOENT
 No such file or directory @ rb_sysopen - src/bashly.yml
-creating user files in src

spec/approvals/validations/invalid_arg renamed to spec/approvals/validations/arg

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.catch_all.label must be a string>