Module: ActionController::UrlFor

Extended by:
ActiveSupport::Concern
Includes:
AbstractController::UrlFor
Included in:
Redirecting
Defined in:
actionpack/lib/action_controller/metal/url_for.rb

Overview

Includes url_for into the host class. The class has to provide a RouteSet by implementing the _routes method. Otherwise, an exception will be raised.

In addition to AbstractController::UrlFor, this module accesses the HTTP layer to define url options like the host. In order to do so, this module requires the host class to implement env which needs to be Rack-compatible and request which is either an instance of ActionDispatch::Request or an object that responds to the host, optional_port, protocol and symbolized_path_parameter methods.

class RootUrl
  include ActionController::UrlFor
  include Rails.application.routes.url_helpers

  delegate :env, :request, to: :controller

  def initialize(controller)
    @controller = controller
    @url        = root_path # named route from the application.
  end
end

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included

Methods included from AbstractController::UrlFor

#_routes

Methods included from ActionDispatch::Routing::UrlFor

#initialize, #url_for

Methods included from ActionDispatch::Routing::PolymorphicRoutes

#polymorphic_path, #polymorphic_url

Instance Method Details

#url_optionsObject


28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'actionpack/lib/action_controller/metal/url_for.rb', line 28

def url_options
  @_url_options ||= {
    :host => request.host,
    :port => request.optional_port,
    :protocol => request.protocol,
    :_recall => request.path_parameters
  }.merge!(super).freeze

  if (same_origin = _routes.equal?(request.routes)) ||
     (script_name = request.engine_script_name(_routes)) ||
     (original_script_name = request.original_script_name)

    options = @_url_options.dup
    if original_script_name
      options[:original_script_name] = original_script_name
    else
      if same_origin
        options[:script_name] = request.script_name.empty? ? "".freeze : request.script_name.dup
      else
        options[:script_name] = script_name
      end
    end
    options.freeze
  else
    @_url_options
  end
end