Class: ActionDispatch::Routing::RouteSet

Inherits:
Object
  • Object
show all
Defined in:
actionpack/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


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

def initialize(request_class = ActionDispatch::Request)
  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
  @valid_conditions = {}

  request_class.public_instance_methods.each { |m|
    @valid_conditions[m.to_sym] = true
  }
  @valid_conditions[:controller] = true
  @valid_conditions[:action] = true

  self.valid_conditions.delete(:id)

  @append                     = []
  @prepend                    = []
  @disable_clear_and_finalize = false
  @finalized                  = false

  @set    = Journey::Routes.new
  @router = Journey::Router.new(@set, {
    :parameters_key => PARAMETERS_KEY,
    :request_class  => request_class})
  @formatter = Journey::Formatter.new @set
end

Instance Attribute Details

#default_scopeObject

Returns the value of attribute default_scope


220
221
222
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 220

def default_scope
  @default_scope
end

#default_url_optionsObject

Returns the value of attribute default_url_options


222
223
224
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 222

def default_url_options
  @default_url_options
end

#disable_clear_and_finalizeObject

Returns the value of attribute disable_clear_and_finalize


221
222
223
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 221

def disable_clear_and_finalize
  @disable_clear_and_finalize
end

#formatterObject

Returns the value of attribute formatter


220
221
222
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 220

def formatter
  @formatter
end

#named_routesObject

Returns the value of attribute named_routes


220
221
222
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 220

def named_routes
  @named_routes
end

#request_classObject

Returns the value of attribute request_class


222
223
224
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 222

def request_class
  @request_class
end

#resources_path_namesObject

Returns the value of attribute resources_path_names


221
222
223
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 221

def resources_path_names
  @resources_path_names
end

#routerObject

Returns the value of attribute router


220
221
222
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 220

def router
  @router
end

#setObject Also known as: routes

Returns the value of attribute set


220
221
222
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 220

def set
  @set
end

#valid_conditionsObject

Returns the value of attribute valid_conditions


222
223
224
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 222

def valid_conditions
  @valid_conditions
end

Class Method Details

.default_resources_path_namesObject


226
227
228
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 226

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

Instance Method Details

#_generate_prefix(options = {}) ⇒ Object


567
568
569
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 567

def _generate_prefix(options = {})
  nil
end

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

Raises:

  • (ArgumentError)

362
363
364
365
366
367
368
369
370
371
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 362

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)

  path = build_path(conditions.delete(:path_info), requirements, SEPARATORS, anchor)
  conditions = build_conditions(conditions, valid_conditions, path.names.map { |x| x.to_sym })

  route = @set.add_route(app, path, conditions, defaults, name)
  named_routes[name] = route if name
  route
end

#append(&block) ⇒ Object


265
266
267
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 265

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

#call(env) ⇒ Object


598
599
600
601
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 598

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

#clear!Object


292
293
294
295
296
297
298
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 292

def clear!
  @finalized = false
  named_routes.clear
  set.clear
  formatter.clear
  @prepend.each { |blk| eval_block(blk) }
end

#define_mounted_helper(name) ⇒ Object


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 312

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


258
259
260
261
262
263
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 258

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

#empty?Boolean

Returns:

  • (Boolean)

358
359
360
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 358

def empty?
  routes.empty?
end

#eval_block(block) ⇒ Object


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

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/"
  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.


552
553
554
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 552

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

#finalize!Object


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

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

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


560
561
562
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 560

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

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


556
557
558
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 556

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

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


300
301
302
303
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 300

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_helpersObject


308
309
310
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 308

def mounted_helpers
  MountedHelpers
end

#prepend(&block) ⇒ Object


269
270
271
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 269

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

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


603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 603

def recognize_path(path, environment = {})
  method = (environment[:method] || "GET").to_s.upcase
  path = Journey::Router::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)
  @router.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


571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 571

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
  params.merge!(options[:params] || {})

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

#url_helpersObject


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

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