grape 1.8.0 → 4.0.1

data/lib/grape.rb

@@ -1,305 +1,113 @@
 # frozen_string_literal: true
 
 require 'logger'
-require 'rack'
-require 'rack/builder'
-require 'rack/accept'
-require 'rack/auth/basic'
-require 'rack/auth/digest/md5'
-require 'set'
-require 'bigdecimal'
-require 'date'
+require 'monitor'
 require 'active_support'
-require 'active_support/concern'
-require 'active_support/configurable'
-require 'active_support/version'
-require 'active_support/isolated_execution_state' if ActiveSupport::VERSION::MAJOR > 6
-require 'active_support/core_ext/array/conversions'
-require 'active_support/core_ext/array/extract_options'
+require 'active_support/isolated_execution_state'
+require 'active_support/core_ext/array/conversions' # to_xml
 require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/hash/conversions' # to_xml
 require 'active_support/core_ext/hash/deep_merge'
-require 'active_support/core_ext/hash/except'
-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/hash/deep_transform_values'
+require 'active_support/core_ext/hash/indifferent_access' # nested_under_indifferent_access, required by HashWithIndifferentAccess.new
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/module/delegation' # delegate_missing_to
 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/dependencies/autoload'
+require 'active_support/core_ext/string/inflections' # demodulize, underscore
 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 'dry-configurable'
+require 'forwardable'
+require 'json'
+require 'mustermann'
+require 'mustermann/ast/pattern'
+require 'rack'
+require 'rack/auth/basic'
+require 'rack/builder'
+require 'rack/head'
+require 'singleton'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  'api' => 'API',
+  'dsl' => 'DSL'
+)
+railtie = "#{__dir__}/grape/railtie.rb"
+# Grape::Testing is a test-environment helper -- it extends Grape::Endpoint with
+# `before_each` and prepends a hook to Grape::Endpoint#run. It is documented as
+# opt-in (`require 'grape/testing'`), which eager loading quietly contradicted
+# by installing it in every process.
+testing = "#{__dir__}/grape/testing.rb"
+loader.do_not_eager_load(railtie, testing)
+loader.setup
 
 I18n.load_path << File.expand_path('grape/locale/en.yml', __dir__)
 
 module Grape
-  include ActiveSupport::Configurable
-  extend ::ActiveSupport::Autoload
-
-  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!
+  extend Dry::Configurable
+
+  setting :param_builder, default: :hash_with_indifferent_access
+  setting :lint, default: false
+  setting :warn_on_helper_overrides, default: false
+  # Let an error response that cannot be rendered propagate out of the
+  # middleware stack instead of being answered with a failsafe 500.
+  setting :raise_rendering_errors, default: false
+
+  # The HTTP QUERY method (RFC 10008): a safe, idempotent request whose content
+  # carries the query. Rack has no constant for it yet, hence the literal.
+  QUERY = 'QUERY'
+
+  HTTP_SUPPORTED_METHODS = [
+    Rack::GET,
+    QUERY,
+    Rack::POST,
+    Rack::PUT,
+    Rack::PATCH,
+    Rack::DELETE,
+    Rack::HEAD,
+    Rack::OPTIONS
+  ].freeze
+
+  # Rack errors that should be rescued and wrapped as Grape::Exceptions::RequestError.
+  # Rack 3.1.0 introduced Rack::BadRequest as a marker module included by all bad request
+  # exception classes, allowing a single rescue entry to cover them all.
+  # Before, these errors are raised as individual exception classes.
+  RACK_ERRORS =
+    if Gem::Version.new(Rack.release) >= Gem::Version.new('3.1.0')
+      [EOFError, Rack::BadRequest]
+    else
+      [
+        EOFError,
+        Rack::Multipart::MultipartPartLimitError,
+        Rack::Multipart::MultipartTotalPartLimitError,
+        Rack::Utils::ParameterTypeError,
+        Rack::Utils::InvalidParameterError,
+        Rack::QueryParser::ParamsTooDeepError
+      ]
+    end.freeze
+
+  # The deprecation horizon is the version a deprecation announces as its
+  # removal point, so it is the *next* major rather than the current one, and
+  # it is derived from VERSION rather than written out. Written out, it went
+  # stale: it said '2.0' from 2023 (#2353) through all of 2.x, 3.x and 4.x, so
+  # a method deprecated through this deprecator announced a removal version
+  # that had already shipped, and every custom `behavior` lambda -- how a Rails
+  # app consumes deprecations -- was handed the same wrong number.
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new("#{Gem::Version.new(VERSION).segments.first + 1}.0", 'Grape')
   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)
+loader.eager_load