grape 2.1.3 → 2.3.0

data/lib/grape/validations/validators/default_validator.rb

@@ -4,7 +4,7 @@ module Grape
   module Validations
     module Validators
       class DefaultValidator < Base
-        def initialize(attrs, options, required, scope, **opts)
+        def initialize(attrs, options, required, scope, opts = {})
           @default = options
           super
         end

data/lib/grape/validations/validators/except_values_validator.rb

@@ -4,7 +4,7 @@ module Grape
   module Validations
     module Validators
       class ExceptValuesValidator < Base
-        def initialize(attrs, options, required, scope, **opts)
+        def initialize(attrs, options, required, scope, opts)
           @except = options.is_a?(Hash) ? options[:value] : options
           super
         end

data/lib/grape/validations/validators/length_validator.rb

@@ -4,23 +4,28 @@ module Grape
   module Validations
     module Validators
       class LengthValidator < Base
-        def initialize(attrs, options, required, scope, **opts)
+        def initialize(attrs, options, required, scope, opts)
           @min = options[:min]
           @max = options[:max]
+          @is = options[:is]
 
           super
 
           raise ArgumentError, 'min must be an integer greater than or equal to zero' if !@min.nil? && (!@min.is_a?(Integer) || @min.negative?)
           raise ArgumentError, 'max must be an integer greater than or equal to zero' if !@max.nil? && (!@max.is_a?(Integer) || @max.negative?)
           raise ArgumentError, "min #{@min} cannot be greater than max #{@max}" if !@min.nil? && !@max.nil? && @min > @max
+
+          return if @is.nil?
+          raise ArgumentError, 'is must be an integer greater than zero' if !@is.is_a?(Integer) || !@is.positive?
+          raise ArgumentError, 'is cannot be combined with min or max' if !@min.nil? || !@max.nil?
         end
 
         def validate_param!(attr_name, params)
           param = params[attr_name]
 
-          raise ArgumentError, "parameter #{param} does not support #length" unless param.respond_to?(:length)
+          return unless param.respond_to?(:length)
 
-          return unless (!@min.nil? && param.length < @min) || (!@max.nil? && param.length > @max)
+          return unless (!@min.nil? && param.length < @min) || (!@max.nil? && param.length > @max) || (!@is.nil? && param.length != @is)
 
           raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: build_message)
         end
@@ -32,8 +37,10 @@ module Grape
             format I18n.t(:length, scope: 'grape.errors.messages'), min: @min, max: @max
           elsif @min
             format I18n.t(:length_min, scope: 'grape.errors.messages'), min: @min
-          else
+          elsif @max
             format I18n.t(:length_max, scope: 'grape.errors.messages'), max: @max
+          else
+            format I18n.t(:length_is, scope: 'grape.errors.messages'), is: @is
           end
         end
       end

data/lib/grape/validations/validators/regexp_validator.rb

@@ -6,7 +6,7 @@ module Grape
       class RegexpValidator < Base
         def validate_param!(attr_name, params)
           return unless params.respond_to?(:key?) && params.key?(attr_name)
-          return if Array.wrap(params[attr_name]).all? { |param| param.nil? || param.to_s.match?((options_key?(:value) ? @option[:value] : @option)) }
+          return if Array.wrap(params[attr_name]).all? { |param| param.nil? || param.to_s.scrub.match?((options_key?(:value) ? @option[:value] : @option)) }
 
           raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:regexp))
         end

data/lib/grape/validations/validators/values_validator.rb

@@ -4,23 +4,8 @@ module Grape
   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
+        def initialize(attrs, options, required, scope, opts)
+          @values = options.is_a?(Hash) ? options[:value] : options
           super
         end
 
@@ -31,57 +16,34 @@ module Grape
 
           return if val.nil? && !required_for_root_scope?
 
+          val = val.scrub if val.respond_to?(:scrub)
+
           # 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 +54,6 @@ module Grape
 
           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

data/lib/grape/validations.rb

@@ -2,29 +2,20 @@
 
 module Grape
   module Validations
+    extend Grape::Util::Registry
+
     module_function
 
-    def validators
-      @validators ||= {}
-    end
+    def require_validator(short_name)
+      raise Grape::Exceptions::UnknownValidator, short_name unless registry.key?(short_name)
 
-    # Register a new validator, so it can be used to validate parameters.
-    # @param short_name [String] all lower-case, no spaces
-    # @param klass [Class] the validator class. Should inherit from
-    #   Grape::Validations::Validators::Base.
-    def register_validator(short_name, klass)
-      validators[short_name] = klass
+      registry[short_name]
     end
 
-    def deregister_validator(short_name)
-      validators.delete(short_name)
-    end
+    def build_short_name(klass)
+      return if klass.name.blank?
 
-    def require_validator(short_name)
-      str_name = short_name.to_s
-      validators.fetch(str_name) { Grape::Validations::Validators.const_get(:"#{str_name.camelize}Validator") }
-    rescue NameError
-      raise Grape::Exceptions::UnknownValidator, short_name
+      klass.name.demodulize.underscore.delete_suffix('_validator')
     end
   end
 end

data/lib/grape/version.rb

@@ -2,5 +2,5 @@
 
 module Grape
   # The current version of Grape.
-  VERSION = '2.1.3'
+  VERSION = '2.3.0'
 end

data/lib/grape.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'active_support'
 require 'active_support/concern'
 require 'active_support/configurable'
@@ -33,7 +34,6 @@ require 'date'
 require 'dry-types'
 require 'forwardable'
 require 'json'
-require 'logger'
 require 'mustermann/grape'
 require 'pathname'
 require 'rack'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.3.0
 platform: ruby
 authors:
 - Michael Bleigh
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-13 00:00:00.000000000 Z
+date: 2025-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,6 +119,8 @@ files:
 - lib/grape/error_formatter.rb
 - lib/grape/error_formatter/base.rb
 - lib/grape/error_formatter/json.rb
+- lib/grape/error_formatter/jsonapi.rb
+- lib/grape/error_formatter/serializable_hash.rb
 - lib/grape/error_formatter/txt.rb
 - lib/grape/error_formatter/xml.rb
 - lib/grape/exceptions/base.rb
@@ -149,6 +150,7 @@ files:
 - lib/grape/extensions/hash.rb
 - lib/grape/extensions/hashie/mash.rb
 - lib/grape/formatter.rb
+- lib/grape/formatter/base.rb
 - lib/grape/formatter/json.rb
 - lib/grape/formatter/serializable_hash.rb
 - lib/grape/formatter/txt.rb
@@ -169,12 +171,15 @@ files:
 - lib/grape/middleware/stack.rb
 - lib/grape/middleware/versioner.rb
 - lib/grape/middleware/versioner/accept_version_header.rb
+- lib/grape/middleware/versioner/base.rb
 - lib/grape/middleware/versioner/header.rb
 - lib/grape/middleware/versioner/param.rb
 - lib/grape/middleware/versioner/path.rb
 - lib/grape/namespace.rb
 - lib/grape/parser.rb
+- lib/grape/parser/base.rb
 - lib/grape/parser/json.rb
+- lib/grape/parser/jsonapi.rb
 - lib/grape/parser/xml.rb
 - lib/grape/path.rb
 - lib/grape/presenters/presenter.rb
@@ -189,7 +194,6 @@ files:
 - lib/grape/serve_stream/sendfile_response.rb
 - lib/grape/serve_stream/stream_response.rb
 - lib/grape/types/invalid_value.rb
-- lib/grape/util/accept_header_handler.rb
 - lib/grape/util/base_inheritable.rb
 - lib/grape/util/cache.rb
 - lib/grape/util/endpoint_configuration.rb
@@ -203,7 +207,7 @@ files:
 - lib/grape/util/lazy/value_enumerable.rb
 - lib/grape/util/lazy/value_hash.rb
 - lib/grape/util/media_type.rb
-- lib/grape/util/registrable.rb
+- lib/grape/util/registry.rb
 - lib/grape/util/reverse_stackable_values.rb
 - lib/grape/util/stackable_values.rb
 - lib/grape/util/strict_hash_configuration.rb
@@ -216,7 +220,6 @@ files:
 - lib/grape/validations/single_attribute_iterator.rb
 - lib/grape/validations/types.rb
 - lib/grape/validations/types/array_coercer.rb
-- lib/grape/validations/types/build_coercer.rb
 - lib/grape/validations/types/custom_type_coercer.rb
 - lib/grape/validations/types/custom_type_collection_coercer.rb
 - lib/grape/validations/types/dry_type_coercer.rb
@@ -234,6 +237,7 @@ files:
 - lib/grape/validations/validators/at_least_one_of_validator.rb
 - lib/grape/validations/validators/base.rb
 - lib/grape/validations/validators/coerce_validator.rb
+- lib/grape/validations/validators/contract_scope_validator.rb
 - lib/grape/validations/validators/default_validator.rb
 - lib/grape/validations/validators/exactly_one_of_validator.rb
 - lib/grape/validations/validators/except_values_validator.rb
@@ -251,10 +255,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.1.3/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/2.1.3
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.1.3
-post_install_message:
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.3.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/2.3.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.3.0
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -269,8 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.13
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
 test_files: []

data/lib/grape/util/accept_header_handler.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    class AcceptHeaderHandler
-      attr_reader :accept_header, :versions, :vendor, :strict, :cascade
-
-      def initialize(accept_header:, versions:, **options)
-        @accept_header = accept_header
-        @versions = versions
-        @vendor = options.fetch(:vendor, nil)
-        @strict = options.fetch(:strict, false)
-        @cascade = options.fetch(:cascade, true)
-      end
-
-      def match_best_quality_media_type!(content_types: Grape::ContentTypes::CONTENT_TYPES, allowed_methods: nil)
-        return unless vendor
-
-        strict_header_checks!
-        media_type = Grape::Util::MediaType.best_quality(accept_header, available_media_types(content_types))
-        if media_type
-          yield media_type
-        else
-          fail!(allowed_methods)
-        end
-      end
-
-      private
-
-      def strict_header_checks!
-        return unless strict
-
-        accept_header_check!
-        version_and_vendor_check!
-      end
-
-      def accept_header_check!
-        return if accept_header.present?
-
-        invalid_accept_header!('Accept header must be set.')
-      end
-
-      def version_and_vendor_check!
-        return if versions.blank? || version_and_vendor?
-
-        invalid_accept_header!('API vendor or version not found.')
-      end
-
-      def q_values_mime_types
-        @q_values_mime_types ||= Rack::Utils.q_values(accept_header).map(&:first)
-      end
-
-      def version_and_vendor?
-        q_values_mime_types.any? { |mime_type| Grape::Util::MediaType.match?(mime_type) }
-      end
-
-      def invalid_accept_header!(message)
-        raise Grape::Exceptions::InvalidAcceptHeader.new(message, error_headers)
-      end
-
-      def invalid_version_header!(message)
-        raise Grape::Exceptions::InvalidVersionHeader.new(message, error_headers)
-      end
-
-      def fail!(grape_allowed_methods)
-        return grape_allowed_methods if grape_allowed_methods.present?
-
-        media_types = q_values_mime_types.map { |mime_type| Grape::Util::MediaType.parse(mime_type) }
-        vendor_not_found!(media_types) || version_not_found!(media_types)
-      end
-
-      def vendor_not_found!(media_types)
-        return unless media_types.all? { |media_type| media_type&.vendor && media_type.vendor != vendor }
-
-        invalid_accept_header!('API vendor not found.')
-      end
-
-      def version_not_found!(media_types)
-        return unless media_types.all? { |media_type| media_type&.version && versions.exclude?(media_type.version) }
-
-        invalid_version_header!('API version not found.')
-      end
-
-      def error_headers
-        cascade ? { Grape::Http::Headers::X_CASCADE => 'pass' } : {}
-      end
-
-      def available_media_types(content_types)
-        [].tap do |available_media_types|
-          base_media_type = "application/vnd.#{vendor}"
-          content_types.each_key do |extension|
-            versions&.reverse_each do |version|
-              available_media_types << "#{base_media_type}-#{version}+#{extension}"
-              available_media_types << "#{base_media_type}-#{version}"
-            end
-            available_media_types << "#{base_media_type}+#{extension}"
-          end
-
-          available_media_types << base_media_type
-          available_media_types.concat(content_types.values.flatten)
-        end
-      end
-    end
-  end
-end

data/lib/grape/util/registrable.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    module Registrable
-      def default_elements
-        @default_elements ||= {}
-      end
-
-      def register(format, element)
-        default_elements[format] = element unless default_elements[format]
-      end
-    end
-  end
-end

data/lib/grape/validations/types/build_coercer.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    module Types
-      module BuildCoercer
-        # Chooses the best coercer for the given type. For example, if the type
-        # is Integer, it will return a coercer which will be able to coerce a value
-        # to the integer.
-        #
-        # There are a few very special coercers which might be returned.
-        #
-        # +Grape::Types::MultipleTypeCoercer+ is a coercer which is returned when
-        # the given type implies values in an array with different types.
-        # For example, +[Integer, String]+ allows integer and string values in
-        # an array.
-        #
-        # +Grape::Types::CustomTypeCoercer+ is a coercer which is returned when
-        # a method is specified by a user with +coerce_with+ option or the user
-        # specifies a custom type which implements requirments of
-        # +Grape::Types::CustomTypeCoercer+.
-        #
-        # +Grape::Types::CustomTypeCollectionCoercer+ is a very similar to the
-        # previous one, but it expects an array or set of values having a custom
-        # type implemented by the user.
-        #
-        # There is also a group of custom types implemented by Grape, check
-        # +Grape::Validations::Types::SPECIAL+ to get the full list.
-        #
-        # @param type [Class] the type to which input strings
-        #   should be coerced
-        # @param method [Class,#call] the coercion method to use
-        # @return [Object] object to be used
-        #   for coercion and type validation
-        def self.build_coercer(type, method: nil, strict: false)
-          cache_instance(type, method, strict) do
-            create_coercer_instance(type, method, strict)
-          end
-        end
-
-        def self.create_coercer_instance(type, method, strict)
-          # Maps a custom type provided by Grape, it doesn't map types wrapped by collections!!!
-          type = Types.map_special(type)
-
-          # Use a special coercer for multiply-typed parameters.
-          if Types.multiple?(type)
-            MultipleTypeCoercer.new(type, method)
-
-            # Use a special coercer for custom types and coercion methods.
-          elsif method || Types.custom?(type)
-            CustomTypeCoercer.new(type, method)
-
-            # Special coercer for collections of types that implement a parse method.
-            # CustomTypeCoercer (above) already handles such types when an explicit coercion
-            # method is supplied.
-          elsif Types.collection_of_custom?(type)
-            Types::CustomTypeCollectionCoercer.new(
-              Types.map_special(type.first), type.is_a?(Set)
-            )
-          else
-            DryTypeCoercer.coercer_instance_for(type, strict)
-          end
-        end
-
-        def self.cache_instance(type, method, strict, &_block)
-          key = cache_key(type, method, strict)
-
-          return @__cache[key] if @__cache.key?(key)
-
-          instance = yield
-
-          @__cache_write_lock.synchronize do
-            @__cache[key] = instance
-          end
-
-          instance
-        end
-
-        def self.cache_key(type, method, strict)
-          [type, method, strict].each_with_object(+'_') do |val, memo|
-            next if val.nil?
-
-            memo << '_' << val.to_s
-          end
-        end
-
-        instance_variable_set(:@__cache,            {})
-        instance_variable_set(:@__cache_write_lock, Mutex.new)
-      end
-    end
-  end
-end