Merge pull request #159 from DannyBen/add/full-validation

Validate the entire config prior to generating

Author: DannyBen

lib/bashly/cli.rb

@@ -10,6 +10,7 @@ def self.runner
 
       runner.route 'init',      to: Commands::Init
       runner.route 'preview',   to: Commands::Preview
+      runner.route 'validate',  to: Commands::Validate
       runner.route 'generate',  to: Commands::Generate
       runner.route 'add',       to: Commands::Add
 

lib/bashly/commands/validate.rb

@@ -0,0 +1,19 @@
+module Bashly
+  module Commands
+    class Validate < Base
+      help "Scan the configuration file for errors"
+
+      usage "bashly validate"
+      usage "bashly validate (-h|--help)"
+
+      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
+        say "!txtgrn!OK"
+      end
+    end
+  end
+end

lib/bashly/config_validator.rb

@@ -0,0 +1,135 @@
+module Bashly
+  class ConfigValidator
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def validate
+      assert_command "root", data
+    end
+
+  private
+
+    def assert(valid, message)
+      raise ConfigurationError, message unless valid
+    end
+
+    def refute(invalid, message)
+      assert !invalid, message
+    end
+
+    def assert_string(key, value)
+      assert value.is_a?(String), "#{key} must be a string"
+    end
+
+    def assert_optional_string(key, value)
+      assert_string key, value if value
+    end
+
+    def assert_boolean(key, value)
+      assert [true, false, nil].include?(value), "#{key} must be a boolean" 
+    end
+
+    def assert_array(key, value, of: nil)
+      return unless value
+      assert value.is_a?(Array), "#{key} must be an array"
+      if of
+        value.each_with_index do |val, i|
+          send "assert_#{of}".to_sym, "#{key}[#{i}]", val
+        end
+      end
+    end
+
+    def assert_hash(key, value)
+      assert value.is_a?(Hash), "#{key} must be a hash"
+    end
+
+    def assert_version(key, value)
+      return unless value
+      assert [String, Integer, Float].include?(value.class),
+        "#{key} must be a string or a number" 
+    end
+
+    def assert_catch_all(key, value)
+      return unless value
+      assert [TrueClass, String, Hash].include?(value.class),
+        "#{key} must be a boolean, a string or a hash" 
+
+      assert_catch_all_hash key, value if value.is_a? Hash
+    end
+
+    def assert_catch_all_hash(key, value)
+      assert_string "#{key}.label", value['label']
+      assert_optional_string "#{key}.help", value['help']
+      assert_boolean "#{key}.required", value['required']
+    end
+
+    def assert_extensible(key, value)
+      return unless value
+      assert [TrueClass, String].include?(value.class),
+        "#{key} must be a boolean or a string" 
+    end
+
+    def assert_arg(key, value)
+      assert_hash key, value
+      assert_string "#{key}.name", value['name']
+      assert_optional_string "#{key}.help", value['help']
+      assert_optional_string "#{key}.default", value['default']
+      assert_optional_string "#{key}.validate", value['validate']
+      assert_boolean "#{key}.required", value['required']
+      
+      assert_array "#{key}.allowed", value['allowed'], of: :string
+    end
+
+    def assert_flag(key, value)
+      assert_hash key, value
+      assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
+
+      assert_optional_string "#{key}.long", value['long']
+      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_optional_string "#{key}.validate", value['validate']
+      
+      assert_boolean "#{key}.required", value['required']
+      assert_array "#{key}.allowed", value['allowed'], of: :string
+    end
+
+    def assert_env_var(key, value)
+      assert_hash key, value
+      assert_string "#{key}.name", value['name']
+      assert_optional_string "#{key}.help", value['help']
+      assert_optional_string "#{key}.default", value['default']
+      assert_boolean "#{key}.required", value['required']
+    end
+
+    def assert_command(key, value)
+      assert_hash key, value
+
+      refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
+      refute value['commands'] && value['flags'], "#{key} cannot have both commands and flags"
+      
+      assert_string "#{key}.name", value['name']
+      assert_optional_string "#{key}.short", value['short']
+      assert_optional_string "#{key}.help", value['help']
+      assert_optional_string "#{key}.footer", value['footer']
+      assert_optional_string "#{key}.group", value['group']
+
+      assert_boolean "#{key}.default", value['default']
+      assert_version "#{key}.version", value['version']
+      assert_catch_all "#{key}.catch_all", value['catch_all']
+      assert_extensible "#{key}.extensible", value['extensible']
+      
+      assert_array "#{key}.args", value['args'], of: :arg
+      assert_array "#{key}.flags", value['flags'] , of: :flag
+      assert_array "#{key}.commands", value['commands'], of: :command
+      assert_array "#{key}.completions", value['completions'], of: :string
+      assert_array "#{key}.dependencies", value['dependencies'], of: :string
+      assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
+      assert_array "#{key}.examples", value['examples'], of: :string
+    end
+  end
+end

lib/bashly/script/argument.rb

@@ -4,10 +4,6 @@ class Argument < Base
       def usage_string
         required ? name.upcase : "[#{name.upcase}]"
       end
-
-      def verify
-        raise ConfigurationError, "Argument must have a name" unless name
-      end
     end
   end
 end

lib/bashly/script/base.rb

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

lib/bashly/script/command.rb

@@ -32,18 +32,15 @@ def caption_string
 
       # Returns a label for the catch_all directive
       def catch_all_label
-        return nil unless catch_all
-
-        if catch_all.is_a? String
-          "#{catch_all.upcase}..."
-        elsif catch_all.is_a?(Hash) and catch_all['label'].is_a?(String)
-          "#{catch_all['label'].upcase}..."
-        else
-          "..."
+        case catch_all
+        when nil then nil
+        when String then "#{catch_all.upcase}..."
+        when Hash then "#{catch_all['label'].upcase}..."
+        else "..."
         end
       end
 
-      # Returns a used defined help string for the catch_all directive
+      # Returns a user defined help string for the catch_all directive
       def catch_all_help
         return nil unless catch_all
 
@@ -213,10 +210,9 @@ def user_lib
       end
 
       # Raise an exception if there are some serious issues with the command
-      # definition.
-      def verify
-        verify_commands if commands.any?
-        raise ConfigurationError, "Command must have a name" unless name
+      # definition. This is called by Base#initialize.
+      def validate_options
+        Bashly::ConfigValidator.new(options).validate
       end
 
       # Returns an array of all the args with a whitelist
@@ -229,14 +225,6 @@ def whitelisted_flags
         flags.select &:allowed
       end
 
-    private
-
-      def verify_commands
-        if args.any? or flags.any?
-          raise ConfigurationError, "Error in the !txtgrn!#{full_name}!txtrst! command.\nThe !txtgrn!commands!txtrst! key cannot be at the same level as the !txtgrn!args!txtrst! or !txtgrn!flags!txtrst! keys."
-        end
-      end
-
     end
   end
 end

lib/bashly/script/environment_variable.rb

@@ -6,10 +6,6 @@ def usage_string(extended: false)
         result << strings[:required] if required and extended
         result.join " "
       end
-
-      def verify
-        raise ConfigurationError, "EnvironmentVariable must have a name" unless name
-      end
     end
   end
 end

lib/bashly/script/flag.rb

@@ -21,11 +21,6 @@ def usage_string(extended: false)
         result << strings[:required] if required and extended
         result.join " "
       end
-
-      def verify
-        raise ConfigurationError, "Flag must have a long and/or short property" unless short or long
-      end
-
     end
   end
 end

spec/approvals/cli/commands

@@ -3,5 +3,6 @@ Bashly - Bash CLI Generator
 Commands:
   init      Initialize a new workspace
   preview   Generate the bash script to STDOUT
+  validate  Scan the configuration file for errors
   generate  Generate the bash script and required files
   add       Add extra features and customization to your script

spec/approvals/cli/validate/help

@@ -0,0 +1,13 @@
+Scan the configuration file for errors
+
+Usage:
+  bashly validate
+  bashly validate (-h|--help)
+
+Options:
+  -h --help
+    Show this help
+
+Environment Variables:
+  BASHLY_SOURCE_DIR
+    The path containing the bashly configuration and source files [default: src]