grape 0.9.0 → 0.10.0

data/lib/grape.rb

@@ -7,11 +7,19 @@ require 'rack/auth/basic'
 require 'rack/auth/digest/md5'
 require 'hashie'
 require 'set'
+require 'active_support/version'
 require 'active_support/core_ext/hash/indifferent_access'
+
+if ActiveSupport::VERSION::MAJOR >= 4
+  require 'active_support/core_ext/object/deep_dup'
+else
+  require_relative 'backports/active_support/deep_dup'
+end
+
 require 'active_support/ordered_hash'
 require 'active_support/core_ext/object/conversions'
 require 'active_support/core_ext/array/extract_options'
-require 'grape/util/deep_merge'
+require 'active_support/core_ext/hash/deep_merge'
 require 'grape/util/content_types'
 require 'multi_json'
 require 'multi_xml'
@@ -92,11 +100,16 @@ module Grape
   end
 
   module Util
-    autoload :HashStack,         'grape/util/hash_stack'
+    autoload :InheritableValues, 'grape/util/inheritable_values'
+    autoload :StackableValues,   'grape/util/stackable_values'
+    autoload :InheritableSetting, 'grape/util/inheritable_setting'
+    autoload :StrictHashConfiguration, 'grape/util/strict_hash_configuration'
   end
 
   module DSL
+    autoload :API,               'grape/dsl/api'
     autoload :Callbacks,         'grape/dsl/callbacks'
+    autoload :Settings,          'grape/dsl/settings'
     autoload :Configuration,     'grape/dsl/configuration'
     autoload :InsideRoute,       'grape/dsl/inside_route'
     autoload :Helpers,           'grape/dsl/helpers'
@@ -112,4 +125,18 @@ module Grape
   end
 end
 
+require 'grape/validations/validators/base'
+require 'grape/validations/attributes_iterator'
+require 'grape/validations/validators/allow_blank'
+require 'grape/validations/validators/at_least_one_of'
+require 'grape/validations/validators/coerce'
+require 'grape/validations/validators/default'
+require 'grape/validations/validators/exactly_one_of'
+require 'grape/validations/validators/mutual_exclusion'
+require 'grape/validations/validators/presence'
+require 'grape/validations/validators/regexp'
+require 'grape/validations/validators/values'
+require 'grape/validations/params_scope'
+require 'grape/validations/validators/all_or_none'
+
 require 'grape/version'

data/lib/grape/api.rb

@@ -3,23 +3,13 @@ module Grape
   # creating Grape APIs.Users should subclass this
   # class in order to build an API.
   class API
-    extend Grape::Middleware::Auth::DSL
-
-    include Grape::DSL::Validations
-    include Grape::DSL::Callbacks
-    include Grape::DSL::Configuration
-    include Grape::DSL::Helpers
-    include Grape::DSL::Middleware
-    include Grape::DSL::RequestResponse
-    include Grape::DSL::Routing
+    include Grape::DSL::API
 
     class << self
       attr_reader :instance
-
       LOCK = Mutex.new
 
       def reset!
-        @settings  = Grape::Util::HashStack.new
         @route_set = Rack::Mount::RouteSet.new
         @endpoints = []
         @routes = nil
@@ -45,36 +35,21 @@ module Grape
 
       # Create a scope without affecting the URL.
       #
-      # @param name [Symbol] Purely placebo, just allows to to name the scope to make the code more readable.
+      # @param name [Symbol] Purely placebo, just allows to name the scope to make the code more readable.
       def scope(name = nil, &block)
-        nest(block)
+        within_namespace do
+          nest(block)
+        end
       end
 
       def cascade(value = nil)
         if value.nil?
-          settings.key?(:cascade) ? !!settings[:cascade] : true
+          inheritable_setting.namespace_inheritable.keys.include?(:cascade) ? !!namespace_inheritable(:cascade) : true
         else
-          set(:cascade, value)
+          namespace_inheritable(:cascade, value)
         end
       end
 
-      # Set a configuration value for this namespace.
-      #
-      # @param key [Symbol] The key of the configuration variable.
-      # @param value [Object] The value to which to set the configuration variable.
-      def set(key, value)
-        settings[key.to_sym] = value
-      end
-
-      # Add to a configuration value for this
-      # namespace.
-      #
-      # @param key [Symbol] The key of the configuration variable.
-      # @param value [Object] The value to which to set the configuration variable.
-      def imbue(key, value)
-        settings.imbue(key, value)
-      end
-
       protected
 
       def prepare_routes
@@ -89,12 +64,10 @@ module Grape
       # block passed in. Allows for simple 'before' setups
       # of settings stack pushes.
       def nest(*blocks, &block)
-        blocks.reject! { |b| b.nil? }
+        blocks.reject!(&:nil?)
         if blocks.any?
-          settings.push  # create a new context to eval the follow
           instance_eval(&block) if block_given?
           blocks.each { |b| instance_eval(&b) }
-          settings.pop # when finished, we pop the context
           reset_validations!
         else
           instance_eval(&block)
@@ -106,12 +79,12 @@ module Grape
         subclass.logger = logger.clone
       end
 
-      def inherit_settings(other_stack)
-        settings.prepend other_stack
-        endpoints.each do |e|
-          e.settings.prepend(other_stack)
-          e.options[:app].inherit_settings(other_stack) if e.options[:app].respond_to?(:inherit_settings, true)
-        end
+      def inherit_settings(other_settings)
+        top_level_setting.inherit_from other_settings.point_in_time_copy
+
+        endpoints.each(&:reset_routes!)
+
+        @routes = nil
       end
     end
 
@@ -121,6 +94,7 @@ module Grape
       self.class.endpoints.each do |endpoint|
         endpoint.mount_in(@route_set)
       end
+
       @route_set.freeze
     end
 
@@ -139,8 +113,8 @@ module Grape
     # errors from reaching upstream. This is effectivelly done by unsetting
     # X-Cascade. Default :cascade is true.
     def cascade?
-      return !!self.class.settings[:cascade] if self.class.settings.key?(:cascade)
-      return !!self.class.settings[:version_options][:cascade] if self.class.settings[:version_options] && self.class.settings[:version_options].key?(:cascade)
+      return !!self.class.namespace_inheritable(:cascade) if self.class.inheritable_setting.namespace_inheritable.keys.include?(:cascade)
+      return !!self.class.namespace_inheritable(:version_options)[:cascade] if self.class.namespace_inheritable(:version_options) && self.class.namespace_inheritable(:version_options).key?(:cascade)
       true
     end
 
@@ -154,6 +128,7 @@ module Grape
     # cannot handle.
     def add_head_not_allowed_methods_and_options_methods
       methods_per_path = {}
+
       self.class.endpoints.each do |endpoint|
         routes = endpoint.routes
         routes.each do |route|
@@ -166,39 +141,58 @@ module Grape
       # contain already versioning information when using path versioning.
       # Disable versioning so adding a route won't prepend versioning
       # informations again.
-      without_versioning do
-        methods_per_path.each do |path, methods|
-          allowed_methods = methods.dup
-          unless self.class.settings[:do_not_route_head]
-            allowed_methods |= ['HEAD'] if allowed_methods.include?('GET')
-          end
+      without_root_prefix do
+        without_versioning do
+          methods_per_path.each do |path, methods|
+            allowed_methods = methods.dup
+            unless self.class.namespace_inheritable(:do_not_route_head)
+              allowed_methods |= ['HEAD'] if allowed_methods.include?('GET')
+            end
 
-          allow_header = (['OPTIONS'] | allowed_methods).join(', ')
-          unless self.class.settings[:do_not_route_options]
-            unless allowed_methods.include?('OPTIONS')
-              self.class.options(path, {}) do
-                header 'Allow', allow_header
-                status 204
-                ''
+            allow_header = (['OPTIONS'] | allowed_methods).join(', ')
+            unless self.class.namespace_inheritable(:do_not_route_options)
+              unless allowed_methods.include?('OPTIONS')
+                self.class.options(path, {}) do
+                  header 'Allow', allow_header
+                  status 204
+                  ''
+                end
               end
             end
-          end
 
-          not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - allowed_methods
-          not_allowed_methods << 'OPTIONS' if self.class.settings[:do_not_route_options]
-          self.class.route(not_allowed_methods, path) do
-            header 'Allow', allow_header
-            status 405
-            ''
+            not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - allowed_methods
+            not_allowed_methods << 'OPTIONS' if self.class.namespace_inheritable(:do_not_route_options)
+            self.class.route(not_allowed_methods, path) do
+              header 'Allow', allow_header
+              status 405
+              ''
+            end
           end
         end
       end
     end
 
     def without_versioning(&block)
-      self.class.settings.push(version: nil, version_options: nil)
+      old_version = self.class.namespace_inheritable(:version)
+      old_version_options = self.class.namespace_inheritable(:version_options)
+
+      self.class.namespace_inheritable_to_nil(:version)
+      self.class.namespace_inheritable_to_nil(:version_options)
+
       yield
-      self.class.settings.pop
+
+      self.class.namespace_inheritable(:version, old_version)
+      self.class.namespace_inheritable(:version_options, old_version_options)
+    end
+
+    def without_root_prefix(&block)
+      old_prefix = self.class.namespace_inheritable(:root_prefix)
+
+      self.class.namespace_inheritable_to_nil(:root_prefix)
+
+      yield
+
+      self.class.namespace_inheritable(:root_prefix, old_prefix)
     end
   end
 end

data/lib/grape/dsl/api.rb

@@ -0,0 +1,19 @@
+require 'active_support/concern'
+
+module Grape
+  module DSL
+    module API
+      extend ActiveSupport::Concern
+
+      include Grape::Middleware::Auth::DSL
+
+      include Grape::DSL::Validations
+      include Grape::DSL::Callbacks
+      include Grape::DSL::Configuration
+      include Grape::DSL::Helpers
+      include Grape::DSL::Middleware
+      include Grape::DSL::RequestResponse
+      include Grape::DSL::Routing
+    end
+  end
+end

data/lib/grape/dsl/callbacks.rb

@@ -5,21 +5,23 @@ module Grape
     module Callbacks
       extend ActiveSupport::Concern
 
+      include Grape::DSL::Configuration
+
       module ClassMethods
         def before(&block)
-          imbue(:befores, [block])
+          namespace_stackable(:befores, block)
         end
 
         def before_validation(&block)
-          imbue(:before_validations, [block])
+          namespace_stackable(:before_validations, block)
         end
 
         def after_validation(&block)
-          imbue(:after_validations, [block])
+          namespace_stackable(:after_validations, block)
         end
 
         def after(&block)
-          imbue(:afters, [block])
+          namespace_stackable(:afters, block)
         end
       end
     end

data/lib/grape/dsl/configuration.rb

@@ -7,19 +7,63 @@ module Grape
 
       module ClassMethods
         attr_writer :logger
-        attr_reader :settings
+
+        include Grape::DSL::Settings
 
         def logger(logger = nil)
           if logger
-            @logger = logger
+            global_setting(:logger, logger)
           else
-            @logger ||= Logger.new($stdout)
+            global_setting(:logger) || global_setting(:logger, Logger.new($stdout))
           end
         end
 
         # Add a description to the next namespace or function.
-        def desc(description, options = {})
-          @last_description = options.merge(description: description)
+        def desc(description, options = {}, &config_block)
+          if block_given?
+            config_class = Grape::DSL::Configuration.desc_container
+
+            config_class.configure do
+              description description
+            end
+
+            config_class.configure(&config_block)
+            options = config_class.settings
+          else
+            options = options.merge(description: description)
+          end
+
+          namespace_setting :description, options
+          route_setting :description, options
+        end
+      end
+
+      module_function
+
+      def stacked_hash_to_hash(settings)
+        return nil if settings.nil? || settings.blank?
+        settings.each_with_object(ActiveSupport::OrderedHash.new) { |value, result| result.deep_merge!(value) }
+      end
+
+      def desc_container
+        Module.new do
+          include Grape::Util::StrictHashConfiguration.module(
+                      :description,
+                      :detail,
+                      :params,
+                      :entity,
+                      :http_codes,
+                      :named,
+                      :headers
+          )
+
+          def config_context.success(*args)
+            entity(*args)
+          end
+
+          def config_context.failure(*args)
+            http_codes(*args)
+          end
         end
       end
     end

data/lib/grape/dsl/helpers.rb

@@ -4,6 +4,7 @@ module Grape
   module DSL
     module Helpers
       extend ActiveSupport::Concern
+      include Grape::DSL::Configuration
 
       module ClassMethods
         # Add helper methods that will be accessible from any
@@ -27,23 +28,21 @@ module Grape
         #
         def helpers(new_mod = nil, &block)
           if block_given? || new_mod
-            mod = settings.peek[:helpers] || Module.new
+            mod = new_mod || Module.new
             if new_mod
               inject_api_helpers_to_mod(new_mod) if new_mod.is_a?(BaseHelper)
-              mod.class_eval do
-                include new_mod
-              end
             end
             if block_given?
               inject_api_helpers_to_mod(mod) do
                 mod.class_eval(&block)
               end
             end
-            set(:helpers, mod)
+
+            namespace_stackable(:helpers, mod)
           else
             mod = Module.new
-            settings.stack.each do |s|
-              mod.send :include, s[:helpers] if s[:helpers]
+            namespace_stackable(:helpers).each do |mod_to_include|
+              mod.send :include, mod_to_include
             end
             change!
             mod
@@ -77,7 +76,7 @@ module Grape
 
         def process_named_params
           if @named_params && @named_params.any?
-            api.imbue(:named_params, @named_params)
+            api.namespace_stackable(:named_params, @named_params)
           end
         end
       end

data/lib/grape/dsl/inside_route.rb

@@ -4,6 +4,7 @@ module Grape
   module DSL
     module InsideRoute
       extend ActiveSupport::Concern
+      include Grape::DSL::Settings
 
       # A filtering method that will return a hash
       # consisting only of keys that have been declared by a
@@ -18,12 +19,12 @@ module Grape
         options[:include_missing] = true unless options.key?(:include_missing)
         options[:include_parent_namespaces] = true unless options.key?(:include_parent_namespaces)
         if declared_params.nil?
-          declared_params = !options[:include_parent_namespaces] ? settings[:declared_params] :
-              settings.gather(:declared_params)
+          declared_params = (!options[:include_parent_namespaces] ? route_setting(:declared_params) :
+              (route_setting(:saved_declared_params) || [])).flatten(1) || []
         end
 
         unless declared_params
-          raise ArgumentError, "Tried to filter for declared parameters but none exist."
+          fail ArgumentError, 'Tried to filter for declared parameters but none exist.'
         end
 
         if params.is_a? Array
@@ -36,6 +37,9 @@ module Grape
 
             key.each_pair do |parent, children|
               output_key = options[:stringify] ? parent.to_s : parent.to_sym
+
+              next unless options[:include_missing] || children || params[parent]
+
               if params.key?(parent) || options[:include_missing]
                 hash[output_key] = if children
                                      declared(params[parent] || {}, options, Array(children))
@@ -61,7 +65,7 @@ module Grape
       # @param message [String] The message to display.
       # @param status [Integer] the HTTP Status Code. Defaults to default_error_status, 500 if not set.
       def error!(message, status = nil, headers = nil)
-        self.status(status || settings[:default_error_status])
+        self.status(status || namespace_inheritable(:default_error_status))
         throw :error, message: message, status: self.status, headers: headers
       end
 
@@ -75,14 +79,14 @@ module Grape
         if merged_options[:permanent]
           status 301
         else
-          if env['HTTP_VERSION'] == 'HTTP/1.1' && request.request_method.to_s.upcase != "GET"
+          if env['HTTP_VERSION'] == 'HTTP/1.1' && request.request_method.to_s.upcase != 'GET'
             status 303
           else
             status 302
           end
         end
-        header "Location", url
-        body ""
+        header 'Location', url
+        body ''
       end
 
       # Set or retrieve the HTTP status code.
@@ -146,6 +150,9 @@ module Grape
       def body(value = nil)
         if value
           @body = value
+        elsif value == false
+          @body = ''
+          status 204
         else
           @body
         end
@@ -186,7 +193,12 @@ module Grape
                          end
 
         representation = { root => representation } if root
-        representation = (@body || {}).merge(key => representation) if key
+        if key
+          representation = (@body || {}).merge(key => representation)
+        elsif entity_class.present? && representation.respond_to?('merge')
+          representation = (@body || {}).merge(representation)
+        end
+
         body representation
       end
 
@@ -199,7 +211,7 @@ module Grape
       #     route.route_description
       #   end
       def route
-        env["rack.routing_args"][:route_info]
+        env['rack.routing_args'][:route_info]
       end
 
       def entity_class_for_obj(object, options)
@@ -214,7 +226,7 @@ module Grape
                          end
 
           object_class.ancestors.each do |potential|
-            entity_class ||= (settings[:representations] || {})[potential]
+            entity_class ||= (Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(:representations)) || {})[potential]
           end
 
           entity_class ||= object_class.const_get(:Entity) if object_class.const_defined?(:Entity) && object_class.const_get(:Entity).respond_to?(:represent)