1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
|
require 'rack/mount/multimap'
require 'rack/mount/route'
require 'rack/mount/utils'
module Rack::Mount
class RoutingError < StandardError; end
class RouteSet
# Initialize a new RouteSet without optimizations
def self.new_without_optimizations(options = {}, &block)
new(options.merge(:_optimize => false), &block)
end
# Basic RouteSet initializer.
#
# If a block is given, the set is yielded and finalized.
#
# See other aspects for other valid options:
# - <tt>Generation::RouteSet.new</tt>
# - <tt>Recognition::RouteSet.new</tt>
def initialize(options = {}, &block)
@parameters_key = options.delete(:parameters_key) || 'rack.routing_args'
@parameters_key.freeze
@named_routes = {}
@recognition_key_analyzer = Analysis::Splitting.new
@generation_keys = [:controller, :action]
@generation_route_keys = []
@request_class = options.delete(:request_class) || Rack::Request
@valid_conditions = @request_class.public_instance_methods.map! { |m| m.to_sym }
extend CodeGeneration unless options[:_optimize] == false
@optimized_recognize_defined = false
@routes = []
expire!
if block_given?
yield self
rehash
end
end
# Builder method to add a route to the set
#
# <tt>app</tt>:: A valid Rack app to call if the conditions are met.
# <tt>conditions</tt>:: A hash of conditions to match against.
# Conditions may be expressed as strings or
# regexps to match against.
# <tt>defaults</tt>:: A hash of values that always gets merged in
# <tt>name</tt>:: Symbol identifier for the route used with named
# route generations
def add_route(app, conditions = {}, defaults = {}, name = nil)
unless conditions.is_a?(Hash)
raise ArgumentError, 'conditions must be a Hash'
end
unless conditions.all? { |method, pattern|
@valid_conditions.include?(method)
}
raise ArgumentError, 'conditions may only include ' +
@valid_conditions.inspect
end
route = Route.new(app, conditions, defaults, name)
@routes << route
@recognition_key_analyzer << route.conditions
@named_routes[route.name] = route if route.name
@generation_route_keys << route.generation_keys
expire!
route
end
def recognize(obj)
raise 'route set not finalized' unless @recognition_graph
cache = {}
keys = @recognition_keys.map { |key|
if key.respond_to?(:call)
key.call(cache, obj)
else
obj.send(key)
end
}
@recognition_graph[*keys].each do |route|
matches = {}
params = route.defaults.dup
if route.conditions.all? { |method, condition|
value = obj.send(method)
if condition.is_a?(Regexp) && (m = value.match(condition))
matches[method] = m
captures = m.captures
route.named_captures[method].each do |k, i|
if v = captures[i]
params[k] = v
end
end
true
elsif value == condition
true
else
false
end
}
if block_given?
yield route, matches, params
else
return route, matches, params
end
end
end
nil
end
X_CASCADE = 'X-Cascade'.freeze
PASS = 'pass'.freeze
PATH_INFO = 'PATH_INFO'.freeze
# Rack compatible recognition and dispatching method. Routes are
# tried until one returns a non-catch status code. If no routes
# match, then catch status code is returned.
#
# This method can only be invoked after the RouteSet has been
# finalized.
def call(env)
raise 'route set not finalized' unless @recognition_graph
env[PATH_INFO] = Utils.normalize_path(env[PATH_INFO])
request = nil
req = @request_class.new(env)
recognize(req) do |route, matches, params|
# TODO: We only want to unescape params from uri related methods
params.each { |k, v| params[k] = Utils.unescape_uri(v) if v.is_a?(String) }
if route.prefix?
env[Prefix::KEY] = matches[:path_info].to_s
end
old_params = env[@parameters_key]
env[@parameters_key] = (old_params || {}).merge(params)
result = route.app.call(env)
if result[1][X_CASCADE] == PASS
env[@parameters_key] = old_params
else
return result
end
end
request || [404, {'Content-Type' => 'text/html', 'X-Cascade' => 'pass'}, ['Not Found']]
end
# Generates a url from Rack env and identifiers or significant keys.
#
# To generate a url by named route, pass the name in as a +Symbol+.
# url(env, :dashboard) # => "/dashboard"
#
# Additional parameters can be passed in as a hash
# url(env, :people, :id => "1") # => "/people/1"
#
# If no named route is given, it will fall back to a slower
# generation search.
# url(env, :controller => "people", :action => "show", :id => "1")
# # => "/people/1"
def url(env, *args)
named_route, params = nil, {}
case args.length
when 2
named_route, params = args[0], args[1].dup
when 1
if args[0].is_a?(Hash)
params = args[0].dup
else
named_route = args[0]
end
else
raise ArgumentError
end
only_path = params.delete(:only_path)
recall = env[@parameters_key] || {}
unless result = generate(:all, named_route, params, recall,
:parameterize => lambda { |name, param| Utils.escape_uri(param) })
return
end
parts, params = result
return unless parts
params.each do |k, v|
if v
params[k] = v
else
params.delete(k)
end
end
req = stubbed_request_class.new(env)
req._stubbed_values = parts.merge(:query_string => Utils.build_nested_query(params))
only_path ? req.fullpath : req.url
end
def generate(method, *args) #:nodoc:
raise 'route set not finalized' unless @generation_graph
method = nil if method == :all
named_route, params, recall, options = extract_params!(*args)
merged = recall.merge(params)
route = nil
if named_route
if route = @named_routes[named_route.to_sym]
recall = route.defaults.merge(recall)
url = route.generate(method, params, recall, options)
[url, params]
else
raise RoutingError, "#{named_route} failed to generate from #{params.inspect}"
end
else
keys = @generation_keys.map { |key|
if k = merged[key]
k.to_s
else
nil
end
}
@generation_graph[*keys].each do |r|
next unless r.significant_params?
if url = r.generate(method, params, recall, options)
return [url, params]
end
end
raise RoutingError, "No route matches #{params.inspect}"
end
end
# Number of routes in the set
def length
@routes.length
end
def rehash #:nodoc:
Utils.debug "rehashing"
@recognition_keys = build_recognition_keys
@recognition_graph = build_recognition_graph
@generation_graph = build_generation_graph
self
end
# Finalizes the set and builds optimized data structures. You *must*
# freeze the set before you can use <tt>call</tt> and <tt>url</tt>.
# So remember to call freeze after you are done adding routes.
def freeze
unless frozen?
rehash
stubbed_request_class
@recognition_key_analyzer = nil
@generation_route_keys = nil
@valid_conditions = nil
@routes.each { |route| route.freeze }
@routes.freeze
end
super
end
protected
def recognition_stats
{ :keys => @recognition_keys,
:keys_size => @recognition_keys.size,
:graph_size => @recognition_graph.size,
:graph_height => @recognition_graph.height,
:graph_average_height => @recognition_graph.average_height }
end
private
def expire! #:nodoc:
@recognition_keys = @recognition_graph = nil
@recognition_key_analyzer.expire!
@generation_graph = nil
end
# An internal helper method for constructing a nested set from
# the linear route set.
#
# build_nested_route_set([:request_method, :path_info]) { |route, method|
# route.send(method)
# }
def build_nested_route_set(keys, &block)
graph = Multimap.new
@routes.each_with_index do |route, index|
catch(:skip) do
k = keys.map { |key| block.call(key, index) }
Utils.pop_trailing_blanks!(k)
k.map! { |key| key || /.*/ }
graph[*k] = route
end
end
graph
end
def build_recognition_graph
build_nested_route_set(@recognition_keys) { |k, i|
@recognition_key_analyzer.possible_keys[i][k]
}
end
def build_recognition_keys
keys = @recognition_key_analyzer.report
Utils.debug "recognition keys - #{keys.inspect}"
keys
end
def build_generation_graph
build_nested_route_set(@generation_keys) { |k, i|
throw :skip unless @routes[i].significant_params?
if k = @generation_route_keys[i][k]
k.to_s
else
nil
end
}
end
def extract_params!(*args)
case args.length
when 4
named_route, params, recall, options = args
when 3
if args[0].is_a?(Hash)
params, recall, options = args
else
named_route, params, recall = args
end
when 2
if args[0].is_a?(Hash)
params, recall = args
else
named_route, params = args
end
when 1
if args[0].is_a?(Hash)
params = args[0]
else
named_route = args[0]
end
else
raise ArgumentError
end
named_route ||= nil
params ||= {}
recall ||= {}
options ||= {}
[named_route, params.dup, recall.dup, options.dup]
end
def stubbed_request_class
@stubbed_request_class ||= begin
klass = Class.new(@request_class)
klass.public_instance_methods.each do |method|
next if method =~ /^__|object_id/
klass.class_eval <<-RUBY
def #{method}(*args, &block)
@_stubbed_values[:#{method}] || super
end
RUBY
end
klass.class_eval { attr_accessor :_stubbed_values }
klass
end
end
end
end
|