Merge pull request #251 from simulacre/nested_namespace_validators

changes: nested namespaces enforce their and parent validations; adds HashStack#gather

Author: dblock

lib/grape/endpoint.rb

@@ -295,7 +295,8 @@ def run(env)
 
       run_filters befores
 
-      Array(settings[:validations]).each do |validator|
+      # Retieve validations from this namespace and all parent namespaces.
+      settings.gather(:validations).each do |validator|
         validator.validate!(params)
       end
 

lib/grape/util/hash_stack.rb

@@ -18,7 +18,7 @@ def peek
       end
 
       # Add a new hash to the top of the stack.
-      # 
+      #
       # @param hash [Hash] optional hash to be pushed. Defaults to empty hash
       # @return [HashStack]
       def push(hash = {})
@@ -31,7 +31,7 @@ def pop
       end
 
       # Looks through the stack for the first frame that matches :key
-      # 
+      #
       # @param key [Symbol] key to look for in hash frames
       # @return value of given key after merging the stack
       def get(key)
@@ -52,7 +52,7 @@ def set(key, value)
       alias_method :[]=, :set
 
       # Replace multiple values on the top hash of the stack.
-      # 
+      #
       # @param hash [Hash] Hash of values to be merged in.
       def update(hash)
         peek.merge!(hash)
@@ -83,6 +83,15 @@ def concat(hash_stack)
         self
       end
 
+      # Looks through the stack for all instances of a given key and returns
+      # them as a flat Array.
+      #
+      # @param key [Symbol] The key to gather
+      # @return [Array]
+      def gather(key)
+        stack.map{|s| s[key] }.flatten.compact.uniq
+      end
+
       def to_s
         @stack.to_s
       end

spec/grape/validations_spec.rb

@@ -49,20 +49,20 @@ def app; subject end
     end
 
     context 'custom validation' do
-      module CustomValidations  
+      module CustomValidations
         class Customvalidator < Grape::Validations::Validator
           def validate_param!(attr_name, params)
             unless params[attr_name] == 'im custom'
               throw :error, :status => 400, :message => "#{attr_name}: is not custom!"
-            end    
+            end
           end
-        end  
-      end     
+        end
+      end
 
       context 'when using optional with a custom validator' do
         before do
           subject.params { optional :custom, :customvalidator => true }
-          subject.get '/optional_custom' do 'optional with custom works!'; end 
+          subject.get '/optional_custom' do 'optional with custom works!'; end
         end
 
         it 'validates when param is present' do
@@ -83,7 +83,7 @@ def validate_param!(attr_name, params)
 
         it 'validates with custom validator when param present and incorrect type' do
           subject.params { optional :custom, :type => String, :customvalidator => true }
-      
+
           get '/optional_custom', { :custom => 123 }
           last_response.status.should == 400
           last_response.body.should == 'custom: is not custom!'
@@ -111,6 +111,44 @@ def validate_param!(attr_name, params)
           last_response.status.should == 400
           last_response.body.should == 'missing parameter: custom'
         end
+
+        context 'nested namespaces' do
+          before do
+            subject.params { requires :custom, :customvalidator => true }
+            subject.namespace 'nested' do
+              get 'one' do 'validation failed' end
+              namespace 'nested' do
+                get 'two' do 'validation failed' end
+              end
+            end
+            subject.namespace 'peer' do
+              get 'one' do 'no validation required' end
+              namespace 'nested' do
+                get 'two' do 'no validation required' end
+              end
+            end
+          end
+          specify 'the parent namespace should use the validator' do
+            get '/nested/one', { :custom => 'im wrong, validate me'}
+            last_response.status.should == 400
+            last_response.body.should == 'custom: is not custom!'
+          end
+          specify 'the nested namesapce should inherit the custom validator' do
+            get '/nested/nested/two', { :custom => 'im wrong, validate me'}
+            last_response.status.should == 400
+            last_response.body.should == 'custom: is not custom!'
+          end
+          specify 'peer namesapces should not have the validator' do
+            get '/peer/one', { :custom => 'im not validated' }
+            last_response.status.should == 200
+            last_response.body.should == 'no validation required'
+          end
+          specify 'namespaces nested in peers should also not have the validator' do
+            get '/peer/nested/two', { :custom => 'im not validated' }
+            last_response.status.should == 200
+            last_response.body.should == 'no validation required'
+          end
+        end
       end
     end # end custom validation
   end