remove ParamsScope#optional_group, and instead allow #requires and #optional to take blocks

asross · asross · commit e70c3cea19d4 · 2013-07-22T16:10:00.000-04:00
diff --git a/lib/grape/validations.rb b/lib/grape/validations.rb
@@ -105,7 +105,9 @@ def optional?
         @optional
       end
 
-      def requires(*attrs)
+      def requires(*attrs, &block)
+        return new_scope(attrs, &block) if block_given?
+
         validations = {:presence => true}
         if attrs.last.is_a?(Hash)
           validations.merge!(attrs.pop)
@@ -115,7 +117,9 @@ def requires(*attrs)
         validates(attrs, validations)
       end
 
-      def optional(*attrs)
+      def optional(*attrs, &block)
+        return new_scope(attrs, true, &block) if block_given?
+
         validations = {}
         if attrs.last.is_a?(Hash)
           validations.merge!(attrs.pop)
@@ -126,11 +130,7 @@ def optional(*attrs)
       end
 
       def group(element, &block)
-        ParamsScope.new(api: @api, element: element, parent: self, &block)
-      end
-
-      def optional_group(element, &block)
-        ParamsScope.new(api: @api, element: element, parent: self, optional: true, &block)
+        requires(element, &block)
       end
 
       def params(params)
@@ -152,6 +152,11 @@ def push_declared_params(attrs)
 
     private
 
+      def new_scope(attrs, optional=false, &block)
+        raise ArgumentError unless attrs.size == 1
+        ParamsScope.new(api: @api, element: attrs.first, parent: self, optional: optional, &block)
+      end
+
       # Pushes declared params to parent or settings
       def configure_declared_params
         if @parent
diff --git a/spec/grape/validations_spec.rb b/spec/grape/validations_spec.rb
@@ -58,6 +58,48 @@ def app; subject end
       end
     end
 
+    context 'required with a block' do
+      before do
+        subject.params {
+          requires :items do
+            requires :key
+          end
+        }
+        subject.get '/required' do 'required works'; end
+      end
+
+      it 'errors when param not present' do
+        get '/required'
+        last_response.status.should == 400
+        last_response.body.should == 'missing parameter: items[key]'
+      end
+
+      it "doesn't throw a missing param when param is present" do
+        get '/required', { :items => [:key => 'hello', :key => 'world'] }
+        last_response.status.should == 200
+        last_response.body.should == 'required works'
+      end
+
+      it "doesn't allow more than one parameter" do
+        expect {
+          subject.params {
+            requires(:items, desc: 'Foo') do
+              requires :key
+            end
+          }
+        }.to raise_error ArgumentError
+      end
+
+      it 'adds to declared parameters' do
+        subject.params {
+          requires :items do
+            requires :key
+          end
+        }
+        subject.settings[:declared_params].should == [:items => [:key]]
+      end
+    end
+
     context 'group' do
       before do
         subject.params {
@@ -90,10 +132,10 @@ def app; subject end
       end
     end
 
-    context 'optional group' do
+    context 'optional with a block' do
       before do
         subject.params {
-          optional_group :items do
+          optional :items do
             requires :key
           end
         }
@@ -120,21 +162,21 @@ def app; subject end
 
       it 'adds to declared parameters' do
         subject.params {
-          optional_group :items do
+          optional :items do
             requires :key
           end
         }
         subject.settings[:declared_params].should == [:items => [:key]]
       end
     end
 
-    context 'nested optional groups' do
+    context 'nested optional blocks' do
       before do
         subject.params {
-          optional_group :items do
+          optional :items do
             requires :key
-            optional_group(:optional_subitems) { requires :value }
-            group(:required_subitems) { requires :value }
+            optional(:optional_subitems) { requires :value }
+            requires(:required_subitems) { requires :value }
           end
         }
         subject.get('/nested_optional_group') { 'nested optional group works' }
@@ -168,10 +210,10 @@ def app; subject end
 
       it 'adds to declared parameters' do
         subject.params {
-          optional_group :items do
+          optional :items do
             requires :key
-            optional_group(:optional_subitems) { requires :value }
-            group(:required_subitems) { requires :value }
+            optional(:optional_subitems) { requires :value }
+            requires(:required_subitems) { requires :value }
           end
         }
         subject.settings[:declared_params].should == [:items => [:key, {:optional_subitems => [:value]}, {:required_subitems => [:value]}]]
