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.



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

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_scope ⇒ Object

Returns the value of attribute default_scope.



209
210
211
 
# File 'lib/action_dispatch/routing/route_set.rb', line 209

def default_scope
  @default_scope
end

#default_url_options ⇒ Object

Returns the value of attribute default_url_options.



211
212
213
 
# File 'lib/action_dispatch/routing/route_set.rb', line 211

def default_url_options
  @default_url_options
end

#disable_clear_and_finalize ⇒ Object

Returns the value of attribute disable_clear_and_finalize.



210
211
212
 
# File 'lib/action_dispatch/routing/route_set.rb', line 210

def disable_clear_and_finalize
  @disable_clear_and_finalize
end

#formatter ⇒ Object

Returns the value of attribute formatter.



209
210
211
 
# File 'lib/action_dispatch/routing/route_set.rb', line 209

def formatter
  @formatter
end

#named_routes ⇒ Object

Returns the value of attribute named_routes.



209
210
211
 
# File 'lib/action_dispatch/routing/route_set.rb', line 209

def named_routes
  @named_routes
end

#request_class ⇒ Object

Returns the value of attribute request_class.



211
212
213
 
# File 'lib/action_dispatch/routing/route_set.rb', line 211

def request_class
  @request_class
end

#resources_path_names ⇒ Object

Returns the value of attribute resources_path_names.



210
211
212
 
# File 'lib/action_dispatch/routing/route_set.rb', line 210

def resources_path_names
  @resources_path_names
end

#router ⇒ Object

Returns the value of attribute router.



209
210
211
 
# File 'lib/action_dispatch/routing/route_set.rb', line 209

def router
  @router
end

#set ⇒ Object Also known as: routes

Returns the value of attribute set.



209
210
211
 
# File 'lib/action_dispatch/routing/route_set.rb', line 209

def set
  @set
end

#valid_conditions ⇒ Object

Returns the value of attribute valid_conditions.



211
212
213
 
# File 'lib/action_dispatch/routing/route_set.rb', line 211

def valid_conditions
  @valid_conditions
end

Class Method Details

.default_resources_path_names ⇒ Object 



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

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

Instance Method Details

#_generate_prefix(options = {}) ⇒ Object 



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

def _generate_prefix(options = {})
  nil
end

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

Raises:

  • (ArgumentError) 


352
353
354
355
356
357
358
359
360
361
 
# File 'lib/action_dispatch/routing/route_set.rb', line 352

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 



254
255
256
 
# File 'lib/action_dispatch/routing/route_set.rb', line 254

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

#call(env) ⇒ Object 



587
588
589
590
 
# File 'lib/action_dispatch/routing/route_set.rb', line 587

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

#clear! ⇒ Object 



282
283
284
285
286
287
288
 
# File 'lib/action_dispatch/routing/route_set.rb', line 282

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

#define_mounted_helper(name) ⇒ Object 



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/action_dispatch/routing/route_set.rb', line 302

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 



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

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

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


348
349
350
 
# File 'lib/action_dispatch/routing/route_set.rb', line 348

def empty?
  routes.empty?
end

#eval_block(block) ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/action_dispatch/routing/route_set.rb', line 262

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.



542
543
544
 
# File 'lib/action_dispatch/routing/route_set.rb', line 542

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

#finalize! ⇒ Object 



276
277
278
279
280
 
# File 'lib/action_dispatch/routing/route_set.rb', line 276

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

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



550
551
552
 
# File 'lib/action_dispatch/routing/route_set.rb', line 550

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

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



546
547
548
 
# File 'lib/action_dispatch/routing/route_set.rb', line 546

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

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



290
291
292
293
 
# File 'lib/action_dispatch/routing/route_set.rb', line 290

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 



298
299
300
 
# File 'lib/action_dispatch/routing/route_set.rb', line 298

def mounted_helpers
  MountedHelpers
end

#prepend(&block) ⇒ Object 



258
259
260
 
# File 'lib/action_dispatch/routing/route_set.rb', line 258

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

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

Raises:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/action_dispatch/routing/route_set.rb', line 592

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 



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/action_dispatch/routing/route_set.rb', line 561

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 



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

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