diff --git a/CHANGELOG.md b/CHANGELOG.md index 09b7d2e88e..14f5ce81f1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ * [#2497](https://github.com/ruby-grape/grape/pull/2497): Update RuboCop to 1.66.1 - [@ericproulx](https://github.com/ericproulx). * [#2500](https://github.com/ruby-grape/grape/pull/2500): Remove deprecated `file` method - [@ericproulx](https://github.com/ericproulx). +* [#2501](https://github.com/ruby-grape/grape/pull/2501): Remove deprecated `except` and `proc` options in values validator - [@ericproulx](https://github.com/ericproulx). * Your contribution here. #### Fixes diff --git a/UPGRADING.md b/UPGRADING.md index acc74fbac8..8039f3af5a 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -3,11 +3,13 @@ Upgrading Grape ### Upgrading to >= 2.3.0 -#### Remove deprecated methods +#### Remove Deprecated Methods and Options -Deprecated `file` method has been removed. Use `send_file` or `stream`. +- Deprecated `file` method has been removed. Use `send_file` or `stream`. +See [#2500](https://github.com/ruby-grape/grape/pull/2500) for more information. -See [#2500](https://github.com/ruby-grape/grape/pull/2500) +- The `except` and `proc` options have been removed from the `values` validator. Use `except_values` validator or assign `proc` directly to `values`. +See [#2501](https://github.com/ruby-grape/grape/pull/2501) for more information. ### Upgrading to >= 2.2.0 diff --git a/lib/grape/validations/validators/values_validator.rb b/lib/grape/validations/validators/values_validator.rb index 8475ffb822..cc2a641721 100644 --- a/lib/grape/validations/validators/values_validator.rb +++ b/lib/grape/validations/validators/values_validator.rb @@ -5,22 +5,7 @@ module Validations module Validators class ValuesValidator < Base def initialize(attrs, options, required, scope, **opts) - if options.is_a?(Hash) - @excepts = options[:except] - @values = options[:value] - @proc = options[:proc] - - Grape.deprecator.warn('The values validator except option is deprecated. Use the except validator instead.') if @excepts - - raise ArgumentError, 'proc must be a Proc' if @proc && !@proc.is_a?(Proc) - - Grape.deprecator.warn('The values validator proc option is deprecated. The lambda expression can now be assigned directly to values.') if @proc - else - @excepts = nil - @values = nil - @proc = nil - @values = options - end + @values = options.is_a?(Hash) ? options[:value] : options super end @@ -34,54 +19,29 @@ def validate_param!(attr_name, params) # don't forget that +false.blank?+ is true return if val != false && val.blank? && @allow_blank - param_array = val.nil? ? [nil] : Array.wrap(val) - - raise validation_exception(attr_name, except_message) \ - unless check_excepts(param_array) - - raise validation_exception(attr_name, message(:values)) \ - unless check_values(param_array, attr_name) + return if check_values?(val, attr_name) - raise validation_exception(attr_name, message(:values)) \ - if @proc && !validate_proc(@proc, param_array) + raise Grape::Exceptions::Validation.new( + params: [@scope.full_name(attr_name)], + message: message(:values) + ) end private - def check_values(param_array, attr_name) + def check_values?(val, attr_name) values = @values.is_a?(Proc) && @values.arity.zero? ? @values.call : @values return true if values.nil? + param_array = val.nil? ? [nil] : Array.wrap(val) + return param_array.all? { |param| values.include?(param) } unless values.is_a?(Proc) + begin - return param_array.all? { |param| values.call(param) } if values.is_a? Proc + param_array.all? { |param| values.call(param) } rescue StandardError => e warn "Error '#{e}' raised while validating attribute '#{attr_name}'" - return false + false end - param_array.all? { |param| values.include?(param) } - end - - def check_excepts(param_array) - excepts = @excepts.is_a?(Proc) ? @excepts.call : @excepts - return true if excepts.nil? - - param_array.none? { |param| excepts.include?(param) } - end - - def validate_proc(proc, param_array) - case proc.arity - when 0 - param_array.all? { |_param| proc.call } - when 1 - param_array.all? { |param| proc.call(param) } - else - raise ArgumentError, 'proc arity must be 0 or 1' - end - end - - def except_message - options = instance_variable_get(:@option) - options_key?(:except_message) ? options[:except_message] : message(:except_values) end def required_for_root_scope? @@ -92,10 +52,6 @@ def required_for_root_scope? scope.root? end - - def validation_exception(attr_name, message) - Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message) - end end end end