actionpack/lib/action_controller/metal/url_for.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

# :markup: markdown

module ActionController
  # # Action Controller UrlFor
  #
  # 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
  module UrlFor
    extend ActiveSupport::Concern

    include AbstractController::UrlFor

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

    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
  end
end