Modify the priority of ANY routes, fixes #1089

Author: namusyaka

CHANGELOG.md

@@ -12,6 +12,7 @@ Next Release
 #### Fixes
 
 * [#1505](https://github.com/ruby-grape/grape/pull/1505): Run `before` and `after` callbacks, but skip the rest when handling OPTIONS - [@jlfaber](https://github.com/jlfaber).
+* [#1517](https://github.com/ruby-grape/grape/pull/1517): Modify the priority of ANY routes, fixes #1089 - [@namusyaka](https://github.com/namusyaka), [@wagenet](https://github.com/wagenet).
 
 0.18.0 (10/7/2016)
 ==================

UPGRADING.md

@@ -3,6 +3,22 @@ Upgrading Grape
 
 ### Upgrading to >= 0.18.1
 
+#### Modify the priority of :any routes
+
+Conventional, the :any routes had been searched after matching first route and 405 routes.
+This version adds the :any routes processing before 405 processing, so the behavior of following code will be changed. 
+
+```ruby
+post :example do
+  'example'
+end
+route :any, '*path' do
+  error! :not_found, 404
+end
+
+get '/example' #=> before: 405, currently: 404
+```
+
 #### Removed param processing from built-in OPTIONS handler
 
 When a request is made to the built-in `OPTIONS` handler, only the `before` and `after`

lib/grape/api.rb

@@ -161,7 +161,7 @@ def add_head_not_allowed_methods_and_options_methods
           route_settings[:endpoint] = route.app
 
           # using the :any shorthand produces [nil] for route methods, substitute all manually
-          route_settings[:methods] = %w(GET PUT POST DELETE PATCH HEAD OPTIONS) if route_settings[:methods].include?('ANY')
+          route_settings[:methods] = %w(GET PUT POST DELETE PATCH HEAD OPTIONS) if route_settings[:methods].include?('*')
         end
       end
 

lib/grape/dsl/routing.rb

@@ -99,6 +99,7 @@ def mount(mounts)
               method: :any,
               path: path,
               app: app,
+              route_options: { anchor: false },
               forward_match: !app.respond_to?(:inheritable_setting),
               for: self
             )
@@ -118,6 +119,7 @@ def mount(mounts)
         #     end
         #   end
         def route(methods, paths = ['/'], route_options = {}, &block)
+          methods = '*' if methods == :any
           endpoint_options = {
             method: methods,
             path: paths,

lib/grape/http/headers.rb

@@ -16,6 +16,8 @@ module Headers
       HEAD    = 'HEAD'.freeze
       OPTIONS = 'OPTIONS'.freeze
 
+      SUPPORTED_METHODS = [GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS].freeze
+
       HTTP_ACCEPT_VERSION    = 'HTTP_ACCEPT_VERSION'.freeze
       X_CASCADE              = 'X-Cascade'.freeze
       HTTP_TRANSFER_ENCODING = 'HTTP_TRANSFER_ENCODING'.freeze

lib/grape/router.rb

@@ -19,6 +19,10 @@ def self.normalize_path(path)
       path
     end
 
+    def self.supported_methods
+      @supported_methods ||= Grape::Http::Headers::SUPPORTED_METHODS + ['*']
+    end
+
     def initialize
       @neutral_map = []
       @map = Hash.new { |hash, key| hash[key] = [] }
@@ -28,7 +32,8 @@ def initialize
     def compile!
       return if compiled
       @union = Regexp.union(@neutral_map.map(&:regexp))
-      map.each do |method, routes|
+      self.class.supported_methods.each do |method|
+        routes = map[method]
         @optimized_map[method] = routes.map.with_index do |route, index|
           route.index = index
           route.regexp = /(?<_#{index}>#{route.pattern.to_regexp})/
@@ -77,7 +82,7 @@ def identity(env)
     def rotation(env, exact_route = nil)
       response = nil
       input, method, routing_args = *extract_required_args(env)
-      routes_for(method).each do |route|
+      map[method].each do |route|
         next if exact_route == route
         next unless route.match?(input)
         env[Grape::Env::GRAPE_ROUTING_ARGS] = make_routing_args(routing_args, route, input)
@@ -92,8 +97,18 @@ def transaction(env)
       response = yield(input, method, routing_args)
 
       return response if response && !(cascade = cascade?(response))
+
       neighbor = greedy_match?(input)
-      return unless neighbor
+
+      if neighbor && method == 'OPTIONS'
+        return (!cascade && neighbor) ? call_with_allow_headers(env, neighbor.allow_header, neighbor.endpoint) : nil
+      end
+
+      if route = match?(input, '*')
+        env[Grape::Env::GRAPE_ROUTING_ARGS] = make_routing_args(routing_args, route, input)
+        response = route.exec(env)
+        return response if response && !(cascade = cascade?(response))
+      end
 
       (!cascade && neighbor) ? call_with_allow_headers(env, neighbor.allow_header, neighbor.endpoint) : nil
     end
@@ -141,10 +156,6 @@ def cascade?(response)
       response && response[1][Grape::Http::Headers::X_CASCADE] == 'pass'
     end
 
-    def routes_for(method)
-      map[method] + map['ANY']
-    end
-
     def string_for(input)
       self.class.normalize_path(input)
     end

lib/grape/router/pattern.rb

@@ -35,7 +35,13 @@ def pattern_options
       end
 
       def build_path(pattern, anchor: false, suffix: nil, **_options)
-        pattern << '*path' unless anchor || pattern.end_with?('*path')
+        unless anchor || pattern.end_with?('*path')
+          pattern << ?/ unless pattern.end_with?(?/)
+          pattern << '*path'
+        end
+        pattern = pattern.split(?/).tap { |parts|
+          parts[parts.length - 1] = ?? + parts.last
+        }.join(?/) if pattern.end_with?('*path')
         pattern + suffix.to_s
       end
 

spec/grape/api_spec.rb

@@ -786,9 +786,6 @@ class DummyFormatClass
         subject.post :example do
           'example'
         end
-        subject.route :any, '*path' do
-          error! :not_found, 404
-        end
         get '/example'
       end