grape 1.0.1 → 1.0.2

data/lib/grape/dsl/routing.rb

@@ -136,7 +136,7 @@ module Grape
           reset_validations!
         end
 
-        %w(get post put head delete options patch).each do |meth|
+        %w[get post put head delete options patch].each do |meth|
           define_method meth do |*args, &block|
             options = args.extract_options!
             paths = args.first || ['/']

data/lib/grape/dsl/settings.rb

@@ -165,13 +165,13 @@ module Grape
 
       private
 
-      # Builds the current class :inheritable_setting. If available, it returns the superclass's :inheritable_setting.
-      # Otherwise, a clean :inheritable_setting is returned.
+      # Builds the current class :inheritable_setting. If available, it inherits from
+      # the superclass's :inheritable_setting.
       def build_top_level_setting
-        if defined?(superclass) && superclass.respond_to?(:inheritable_setting) && superclass != Grape::API
-          superclass.inheritable_setting
-        else
-          Grape::Util::InheritableSetting.new
+        Grape::Util::InheritableSetting.new.tap do |setting|
+          if defined?(superclass) && superclass.respond_to?(:inheritable_setting) && superclass != Grape::API
+            setting.inherit_from superclass.inheritable_setting
+          end
         end
       end
     end

data/lib/grape/endpoint.rb

@@ -44,7 +44,7 @@ module Grape
       # @return [Proc]
       # @raise [NameError] an instance method with the same name already exists
       def generate_api_method(method_name, &block)
-        if instance_methods.include?(method_name.to_sym) || instance_methods.include?(method_name.to_s)
+        if method_defined?(method_name)
           raise NameError.new("method #{method_name.inspect} already exists and cannot be used as an unbound method name")
         end
 

data/lib/grape/exceptions/incompatible_option_values.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class IncompatibleOptionValues < Base

data/lib/grape/exceptions/invalid_accept_header.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class InvalidAcceptHeader < Base

data/lib/grape/exceptions/invalid_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class InvalidFormatter < Base

data/lib/grape/exceptions/invalid_message_body.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class InvalidMessageBody < Base

data/lib/grape/exceptions/invalid_version_header.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class InvalidVersionHeader < Base

data/lib/grape/exceptions/invalid_versioner_option.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class InvalidVersionerOption < Base

data/lib/grape/exceptions/invalid_with_option_for_represent.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class InvalidWithOptionForRepresent < Base

data/lib/grape/exceptions/method_not_allowed.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class MethodNotAllowed < Base

data/lib/grape/exceptions/missing_group_type.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class MissingGroupTypeError < Base

data/lib/grape/exceptions/missing_mime_type.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class MissingMimeType < Base

data/lib/grape/exceptions/missing_option.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class MissingOption < Base

data/lib/grape/exceptions/missing_vendor_option.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class MissingVendorOption < Base

data/lib/grape/exceptions/unknown_options.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class UnknownOptions < Base

data/lib/grape/exceptions/unknown_parameter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class UnknownParameter < Base

data/lib/grape/exceptions/unknown_validator.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class UnknownValidator < Base

data/lib/grape/exceptions/unsupported_group_type.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Grape
   module Exceptions
     class UnsupportedGroupTypeError < Base

data/lib/grape/namespace.rb

@@ -1,6 +1,6 @@
 module Grape
   # A container for endpoints or other namespaces, which allows for both
-  # logical grouping of endpoints as well as sharing commonconfiguration.
+  # logical grouping of endpoints as well as sharing common configuration.
   # May also be referred to as group, segment, or resource.
   class Namespace
     attr_reader :space, :options

data/lib/grape/router.rb

@@ -104,6 +104,8 @@ module Grape
       ) if neighbor && method == 'OPTIONS' && !cascade
 
       route = match?(input, '*')
+      return neighbor.endpoint.call(env) if neighbor && cascade && route
+
       if route
         response = process_route(route, env)
         return response if response && !(cascade = cascade?(response))

data/lib/grape/router/pattern.rb

@@ -5,7 +5,7 @@ module Grape
   class Router
     class Pattern
       DEFAULT_PATTERN_OPTIONS   = { uri_decode: true, type: :grape }.freeze
-      DEFAULT_SUPPORTED_CAPTURE = [:format, :version].freeze
+      DEFAULT_SUPPORTED_CAPTURE = %i[format version].freeze
 
       attr_reader :origin, :path, :capture, :pattern
 

data/lib/grape/router/route.rb

@@ -8,7 +8,7 @@ module Grape
     class Route
       ROUTE_ATTRIBUTE_REGEXP = /route_([_a-zA-Z]\w*)/
       SOURCE_LOCATION_REGEXP = /^(.*?):(\d+?)(?::in `.+?')?$/
-      FIXED_NAMED_CAPTURES = %w(format version).freeze
+      FIXED_NAMED_CAPTURES = %w[format version].freeze
 
       attr_accessor :pattern, :translator, :app, :index, :regexp, :options
 
@@ -32,19 +32,19 @@ module Grape
         ROUTE_ATTRIBUTE_REGEXP.match(method_id.to_s)
       end
 
-      [
-        :prefix,
-        :version,
-        :settings,
-        :format,
-        :description,
-        :http_codes,
-        :headers,
-        :entity,
-        :details,
-        :requirements,
-        :request_method,
-        :namespace
+      %i[
+        prefix
+        version
+        settings
+        format
+        description
+        http_codes
+        headers
+        entity
+        details
+        requirements
+        request_method
+        namespace
       ].each do |method_name|
         define_method method_name do
           attributes.public_send method_name

data/lib/grape/validations/params_scope.rb

@@ -39,8 +39,7 @@ module Grape
       # @return [Boolean] whether or not this entire scope needs to be
       #   validated
       def should_validate?(parameters)
-        return false if @optional && (params(parameters).blank? ||
-                                       any_element_blank?(parameters))
+        return false if @optional && (params(parameters).blank? || all_element_blank?(parameters))
 
         return true if parent.nil?
         parent.should_validate?(parameters)
@@ -441,8 +440,8 @@ module Grape
         validations[type].respond_to?(:key?) && validations[type].key?(key) && !validations[type][key].nil?
       end
 
-      def any_element_blank?(parameters)
-        params(parameters).respond_to?(:any?) && params(parameters).any?(&:blank?)
+      def all_element_blank?(parameters)
+        params(parameters).respond_to?(:all?) && params(parameters).all?(&:blank?)
       end
     end
   end

data/lib/grape/validations/types.rb

@@ -1,5 +1,6 @@
 require_relative 'types/build_coercer'
 require_relative 'types/custom_type_coercer'
+require_relative 'types/custom_type_collection_coercer'
 require_relative 'types/multiple_type_coercer'
 require_relative 'types/variant_collection_coercer'
 require_relative 'types/json'
@@ -143,7 +144,8 @@ module Grape
       end
 
       # A valid custom type must implement a class-level `parse` method, taking
-      #   one String argument and returning the parsed value in its correct type.
+      # one String argument and returning the parsed value in its correct type.
+      #
       # @param type [Class] type to check
       # @return [Boolean] whether or not the type can be used as a custom type
       def self.custom?(type)
@@ -155,6 +157,17 @@ module Grape
           type.respond_to?(:parse) &&
           type.method(:parse).arity == 1
       end
+
+      # Is the declared type an +Array+ or +Set+ of a {#custom?} type?
+      #
+      # @param type [Array<Class>,Class] type to check
+      # @return [Boolean] true if +type+ is a collection of a type that implements
+      #   its own +#parse+ method.
+      def self.collection_of_custom?(type)
+        (type.is_a?(Array) || type.is_a?(Set)) &&
+          type.length == 1 &&
+          custom?(type.first)
+      end
     end
   end
 end

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

@@ -51,6 +51,14 @@ module Grape
         elsif method || Types.custom?(type)
           converter_options[:coercer] = Types::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)
+          converter_options[:coercer] = Types::CustomTypeCollectionCoercer.new(
+            type.first, type.is_a?(Set)
+          )
+
         # Grape swaps in its own Virtus::Attribute implementations
         # for certain special types that merit first-class support
         # (but not if a custom coercion method has been supplied).

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

@@ -137,7 +137,7 @@ module Grape
             # passed, or if the type also implements a parse() method.
             type
           elsif type.is_a?(Enumerable)
-            ->(value) { value.all? { |item| item.is_a? type[0] } }
+            ->(value) { value.respond_to?(:all?) && value.all? { |item| item.is_a? type[0] } }
           else
             # By default, do a simple type check
             ->(value) { value.is_a? type }

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

@@ -0,0 +1,71 @@
+module Grape
+  module Validations
+    module Types
+      # Instances of this class may be passed to
+      # +Virtus::Attribute.build+ as the +:coercer+
+      # option, to handle collections of types that
+      # provide their own parsing (and optionally,
+      # type-checking) functionality.
+      #
+      # See {CustomTypeCoercer} for details on types
+      # that will be supported by this by this coercer.
+      # This coercer works in the same way as +CustomTypeCoercer+
+      # except that it expects to receive an array of strings to
+      # coerce and will return an array (or optionally, a set)
+      # of coerced values.
+      #
+      # +CustomTypeCoercer+ is already capable of providing type
+      # checking for arrays where an independent coercion method
+      # is supplied. As such, +CustomTypeCollectionCoercer+ does
+      # not allow for such a method to be supplied independently
+      # of the type.
+      class CustomTypeCollectionCoercer < CustomTypeCoercer
+        # A new coercer for collections of the given type.
+        #
+        # @param type [Class,#parse]
+        #   type to which items in the array should be coerced.
+        #   Must implement a +parse+ method which accepts a string,
+        #   and for the purposes of type-checking it may either be
+        #   a class, or it may implement a +coerced?+, +parsed?+ or
+        #   +call+ method (in that order of precedence) which
+        #   accepts a single argument and returns true if the given
+        #   array item has been coerced correctly.
+        # @param set [Boolean]
+        #   when true, a +Set+ will be returned by {#call} instead
+        #   of an +Array+ and duplicate items will be discarded.
+        def initialize(type, set = false)
+          super(type)
+          @set = set
+        end
+
+        # This method is called from somewhere within
+        # +Virtus::Attribute::coerce+ in order to coerce
+        # the given value.
+        #
+        # @param value [Array<String>] an array of values to be coerced
+        # @return [Array,Set] the coerced result. May be an +Array+ or a
+        #   +Set+ depending on the setting given to the constructor
+        def call(value)
+          coerced = value.map { |item| super(item) }
+
+          @set ? Set.new(coerced) : coerced
+        end
+
+        # This method is called from somewhere within
+        # +Virtus::Attribute::value_coerced?+ in order to assert
+        # that the all of the values in the array have been coerced
+        # successfully.
+        #
+        # @param primitive [Axiom::Types::Type] primitive type for
+        #   the coercion as deteced by axiom-types' inference system.
+        # @param value [Enumerable] a coerced result returned from {#call}
+        # @return [true,false] whether or not all of the coerced values in
+        #   the collection satisfy type requirements.
+        def success?(primitive, value)
+          value.is_a?(@set ? Set : Array) &&
+            value.all? { |item| super(primitive, item) }
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module Grape
         value = params[attr_name]
         value = value.strip if value.respond_to?(:strip)
 
-        return if false == value || value.present?
+        return if value == false || value.present?
 
         raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:blank)
       end

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

@@ -38,6 +38,7 @@ module Grape
         attributes = AttributesIterator.new(self, @scope, params)
         array_errors = []
         attributes.each do |resource_params, attr_name|
+          next if !@scope.required? && resource_params.empty?
           next unless @required || (resource_params.respond_to?(:key?) && resource_params.key?(attr_name))
           next unless @scope.meets_dependency?(resource_params, params)
 

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

@@ -16,6 +16,7 @@ module Grape
 
       def validate_param!(attr_name, params)
         raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:coerce) unless params.is_a? Hash
+        return unless requires_coercion?(params[attr_name])
         new_value = coerce_value(params[attr_name])
         raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:coerce) unless valid_type?(new_value)
         params[attr_name] = new_value
@@ -63,6 +64,11 @@ module Grape
       def type
         @option[:type].is_a?(Hash) ? @option[:type][:value] : @option[:type]
       end
+
+      def requires_coercion?(value)
+        # JSON types do not require coercion if value is valid
+        !valid_type?(value) || converter.coercer.respond_to?(:method) && !converter.is_a?(Grape::Validations::Types::Json)
+      end
     end
   end
 end

data/lib/grape/version.rb

@@ -1,4 +1,4 @@
 module Grape
   # The current version of Grape.
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'.freeze
 end

data/spec/grape/api_spec.rb

@@ -209,7 +209,7 @@ describe Grape::API do
       expect(last_response.body).to eq('outer')
     end
 
-    %w(group resource resources segment).each do |als|
+    %w[group resource resources segment].each do |als|
       it "`.#{als}` is an alias" do
         inner_namespace = nil
         subject.send(als, :awesome) do
@@ -318,7 +318,7 @@ describe Grape::API do
         end
 
         context 'when array of versions provided' do
-          let(:version) { %w(v1 v2) }
+          let(:version) { %w[v1 v2] }
 
           it { versioned_get '/', 'v1', using: :path }
           it { versioned_get '/', 'v2', using: :path }
@@ -333,7 +333,7 @@ describe Grape::API do
       end
 
       it 'header versioned APIs with multiple headers' do
-        subject.version %w(v1 v2), using: :header, vendor: 'test'
+        subject.version %w[v1 v2], using: :header, vendor: 'test'
         subject.enable_root_route!
 
         versioned_get '/', 'v1', using: :header, vendor: 'test'
@@ -421,7 +421,7 @@ describe Grape::API do
     end
 
     it 'allows for multiple verbs' do
-      subject.route([:get, :post], '/abc') do
+      subject.route(%i[get post], '/abc') do
         'hiya'
       end
 
@@ -435,7 +435,7 @@ describe Grape::API do
       expect(last_response.body).to eql 'hiya'
     end
 
-    [:put, :post].each do |verb|
+    %i[put post].each do |verb|
       context verb do
         ['string', :symbol, 1, -1.1, {}, [], true, false, nil].each do |object|
           it "allows a(n) #{object.class} json object in params" do
@@ -473,14 +473,14 @@ describe Grape::API do
     end
 
     it 'allows for multipart paths' do
-      subject.route([:get, :post], '/:id/first') do
+      subject.route(%i[get post], '/:id/first') do
         'first'
       end
 
-      subject.route([:get, :post], '/:id') do
+      subject.route(%i[get post], '/:id') do
         'ola'
       end
-      subject.route([:get, :post], '/:id/first/second') do
+      subject.route(%i[get post], '/:id/first/second') do
         'second'
       end
 
@@ -501,7 +501,7 @@ describe Grape::API do
         'lol'
       end
 
-      %w(get post put delete options patch).each do |m|
+      %w[get post put delete options patch].each do |m|
         send(m, '/abc')
         expect(last_response.body).to eql 'lol'
       end
@@ -538,7 +538,7 @@ describe Grape::API do
       expect(last_response.body).to eql 'catch-all'
     end
 
-    verbs = %w(post get head delete put options patch)
+    verbs = %w[post get head delete put options patch]
     verbs.each do |verb|
       it "allows and properly constrain a #{verb.upcase} method" do
         subject.send(verb, '/example') do
@@ -2393,7 +2393,7 @@ XML
         expect(subject.version).to eq('v2')
       end
       it 'returns versions' do
-        expect(subject.versions).to eq(%w(v1 v2))
+        expect(subject.versions).to eq(%w[v1 v2])
       end
       it 'sets route paths' do
         expect(subject.routes.size).to be >= 2
@@ -3129,6 +3129,16 @@ XML
         get '/two/v1/world'
         expect(last_response.status).to eq 200
       end
+
+      context 'when mounting class extends a subclass of Grape::API' do
+        it 'mounts APIs with the same superclass' do
+          base_api = Class.new(Grape::API)
+          a = Class.new(base_api)
+          b = Class.new(base_api)
+
+          expect { a.mount b }.to_not raise_error
+        end
+      end
     end
   end
 
@@ -3368,7 +3378,7 @@ XML
       end
       it 'array' do
         subject.get '/example' do
-          %w(example1 example2)
+          %w[example1 example2]
         end
         get '/example'
         expect(last_response.status).to eq(200)