Raise validation error when optional Hash type parameter is received String type value and exactly_one_of be used (#1822)

* adds test for exactly_one_of validator with nested and optional parmeters

* add check if the parameter responds to any? method in MultipleParamsBase#scope_requires_params to handle nested invalid parameter

Author: woshidan

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-12-10 01:15:22 +0900 using RuboCop version 0.51.0.
+# on 2018-11-22 00:04:22 +0900 using RuboCop version 0.51.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -27,29 +27,30 @@ Lint/RescueWithoutErrorClass:
   Exclude:
     - 'lib/grape/validations/validators/coerce.rb'
 
-# Offense count: 49
+# Offense count: 47
 Metrics/AbcSize:
   Max: 44
 
-# Offense count: 282
+# Offense count: 4
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 3125
+  Max: 182
 
 # Offense count: 9
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 288
 
-# Offense count: 32
+# Offense count: 31
 Metrics/CyclomaticComplexity:
   Max: 14
 
-# Offense count: 1159
+# Offense count: 1227
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 215
+
 # Offense count: 57
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
@@ -58,9 +59,7 @@ Metrics/MethodLength:
 # Offense count: 11
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 212
-  Exclude:
-    - 'spec/grape/dsl/routing_spec.rb'
+  Max: 220
 
 # Offense count: 21
 Metrics/PerceivedComplexity:
@@ -91,7 +90,7 @@ Performance/HashEachMethods:
     - 'lib/grape/api/instance.rb'
     - 'lib/grape/middleware/versioner/header.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
 # SupportedStyles: line_count_based, semantic, braces_for_chaining

CHANGELOG.md

@@ -17,6 +17,7 @@
 * [#1788](https://github.com/ruby-grape/grape/pull/1788): Fix route requirements bug - [@darren987469](https://github.com/darren987469), [@darrellnash](https://github.com/darrellnash).
 * [#1810](https://github.com/ruby-grape/grape/pull/1810): Fix support in `given` for aliased params - [@darren987469](https://github.com/darren987469).
 * [#1811](https://github.com/ruby-grape/grape/pull/1811): Support nested dependent parameters - [@darren987469](https://github.com/darren987469), [@andreacfm](https://github.com/andreacfm).
+* [#1822](https://github.com/ruby-grape/grape/pull/1822): Raise validation error when optional hash type parameter is received string type value and exactly_one_of be used - [@woshidan](https://github.com/woshidan).
 
 ### 1.1.0 (8/4/2018)
 

lib/grape/validations/validators/multiple_params_base.rb

@@ -11,7 +11,7 @@ def validate!(params)
       private
 
       def scope_requires_params
-        @scope.required? || scoped_params.any?(&:any?)
+        @scope.required? || scoped_params.any? { |param| param.respond_to?(:any?) && param.any? }
       end
 
       def keys_in_common(resource_params)

spec/grape/validations/params_scope_spec.rb

@@ -1045,4 +1045,40 @@ def initialize(value)
       end
     end
   end
+
+  context 'with exactly_one_of validation for optional parameters within an Hash param' do
+    before do
+      subject.params do
+        optional :memo, type: Hash do
+          optional :text, type: String
+          optional :custom_body, type: Hash, coerce_with: JSON
+          exactly_one_of :text, :custom_body
+        end
+      end
+      subject.get('test')
+    end
+
+    context 'when correct data is provided' do
+      it 'returns a successful response' do
+        get 'test', memo: {}
+        expect(last_response.status).to eq(200)
+
+        get 'test', memo: { text: 'HOGEHOGE' }
+        expect(last_response.status).to eq(200)
+
+        get 'test', memo: { custom_body: '{ "xxx": "yyy" }' }
+        expect(last_response.status).to eq(200)
+      end
+    end
+
+    context 'when invalid data is provided' do
+      it 'returns a failure response' do
+        get 'test', memo: { text: 'HOGEHOGE', custom_body: '{ "xxx": "yyy" }' }
+        expect(last_response.status).to eq(400)
+
+        get 'test', memo: '{ "custom_body": "HOGE" }'
+        expect(last_response.status).to eq(400)
+      end
+    end
+  end
 end