Module: ActionDispatch::Routing::Redirection

Included in:
Mapper
Defined in:
actionpack/lib/action_dispatch/routing/redirection.rb

Instance Method Summary collapse

Instance Method Details

#redirect(*args, &block) ⇒ Object

Redirect any path to another path:

match "/stories" => redirect("/posts")

You can also use interpolation in the supplied redirect argument:

match 'docs/:article', :to => redirect('/wiki/%{article}')

Alternatively you can use one of the other syntaxes:

The block version of redirect allows for the easy encapsulation of any logic associated with the redirect in question. Either the params and request are supplied as arguments, or just params, depending of how many arguments your block accepts. A string is required as a return value.

match 'jokes/:number', :to => redirect do |params, request|
  path = (params[:number].to_i.even? ? "/wheres-the-beef" : "/i-love-lamp")
  "http://#{request.host_with_port}/#{path}"
end

The options version of redirect allows you to supply only the parts of the url which need to change, it also supports interpolation of the path similar to the first example.

match 'stores/:name',       :to => redirect(:subdomain => 'stores', :path => '/%{name}')
match 'stores/:name(*all)', :to => redirect(:subdomain => 'stores', :path => '/%{name}%{all}')

Finally, an object which responds to call can be supplied to redirect, allowing you to reuse common redirect routes. The call method must accept two arguments, params and request, and return a string.

match 'accounts/:name' => redirect(SubdomainRedirector.new('api'))

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'actionpack/lib/action_dispatch/routing/redirection.rb', line 39

def redirect(*args, &block)
  options = args.last.is_a?(Hash) ? args.pop : {}
  status  = options.delete(:status) || 301

  path = args.shift

  path_proc = if path.is_a?(String)
    proc { |params| (params.empty? || !path.match(/%\{\w*\}/)) ? path : (path % params) }
  elsif options.any?
    options_proc(options)
  elsif path.respond_to?(:call)
    proc { |params, request| path.call(params, request) }
  elsif block
    block
  else
    raise ArgumentError, "redirection argument not supported"
  end

  redirection_proc(status, path_proc)
end