Class: Merb::Router

Inherits:
Object show all
Defined in:
lib/merb-core/dispatch/router.rb,
lib/merb-core/dispatch/router/route.rb,
lib/merb-core/dispatch/router/behavior.rb,
lib/merb-core/dispatch/router/cached_proc.rb

Overview

Router stores route definitions and finds first that matches incoming request URL.

Then information from route is used by dispatcher to call action on the controller.

Routes compilation.

Most interesting method of Router (and heart of route matching machinery) is match method generated on fly from routes definitions. It is called routes compilation. Generated match method body contains one if/elsif statement that picks first matching route definition and sets values to named parameters of the route.

Compilation is synchronized by mutex.

Defined Under Namespace

Classes: Behavior, CachedProc, Route

Constant Summary collapse

SEGMENT_REGEXP = 
/(:([a-z_][a-z0-9_]*|:))/
SEGMENT_REGEXP_WITH_BRACKETS = 
/(:[a-z_]+)(\[(\d+)\])?/
JUST_BRACKETS = 
/\[(\d+)\]/
PARENTHETICAL_SEGMENT_STRING = 
"([^\/.,;?]+)".freeze
@@named_routes = 
{}
@@routes = 
[]
@@compiler_mutex = 
Mutex.new

Class Method Summary collapse

Class Method Details

.append(&block) ⇒ Object

Appends the generated routes to the current routes.

Parameters

&block

A block that generates new routes when yielded a new Behavior.



45
46
47
 
# File 'lib/merb-core/dispatch/router.rb', line 45

def append(&block)
  prepare(@@routes, [], &block)
end

.capture(&block) ⇒ Object

Capture any new routes that have been added within the block.

This utility method lets you track routes that have been added; it doesn’t affect how/which routes are added.

&block

A context in which routes are generated.



80
81
82
83
84
 
# File 'lib/merb-core/dispatch/router.rb', line 80

def capture(&block)
  routes_before, named_route_keys_before = self.routes.dup, self.named_routes.keys
  yield
  [self.routes - routes_before, self.named_routes.except(*named_route_keys_before)]
end

.compile ⇒ Object

Defines the match function for this class based on the compiled_statement.



102
103
104
105
 
# File 'lib/merb-core/dispatch/router.rb', line 102

def compile
  puts "compiled route: #{compiled_statement}" if $DEBUG
  eval(compiled_statement, binding, "Generated Code for Router#match(#{__FILE__}:#{__LINE__})", 1)
end

.compiled_statement ⇒ Object

Returns

String

A routing lambda statement generated from the routes.



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/merb-core/dispatch/router.rb', line 88

def compiled_statement
  @@compiler_mutex.synchronize do
    @@compiled_statement = "def match(request)\n"
    @@compiled_statement << "  params = request.params\n"
    @@compiled_statement << "  cached_path = request.path\n  cached_method = request.method.to_s\n  "
    @@routes.each_with_index { |route, i| @@compiled_statement << route.compile(i == 0) }
    @@compiled_statement << "  else\n    [nil, {}]\n"
    @@compiled_statement << "  end\n"
    @@compiled_statement << "end"
  end
end

.generate(name, params = {}, fallback = {}) ⇒ Object

Generates a URL based on passed options.

Parameters

name<~to_sym, Hash>

The name of the route to generate.

params<Hash, Fixnum, Object>

The params to use in the route generation.

fallback<Hash>

Parameters for generating a fallback URL.

Returns

String

The generated URL.

Alternatives

If name is a hash, it will be merged with params and passed on to generate_for_default_route along with fallback.



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/merb-core/dispatch/router.rb', line 120

def generate(name, params = {}, fallback = {})
  params.reject! { |k,v| v.nil? } if params.is_a? Hash
  if name.is_a? Hash
    name.reject! { |k,v| v.nil? }
    return generate_for_default_route(name.merge(params), fallback)
  end
  name = name.to_sym
  unless @@named_routes.key? name
    raise "Named route not found: #{name}"
  else
    @@named_routes[name].generate(params, fallback)
  end
end

.generate_for_default_route(params, fallback) ⇒ Object

Generates a URL based on the default route scheme of “/:controller/:action/:id.:format”.

Parameters

params<Hash>

The primary parameters to create the route from (see below).

fallback<Hash>

Fallback parameters. Same options as params.

Options (params)

:controller<~to_s>

The controller name. Required.

:action<~to_s>

The action name. Required.

:id<~to_s>

The ID for use in the action.

:format<~to_s>

The format of the preferred response.

Returns

String

The generated URL.



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
 
# File 'lib/merb-core/dispatch/router.rb', line 150

def generate_for_default_route(params, fallback)
  query_params = params.reject do |k,v|
    [:controller, :action, :id, :format].include?(k.to_sym)
  end

  controller = params[:controller] || fallback[:controller]
  raise "Controller Not Specified" unless controller
  url = "/#{controller}"

  if params[:action] || params[:id] || params[:format] || !query_params.empty?
    action = params[:action] || fallback[:action]
    raise "Action Not Specified" unless action
    url += "/#{action}"
  end
  if params[:id]
    url += "/#{params[:id]}"
  end
  if format = params[:format]
    format = fallback[:format] if format == :current
    url += ".#{format}"
  end
  unless query_params.empty?
    url += "?" + Merb::Request.params_to_query_string(query_params)
  end
  url
end

.prepare(first = [], last = []) {|Behavior.new({}, { :action => 'index' })| ... } ⇒ Object

Prepares new routes and adds them to existing routes.

Parameters

first<Array>

An array of routes to add before the generated routes.

last<Array>

An array of routes to add after the generated routes.

&block

A block that generates new routes.

Block parameters (&block)

new_behavior<Behavior>

Behavior for child routes.

Yields:

  • (Behavior.new({}, { :action => 'index' })) 


67
68
69
70
71
72
 
# File 'lib/merb-core/dispatch/router.rb', line 67

def prepare(first = [], last = [], &block)
  @@routes = []
  yield Behavior.new({}, { :action => 'index' }) # defaults
  @@routes = first + @@routes + last
  compile
end

.prepend(&block) ⇒ Object

Prepends the generated routes to the current routes.

Parameters

&block

A block that generates new routes when yielded a new Behavior.



54
55
56
 
# File 'lib/merb-core/dispatch/router.rb', line 54

def prepend(&block)
  prepare([], @@routes, &block)
end

.reset! ⇒ Object

Clear all routes.



36
37
38
 
# File 'lib/merb-core/dispatch/router.rb', line 36

def reset!
  self.routes, self.named_routes = [], {}
end