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

PATH =

:stopdoc: strategy for building urls to send to the client

->(options) { ActionDispatch::Http::URL.path_for(options) }
UNKNOWN =
->(options) { ActionDispatch::Http::URL.url_for(options) }
RESERVED_OPTIONS =
[:host, :protocol, :port, :subdomain, :domain, :tld_length,
:trailing_slash, :anchor, :params, :only_path, :script_name,
:original_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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 318

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

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

  @set    = Journey::Routes.new
  @router = Journey::Router.new @set
  @formatter = Journey::Formatter.new @set
end

Instance Attribute Details

#default_scopeObject

:startdoc:



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

def default_scope
  @default_scope
end

#default_url_optionsObject

Returns the value of attribute default_url_options



310
311
312
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 310

def default_url_options
  @default_url_options
end

#disable_clear_and_finalizeObject

Returns the value of attribute disable_clear_and_finalize



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

def disable_clear_and_finalize
  @disable_clear_and_finalize
end

#formatterObject

:startdoc:



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

def formatter
  @formatter
end

#named_routesObject

:startdoc:



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

def named_routes
  @named_routes
end

#request_classObject

Returns the value of attribute request_class



310
311
312
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 310

def request_class
  @request_class
end

#resources_path_namesObject

Returns the value of attribute resources_path_names



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

def resources_path_names
  @resources_path_names
end

#routerObject

:startdoc:



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

def router
  @router
end

#setObject Also known as: routes

:startdoc:



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

def set
  @set
end

Class Method Details

.default_resources_path_namesObject



314
315
316
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 314

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

Instance Method Details

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

Raises:

  • (ArgumentError)


467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 467

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)

  if name && named_routes[name]
    raise ArgumentError, "Invalid route name, already in use: '#{name}' \n" \
      "You may have defined two routes with the same name using the `:as` option, or " \
      "you may be overriding a route already defined by a resource with the same naming. " \
      "For the latter, you can restrict the routes created with `resources` as explained here: \n" \
      "http://guides.rubyonrails.org/routing.html#restricting-the-routes-created"
  end

  path = conditions.delete :path_info
  ast  = conditions.delete :parsed_path_info
  path = build_path(path, ast, requirements, anchor)
  conditions = build_conditions(conditions, path.names.map(&:to_sym))

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

#append(&block) ⇒ Object



341
342
343
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 341

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

#call(env) ⇒ Object



732
733
734
735
736
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 732

def call(env)
  req = request_class.new(env)
  req.path_info = Journey::Router::Utils.normalize_path(req.path_info)
  @router.serve(req)
end

#clear!Object



369
370
371
372
373
374
375
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 369

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

#define_mounted_helper(name) ⇒ Object



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 394

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

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

  MountedHelpers.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
    def #{name}
      @_#{name} ||= _#{name}
    end
  RUBY
end

#dispatcher(defaults) ⇒ Object



377
378
379
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 377

def dispatcher(defaults)
  Routing::RouteSet::Dispatcher.new(defaults)
end

#draw(&block) ⇒ Object



334
335
336
337
338
339
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 334

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

#empty?Boolean

Returns:

  • (Boolean)


463
464
465
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 463

def empty?
  routes.empty?
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.



663
664
665
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 663

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

#finalize!Object



363
364
365
366
367
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 363

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

#find_script_name(options) ⇒ Object



686
687
688
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 686

def find_script_name(options)
  options.delete(:script_name) || ''
end

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



667
668
669
670
671
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 667

def generate_extras(options, recall={})
  route_key = options.delete :use_route
  path, params = generate(route_key, options, recall)
  return path, params.keys
end

#mounted_helpersObject

Contains all the mounted helpers across different engines and the `main_app` helper for the application. You can include this in your classes if you want to access routes for other engines.



390
391
392
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 390

def mounted_helpers
  MountedHelpers
end

#optimize_routes_generation?Boolean

Returns:

  • (Boolean)


682
683
684
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 682

def optimize_routes_generation?
  default_url_options.empty?
end

#path_for(options, route_name = nil) ⇒ Object

:nodoc:



690
691
692
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 690

def path_for(options, route_name = nil) # :nodoc:
  url_for(options, route_name, PATH)
end

#prepend(&block) ⇒ Object



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

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

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



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 738

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

  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, params|
    params.merge!(extras)
    params.each do |key, value|
      if value.is_a?(String)
        value = value.dup.force_encoding(Encoding::BINARY)
        params[key] = URI.parser.unescape(value)
      end
    end
    old_params = req.path_parameters
    req.path_parameters = old_params.merge params
    app = route.app
    if app.matches?(req) && app.dispatcher?
      dispatcher = app.app

      if dispatcher.controller(params, false)
        dispatcher.prepare_params!(params)
        return params
      else
        raise ActionController::RoutingError, "A route matches #{path.inspect}, but references missing controller: #{params[:controller].camelize}Controller"
      end
    end
  end

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

#url_for(options, route_name = nil, url_strategy = UNKNOWN) ⇒ Object

The options argument must be a hash whose keys are symbols.



695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 695

def url_for(options, route_name = nil, url_strategy = UNKNOWN)
  options = default_url_options.merge options

  user = password = nil

  if options[:user] && options[:password]
    user     = options.delete :user
    password = options.delete :password
  end

  recall  = options.delete(:_recall) { {} }

  original_script_name = options.delete(:original_script_name)
  script_name = find_script_name options

  if original_script_name
    script_name = original_script_name + script_name
  end

  path_options = options.dup
  RESERVED_OPTIONS.each { |ro| path_options.delete ro }

  path, params = generate(route_name, path_options, recall)

  if options.key? :params
    params.merge! options[:params]
  end

  options[:path]        = path
  options[:script_name] = script_name
  options[:params]      = params
  options[:user]        = user
  options[:password]    = password

  url_strategy.call options
end

#url_helpers(supports_path = true) ⇒ Object



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 411

def url_helpers(supports_path = true)
  routes = self

  Module.new do
    extend ActiveSupport::Concern
    include UrlFor

    # Define url_for in the singleton level so one can do:
    # Rails.application.routes.url_helpers.url_for(args)
    @_routes = routes
    class << self
      delegate :url_for, :optimize_routes_generation?, to: '@_routes'
      attr_reader :_routes
      def url_options; {}; end
    end

    url_helpers = routes.named_routes.url_helpers_module

    # Make named_routes available in the module singleton
    # as well, so one can do:
    # Rails.application.routes.url_helpers.posts_path
    extend url_helpers

    # Any class that includes this module will get all
    # named routes...
    include url_helpers

    if supports_path
      path_helpers = routes.named_routes.path_helpers_module

      include path_helpers
      extend path_helpers
    end

    # plus a singleton class method called _routes ...
    included do
      singleton_class.send(:redefine_method, :_routes) { routes }
    end

    # And an instance method _routes. Note that
    # UrlFor (included in this module) add extra
    # conveniences for working with @_routes.
    define_method(:_routes) { @_routes || routes }

    define_method(:_generate_paths_by_default) do
      supports_path
    end

    private :_generate_paths_by_default
  end
end