grape 1.5.3 → 1.7.1

data/lib/grape/api/instance.rb

@@ -10,12 +10,11 @@ module Grape
       include Grape::DSL::API
 
       class << self
-        attr_reader :instance
-        attr_reader :base
+        attr_reader :instance, :base
         attr_accessor :configuration
 
         def given(conditional_option, &block)
-          evaluate_as_instance_with_configuration(block, lazy: true) if conditional_option && block_given?
+          evaluate_as_instance_with_configuration(block, lazy: true) if conditional_option && block
         end
 
         def mounted(&block)
@@ -28,7 +27,7 @@ module Grape
         end
 
         def to_s
-          (base && base.to_s) || super
+          base&.to_s || super
         end
 
         def base_instance?
@@ -82,6 +81,7 @@ module Grape
 
         def compile!
           return if instance
+
           LOCK.synchronize { compile unless instance }
         end
 
@@ -101,9 +101,9 @@ module Grape
         # block passed in. Allows for simple 'before' setups
         # of settings stack pushes.
         def nest(*blocks, &block)
-          blocks.reject!(&:nil?)
+          blocks.compact!
           if blocks.any?
-            evaluate_as_instance_with_configuration(block) if block_given?
+            evaluate_as_instance_with_configuration(block) if block
             blocks.each { |b| evaluate_as_instance_with_configuration(b) }
             reset_validations!
           else
@@ -114,9 +114,7 @@ module Grape
         def evaluate_as_instance_with_configuration(block, lazy: false)
           lazy_block = Grape::Util::LazyBlock.new do |configuration|
             value_for_configuration = configuration
-            if value_for_configuration.respond_to?(:lazy?) && value_for_configuration.lazy?
-              self.configuration = value_for_configuration.evaluate
-            end
+            self.configuration = value_for_configuration.evaluate if value_for_configuration.respond_to?(:lazy?) && value_for_configuration.lazy?
             response = instance_eval(&block)
             self.configuration = value_for_configuration
             response
@@ -179,7 +177,8 @@ module Grape
       # X-Cascade. Default :cascade is true.
       def cascade?
         return self.class.namespace_inheritable(:cascade) if self.class.inheritable_setting.namespace_inheritable.key?(:cascade)
-        return self.class.namespace_inheritable(:version_options)[:cascade] if self.class.namespace_inheritable(:version_options) && self.class.namespace_inheritable(:version_options).key?(:cascade)
+        return self.class.namespace_inheritable(:version_options)[:cascade] if self.class.namespace_inheritable(:version_options)&.key?(:cascade)
+
         true
       end
 
@@ -200,17 +199,15 @@ module Grape
         without_root_prefix do
           without_versioning do
             versioned_route_configs.each do |config|
+              next if config[:options][:matching_wildchar]
+
               allowed_methods = config[:methods].dup
 
-              unless self.class.namespace_inheritable(:do_not_route_head)
-                allowed_methods |= [Grape::Http::Headers::HEAD] if allowed_methods.include?(Grape::Http::Headers::GET)
-              end
+              allowed_methods |= [Grape::Http::Headers::HEAD] if !self.class.namespace_inheritable(:do_not_route_head) && allowed_methods.include?(Grape::Http::Headers::GET)
 
               allow_header = (self.class.namespace_inheritable(:do_not_route_options) ? allowed_methods : [Grape::Http::Headers::OPTIONS] | allowed_methods)
 
-              unless self.class.namespace_inheritable(:do_not_route_options) || allowed_methods.include?(Grape::Http::Headers::OPTIONS)
-                config[:endpoint].options[:options_route_enabled] = true
-              end
+              config[:endpoint].options[:options_route_enabled] = true unless self.class.namespace_inheritable(:do_not_route_options) || allowed_methods.include?(Grape::Http::Headers::OPTIONS)
 
               attributes = config.merge(allowed_methods: allowed_methods, allow_header: allow_header)
               generate_not_allowed_method(config[:pattern], **attributes)
@@ -228,7 +225,7 @@ module Grape
           last_route        = routes.last # Most of the configuration is taken from the last endpoint
           matching_wildchar = routes.any? { |route| route.request_method == '*' }
           {
-            options: {},
+            options: { matching_wildchar: matching_wildchar },
             pattern: last_route.pattern,
             requirements: last_route.requirements,
             path: last_route.origin,
@@ -248,7 +245,6 @@ module Grape
             Grape::Http::Headers::SUPPORTED_METHODS_WITHOUT_OPTIONS
           end
         not_allowed_methods = supported_methods - allowed_methods
-        return if not_allowed_methods.empty?
         @router.associate_routes(pattern, not_allowed_methods: not_allowed_methods, **attributes)
       end
 

data/lib/grape/api.rb

@@ -10,6 +10,18 @@ module Grape
     # Class methods that we want to call on the API rather than on the API object
     NON_OVERRIDABLE = (Class.new.methods + %i[call call! configuration compile! inherited]).freeze
 
+    class Boolean
+      def self.build(val)
+        return nil if val != true && val != false
+
+        new
+      end
+    end
+
+    class Instance
+      Boolean = Grape::API::Boolean
+    end
+
     class << self
       attr_accessor :base_instance, :instances
 
@@ -20,10 +32,11 @@ module Grape
 
       # When inherited, will create a list of all instances (times the API was mounted)
       # It will listen to the setup required to mount that endpoint, and replicate it on any new instance
-      def inherited(api, base_instance_parent = Grape::API::Instance)
-        api.initial_setup(base_instance_parent)
+      def inherited(api)
+        super
+
+        api.initial_setup(Grape::API == self ? Grape::API::Instance : @base_instance)
         api.override_all_methods!
-        make_inheritable(api)
       end
 
       # Initialize the instance variables on the remountable class, and the base_instance
@@ -68,15 +81,6 @@ module Grape
         instance_for_rack.call(*args, &block)
       end
 
-      # Allows an API to itself be inheritable:
-      def make_inheritable(api)
-        # When a child API inherits from a parent API.
-        def api.inherited(child_api)
-          # The instances of the child API inherit from the instances of the parent API
-          Grape::API.inherited(child_api, base_instance)
-        end
-      end
-
       # Alleviates problems with autoloading by tring to search for the constant
       def const_missing(*args)
         if base_instance.const_defined?(*args)
@@ -151,6 +155,7 @@ module Grape
 
       def replay_step_on(instance, setup_step)
         return if skip_immediate_run?(instance, setup_step[:args])
+
         args = evaluate_arguments(instance.configuration, *setup_step[:args])
         response = instance.send(setup_step[:method], *args, &setup_step[:block])
         if skip_immediate_run?(instance, [response])

data/lib/grape/cookies.rb

@@ -33,9 +33,11 @@ module Grape
       @cookies.each(&block)
     end
 
+    # rubocop:disable Layout/SpaceBeforeBrackets
     def delete(name, **opts)
       options = opts.merge(value: 'deleted', expires: Time.at(0))
       self.[]=(name, options)
     end
+    # rubocop:enable Layout/SpaceBeforeBrackets
   end
 end

data/lib/grape/dry_types.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'dry-types'
+
+module Grape
+  module DryTypes
+    # Call +Dry.Types()+ to add all registered types to +DryTypes+ which is
+    # a container in this case. Check documentation for more information
+    # https://dry-rb.org/gems/dry-types/1.2/getting-started/
+    include Dry.Types()
+  end
+end

data/lib/grape/dsl/api.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module Grape
   module DSL
     module API

data/lib/grape/dsl/callbacks.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module Grape
   module DSL
     # Blocks can be executed before or after every API call, using `before`, `after`,

data/lib/grape/dsl/configuration.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module Grape
   module DSL
     module Configuration

data/lib/grape/dsl/desc.rb

@@ -50,7 +50,7 @@ module Grape
       #     end
       #
       def desc(description, options = {}, &config_block)
-        if block_given?
+        if config_block
           endpoint_configuration = if defined?(configuration)
                                      # When the instance is mounted - the configuration is executed on mount time
                                      if configuration.respond_to?(:evaluate)
@@ -68,9 +68,7 @@ module Grape
           end
 
           config_class.configure(&config_block)
-          unless options.empty?
-            warn '[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.'
-          end
+          warn '[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.' unless options.empty?
           options = config_class.settings
         else
           options = options.merge(description: description)
@@ -80,21 +78,6 @@ module Grape
         route_setting :description, options
       end
 
-      def description_field(field, value = nil)
-        description = route_setting(:description)
-        if value
-          description ||= route_setting(:description, {})
-          description[field] = value
-        elsif description
-          description[field]
-        end
-      end
-
-      def unset_description_field(field)
-        description = route_setting(:description)
-        description.delete(field) if description
-      end
-
       # Returns an object which configures itself via an instance-context DSL.
       def desc_container(endpoint_configuration)
         Module.new do
@@ -115,7 +98,8 @@ module Grape
             :produces,
             :consumes,
             :security,
-            :tags
+            :tags,
+            :default
           )
           config_context.define_singleton_method(:configuration) do
             endpoint_configuration

data/lib/grape/dsl/headers.rb

@@ -3,8 +3,11 @@
 module Grape
   module DSL
     module Headers
-      # Set an individual header or retrieve
-      # all headers that have been set.
+      # This method has four responsibilities:
+      # 1. Set a specifc header value by key
+      # 2. Retrieve a specifc header value by key
+      # 3. Retrieve all headers that have been set
+      # 4. Delete a specifc header key-value pair
       def header(key = nil, val = nil)
         if key
           val ? header[key.to_s] = val : header.delete(key.to_s)

data/lib/grape/dsl/helpers.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module Grape
   module DSL
     module Helpers
@@ -36,8 +34,8 @@ module Grape
         #
         def helpers(*new_modules, &block)
           include_new_modules(new_modules) if new_modules.any?
-          include_block(block) if block_given?
-          include_all_in_scope if !block_given? && new_modules.empty?
+          include_block(block) if block
+          include_all_in_scope if !block && new_modules.empty?
         end
 
         protected
@@ -67,12 +65,13 @@ module Grape
 
         def define_boolean_in_mod(mod)
           return if defined? mod::Boolean
-          mod.const_set('Boolean', Grape::API::Boolean)
+
+          mod.const_set(:Boolean, Grape::API::Boolean)
         end
 
-        def inject_api_helpers_to_mod(mod, &_block)
+        def inject_api_helpers_to_mod(mod, &block)
           mod.extend(BaseHelper) unless mod.is_a?(BaseHelper)
-          yield if block_given?
+          yield if block
           mod.api_changed(self)
         end
       end
@@ -96,6 +95,7 @@ module Grape
 
         def process_named_params
           return unless instance_variable_defined?(:@named_params) && @named_params && @named_params.any?
+
           api.namespace_stackable(:named_params, @named_params)
         end
       end

data/lib/grape/dsl/inside_route.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
 require 'grape/dsl/headers'
 
 module Grape
@@ -29,7 +28,7 @@ module Grape
       # has completed
       module PostBeforeFilter
         def declared(passed_params, options = {}, declared_params = nil, params_nested_path = [])
-          options = options.reverse_merge(include_missing: true, include_parent_namespaces: true)
+          options = options.reverse_merge(include_missing: true, include_parent_namespaces: true, evaluate_given: false)
           declared_params ||= optioned_declared_params(**options)
 
           if passed_params.is_a?(Array)
@@ -48,37 +47,47 @@ module Grape
         end
 
         def declared_hash(passed_params, options, declared_params, params_nested_path)
-          declared_params.each_with_object(passed_params.class.new) do |declared_param, memo|
-            if declared_param.is_a?(Hash)
-              declared_param.each_pair do |declared_parent_param, declared_children_params|
-                params_nested_path_dup = params_nested_path.dup
-                params_nested_path_dup << declared_parent_param.to_s
-                next unless options[:include_missing] || passed_params.key?(declared_parent_param)
-
-                passed_children_params = passed_params[declared_parent_param] || passed_params.class.new
-                memo_key = optioned_param_key(declared_parent_param, options)
-
-                memo[memo_key] = handle_passed_param(params_nested_path_dup, passed_children_params.any?) do
-                  declared(passed_children_params, options, declared_children_params, params_nested_path_dup)
-                end
-              end
-            else
-              # If it is not a Hash then it does not have children.
-              # Find its value or set it to nil.
-              has_renaming = route_setting(:renamed_params) && route_setting(:renamed_params).find { |current| current[declared_param] }
-              param_renaming = has_renaming[declared_param] if has_renaming
-
-              next unless options[:include_missing] || passed_params.key?(declared_param) || (param_renaming && passed_params.key?(param_renaming))
+          declared_params.each_with_object(passed_params.class.new) do |declared_param_attr, memo|
+            next if options[:evaluate_given] && !declared_param_attr.scope.attr_meets_dependency?(passed_params)
 
-              memo_key = optioned_param_key(param_renaming || declared_param, options)
-              passed_param = passed_params[param_renaming || declared_param]
+            declared_hash_attr(passed_params, options, declared_param_attr.key, params_nested_path, memo)
+          end
+        end
 
+        def declared_hash_attr(passed_params, options, declared_param, params_nested_path, memo)
+          renamed_params = route_setting(:renamed_params) || {}
+          if declared_param.is_a?(Hash)
+            declared_param.each_pair do |declared_parent_param, declared_children_params|
               params_nested_path_dup = params_nested_path.dup
-              params_nested_path_dup << declared_param.to_s
-              memo[memo_key] = passed_param || handle_passed_param(params_nested_path_dup) do
-                passed_param
+              params_nested_path_dup << declared_parent_param.to_s
+              next unless options[:include_missing] || passed_params.key?(declared_parent_param)
+
+              rename_path = params_nested_path + [declared_parent_param.to_s]
+              renamed_param_name = renamed_params[rename_path]
+
+              memo_key = optioned_param_key(renamed_param_name || declared_parent_param, options)
+              passed_children_params = passed_params[declared_parent_param] || passed_params.class.new
+
+              memo[memo_key] = handle_passed_param(params_nested_path_dup, passed_children_params.any?) do
+                declared(passed_children_params, options, declared_children_params, params_nested_path_dup)
               end
             end
+          else
+            # If it is not a Hash then it does not have children.
+            # Find its value or set it to nil.
+            return unless options[:include_missing] || passed_params.key?(declared_param)
+
+            rename_path = params_nested_path + [declared_param.to_s]
+            renamed_param_name = renamed_params[rename_path]
+
+            memo_key = optioned_param_key(renamed_param_name || declared_param, options)
+            passed_param = passed_params[declared_param]
+
+            params_nested_path_dup = params_nested_path.dup
+            params_nested_path_dup << declared_param.to_s
+            memo[memo_key] = passed_param || handle_passed_param(params_nested_path_dup) do
+              passed_param
+            end
           end
         end
 
@@ -86,7 +95,7 @@ module Grape
           return yield if has_passed_children
 
           key = params_nested_path[0]
-          key += '[' + params_nested_path[1..-1].join('][') + ']' if params_nested_path.size > 1
+          key += "[#{params_nested_path[1..].join('][')}]" if params_nested_path.size > 1
 
           route_options_params = options[:route_options][:params] || {}
           type = route_options_params.dig(key, :type)
@@ -94,7 +103,7 @@ module Grape
 
           if type == 'Hash' && !has_children
             {}
-          elsif type == 'Array' || type&.start_with?('[') && !type&.include?(',')
+          elsif type == 'Array' || (type&.start_with?('[') && !type&.include?(','))
             []
           elsif type == 'Set' || type&.start_with?('#<Set')
             Set.new
@@ -117,6 +126,7 @@ module Grape
                             end
 
           raise ArgumentError, 'Tried to filter for declared parameters but none exist.' unless declared_params
+
           declared_params
         end
       end
@@ -187,11 +197,13 @@ module Grape
         case status
         when Symbol
           raise ArgumentError, "Status code :#{status} is invalid." unless Rack::Utils::SYMBOL_TO_STATUS_CODE.key?(status)
+
           @status = Rack::Utils.status_code(status)
         when Integer
           @status = status
         when nil
           return @status if instance_variable_defined?(:@status) && @status
+
           case request.request_method.to_s.upcase
           when Grape::Http::Headers::POST
             201
@@ -369,6 +381,7 @@ module Grape
           representation = (body || {}).merge(key => representation)
         elsif entity_class.present? && body
           raise ArgumentError, "Representation of type #{representation.class} cannot be merged." unless representation.respond_to?(:merge)
+
           representation = body.merge(representation)
         end
 

data/lib/grape/dsl/middleware.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module Grape
   module DSL
     module Middleware
@@ -18,28 +16,28 @@ module Grape
         #   to inject.
         def use(middleware_class, *args, &block)
           arr = [:use, middleware_class, *args]
-          arr << block if block_given?
+          arr << block if block
 
           namespace_stackable(:middleware, arr)
         end
 
         def insert(*args, &block)
           arr = [:insert, *args]
-          arr << block if block_given?
+          arr << block if block
 
           namespace_stackable(:middleware, arr)
         end
 
         def insert_before(*args, &block)
           arr = [:insert_before, *args]
-          arr << block if block_given?
+          arr << block if block
 
           namespace_stackable(:middleware, arr)
         end
 
         def insert_after(*args, &block)
           arr = [:insert_after, *args]
-          arr << block if block_given?
+          arr << block if block
 
           namespace_stackable(:middleware, arr)
         end

data/lib/grape/dsl/parameters.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module Grape
   module DSL
     # Defines DSL methods, meant to be applied to a ParamsScope, which define
@@ -64,7 +62,12 @@ module Grape
           params_block = named_params.fetch(name) do
             raise "Params :#{name} not found!"
           end
-          instance_exec(options, &params_block)
+
+          if options.empty?
+            instance_exec(options, &params_block)
+          else
+            instance_exec(**options, &params_block)
+          end
         end
       end
       alias use_scope use
@@ -133,7 +136,7 @@ module Grape
           require_required_and_optional_fields(attrs.first, opts)
         else
           validate_attributes(attrs, opts, &block)
-          block_given? ? new_scope(orig_attrs, &block) : push_declared_params(attrs, **opts.slice(:as))
+          block ? new_scope(orig_attrs, &block) : push_declared_params(attrs, **opts.slice(:as))
         end
       end
 
@@ -149,9 +152,9 @@ module Grape
         opts = @group.merge(opts) if instance_variable_defined?(:@group) && @group
 
         # check type for optional parameter group
-        if attrs && block_given?
-          raise Grape::Exceptions::MissingGroupTypeError.new if type.nil?
-          raise Grape::Exceptions::UnsupportedGroupTypeError.new unless Grape::Validations::Types.group?(type)
+        if attrs && block
+          raise Grape::Exceptions::MissingGroupType if type.nil?
+          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)
         end
 
         if opts[:using]
@@ -159,7 +162,7 @@ module Grape
         else
           validate_attributes(attrs, opts, &block)
 
-          block_given? ? new_scope(orig_attrs, true, &block) : push_declared_params(attrs, **opts.slice(:as))
+          block ? new_scope(orig_attrs, true, &block) : push_declared_params(attrs, **opts.slice(:as))
         end
       end
 
@@ -219,8 +222,8 @@ module Grape
         else
           # @declared_params also includes hashes of options and such, but those
           # won't be flattened out.
-          @declared_params.flatten.any? do |declared_param|
-            first_hash_key_or_param(declared_param) == param
+          @declared_params.flatten.any? do |declared_param_attr|
+            first_hash_key_or_param(declared_param_attr.key) == param
           end
         end
       end

data/lib/grape/dsl/request_response.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module Grape
   module DSL
     module RequestResponse
@@ -26,6 +24,7 @@ module Grape
             # define a single mime type
             mime_type = content_types[new_format.to_sym]
             raise Grape::Exceptions::MissingMimeType.new(new_format) unless mime_type
+
             namespace_stackable(:content_types, new_format.to_sym => mime_type)
           else
             namespace_inheritable(:format)
@@ -102,14 +101,13 @@ module Grape
         def rescue_from(*args, &block)
           if args.last.is_a?(Proc)
             handler = args.pop
-          elsif block_given?
+          elsif block
             handler = block
           end
 
           options = args.extract_options!
-          if block_given? && options.key?(:with)
-            raise ArgumentError, 'both :with option and block cannot be passed'
-          end
+          raise ArgumentError, 'both :with option and block cannot be passed' if block && options.key?(:with)
+
           handler ||= extract_with(options)
 
           if args.include?(:all)
@@ -127,7 +125,7 @@ module Grape
                 :base_only_rescue_handlers
               end
 
-            namespace_reverse_stackable handler_type, Hash[args.map { |arg| [arg, handler] }]
+            namespace_reverse_stackable(handler_type, args.to_h { |arg| [arg, handler] })
           end
 
           namespace_stackable(:rescue_options, options)
@@ -154,7 +152,8 @@ module Grape
         # @param model_class [Class] The model class that will be represented.
         # @option options [Class] :with The entity class that will represent the model.
         def represent(model_class, options)
-          raise Grape::Exceptions::InvalidWithOptionForRepresent.new unless options[:with] && options[:with].is_a?(Class)
+          raise Grape::Exceptions::InvalidWithOptionForRepresent.new unless options[:with].is_a?(Class)
+
           namespace_stackable(:representations, model_class => options[:with])
         end
 
@@ -162,9 +161,11 @@ module Grape
 
         def extract_with(options)
           return unless options.key?(:with)
+
           with_option = options.delete(:with)
           return with_option if with_option.instance_of?(Proc)
           return with_option.to_sym if with_option.instance_of?(Symbol) || with_option.instance_of?(String)
+
           raise ArgumentError, "with: #{with_option.class}, expected Symbol, String or Proc"
         end
       end

data/lib/grape/dsl/routing.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module Grape
   module DSL
     module Routing
@@ -38,7 +36,7 @@ module Grape
 
             @versions = versions | requested_versions
 
-            if block_given?
+            if block
               within_namespace do
                 namespace_inheritable(:version, requested_versions)
                 namespace_inheritable(:version_options, options)
@@ -79,6 +77,10 @@ module Grape
           namespace_inheritable(:do_not_route_options, true)
         end
 
+        def do_not_document!
+          namespace_inheritable(:do_not_document, true)
+        end
+
         def mount(mounts, *opts)
           mounts = { mounts => '/' } unless mounts.respond_to?(:each_pair)
           mounts.each_pair do |app, path|
@@ -166,7 +168,7 @@ module Grape
         def namespace(space = nil, options = {}, &block)
           @namespace_description = nil unless instance_variable_defined?(:@namespace_description) && @namespace_description
 
-          if space || block_given?
+          if space || block
             within_namespace do
               previous_namespace_description = @namespace_description
               @namespace_description = (@namespace_description || {}).deep_merge(namespace_setting(:description) || {})