Merge pull request #527 from myitcv/before_validation_callback

Make before_validation its own distinct callback

Author: dblock

CHANGELOG.md

@@ -9,6 +9,7 @@ Next Release
 * [#525](https://github.com/intridea/grape/pull/525): The default status code returned from `error!` has been changed from 403 to 500 - [@dblock](https://github.com/dblock).
 * [#526](https://github.com/intridea/grape/pull/526): Allow specifying headers in `error!` - [@dblock](https://github.com/dblock).
 * [#523](https://github.com/intridea/grape/pull/523): Aliased `before` as `before_validation` - [@myitcv](https://github.com/myitcv).
+* [#527](https://github.com/intridea/grape/pull/527): `before_validation` now a distinct callback (supersedes [#523](https://github.com/intridea/grape/pull/523)) - [@myitcv](https://github.com/myitcv).
 * Your contribution here.
 
 #### Fixes

README.md

@@ -1211,11 +1211,12 @@ Blocks can be executed before or after every API call, using `before`, `after`,
 
 Before and after callbacks execute in the following order:
 
-1. `before` and `before_validation` (these are aliases - no ordering between them,
-execution could be interleaved)
-2. `after_validation`
-3. the API call
-4. `after`
+1. `before`
+2. `before_validation`
+3. _validations_
+4. `after_validation`
+5. _the API call_
+6. `after`
 
 Steps 2, 3 and 4 only happen if validation succeeds.
 

lib/grape/api.rb

@@ -361,7 +361,9 @@ def before(&block)
         imbue(:befores, [block])
       end
 
-      alias_method :before_validation, :before
+      def before_validation(&block)
+        imbue(:before_validations, [block])
+      end
 
       def after_validation(&block)
         imbue(:after_validations, [block])

lib/grape/endpoint.rb

@@ -377,6 +377,8 @@ def run(env)
 
       run_filters befores
 
+      run_filters before_validations
+
       # Retieve validations from this namespace and all parent namespaces.
       validation_errors = []
       settings.gather(:validations).each do |validator|
@@ -475,6 +477,10 @@ def befores
       aggregate_setting(:befores)
     end
 
+    def before_validations
+      aggregate_setting(:before_validations)
+    end
+
     def after_validations
       aggregate_setting(:after_validations)
     end

spec/grape/api_spec.rb

@@ -692,6 +692,36 @@ def subject.enable_root_route!
       last_response.status.should eql 400
       last_response.body.should eql 'id is invalid'
     end
+
+    it 'calls filters in the correct order' do
+      i = 0
+      a = double('before mock')
+      b = double('before_validation mock')
+      c = double('after_validation mock')
+      d = double('after mock')
+
+      subject.params do
+        requires :id, type: Integer
+      end
+      subject.resource ':id' do
+        before { a.here(i += 1) }
+        before_validation { b.here(i += 1) }
+        after_validation { c.here(i += 1) }
+        after { d.here(i += 1) }
+        get do
+          'got it'
+        end
+      end
+
+      a.should_receive(:here).with(1).exactly(1).times
+      b.should_receive(:here).with(2).exactly(1).times
+      c.should_receive(:here).with(3).exactly(1).times
+      d.should_receive(:here).with(4).exactly(1).times
+
+      get '/123'
+      last_response.status.should eql 200
+      last_response.body.should eql 'got it'
+    end
   end
 
   context 'format' do