Class: ActionDispatch::Routing::RouteSet
- Inherits:
-
Object
- Object
- ActionDispatch::Routing::RouteSet
- 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, :original_script_name]
Instance Attribute Summary collapse
-
#default_scope ⇒ Object
Returns the value of attribute default_scope.
-
#default_url_options ⇒ Object
Returns the value of attribute default_url_options.
-
#disable_clear_and_finalize ⇒ Object
Returns the value of attribute disable_clear_and_finalize.
-
#formatter ⇒ Object
Returns the value of attribute formatter.
-
#named_routes ⇒ Object
Returns the value of attribute named_routes.
-
#request_class ⇒ Object
Returns the value of attribute request_class.
-
#resources_path_names ⇒ Object
Returns the value of attribute resources_path_names.
-
#router ⇒ Object
Returns the value of attribute router.
-
#set ⇒ Object
(also: #routes)
Returns the value of attribute set.
Class Method Summary collapse
Instance Method Summary collapse
- #_generate_prefix(options = {}) ⇒ Object
- #add_route(app, conditions = {}, requirements = {}, defaults = {}, name = nil, anchor = true) ⇒ Object
- #append(&block) ⇒ Object
- #call(env) ⇒ Object
- #clear! ⇒ Object
- #define_mounted_helper(name) ⇒ Object
- #draw(&block) ⇒ Object
- #empty? ⇒ Boolean
- #eval_block(block) ⇒ Object
-
#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.
- #finalize! ⇒ Object
- #generate(options, recall = {}) ⇒ Object
- #generate_extras(options, recall = {}) ⇒ Object
-
#initialize(request_class = ActionDispatch::Request) ⇒ RouteSet
constructor
A new instance of RouteSet.
- #mounted? ⇒ Boolean
-
#mounted_helpers ⇒ Object
Contains all the mounted helpers across different engines and the ‘main_app` helper for the application.
- #optimize_routes_generation? ⇒ Boolean
- #prepend(&block) ⇒ Object
- #recognize_path(path, environment = {}) ⇒ Object
-
#url_for(options) ⇒ Object
The
options
argument must benil
or a hash whose keys are symbols. - #url_helpers ⇒ Object
Constructor Details
#initialize(request_class = ActionDispatch::Request) ⇒ RouteSet
Returns a new instance of RouteSet.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/action_dispatch/routing/route_set.rb', line 293 def initialize(request_class = ActionDispatch::Request) self.named_routes = NamedRouteCollection.new self.resources_path_names = self.class.default_resources_path_names.dup self. = {} self.request_class = request_class @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.
283 284 285 |
# File 'lib/action_dispatch/routing/route_set.rb', line 283 def default_scope @default_scope end |
#default_url_options ⇒ Object
Returns the value of attribute default_url_options.
285 286 287 |
# File 'lib/action_dispatch/routing/route_set.rb', line 285 def @default_url_options end |
#disable_clear_and_finalize ⇒ Object
Returns the value of attribute disable_clear_and_finalize.
284 285 286 |
# File 'lib/action_dispatch/routing/route_set.rb', line 284 def disable_clear_and_finalize @disable_clear_and_finalize end |
#formatter ⇒ Object
Returns the value of attribute formatter.
283 284 285 |
# File 'lib/action_dispatch/routing/route_set.rb', line 283 def formatter @formatter end |
#named_routes ⇒ Object
Returns the value of attribute named_routes.
283 284 285 |
# File 'lib/action_dispatch/routing/route_set.rb', line 283 def named_routes @named_routes end |
#request_class ⇒ Object
Returns the value of attribute request_class.
285 286 287 |
# File 'lib/action_dispatch/routing/route_set.rb', line 285 def request_class @request_class end |
#resources_path_names ⇒ Object
Returns the value of attribute resources_path_names.
284 285 286 |
# File 'lib/action_dispatch/routing/route_set.rb', line 284 def resources_path_names @resources_path_names end |
#router ⇒ Object
Returns the value of attribute router.
283 284 285 |
# File 'lib/action_dispatch/routing/route_set.rb', line 283 def router @router end |
#set ⇒ Object Also known as: routes
Returns the value of attribute set.
283 284 285 |
# File 'lib/action_dispatch/routing/route_set.rb', line 283 def set @set end |
Class Method Details
.default_resources_path_names ⇒ Object
289 290 291 |
# File 'lib/action_dispatch/routing/route_set.rb', line 289 def self.default_resources_path_names { :new => 'new', :edit => 'edit' } end |
Instance Method Details
#_generate_prefix(options = {}) ⇒ Object
642 643 644 |
# File 'lib/action_dispatch/routing/route_set.rb', line 642 def _generate_prefix( = {}) nil end |
#add_route(app, conditions = {}, requirements = {}, defaults = {}, name = nil, anchor = true) ⇒ Object
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 |
# File 'lib/action_dispatch/routing/route_set.rb', line 424 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 = build_path(conditions.delete(:path_info), requirements, SEPARATORS, anchor) conditions = build_conditions(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
318 319 320 |
# File 'lib/action_dispatch/routing/route_set.rb', line 318 def append(&block) @append << block end |
#call(env) ⇒ Object
675 676 677 |
# File 'lib/action_dispatch/routing/route_set.rb', line 675 def call(env) @router.call(env) end |
#clear! ⇒ Object
345 346 347 348 349 350 351 |
# File 'lib/action_dispatch/routing/route_set.rb', line 345 def clear! @finalized = false named_routes.clear set.clear formatter.clear @prepend.each { |blk| eval_block(blk) } end |
#define_mounted_helper(name) ⇒ Object
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/action_dispatch/routing/route_set.rb', line 366 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 |
#draw(&block) ⇒ Object
311 312 313 314 315 316 |
# File 'lib/action_dispatch/routing/route_set.rb', line 311 def draw(&block) clear! unless @disable_clear_and_finalize eval_block(block) finalize! unless @disable_clear_and_finalize nil end |
#empty? ⇒ Boolean
420 421 422 |
# File 'lib/action_dispatch/routing/route_set.rb', line 420 def empty? routes.empty? end |
#eval_block(block) ⇒ Object
326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/action_dispatch/routing/route_set.rb', line 326 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.
617 618 619 |
# File 'lib/action_dispatch/routing/route_set.rb', line 617 def extra_keys(, recall={}) generate_extras(, recall).last end |
#finalize! ⇒ Object
339 340 341 342 343 |
# File 'lib/action_dispatch/routing/route_set.rb', line 339 def finalize! return if @finalized @append.each { |blk| eval_block(blk) } @finalized = true end |
#generate(options, recall = {}) ⇒ Object
626 627 628 |
# File 'lib/action_dispatch/routing/route_set.rb', line 626 def generate(, recall = {}) Generator.new(, recall, self).generate end |
#generate_extras(options, recall = {}) ⇒ Object
621 622 623 624 |
# File 'lib/action_dispatch/routing/route_set.rb', line 621 def generate_extras(, recall={}) path, params = generate(, recall) return path, params.keys end |
#mounted? ⇒ Boolean
634 635 636 |
# File 'lib/action_dispatch/routing/route_set.rb', line 634 def mounted? false end |
#mounted_helpers ⇒ Object
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.
362 363 364 |
# File 'lib/action_dispatch/routing/route_set.rb', line 362 def mounted_helpers MountedHelpers end |
#optimize_routes_generation? ⇒ Boolean
638 639 640 |
# File 'lib/action_dispatch/routing/route_set.rb', line 638 def optimize_routes_generation? !mounted? && .empty? end |
#prepend(&block) ⇒ Object
322 323 324 |
# File 'lib/action_dispatch/routing/route_set.rb', line 322 def prepend(&block) @prepend << block end |
#recognize_path(path, environment = {}) ⇒ Object
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 |
# File 'lib/action_dispatch/routing/route_set.rb', line 679 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. end req = @request_class.new(env) @router.recognize(req) do |route, _matches, 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 = env[::ActionDispatch::Routing::RouteSet::PARAMETERS_KEY] env[::ActionDispatch::Routing::RouteSet::PARAMETERS_KEY] = (old_params || {}).merge(params) dispatcher = route.app while dispatcher.is_a?(Mapper::Constraints) && dispatcher.matches?(env) do dispatcher = dispatcher.app end if dispatcher.is_a?(Dispatcher) 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) ⇒ Object
The options
argument must be nil
or a hash whose keys are symbols.
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 |
# File 'lib/action_dispatch/routing/route_set.rb', line 647 def url_for() = .merge( || {}) user, password = extract_authentication() recall = .delete(:_recall) original_script_name = .delete(:original_script_name).presence script_name = .delete(:script_name).presence || _generate_prefix() if script_name && original_script_name script_name = original_script_name + script_name end = .except(*RESERVED_OPTIONS) = yield() if block_given? path, params = generate(, recall || {}) params.merge!([:params] || {}) ActionDispatch::Http::URL.url_for(.merge!({ :path => path, :script_name => script_name, :params => params, :user => user, :password => password })) end |
#url_helpers ⇒ Object
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 |
# File 'lib/action_dispatch/routing/route_set.rb', line 383 def url_helpers @url_helpers ||= begin 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' end # Make named_routes available in the module singleton # as well, so one can do: # Rails.application.routes.url_helpers.posts_path extend routes.named_routes.module # Any class that includes this module will get all # named routes... include routes.named_routes.module # 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 } end end end |