Module: ActionDispatch::Routing::Mapper::Base

default_url_options(options) click to toggle source

default_url_options=(options) click to toggle source

     # File lib/action_dispatch/routing/mapper.rb, line 298
298:         def default_url_options=(options)
299:           @set.default_url_options = options
300:         end

Also aliased as: default_url_options

match(path, options=nil) click to toggle source

When you set up a regular route, you supply a series of symbols that Rails maps to parts of an incoming HTTP request.

  match ':controller/:action/:id/:user_id'

Two of these symbols are special: :controller maps to the name of a controller in your application, and :action maps to the name of an action within that controller. Anything other than :controller or :action will be available to the action as part of params.

     # File lib/action_dispatch/routing/mapper.rb, line 260
260:         def match(path, options=nil)
261:           mapping = Mapping.new(@set, @scope, path, options || {}).to_route
262:           @set.add_route(*mapping)
263:           self
264:         end

mount(app, options = nil) click to toggle source

Mount a Rack-based application to be used within the application.

mount SomeRackApp, :at => “some_route“

Alternatively:

mount(SomeRackApp => “some_route“)

All mounted applications come with routing helpers to access them. These are named after the class specified, so for the above example the helper is either some_rack_app_path or some_rack_app_url. To customize this helper’s name, use the :as option:

mount(SomeRackApp => “some_route“, :as => “exciting”)

This will generate the exciting_path and exciting_url helpers which can be used to navigate to this mounted app.

     # File lib/action_dispatch/routing/mapper.rb, line 283
283:         def mount(app, options = nil)
284:           if options
285:             path = options.delete(:at)
286:           else
287:             options = app
288:             app, path = options.find { |k, v| k.respond_to?(:call) }
289:             options.delete(app) if app
290:           end
291: 
292:           raise "A rack application must be specified" unless path
293: 
294:           match(path, options.merge(:to => app, :anchor => false, :format => false))
295:           self
296:         end

root(options = {}) click to toggle source

You can specify what Rails should route “/” to with the root method:

  root :to => 'pages#main'

You should put the root route at the end of config/routes.rb.

     # File lib/action_dispatch/routing/mapper.rb, line 247
247:         def root(options = {})
248:           match '/', options.reverse_merge(:as => :root)
249:         end

Home Classes Methods

In Files

Methods

Class Index

ActionDispatch::Routing::Mapper::Base

Public Instance Methods