Merge pull request #205 from DannyBen/add/validation-for-unknown-keys

Abort generation if the config file contains unknown keys

Author: DannyBen

lib/bashly/config_validator.rb

@@ -42,8 +42,13 @@ def assert_array(key, value, of: nil)
       end
     end
 
-    def assert_hash(key, value)
+    def assert_hash(key, value, whitelist = nil)
       assert value.is_a?(Hash), "#{key} must be a hash"
+      
+      if whitelist
+        invalid_keys = value.keys.map(&:to_sym) - whitelist
+        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join(', ')}"
+      end
     end
 
     def assert_version(key, value)
@@ -61,6 +66,7 @@ def assert_catch_all(key, value)
     end
 
     def assert_catch_all_hash(key, value)
+      assert_hash key, value, Script::CatchAll.option_keys
       assert_string "#{key}.label", value['label']
       assert_optional_string "#{key}.help", value['help']
       assert_boolean "#{key}.required", value['required']
@@ -73,7 +79,7 @@ def assert_extensible(key, value)
     end
 
     def assert_arg(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::Argument.option_keys
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.default", value['default']
@@ -89,7 +95,7 @@ def assert_arg(key, value)
     end
 
     def assert_flag(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::Flag.option_keys
       assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
 
       assert_optional_string "#{key}.long", value['long']
@@ -120,15 +126,15 @@ def assert_flag(key, value)
     end
 
     def assert_env_var(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::EnvironmentVariable.option_keys
       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
+      assert_hash key, value, Script::Command.option_keys
 
       refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
       refute value['commands'] && value['flags'], "#{key} cannot have both commands and flags"
@@ -140,6 +146,7 @@ def assert_command(key, value)
       assert_optional_string "#{key}.group", value['group']
       assert_optional_string "#{key}.filename", value['filename']
 
+      assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.default", value['default']
       assert_version "#{key}.version", value['version']
       assert_catch_all "#{key}.catch_all", value['catch_all']

lib/bashly/extensions/yaml.rb

@@ -3,6 +3,8 @@ module YAML
   def self.properly_load_file(path)
     YAML.load_file path, aliases: true
   rescue ArgumentError
+    # :nocov:
     YAML.load_file path
+    # :nocov:
   end
 end

lib/bashly/script/argument.rb

@@ -1,6 +1,14 @@
 module Bashly
   module Script
     class Argument < Base
+      class << self
+        def option_keys
+          @option_keys ||= %i[
+            allowed default help name repeatable required validate
+          ]
+        end
+      end
+
       def usage_string
         required ? label : "[#{label}]"
       end

lib/bashly/script/base.rb

@@ -5,41 +5,19 @@ class Base
 
       attr_reader :options
 
-      OPTION_KEYS = %i[
-        allowed
-        arg
-        catch_all
-        completions
-        conflicts
-        default
-        dependencies
-        description
-        environment_variables
-        examples
-        extensible
-        filters
-        flags
-        footer
-        group
-        help
-        long
-        name
-        parent_name
-        private
-        repeatable
-        required
-        short
-        validate
-        version
-      ]
+      class << self
+        def option_keys
+          @option_keys ||= []
+        end
+      end
 
       def initialize(options)
         raise Error, "Invalid options provided" unless options.respond_to? :keys
         @options = options
       end
 
       def optional
-        !required
+        !options['required']
       end
 
       def summary
@@ -56,7 +34,7 @@ def method_missing(method_name, *arguments, &block)
       end
 
       def respond_to_missing?(method_name, include_private = false)
-        OPTION_KEYS.include?(method_name) || super
+        self.class.option_keys.include?(method_name) || super
       end
     end
   end

lib/bashly/script/catch_all.rb

@@ -2,6 +2,10 @@ module Bashly
   module Script
     class CatchAll
       class << self
+        def option_keys
+          @option_keys ||= %i[label help required]
+        end
+
         def from_config(config)
           options = case config
           when nil

lib/bashly/script/command.rb

@@ -4,6 +4,18 @@ class Command < Base
       include Completions
       include CommandScopes
 
+      class << self
+        def option_keys
+          @option_keys ||= %i[
+            args catch_all commands completions
+            default dependencies environment_variables examples
+            extensible filename filters flags
+            footer group help name
+            private short version
+          ]
+        end
+      end
+
       # Returns the name to be used as an action.
       # - If it is the root command, the action is "root"
       # - Else, it is all the parents, except the first one (root) joined

lib/bashly/script/environment_variable.rb

@@ -1,6 +1,12 @@
 module Bashly
   module Script
     class EnvironmentVariable < Base
+      class << self
+        def option_keys
+          @option_keys ||= %i[default help name required]
+        end
+      end
+      
       def usage_string(extended: false)
         result = [name.upcase]
         result << strings[:required] if required and extended

lib/bashly/script/flag.rb

@@ -1,6 +1,15 @@
 module Bashly
   module Script
     class Flag < Base
+      class << self
+        def option_keys
+          @option_keys ||= %i[
+            allowed arg conflicts default help long repeatable required
+            short validate
+          ]
+        end
+      end
+      
       def aliases
         if long and short
           [long, short]

spec/approvals/validations/invalid_arg_keys

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.args[0] contains invalid options: private, disallowed>

spec/approvals/validations/invalid_catch_all_keys

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.catch_all contains invalid options: private>