grape 1.2.4 → 1.2.5

data/lib/grape/api.rb

@@ -6,7 +6,7 @@ module Grape
   # should subclass this class in order to build an API.
   class API
     # 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]).freeze
+    NON_OVERRIDABLE = (Class.new.methods + %i[call call! configuration compile!]).freeze
 
     class << self
       attr_accessor :base_instance, :instances
@@ -42,13 +42,28 @@ module Grape
         end
       end
 
+      # Configure an API from the outside. If a block is given, it'll pass a
+      # configuration hash to the block which you can use to configure your
+      # API. If no block is given, returns the configuration hash.
+      # The configuration set here is accessible from inside an API with
+      # `configuration` as normal.
+      def configure
+        config = @base_instance.configuration
+        if block_given?
+          yield config
+          self
+        else
+          config
+        end
+      end
+
       # This is the interface point between Rack and Grape; it accepts a request
       # from Rack and ultimately returns an array of three values: the status,
       # the headers, and the body. See [the rack specification]
       # (http://www.rubydoc.info/github/rack/rack/master/file/SPEC) for more.
       # NOTE: This will only be called on an API directly mounted on RACK
       def call(*args, &block)
-        base_instance.call(*args, &block)
+        instance_for_rack.call(*args, &block)
       end
 
       # Allows an API to itself be inheritable:
@@ -106,8 +121,21 @@ module Grape
         end
       end
 
+      def compile!
+        require 'grape/eager_load'
+        instance_for_rack.compile! # See API::Instance.compile!
+      end
+
       private
 
+      def instance_for_rack
+        if never_mounted?
+          base_instance
+        else
+          mounted_instances.first
+        end
+      end
+
       # Adds a new stage to the set up require to get a Grape::API up and running
       def add_setup(method, *args, &block)
         setup_step = { method: method, args: args, block: block }
@@ -121,7 +149,13 @@ module Grape
 
       def replay_step_on(instance, setup_step)
         return if skip_immediate_run?(instance, setup_step[:args])
-        instance.send(setup_step[:method], *evaluate_arguments(instance.configuration, *setup_step[:args]), &setup_step[:block])
+        args = evaluate_arguments(instance.configuration, *setup_step[:args])
+        response = instance.send(setup_step[:method], *args, &setup_step[:block])
+        if skip_immediate_run?(instance, [response])
+          response
+        else
+          evaluate_arguments(instance.configuration, response).first
+        end
       end
 
       # Skips steps that contain arguments to be lazily executed (on re-mount time)
@@ -137,7 +171,7 @@ module Grape
       def evaluate_arguments(configuration, *args)
         args.map do |argument|
           if argument.respond_to?(:lazy?) && argument.lazy?
-            configuration.fetch(argument.access_keys).evaluate
+            argument.evaluate_from(configuration)
           elsif argument.is_a?(Hash)
             argument.map { |key, value| [key, evaluate_arguments(configuration, value).first] }.to_h
           elsif argument.is_a?(Array)
@@ -147,6 +181,14 @@ module Grape
           end
         end
       end
+
+      def never_mounted?
+        mounted_instances.empty?
+      end
+
+      def mounted_instances
+        instances - [base_instance]
+      end
     end
   end
 end

data/lib/grape/api/instance.rb

@@ -13,12 +13,11 @@ module Grape
         attr_accessor :configuration
 
         def given(conditional_option, &block)
-          evaluate_as_instance_with_configuration(block) if conditional_option && block_given?
+          evaluate_as_instance_with_configuration(block, lazy: true) if conditional_option && block_given?
         end
 
         def mounted(&block)
-          return if base_instance?
-          evaluate_as_instance_with_configuration(block)
+          evaluate_as_instance_with_configuration(block, lazy: true)
         end
 
         def base=(grape_api)
@@ -61,7 +60,7 @@ module Grape
         # the headers, and the body. See [the rack specification]
         # (http://www.rubydoc.info/github/rack/rack/master/file/SPEC) for more.
         def call(env)
-          LOCK.synchronize { compile } unless instance
+          compile!
           call!(env)
         end
 
@@ -79,9 +78,14 @@ module Grape
           end
         end
 
+        def compile!
+          return if instance
+          LOCK.synchronize { compile unless instance }
+        end
+
         # see Grape::Router#recognize_path
         def recognize_path(path)
-          LOCK.synchronize { compile } unless instance
+          compile!
           instance.router.recognize_path(path)
         end
 
@@ -105,14 +109,21 @@ module Grape
           end
         end
 
-        def evaluate_as_instance_with_configuration(block)
-          value_for_configuration = configuration
-          if value_for_configuration.respond_to?(:lazy?) && value_for_configuration.lazy?
-            self.configuration = value_for_configuration.evaluate
+        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
+            response = instance_eval(&block)
+            self.configuration = value_for_configuration
+            response
+          end
+          if base_instance? && lazy
+            lazy_block
+          else
+            lazy_block.evaluate_from(configuration)
           end
-          response = instance_eval(&block)
-          self.configuration = value_for_configuration
-          response
         end
 
         def inherited(subclass)

data/lib/grape/dsl/desc.rb

@@ -49,8 +49,17 @@ module Grape
       #
       def desc(description, options = {}, &config_block)
         if block_given?
-          configuration = defined?(configuration) && configuration.respond_to?(:evaluate) ? configuration.evaluate : {}
-          config_class = desc_container(configuration)
+          endpoint_configuration = if defined?(configuration)
+                                     # When the instance is mounted - the configuration is executed on mount time
+                                     if configuration.respond_to?(:evaluate)
+                                       configuration.evaluate
+                                     # Within `given` or `mounted blocks` the configuration is already evaluated
+                                     elsif configuration.is_a?(Hash)
+                                       configuration
+                                     end
+                                   end
+          endpoint_configuration ||= {}
+          config_class = desc_container(endpoint_configuration)
 
           config_class.configure do
             description description

data/lib/grape/dsl/validations.rb

@@ -27,10 +27,11 @@ module Grape
           setting = description_field(:params)
           setting ||= description_field(:params, {})
           Array(names).each do |name|
-            setting[name[:full_name].to_s] ||= {}
-            setting[name[:full_name].to_s].merge!(opts)
+            full_name = name[:full_name].to_s
+            setting[full_name] ||= {}
+            setting[full_name].merge!(opts)
 
-            namespace_stackable(:params, name[:full_name].to_s => opts)
+            namespace_stackable(:params, full_name => opts)
           end
         end
       end

data/lib/grape/eager_load.rb

@@ -0,0 +1,18 @@
+Grape.eager_load!
+Grape::Http.eager_load!
+Grape::Exceptions.eager_load!
+Grape::Extensions.eager_load!
+Grape::Extensions::ActiveSupport.eager_load!
+Grape::Extensions::Hashie.eager_load!
+Grape::Middleware.eager_load!
+Grape::Middleware::Auth.eager_load!
+Grape::Middleware::Versioner.eager_load!
+Grape::Util.eager_load!
+Grape::ErrorFormatter.eager_load!
+Grape::Formatter.eager_load!
+Grape::Parser.eager_load!
+Grape::DSL.eager_load!
+Grape::API.eager_load!
+Grape::Presenters.eager_load!
+Grape::ServeFile.eager_load!
+Rack::Head # AutoLoads the Rack::Head

data/lib/grape/endpoint.rb

@@ -200,7 +200,7 @@ module Grape
     end
 
     def merge_route_options(**default)
-      options[:route_options].clone.merge(**default)
+      options[:route_options].clone.merge!(**default)
     end
 
     def map_routes
@@ -353,7 +353,7 @@ module Grape
     def run_validators(validator_factories, request)
       validation_errors = []
 
-      validators = validator_factories.map(&:create_validator)
+      validators = validator_factories.map { |options| Grape::Validations::ValidatorFactory.create_validator(options) }
 
       ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators: validators, request: request) do
         validators.each do |validator|
@@ -363,7 +363,7 @@ module Grape
             validation_errors << e
             break if validator.fail_fast?
           rescue Grape::Exceptions::ValidationArrayErrors => e
-            validation_errors += e.errors
+            validation_errors.concat e.errors
             break if validator.fail_fast?
           end
         end

data/lib/grape/error_formatter.rb

@@ -14,7 +14,7 @@ module Grape
       end
 
       def formatters(options)
-        builtin_formatters.merge(default_elements).merge(options[:error_formatters] || {})
+        builtin_formatters.merge(default_elements).merge!(options[:error_formatters] || {})
       end
 
       def formatter_for(api_format, **options)

data/lib/grape/exceptions/validation_errors.rb

@@ -39,14 +39,16 @@ module Grape
       end
 
       def full_messages
-        map { |attributes, error| full_message(attributes, error) }.uniq
+        messages = map { |attributes, error| full_message(attributes, error) }
+        messages.uniq!
+        messages
       end
 
       private
 
       def full_message(attributes, error)
         I18n.t(
-          'grape.errors.format'.to_sym,
+          'grape.errors.format',
           default: '%{attributes} %{message}',
           attributes: attributes.count == 1 ? translate_attribute(attributes.first) : translate_attributes(attributes),
           message: error.message

data/lib/grape/formatter.rb

@@ -14,7 +14,7 @@ module Grape
       end
 
       def formatters(options)
-        builtin_formmaters.merge(default_elements).merge(options[:formatters] || {})
+        builtin_formmaters.merge(default_elements).merge!(options[:formatters] || {})
       end
 
       def formatter_for(api_format, **options)

data/lib/grape/middleware/auth/base.rb

@@ -4,6 +4,8 @@ module Grape
   module Middleware
     module Auth
       class Base
+        include Helpers
+
         attr_accessor :options, :app, :env
 
         def initialize(app, **options)
@@ -11,10 +13,6 @@ module Grape
           @options = options
         end
 
-        def context
-          env[Grape::Env::API_ENDPOINT]
-        end
-
         def call(env)
           dup._call(env)
         end

data/lib/grape/middleware/base.rb

@@ -3,6 +3,8 @@ require 'grape/dsl/headers'
 module Grape
   module Middleware
     class Base
+      include Helpers
+
       attr_reader :app, :env, :options
       TEXT_HTML = 'text/html'.freeze
 

data/lib/grape/middleware/helpers.rb

@@ -0,0 +1,10 @@
+module Grape
+  module Middleware
+    # Common methods for all types of Grape middleware
+    module Helpers
+      def context
+        env[Grape::Env::API_ENDPOINT]
+      end
+    end
+  end
+end

data/lib/grape/parser.rb

@@ -12,7 +12,7 @@ module Grape
       end
 
       def parsers(options)
-        builtin_parsers.merge(default_elements).merge(options[:parsers] || {})
+        builtin_parsers.merge(default_elements).merge!(options[:parsers] || {})
       end
 
       def parser_for(api_format, **options)

data/lib/grape/util/base_inheritable.rb

@@ -0,0 +1,34 @@
+module Grape
+  module Util
+    # Base for classes which need to operate with own values kept
+    # in the hash and inherited values kept in a Hash-like object.
+    class BaseInheritable
+      attr_accessor :inherited_values
+      attr_accessor :new_values
+
+      # @param inherited_values [Object] An object implementing an interface
+      #   of the Hash class.
+      def initialize(inherited_values = {})
+        @inherited_values = inherited_values
+        @new_values = {}
+      end
+
+      def delete(key)
+        new_values.delete key
+      end
+
+      def initialize_copy(other)
+        super
+        self.inherited_values = other.inherited_values
+        self.new_values = other.new_values.dup
+      end
+
+      def keys
+        combined = inherited_values.keys
+        combined.concat(new_values.keys)
+        combined.uniq!
+        combined
+      end
+    end
+  end
+end

data/lib/grape/util/inheritable_values.rb

@@ -1,14 +1,8 @@
+require_relative 'base_inheritable'
+
 module Grape
   module Util
-    class InheritableValues
-      attr_accessor :inherited_values
-      attr_accessor :new_values
-
-      def initialize(inherited_values = {})
-        self.inherited_values = inherited_values
-        self.new_values = {}
-      end
-
+    class InheritableValues < BaseInheritable
       def [](name)
         values[name]
       end
@@ -17,26 +11,12 @@ module Grape
         new_values[name] = value
       end
 
-      def delete(key)
-        new_values.delete key
-      end
-
       def merge(new_hash)
-        values.merge(new_hash)
-      end
-
-      def keys
-        (new_values.keys + inherited_values.keys).sort.uniq
+        values.merge!(new_hash)
       end
 
       def to_hash
-        values.clone
-      end
-
-      def initialize_copy(other)
-        super
-        self.inherited_values = other.inherited_values
-        self.new_values = other.new_values.dup
+        values
       end
 
       protected

data/lib/grape/util/lazy_block.rb

@@ -0,0 +1,25 @@
+module Grape
+  module Util
+    class LazyBlock
+      def initialize(&new_block)
+        @block = new_block
+      end
+
+      def evaluate_from(configuration)
+        @block.call(configuration)
+      end
+
+      def evaluate
+        @block.call({})
+      end
+
+      def lazy?
+        true
+      end
+
+      def to_s
+        evaluate.to_s
+      end
+    end
+  end
+end