Class: ActionDispatch::Routing::RouteSet

Inherits:
Object
  • Object
show all
Defined in:
lib/action_dispatch/routing/route_set.rb

Overview

:nodoc:

Defined Under Namespace

Modules: MountedHelpers Classes: Dispatcher, Generator, NamedRouteCollection

Constant Summary collapse

PARAMETERS_KEY = 
'action_dispatch.request.path_parameters'
RESERVED_OPTIONS = 
[:host, :protocol, :port, :subdomain, :domain, :tld_length,
:trailing_slash, :anchor, :params, :only_path, :script_name]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_class = ActionDispatch::Request) ⇒ RouteSet

Returns a new instance of RouteSet.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/action_dispatch/routing/route_set.rb', line 222

def initialize(request_class = ActionDispatch::Request)
  self.routes = []
  self.named_routes = NamedRouteCollection.new
  self.resources_path_names = self.class.default_resources_path_names.dup
  self.default_url_options = {}

  self.request_class = request_class
  self.valid_conditions = request_class.public_instance_methods.map { |m| m.to_sym }
  self.valid_conditions.delete(:id)
  self.valid_conditions.push(:controller, :action)

  @append = []
  @prepend = []
  @disable_clear_and_finalize = false
  clear!
end

Instance Attribute Details

#default_scope ⇒ Object

Returns the value of attribute default_scope.



214
215
216
 
# File 'lib/action_dispatch/routing/route_set.rb', line 214

def default_scope
  @default_scope
end

#default_url_options ⇒ Object

Returns the value of attribute default_url_options.



216
217
218
 
# File 'lib/action_dispatch/routing/route_set.rb', line 216

def default_url_options
  @default_url_options
end

#disable_clear_and_finalize ⇒ Object

Returns the value of attribute disable_clear_and_finalize.



215
216
217
 
# File 'lib/action_dispatch/routing/route_set.rb', line 215

def disable_clear_and_finalize
  @disable_clear_and_finalize
end

#named_routes ⇒ Object

Returns the value of attribute named_routes.



214
215
216
 
# File 'lib/action_dispatch/routing/route_set.rb', line 214

def named_routes
  @named_routes
end

#request_class ⇒ Object

Returns the value of attribute request_class.



216
217
218
 
# File 'lib/action_dispatch/routing/route_set.rb', line 216

def request_class
  @request_class
end

#resources_path_names ⇒ Object

Returns the value of attribute resources_path_names.



215
216
217
 
# File 'lib/action_dispatch/routing/route_set.rb', line 215

def resources_path_names
  @resources_path_names
end

#routes ⇒ Object

Returns the value of attribute routes.



214
215
216
 
# File 'lib/action_dispatch/routing/route_set.rb', line 214

def routes
  @routes
end

#set ⇒ Object

Returns the value of attribute set.



214
215
216
 
# File 'lib/action_dispatch/routing/route_set.rb', line 214

def set
  @set
end

#valid_conditions ⇒ Object

Returns the value of attribute valid_conditions.



216
217
218
 
# File 'lib/action_dispatch/routing/route_set.rb', line 216

def valid_conditions
  @valid_conditions
end

Class Method Details

.default_resources_path_names ⇒ Object 



218
219
220
 
# File 'lib/action_dispatch/routing/route_set.rb', line 218

def self.default_resources_path_names
  { :new => 'new', :edit => 'edit' }
end

Instance Method Details

#_generate_prefix(options = {}) ⇒ Object 



506
507
508
 
# File 'lib/action_dispatch/routing/route_set.rb', line 506

def _generate_prefix(options = {})
  nil
end

#add_route(app, conditions = {}, requirements = {}, defaults = {}, name = nil, anchor = true) ⇒ Object

Raises:

  • (ArgumentError) 


348
349
350
351
352
353
354
355
 
# File 'lib/action_dispatch/routing/route_set.rb', line 348

def add_route(app, conditions = {}, requirements = {}, defaults = {}, name = nil, anchor = true)
  raise ArgumentError, "Invalid route name: '#{name}'" unless name.blank? || name.to_s.match(/^[_a-z]\w*$/i)
  route = Route.new(self, app, conditions, requirements, defaults, name, anchor)
  @set.add_route(route.app, route.conditions, route.defaults, route.name)
  named_routes[name] = route if name
  routes << route
  route
end

#append(&block) ⇒ Object 



246
247
248
 
# File 'lib/action_dispatch/routing/route_set.rb', line 246

def append(&block)
  @append << block
end

#call(env) ⇒ Object 



536
537
538
539
 
# File 'lib/action_dispatch/routing/route_set.rb', line 536

def call(env)
  finalize!
  @set.call(env)
end

#clear! ⇒ Object 



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/action_dispatch/routing/route_set.rb', line 275

def clear!
  @finalized = false
  routes.clear
  named_routes.clear
  @set = ::Rack::Mount::RouteSet.new(
    :parameters_key => PARAMETERS_KEY,
    :request_class  => request_class
  )
  @prepend.each { |blk| eval_block(blk) }
end

#define_mounted_helper(name) ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/action_dispatch/routing/route_set.rb', line 298

def define_mounted_helper(name)
  return if MountedHelpers.method_defined?(name)

  routes = self
  MountedHelpers.class_eval do
    define_method "_#{name}" do
      RoutesProxy.new(routes, self._routes_context)
    end
  end

  MountedHelpers.class_eval <<-RUBY
    def #{name}
      @#{name} ||= _#{name}
    end
  RUBY
end

#draw(&block) ⇒ Object 



239
240
241
242
243
244
 
# File 'lib/action_dispatch/routing/route_set.rb', line 239

def draw(&block)
  clear! unless @disable_clear_and_finalize
  eval_block(block)
  finalize! unless @disable_clear_and_finalize
  nil
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


344
345
346
 
# File 'lib/action_dispatch/routing/route_set.rb', line 344

def empty?
  routes.empty?
end

#eval_block(block) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/action_dispatch/routing/route_set.rb', line 254

def eval_block(block)
  if block.arity == 1
    raise "You are using the old router DSL which has been removed in Rails 3.1. " <<
      "Please check how to update your routes file at: http://www.engineyard.com/blog/2010/the-lowdown-on-routes-in-rails-3/ " <<
      "or add the rails_legacy_mapper gem to your Gemfile"
  end
  mapper = Mapper.new(self)
  if default_scope
    mapper.with_default_scope(default_scope, &block)
  else
    mapper.instance_exec(&block)
  end
end

#extra_keys(options, recall = {}) ⇒ Object

Generate the path indicated by the arguments, and return an array of the keys that were not used to generate it.



491
492
493
 
# File 'lib/action_dispatch/routing/route_set.rb', line 491

def extra_keys(options, recall={})
  generate_extras(options, recall).last
end

#finalize! ⇒ Object 



268
269
270
271
272
273
 
# File 'lib/action_dispatch/routing/route_set.rb', line 268

def finalize!
  return if @finalized
  @append.each { |blk| eval_block(blk) }
  @finalized = true
  @set.freeze
end

#generate(options, recall = {}, extras = false) ⇒ Object 



499
500
501
 
# File 'lib/action_dispatch/routing/route_set.rb', line 499

def generate(options, recall = {}, extras = false)
  Generator.new(options, recall, self, extras).generate
end

#generate_extras(options, recall = {}) ⇒ Object 



495
496
497
 
# File 'lib/action_dispatch/routing/route_set.rb', line 495

def generate_extras(options, recall={})
  generate(options, recall, true)
end

#install_helpers(destinations = [ActionController::Base, ActionView::Base], regenerate_code = false) ⇒ Object 



286
287
288
289
 
# File 'lib/action_dispatch/routing/route_set.rb', line 286

def install_helpers(destinations = [ActionController::Base, ActionView::Base], regenerate_code = false)
  Array(destinations).each { |d| d.module_eval { include Helpers } }
  named_routes.install(destinations, regenerate_code)
end

#mounted_helpers ⇒ Object 



294
295
296
 
# File 'lib/action_dispatch/routing/route_set.rb', line 294

def mounted_helpers
  MountedHelpers
end

#prepend(&block) ⇒ Object 



250
251
252
 
# File 'lib/action_dispatch/routing/route_set.rb', line 250

def prepend(&block)
  @prepend << block
end

#recognize_path(path, environment = {}) ⇒ Object

Raises:



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/action_dispatch/routing/route_set.rb', line 541

def recognize_path(path, environment = {})
  method = (environment[:method] || "GET").to_s.upcase
  path = Rack::Mount::Utils.normalize_path(path) unless path =~ %r{://}

  begin
    env = Rack::MockRequest.env_for(path, {:method => method})
  rescue URI::InvalidURIError => e
    raise ActionController::RoutingError, e.message
  end

  req = @request_class.new(env)
  @set.recognize(req) do |route, matches, params|
    params.each do |key, value|
      if value.is_a?(String)
        value = value.dup.force_encoding(Encoding::BINARY) if value.encoding_aware?
        params[key] = URI.parser.unescape(value)
      end
    end

    dispatcher = route.app
    while dispatcher.is_a?(Mapper::Constraints) && dispatcher.matches?(env) do
      dispatcher = dispatcher.app
    end

    if dispatcher.is_a?(Dispatcher) && dispatcher.controller(params, false)
      dispatcher.prepare_params!(params)
      return params
    end
  end

  raise ActionController::RoutingError, "No route matches #{path.inspect}"
end

#url_for(options) ⇒ Object 



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/action_dispatch/routing/route_set.rb', line 510

def url_for(options)
  finalize!
  options = (options || {}).reverse_merge!(default_url_options)

  handle_positional_args(options)

  user, password = extract_authentication(options)
  path_segments  = options.delete(:_path_segments)
  script_name    = options.delete(:script_name)

  path = (script_name.blank? ? _generate_prefix(options) : script_name.chomp('/')).to_s

  path_options = options.except(*RESERVED_OPTIONS)
  path_options = yield(path_options) if block_given?

  path_addition, params = generate(path_options, path_segments || {})
  path << path_addition

  ActionDispatch::Http::URL.url_for(options.merge({
    :path => path,
    :params => params,
    :user => user,
    :password => password
  }))
end

#url_helpers ⇒ Object 



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
 
# File 'lib/action_dispatch/routing/route_set.rb', line 315

def url_helpers
  @url_helpers ||= begin
    routes = self

    helpers = Module.new do
      extend ActiveSupport::Concern
      include UrlFor

      @_routes = routes
      class << self
        delegate :url_for, :to => '@_routes'
      end
      extend routes.named_routes.module

      # ROUTES TODO: install_helpers isn't great... can we make a module with the stuff that
      # we can include?
      # Yes plz - JP
      included do
        routes.install_helpers(self)
        singleton_class.send(:redefine_method, :_routes) { routes }
      end

      define_method(:_routes) { @_routes || routes }
    end

    helpers
  end
end