grape 4.0.0 → 4.1.0

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      # Rejects an element that is not a Hash in an Array param given a block,
+      # which ParamsScope registers this for: the block declares the keys of
+      # each element, and an element with no keys cannot hold any of them.
+      # Without it, an element like +"x"+ or a nested Array only failed where
+      # the block required a key of it, so a block of optional params let
+      # anything through.
+      #
+      # An Array whose elements are all blank is passed over, as the block's
+      # own validators pass over an optional scope whose elements are all
+      # blank. Otherwise a blank element is not a Hash either. Elements are
+      # scrubbed first, since String#blank? raises on bytes their encoding
+      # does not allow.
+      class HashElementsValidator < Base
+        default_message_key :coerce
+
+        # Registered not required, so it is only asked about params that are a
+        # Hash (see Base#validate!).
+        def validate_param!(attr_name, params)
+          elements = params[attr_name]
+          return unless elements.is_a?(Array)
+          return if elements.all? { |element| Grape::Util::Scrub.blank?(element) }
+
+          index = elements.index { |element| !hash_like?(element) }
+          validation_error!(["#{scope.full_name(attr_name)}[#{index}]"]) if index
+        end
+      end
+    end
+  end
+end

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

@@ -12,9 +12,7 @@ module Grape
           validate_boundary!(:max, @max)
           raise ArgumentError, "min `#{@min}` cannot be greater than max `#{@max}`" if @min && @max && @min > @max
 
-          return if @is.nil?
-          raise ArgumentError, 'is must be an integer greater than zero' unless @is.is_a?(Integer) && @is.positive?
-          raise ArgumentError, 'is cannot be combined with min or max' unless @min.nil? && @max.nil?
+          validate_is! unless @is.nil?
         end
 
         def validate_param!(attr_name, params)
@@ -23,24 +21,34 @@ module Grape
           param = params[attr_name]
 
           return unless param.respond_to?(:length)
+          return if within_bounds?(param.length)
 
-          return unless (!@min.nil? && param.length < @min) || (!@max.nil? && param.length > @max) || (!@is.nil? && param.length != @is)
-
-          validation_error!(attr_name, message do
-            if @min && @max
-              translate(:length, min: @min, max: @max)
-            elsif @min
-              translate(:length_min, min: @min)
-            elsif @max
-              translate(:length_max, max: @max)
-            else
-              translate(:length_is, is: @is)
-            end
-          end)
+          validation_error!(attr_name, message { length_message })
         end
 
         private
 
+        def validate_is!
+          raise ArgumentError, 'is must be an integer greater than zero' unless @is.is_a?(Integer) && @is.positive?
+          raise ArgumentError, 'is cannot be combined with min or max' unless @min.nil? && @max.nil?
+        end
+
+        def within_bounds?(length)
+          (@min.nil? || length >= @min) && (@max.nil? || length <= @max) && (@is.nil? || length == @is)
+        end
+
+        def length_message
+          if @min && @max
+            translate(:length, min: @min, max: @max)
+          elsif @min
+            translate(:length_min, min: @min)
+          elsif @max
+            translate(:length_max, max: @max)
+          else
+            translate(:length_is, is: @is)
+          end
+        end
+
         def validate_boundary!(name, val)
           raise ArgumentError, "`#{name}` must be an integer greater than or equal to zero" if !val.nil? && (!val.is_a?(Integer) || val.negative?)
         end

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

@@ -18,10 +18,6 @@ module Grape
 
         private
 
-        def iterator_class
-          MultipleAttributesIterator
-        end
-
         def keys_in_common(resource_params, known_keys = all_keys)
           return [] unless hash_like?(resource_params)
 

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

@@ -12,12 +12,13 @@ module Grape
 
           # Zero-arity procs return a collection per-request (e.g. DB-backed lists).
           # Non-zero-arity procs are per-element predicates, called directly at validation time.
-          # Non-Proc values are wrapped in a zero-arity lambda for a uniform call interface.
+          # Anything else is the collection itself, held as it came rather than
+          # behind a lambda that would only hand it back.
           if values.is_a?(Proc)
             @values_call = values
             @values_is_predicate = !values.arity.zero?
           else
-            @values_call = -> { values }
+            @values = values
             @values_is_predicate = false
           end
         end
@@ -27,8 +28,8 @@ module Grape
 
           val = scrub(params[attr_name])
 
-          return if val.nil? && !required_for_root_scope?
-          return if val != false && val.blank? && allow_blank?
+          return if val.nil? && !required?
+          return if blank_and_allowed?(val)
           return if check_values?(val, attr_name)
 
           validation_error!(attr_name)
@@ -36,31 +37,24 @@ module Grape
 
         private
 
+        # +false+ is a value: AS's +blank?+ says otherwise.
+        def blank_and_allowed?(val)
+          val != false && val.blank? && allow_blank?
+        end
+
         def check_values?(val, attr_name)
           param_array = val.nil? ? [nil] : Array.wrap(val)
+          return predicate_holds?(param_array, attr_name) if @values_is_predicate
 
-          if @values_is_predicate
-            begin
-              param_array.all? { |param| @values_call.call(param) }
-            rescue StandardError => e
-              warn "Error '#{e}' raised while validating attribute '#{attr_name}'"
-              false
-            end
-          else
-            values = @values_call.call
-            return true if values.nil?
-
-            param_array.all? { |param| values.include?(param) }
-          end
+          values = @values_call ? @values_call.call : @values
+          values.nil? || param_array.all? { |param| values.include?(param) }
         end
 
-        def required_for_root_scope?
-          return false unless required?
-
-          current_scope = scope
-          current_scope = current_scope.parent while current_scope.lateral?
-
-          current_scope.root?
+        def predicate_holds?(param_array, attr_name)
+          param_array.all? { |param| @values_call.call(param) }
+        rescue StandardError => e
+          warn "Error '#{e}' raised while validating attribute '#{attr_name}'"
+          false
         end
       end
     end

data/lib/grape/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module Grape
-  # The current version of Grape.
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

data/lib/grape.rb

@@ -61,6 +61,9 @@ module Grape
   # 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
+  # Let an exception raised inside a `rescue_from` block propagate out of the
+  # middleware stack instead of being redispatched.
+  setting :raise_rescue_handler_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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Michael Bleigh
@@ -123,6 +123,7 @@ files:
 - lib/grape/dsl/inside_route.rb
 - lib/grape/dsl/logger.rb
 - lib/grape/dsl/middleware.rb
+- lib/grape/dsl/mounting.rb
 - lib/grape/dsl/parameters.rb
 - lib/grape/dsl/request_response.rb
 - lib/grape/dsl/rescue_options.rb
@@ -130,17 +131,21 @@ files:
 - lib/grape/dsl/settings.rb
 - lib/grape/dsl/validations.rb
 - lib/grape/dsl/version_options.rb
+- lib/grape/dsl/versioning.rb
 - lib/grape/endpoint.rb
 - lib/grape/endpoint/options.rb
+- lib/grape/endpoint/state.rb
 - lib/grape/env.rb
 - lib/grape/error_formatter.rb
 - lib/grape/error_formatter/base.rb
 - lib/grape/error_formatter/json.rb
+- lib/grape/error_formatter/jsonl.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
 - lib/grape/exceptions/error_response.rb
+- lib/grape/exceptions/halt.rb
 - lib/grape/exceptions/incompatible_option_values.rb
 - lib/grape/exceptions/internal_server_error.rb
 - lib/grape/exceptions/invalid_accept_header.rb
@@ -167,6 +172,9 @@ files:
 - lib/grape/formatter.rb
 - lib/grape/formatter/base.rb
 - lib/grape/formatter/json.rb
+- lib/grape/formatter/jsonl.rb
+- lib/grape/formatter/markdown.rb
+- lib/grape/formatter/md.rb
 - lib/grape/formatter/serializable_hash.rb
 - lib/grape/formatter/txt.rb
 - lib/grape/formatter/xml.rb
@@ -198,6 +206,7 @@ files:
 - lib/grape/parser.rb
 - lib/grape/parser/base.rb
 - lib/grape/parser/json.rb
+- lib/grape/parser/jsonl.rb
 - lib/grape/parser/xml.rb
 - lib/grape/path.rb
 - lib/grape/precompiled_json.rb
@@ -211,6 +220,7 @@ files:
 - lib/grape/router/pattern.rb
 - lib/grape/router/pattern/path.rb
 - lib/grape/router/route.rb
+- lib/grape/router/route_buckets.rb
 - lib/grape/serve_stream/file_body.rb
 - lib/grape/serve_stream/sendfile_response.rb
 - lib/grape/serve_stream/stream_response.rb
@@ -225,12 +235,10 @@ files:
 - lib/grape/util/lazy/base.rb
 - lib/grape/util/lazy/block.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/path_normalizer.rb
 - lib/grape/util/registry.rb
+- lib/grape/util/scrub.rb
 - lib/grape/util/shadowed_rescue_handlers.rb
 - lib/grape/util/stackable_values.rb
 - lib/grape/util/translation.rb
@@ -238,13 +246,11 @@ files:
 - lib/grape/validations/attributes_iterator.rb
 - lib/grape/validations/coerce_options.rb
 - lib/grape/validations/contract_scope.rb
-- lib/grape/validations/multiple_attributes_iterator.rb
 - lib/grape/validations/oneof_collector.rb
 - lib/grape/validations/param_scope_tracker.rb
 - lib/grape/validations/params_documentation.rb
 - lib/grape/validations/params_scope.rb
 - lib/grape/validations/shared_options.rb
-- lib/grape/validations/single_attribute_iterator.rb
 - lib/grape/validations/types.rb
 - lib/grape/validations/types/array_coercer.rb
 - lib/grape/validations/types/custom_type_coercer.rb
@@ -268,6 +274,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/hash_elements_validator.rb
 - lib/grape/validations/validators/length_validator.rb
 - lib/grape/validations/validators/multiple_params_base.rb
 - lib/grape/validations/validators/mutually_exclusive_validator.rb
@@ -283,9 +290,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v4.0.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/4.0.0
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v4.0.0
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v4.1.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/4.1.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v4.1.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -294,14 +301,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.3'
+      version: 3.3.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
 test_files: []

data/lib/grape/util/lazy/value_array.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    module Lazy
-      class ValueArray < ValueEnumerable
-        def initialize(array)
-          super
-          @value_hash = []
-          array.each_with_index do |value, index|
-            self[index] = value
-          end
-        end
-
-        def evaluate
-          @value_hash.map(&:evaluate)
-        end
-      end
-    end
-  end
-end

data/lib/grape/util/lazy/value_enumerable.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    module Lazy
-      class ValueEnumerable < Value
-        def [](key)
-          return Value.new(nil).reached_by(access_keys, key) if @value_hash[key].nil?
-
-          @value_hash[key].reached_by(access_keys, key)
-        end
-
-        def fetch(access_keys)
-          access_keys.reduce(self) { |node, key| node[key] }
-        end
-
-        def []=(key, value)
-          value_class = case value
-                        when Hash
-                          ValueHash
-                        when Array
-                          ValueArray
-                        else
-                          Value
-                        end
-          @value_hash[key] = value_class.new(value)
-        end
-      end
-    end
-  end
-end

data/lib/grape/util/lazy/value_hash.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    module Lazy
-      class ValueHash < ValueEnumerable
-        def initialize(hash)
-          super
-          @value_hash = ActiveSupport::HashWithIndifferentAccess.new
-          hash.each do |key, value|
-            self[key] = value
-          end
-        end
-
-        def evaluate
-          @value_hash.transform_values(&:evaluate)
-        end
-      end
-    end
-  end
-end

data/lib/grape/validations/multiple_attributes_iterator.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class MultipleAttributesIterator < AttributesIterator
-      private
-
-      def yield_attributes(resource_params)
-        yield resource_params unless skip?(resource_params)
-      end
-    end
-  end
-end

data/lib/grape/validations/single_attribute_iterator.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class SingleAttributeIterator < AttributesIterator
-      private
-
-      def yield_attributes(val)
-        return if skip?(val)
-
-        # The emptiness of the scope's params is the same answer for every
-        # attribute in it, and answering it costs a +respond_to?+, so it is
-        # asked once for the whole list rather than once per attribute.
-        empty_val = empty?(val)
-        @attrs.each { |attr_name| yield val, attr_name, empty_val }
-      end
-
-      # Primitives like Integers and Booleans don't respond to +empty?+.
-      # It could be possible to use +blank?+ instead, but
-      #
-      #     false.blank?
-      #     => true
-      def empty?(val)
-        val.respond_to?(:empty?) ? val.empty? : val.nil?
-      end
-    end
-  end
-end