123456789_123456789_123456789_123456789_123456789_

Module: ActionDispatch::Http::URL

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
ActionController::TestRequest, ::ActionDispatch::Request, ::ActionDispatch::TestRequest
Defined in: actionpack/lib/action_dispatch/http/url.rb

Constant Summary

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Class Attribute Details

.tld_length (rw) Also known as: #tld_length

[ GitHub ] 

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 11



mattr_accessor :tld_length


  







Class Method Details



  

    .extract_domain(host, tld_length)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 15



def extract_domain(host, tld_length)
  extract_domain_from(host, tld_length) if named_host?(host)
end


  








  

    .extract_subdomain(host, tld_length)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 27



def extract_subdomain(host, tld_length)
  extract_subdomains(host, tld_length).join('.')
end


  








  

    .extract_subdomains(host, tld_length)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 19



def extract_subdomains(host, tld_length)
  if named_host?(host)
    extract_subdomains_from(host, tld_length)
  else
    []
  end
end


  








  

    .full_url_for(options)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 39



def full_url_for(options)
  host     = options[:host]
  protocol = options[:protocol]
  port     = options[:port]

  unless host
    raise ArgumentError, 'Missing host to link to! Please provide the :host parameter, set default_url_options[:host], or set :only_path to true'
  end

  build_host_url(host, port, protocol, options, path_for(options))
end


  








  

    .path_for(options)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 51



def path_for(options)
  path  = options[:script_name].to_s.chomp("/")
  path << options[:path] if options.key?(:path)

  add_trailing_slash(path) if options[:trailing_slash]
  add_params(path, options[:params]) if options.key?(:params)
  add_anchor(path, options[:anchor]) if options.key?(:anchor)

  path
end


  








  

    .url_for(options)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 31



def url_for(options)
  if options[:only_path]
    path_for options
  else
    full_url_for options
  end
end


  







Instance Attribute Details



  

    #standard_port   (readonly)
  



  

    

Returns the standard port number for this request's protocol.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 217



def standard_port
  case protocol
    when 'https://' then 443
    else 80
  end
end


  








  

    #standard_port?  ⇒ Boolean  (readonly)
  



  

    

Returns whether this request is using the standard port


  





  


  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 225



def standard_port?
  port == standard_port
end


  








  

    #tld_length   (rw)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 11



mattr_accessor :tld_length


  







Instance Method Details



  

    #domain(tld_length = @@tld_length)  
  



  

    

Returns the domain part of a host, such as “rubyonrails.org” in “www.rubyonrails.org”. You can specify a different .tld_length, such as 2 to catch rubyonrails.co.uk in “www.rubyonrails.co.uk”.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 247



def domain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_domain(host, tld_length)
end


  








  

    #host  
  



  

    

Returns the host for this request, such as example.com.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 195



def host
  raw_host_with_port.sub(/:\d+$/, '')
end


  








  

    #host_with_port  
  



  

    

Returns a host:port string for this request, such as “example.com” or “example.com:8080”.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 201



def host_with_port
  "#{host}#{port_string}"
end


  








  

    #initialize(env)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 169



def initialize(env)
  super
  @protocol = nil
  @port     = nil
end


  








  

    #optional_port  
  



  

    

Returns a number port suffix like 8080 if the port number of this request is not the default HTTP port 80 or HTTPS port 443.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 231



def optional_port
  standard_port? ? nil : port
end


  








  

    #port  
  



  

    

Returns the port number of this request as an integer.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 206



def port
  @port ||= begin
    if raw_host_with_port =~ /:(\d+)$/
      $1.to_i
    else
      standard_port
    end
  end
end


  








  

    #port_string  
  



  

    

Returns a string port suffix, including colon, like “:8080” if the port number of this request is not the default HTTP port 80 or HTTPS port 443.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 237



def port_string
  standard_port? ? '' : ":#{port}"
end


  








  

    #protocol  
  



  

    

Returns 'https://' if this is an ::ActionDispatch::SSL request and 'http://' otherwise.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 181



def protocol
  @protocol ||= ssl? ? 'https://' : 'http://'
end


  








  

    #raw_host_with_port  
  



  

    

Returns the host for this request, such as “example.com”.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 186



def raw_host_with_port
  if forwarded = env["HTTP_X_FORWARDED_HOST"].presence
    forwarded.split(/,\s?/).last
  else
    env['HTTP_HOST'] || "#{env['SERVER_NAME'] || env['SERVER_ADDR']}:#{env['SERVER_PORT']}"
  end
end


  








  

    #server_port  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 241



def server_port
  @env['SERVER_PORT'].to_i
end


  








  

    #subdomain(tld_length = @@tld_length)  
  



  

    

Returns all the subdomains as a string, so "dev.www" would be returned for “dev.www.rubyonrails.org”. You can specify a different .tld_length, such as 2 to catch "www" instead of "www.rubyonrails" in “www.rubyonrails.co.uk”.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 263



def subdomain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomain(host, tld_length)
end


  








  

    #subdomains(tld_length = @@tld_length)  
  



  

    

Returns all the subdomains as an array, so ["dev", "www"] would be returned for “dev.www.rubyonrails.org”. You can specify a different .tld_length, such as 2 to catch ["www"] instead of ["www", "rubyonrails"] in “www.rubyonrails.co.uk”.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 255



def subdomains(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomains(host, tld_length)
end


  








  

    #url  
  



  

    

Returns the complete URL used for this request.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/url.rb', line 176



def url
  protocol + host_with_port + fullpath
end