grape 2.0.0 → 2.2.0

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

@@ -59,6 +59,7 @@ module Grape
         end
 
         def self.inherited(klass)
+          super
           return if klass.name.blank?
 
           short_validator_name = klass.name.demodulize.underscore.delete_suffix('_validator')

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

@@ -11,7 +11,11 @@ module Grape
 
         def validate_param!(attr_name, params)
           params[attr_name] = if @default.is_a? Proc
-                                @default.call
+                                if @default.parameters.empty?
+                                  @default.call
+                                else
+                                  @default.call(params)
+                                end
                               elsif @default.frozen? || !@default.duplicable?
                                 @default
                               else

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

@@ -7,7 +7,7 @@ module Grape
         def validate_params!(params)
           keys = keys_in_common(params)
           return if keys.length == 1
-          raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:exactly_one)) if keys.length.zero?
+          raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:exactly_one)) if keys.empty?
 
           raise Grape::Exceptions::Validation.new(params: keys, message: message(:mutual_exclusion))
         end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      class LengthValidator < Base
+        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]
+
+          return unless param.respond_to?(:length)
+
+          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
+
+        def build_message
+          if options_key?(:message)
+            @option[:message]
+          elsif @min && @max
+            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
+          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
+    end
+  end
+end

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

@@ -85,7 +85,12 @@ module Grape
         end
 
         def required_for_root_scope?
-          @required && @scope.root?
+          return false unless @required
+
+          scope = @scope
+          scope = scope.parent while scope.lateral?
+
+          scope.root?
         end
 
         def validation_exception(attr_name, message)

data/lib/grape/validations.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Grape
-  # Registry to store and locate known Validators.
   module Validations
     module_function
 
@@ -12,7 +11,7 @@ module Grape
     # 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
-    #   Validations::Base.
+    #   Grape::Validations::Validators::Base.
     def register_validator(short_name, klass)
       validators[short_name] = klass
     end
@@ -21,14 +20,11 @@ module Grape
       validators.delete(short_name)
     end
 
-    # Find a validator and if not found will try to load it
     def require_validator(short_name)
       str_name = short_name.to_s
-      validators.fetch(str_name) do
-        Grape::Validations::Validators.const_get("#{str_name.camelize}Validator")
-      end
+      validators.fetch(str_name) { Grape::Validations::Validators.const_get(:"#{str_name.camelize}Validator") }
     rescue NameError
-      raise Grape::Exceptions::UnknownValidator.new(short_name)
+      raise Grape::Exceptions::UnknownValidator, short_name
     end
   end
 end

data/lib/grape/version.rb

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

data/lib/grape/{util/xml.rb → xml.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Grape
-  if Object.const_defined? :MultiXml
+  if defined?(::MultiXml)
     Xml = ::MultiXml
   else
     Xml = ::ActiveSupport::XmlMini

data/lib/grape.rb

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-require 'rack'
-require 'rack/builder'
-require 'rack/accept'
-require 'rack/auth/basic'
-require 'set'
-require 'bigdecimal'
-require 'date'
 require 'active_support'
 require 'active_support/concern'
 require 'active_support/configurable'
@@ -24,295 +16,59 @@ require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/deep_dup'
 require 'active_support/core_ext/object/duplicable'
+require 'active_support/core_ext/string/output_safety'
 require 'active_support/core_ext/string/exclude'
-require 'active_support/dependencies/autoload'
 require 'active_support/deprecation'
 require 'active_support/inflector'
+require 'active_support/ordered_options'
 require 'active_support/notifications'
-require 'i18n'
+
+require 'English'
+require 'bigdecimal'
+require 'date'
+require 'dry-types'
+require 'forwardable'
+require 'json'
+require 'logger'
+require 'mustermann/grape'
+require 'pathname'
+require 'rack'
+require 'rack/auth/basic'
+require 'rack/builder'
+require 'rack/head'
+require 'set'
+require 'singleton'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  'api' => 'API',
+  'dsl' => 'DSL'
+)
+railtie = "#{__dir__}/grape/railtie.rb"
+loader.do_not_eager_load(railtie)
+loader.setup
 
 I18n.load_path << File.expand_path('grape/locale/en.yml', __dir__)
 
 module Grape
   include ActiveSupport::Configurable
-  extend ::ActiveSupport::Autoload
 
   def self.deprecator
     @deprecator ||= ActiveSupport::Deprecation.new('2.0', 'Grape')
   end
 
-  def self.lowercase_headers?
-    Rack::CONTENT_TYPE == 'content-type'
-  end
-
-  eager_autoload do
-    autoload :API
-    autoload :Endpoint
-
-    autoload :Namespace
-
-    autoload :Path
-    autoload :Cookies
-    autoload :Validations
-    autoload :ErrorFormatter
-    autoload :Formatter
-    autoload :Parser
-    autoload :Request
-    autoload :Env, 'grape/util/env'
-    autoload :Json, 'grape/util/json'
-    autoload :Xml, 'grape/util/xml'
-    autoload :DryTypes
-  end
-
-  module Http
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Headers
-    end
-  end
-
-  module Exceptions
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Base
-      autoload :Validation
-      autoload :ValidationArrayErrors
-      autoload :ValidationErrors
-      autoload :MissingVendorOption
-      autoload :MissingMimeType
-      autoload :MissingOption
-      autoload :InvalidFormatter
-      autoload :InvalidVersionerOption
-      autoload :UnknownValidator
-      autoload :UnknownOptions
-      autoload :UnknownParameter
-      autoload :InvalidWithOptionForRepresent
-      autoload :IncompatibleOptionValues
-      autoload :MissingGroupType
-      autoload :UnsupportedGroupType
-      autoload :InvalidMessageBody
-      autoload :InvalidAcceptHeader
-      autoload :InvalidVersionHeader
-      autoload :MethodNotAllowed
-      autoload :InvalidResponse
-      autoload :EmptyMessageBody
-      autoload :TooManyMultipartFiles
-      autoload :MissingGroupTypeError, 'grape/exceptions/missing_group_type'
-      autoload :UnsupportedGroupTypeError, 'grape/exceptions/unsupported_group_type'
-    end
-  end
-
-  module Extensions
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Hash
-    end
-    module ActiveSupport
-      extend ::ActiveSupport::Autoload
-      eager_autoload do
-        autoload :HashWithIndifferentAccess
-      end
-    end
-
-    module Hashie
-      extend ::ActiveSupport::Autoload
-      eager_autoload do
-        autoload :Mash
-      end
-    end
-  end
-
-  module Middleware
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Base
-      autoload :Versioner
-      autoload :Formatter
-      autoload :Error
-      autoload :Globals
-      autoload :Stack
-      autoload :Helpers
-    end
-
-    module Auth
-      extend ::ActiveSupport::Autoload
-      eager_autoload do
-        autoload :Base
-        autoload :DSL
-        autoload :StrategyInfo
-        autoload :Strategies
-      end
-    end
-
-    module Versioner
-      extend ::ActiveSupport::Autoload
-      eager_autoload do
-        autoload :Path
-        autoload :Header
-        autoload :Param
-        autoload :AcceptVersionHeader
-      end
-    end
-  end
-
-  module Util
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :InheritableValues
-      autoload :StackableValues
-      autoload :ReverseStackableValues
-      autoload :InheritableSetting
-      autoload :StrictHashConfiguration
-      autoload :Registrable
-    end
-  end
-
-  module ErrorFormatter
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Base
-      autoload :Json
-      autoload :Txt
-      autoload :Xml
-    end
-  end
-
-  module Formatter
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Json
-      autoload :SerializableHash
-      autoload :Txt
-      autoload :Xml
-    end
-  end
-
-  module Parser
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Json
-      autoload :Xml
-    end
-  end
-
-  module DSL
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :API
-      autoload :Callbacks
-      autoload :Settings
-      autoload :Configuration
-      autoload :InsideRoute
-      autoload :Helpers
-      autoload :Middleware
-      autoload :Parameters
-      autoload :RequestResponse
-      autoload :Routing
-      autoload :Validations
-      autoload :Logger
-      autoload :Desc
-    end
-  end
-
-  class API
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Helpers
-    end
-  end
-
-  module Presenters
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Presenter
-    end
-  end
-
-  module ServeStream
-    extend ::ActiveSupport::Autoload
-    eager_autoload do
-      autoload :FileBody
-      autoload :SendfileResponse
-      autoload :StreamResponse
-    end
-  end
-
-  module Validations
-    extend ::ActiveSupport::Autoload
-
-    eager_autoload do
-      autoload :AttributesIterator
-      autoload :MultipleAttributesIterator
-      autoload :SingleAttributeIterator
-      autoload :Types
-      autoload :ParamsScope
-      autoload :ValidatorFactory
-      autoload :Base, 'grape/validations/validators/base'
-    end
-
-    module Types
-      extend ::ActiveSupport::Autoload
-
-      eager_autoload do
-        autoload :InvalidValue
-        autoload :DryTypeCoercer
-        autoload :ArrayCoercer
-        autoload :SetCoercer
-        autoload :PrimitiveCoercer
-        autoload :CustomTypeCoercer
-        autoload :CustomTypeCollectionCoercer
-        autoload :MultipleTypeCoercer
-        autoload :VariantCollectionCoercer
-      end
-    end
-
-    module Validators
-      extend ::ActiveSupport::Autoload
-
-      eager_autoload do
-        autoload :Base
-        autoload :MultipleParamsBase
-        autoload :AllOrNoneOfValidator
-        autoload :AllowBlankValidator
-        autoload :AsValidator
-        autoload :AtLeastOneOfValidator
-        autoload :CoerceValidator
-        autoload :DefaultValidator
-        autoload :ExactlyOneOfValidator
-        autoload :ExceptValuesValidator
-        autoload :MutualExclusionValidator
-        autoload :PresenceValidator
-        autoload :RegexpValidator
-        autoload :SameAsValidator
-        autoload :ValuesValidator
-      end
-    end
-  end
-
-  module Types
-    extend ::ActiveSupport::Autoload
-
-    eager_autoload do
-      autoload :InvalidValue
-    end
-  end
-
   configure do |config|
     config.param_builder = Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
     config.compile_methods!
   end
 end
 
-require 'grape/content_types'
-
-require 'grape/util/lazy_value'
-require 'grape/util/lazy_block'
-require 'grape/util/endpoint_configuration'
-require 'grape/version'
-
 # https://api.rubyonrails.org/classes/ActiveSupport/Deprecation.html
 # adding Grape.deprecator to Rails App if any
 require 'grape/railtie' if defined?(Rails::Railtie) && ActiveSupport.gem_version >= Gem::Version.new('7.1')
+loader.eager_load

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-11 00:00:00.000000000 Z
+date: 2024-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: builder
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
@@ -58,30 +44,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: rack-accept
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,8 +115,8 @@ files:
 - lib/grape/dsl/routing.rb
 - lib/grape/dsl/settings.rb
 - lib/grape/dsl/validations.rb
-- lib/grape/eager_load.rb
 - lib/grape/endpoint.rb
+- lib/grape/env.rb
 - lib/grape/error_formatter.rb
 - lib/grape/error_formatter/base.rb
 - lib/grape/error_formatter/json.rb
@@ -168,6 +154,7 @@ files:
 - lib/grape/formatter/txt.rb
 - lib/grape/formatter/xml.rb
 - lib/grape/http/headers.rb
+- lib/grape/json.rb
 - lib/grape/locale/en.yml
 - lib/grape/middleware/auth/base.rb
 - lib/grape/middleware/auth/dsl.rb
@@ -184,8 +171,8 @@ files:
 - lib/grape/middleware/versioner/accept_version_header.rb
 - lib/grape/middleware/versioner/header.rb
 - lib/grape/middleware/versioner/param.rb
-- lib/grape/middleware/versioner/parse_media_type_patch.rb
 - lib/grape/middleware/versioner/path.rb
+- lib/grape/middleware/versioner_helpers.rb
 - lib/grape/namespace.rb
 - lib/grape/parser.rb
 - lib/grape/parser/json.rb
@@ -195,7 +182,8 @@ files:
 - lib/grape/railtie.rb
 - lib/grape/request.rb
 - lib/grape/router.rb
-- lib/grape/router/attribute_translator.rb
+- lib/grape/router/base_route.rb
+- lib/grape/router/greedy_route.rb
 - lib/grape/router/pattern.rb
 - lib/grape/router/route.rb
 - lib/grape/serve_stream/file_body.rb
@@ -205,21 +193,23 @@ files:
 - lib/grape/util/base_inheritable.rb
 - lib/grape/util/cache.rb
 - lib/grape/util/endpoint_configuration.rb
-- lib/grape/util/env.rb
+- lib/grape/util/header.rb
 - lib/grape/util/inheritable_setting.rb
 - lib/grape/util/inheritable_values.rb
-- lib/grape/util/json.rb
-- lib/grape/util/lazy_block.rb
-- lib/grape/util/lazy_object.rb
-- lib/grape/util/lazy_value.rb
-- lib/grape/util/registrable.rb
+- lib/grape/util/lazy/block.rb
+- lib/grape/util/lazy/object.rb
+- lib/grape/util/lazy/value.rb
+- lib/grape/util/lazy/value_array.rb
+- lib/grape/util/lazy/value_enumerable.rb
+- lib/grape/util/lazy/value_hash.rb
+- lib/grape/util/media_type.rb
 - lib/grape/util/reverse_stackable_values.rb
 - lib/grape/util/stackable_values.rb
 - lib/grape/util/strict_hash_configuration.rb
-- lib/grape/util/xml.rb
 - lib/grape/validations.rb
 - lib/grape/validations/attributes_doc.rb
 - lib/grape/validations/attributes_iterator.rb
+- lib/grape/validations/contract_scope.rb
 - lib/grape/validations/multiple_attributes_iterator.rb
 - lib/grape/validations/params_scope.rb
 - lib/grape/validations/single_attribute_iterator.rb
@@ -246,6 +236,7 @@ files:
 - lib/grape/validations/validators/default_validator.rb
 - lib/grape/validations/validators/exactly_one_of_validator.rb
 - lib/grape/validations/validators/except_values_validator.rb
+- lib/grape/validations/validators/length_validator.rb
 - lib/grape/validations/validators/multiple_params_base.rb
 - lib/grape/validations/validators/mutual_exclusion_validator.rb
 - lib/grape/validations/validators/presence_validator.rb
@@ -253,14 +244,16 @@ files:
 - lib/grape/validations/validators/same_as_validator.rb
 - lib/grape/validations/validators/values_validator.rb
 - lib/grape/version.rb
+- lib/grape/xml.rb
 homepage: https://github.com/ruby-grape/grape
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.0.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/2.0.0
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.0.0
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.2.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/2.2.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.2.0
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -269,14 +262,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.13
 signing_key:
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.