Merge pull request #533 from DannyBen/add/arg-order-validation

Add validation to disallow required args before optional

Author: DannyBen

lib/bashly/config_validator.rb

@@ -231,6 +231,10 @@ def assert_command(key, value)
           assert value['args'].last['repeatable'],
             "#{key}.args cannot contain a repeatable arg unless it is the last one"
         end
+
+        required_order = value['args'].map { |x| x['required'] ? true : false }
+        refute required_order.include_sequence?(false, true),
+          "#{key}.args cannot contain required arg after optional arg"
       end
 
       if value['expose']

lib/bashly/extensions/array.rb

@@ -13,4 +13,10 @@ def indent(offset)
   def nonuniq
     tally.select { |_key, count| count > 1 }.keys
   end
+
+  def include_sequence?(*elements)
+    return false if elements.empty?
+
+    each_cons(elements.size).any?(elements)
+  end
 end

spec/approvals/validations/command_args_required_after_optional

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.args cannot contain required arg after optional arg>

spec/bashly/extensions/array_spec.rb

@@ -54,4 +54,14 @@
       expect(subject.nonuniq).to eq %w[it works]
     end
   end
+
+  describe '#include_sequence?' do
+    it 'returns true when the array includes the sequence' do
+      expect([1, 2, 3, 4].include_sequence?(2, 3)).to be true
+    end
+
+    it 'returns true when the array does not include the sequence' do
+      expect([1, 2, 3, 4].include_sequence?(3, 2)).to be false
+    end
+  end
 end

spec/fixtures/script/validations.yml

@@ -69,6 +69,13 @@
     repeatable: true
     required: true
 
+:command_args_required_after_optional:
+  name: invalid
+  args:
+  - name: user
+  - name: password
+    required: true
+
 :command_catch_all_commands:
   name: invalid
   catch_all: