Merge pull request #222 from DannyBen/add/uniq-validations

Validate uniqueness of command args, flags and subcommands

Author: DannyBen

lib/bashly/concerns/validation_helpers.rb

@@ -0,0 +1,69 @@
+module Bashly
+  # This is a `ConfigValidator` concern responsible for providing basic
+  # assertion methods.
+  module ValidationHelpers
+
+    def deprecations
+      @deprecations ||= []
+    end
+
+  protected
+
+    def assert(valid, message)
+      raise ConfigurationError, message unless valid
+    end
+
+    def refute(invalid, message)
+      assert !invalid, message
+    end
+
+    def deprecate(key, **options)
+      deprecations.push Deprecation.new(key, **options)
+    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, 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_uniq(key, value, array_key)
+      return unless value
+      list = value.map { |c| c[array_key] }.compact.flatten
+      assert list.uniq?, "#{key} cannot have elements with similar #{array_key} values"
+    end
+
+    def assert_string_or_array(key, value)
+      return unless value
+      assert [Array, String].include?(value.class),
+        "#{key} must be a string or an array"
+
+      assert_array key, value, of: :string if value.is_a? Array
+    end
+  end
+end

lib/bashly/config_validator.rb

@@ -1,5 +1,7 @@
 module Bashly
   class ConfigValidator
+    include ValidationHelpers
+
     attr_reader :data
 
     def initialize(data)
@@ -10,63 +12,8 @@ def validate
       assert_command "root", data
     end
 
-    def deprecations
-      @deprecations ||= []
-    end
-
   private
 
-    def assert(valid, message)
-      raise ConfigurationError, message unless valid
-    end
-
-    def refute(invalid, message)
-      assert !invalid, message
-    end
-
-    def deprecate(key, **options)
-      deprecations.push Deprecation.new(key, **options)
-    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, 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_string_or_array(key, value)
-      return unless value
-      assert [Array, String].include?(value.class),
-        "#{key} must be a string or an array"
-
-      assert_array key, value, of: :string if value.is_a? Array
-    end
-
     def assert_version(key, value)
       return unless value
       assert [String, Integer, Float].include?(value.class),
@@ -177,6 +124,12 @@ def assert_command(key, value)
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
 
+      assert_uniq "#{key}.commands", value['commands'], 'name'
+      assert_uniq "#{key}.commands", value['commands'], 'alias'
+      assert_uniq "#{key}.flags", value['flags'], 'long'
+      assert_uniq "#{key}.flags", value['flags'], 'short'
+      assert_uniq "#{key}.args", value['args'], 'name'
+
       if value['catch_all'] and value['args']
         repeatable_arg = value['args'].select { |a| a['repeatable'] }.first&.dig 'name'
         refute repeatable_arg, "#{key}.catch_all makes no sense with repeatable arg (#{repeatable_arg})"

lib/bashly/extensions/array.rb

@@ -4,4 +4,9 @@ def indent(offset)
     indentation = " " * offset
     map { |line| "#{indentation}#{line}" }
   end
+
+  def uniq?
+    self == uniq
+  end
+
 end

spec/approvals/validations/non_uniq_arg_names

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.args cannot have elements with similar name values>

spec/approvals/validations/non_uniq_command_aliases

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.commands cannot have elements with similar alias values>

spec/approvals/validations/non_uniq_command_names

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.commands cannot have elements with similar name values>

spec/approvals/validations/non_uniq_flags_longs

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.flags cannot have elements with similar long values>

spec/approvals/validations/non_uniq_flags_shorts

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.flags cannot have elements with similar short values>

spec/fixtures/script/validations.yml

@@ -209,3 +209,42 @@
     help: Path to one or more files
     repeatable: true
     required: true
+
+:non_uniq_command_names:
+  name: invalid
+  help: commands with the same name
+  commands:
+  - name: upload
+  - name: download
+  - name: download
+
+:non_uniq_command_aliases:
+  name: invalid
+  help: commands with the same alias
+  commands:
+  - name: connect
+    alias: c
+  - name: config
+    alias: [c, conf]
+
+:non_uniq_flags_longs:
+  name: invalid
+  help: flags with the same long name
+  flags:
+  - long: --force
+  - long: --force
+
+:non_uniq_flags_shorts:
+  name: invalid
+  help: flags with the same short name
+  flags:
+  - short: -f
+  - short: -f
+  
+:non_uniq_arg_names:
+  name: invalid
+  help: args with the same name
+  args:
+  - name: file
+  - name: file
+