123456789_123456789_123456789_123456789_123456789_

Module: ActionController::UrlFor

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
API, Base, Redirecting, ::ActionView::TestCase::TestController, Rails::ApplicationController, ::Rails::HealthController, Rails::InfoController, Rails::MailersController, Rails::WelcomeController
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveSupport::Concern
Instance Chain:
self, ::AbstractController::UrlFor, ::ActionDispatch::Routing::UrlFor, ::ActionDispatch::Routing::PolymorphicRoutes
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 returns an ::ActionDispatch::Request instance.

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

Class Method Summary

::ActiveSupport::Concern - Extended

class_methods

Define class methods from given block.
included

Evaluate given block in context of base class, so that you can write class macros here.
prepended

Evaluate given block in context of base class, so that you can write class macros here.

Instance Attribute Summary

::AbstractController::UrlFor - Included

#default_url_options, #default_url_options?

Instance Method Summary

::AbstractController::UrlFor - Included

#_routes

::ActionDispatch::Routing::UrlFor - Included

#initialize,
#route_for

Allows calling direct or regular named route.
#url_for

Generate a URL based on the options provided, default_url_options, and the routes defined in config/routes.rb.
#url_options

Hook overridden in controller to add request information with default_url_options.
#_routes_context, #_with_routes

::ActionDispatch::Routing::PolymorphicRoutes - Included

#polymorphic_path

Returns the path component of a URL for the given record.
#polymorphic_url

Constructs a call to a named RESTful route for the given record and returns the resulting URL string.

Instance Method Details

#initialize

[ GitHub ] 

  


# File 'actionpack/lib/action_controller/metal/url_for.rb', line 30



def initialize(...)
  super
  @_url_options = nil
end


  








  

    #url_options  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_controller/metal/url_for.rb', line 35



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? ? "" : request.script_name.dup
      else
        options[:script_name] = script_name
      end
    end
    options.freeze
  else
    @_url_options
  end
end