module ActionView::Helpers::UrlHelper
def _back_url # :nodoc:
def _back_url # :nodoc: _filtered_referrer || "javascript:history.back()" end
def _filtered_referrer # :nodoc:
def _filtered_referrer # :nodoc: if controller.respond_to?(:request) referrer = controller.request.env["HTTP_REFERER"] if referrer && URI(referrer).scheme != "javascript" referrer end end rescue URI::InvalidURIError end
def add_method_to_attributes!(html_options, method)
def add_method_to_attributes!(html_options, method) if method_not_get_method?(method) && !html_options["rel"]&.match?(/nofollow/) if html_options["rel"].blank? html_options["rel"] = "nofollow" else html_options["rel"] = "#{html_options["rel"]} nofollow" end end html_options["data-method"] = method end
def button_to(name = nil, options = nil, html_options = nil, &block)
# "
#
#
# => ""
#
#
# => ""
#
#
# => ""
#
#
# Make happy <%= @user.name %>
#
def button_to(name = nil, options = nil, html_options = nil, &block) html_options, options = options, name if block_given? html_options ||= {} html_options = html_options.stringify_keys url = case options when FalseClass then nil else url_for(options) end remote = html_options.delete("remote") params = html_options.delete("params") authenticity_token = html_options.delete("authenticity_token") method = (html_options.delete("method").presence || method_for_options(options)).to_s method_tag = BUTTON_TAG_METHOD_VERBS.include?(method) ? method_tag(method) : "".html_safe form_method = method == "get" ? "get" : "post" form_options = html_options.delete("form") || {} form_options[:class] ||= html_options.delete("form_class") || "button_to" form_options[:method] = form_method form_options[:action] = url form_options[:'data-remote'] = true if remote request_token_tag = if form_method == "post" request_method = method.empty? ? "post" : method token_tag(authenticity_token, form_options: { action: url, method: request_method }) else "" end html_options = convert_options_to_data_attributes(options, html_options) html_options["type"] = "submit" button = if block_given? content_tag("button", html_options, &block) elsif button_to_generates_button_tag content_tag("button", name || url, html_options, &block) else html_options["value"] = name || url tag("input", html_options) end inner_tags = method_tag.safe_concat(button).safe_concat(request_token_tag) if params to_form_params(params).each do |param| inner_tags.safe_concat tag(:input, type: "hidden", name: param[:name], value: param[:value], autocomplete: "off") end end content_tag("form", inner_tags, form_options) end
def convert_options_to_data_attributes(options, html_options)
def convert_options_to_data_attributes(options, html_options) if html_options html_options = html_options.stringify_keys html_options["data-remote"] = "true" if link_to_remote_options?(options) || link_to_remote_options?(html_options) method = html_options.delete("method") add_method_to_attributes!(html_options, method) if method html_options else link_to_remote_options?(options) ? { "data-remote" => "true" } : {} end end
def current_page?(options = nil, check_parameters: false, **options_as_kwargs)
We can also pass in the symbol arguments instead of strings.
# => false
current_page?(controller: 'product', action: 'index')
Let's say we're in the http://www.example.com/products action with method POST in case of invalid product.
# => true
current_page?('http://www.example.com/shop/checkout?order=desc&page=1')
# => true
current_page?('/shop/checkout')
# => false
current_page?('http://www.example.com/shop/checkout', check_parameters: true)
# => true
current_page?('http://www.example.com/shop/checkout')
# => false
current_page?(controller: 'shop', action: 'checkout', order: 'desc', page: '2')
# => true
current_page?(controller: 'shop', action: 'checkout', order: 'desc', page: '1')
# => false
current_page?(controller: 'shop', action: 'checkout', order: 'asc')
# => true
current_page?(controller: 'shop', action: 'checkout')
# => false
current_page?(controller: 'library', action: 'checkout')
# => true
current_page?(action: 'checkout')
# => false
current_page?(action: 'process')
Let's say we're in the http://www.example.com/shop/checkout?order=desc&page=1 action.
==== Examples
True if the current request URI was generated by the given +options+.
def current_page?(options = nil, check_parameters: false, **options_as_kwargs) unless request raise "You cannot use helpers that need to determine the current " \ "page unless your view context provides a Request object " \ "in a #request method" end return false unless request.get? || request.head? options ||= options_as_kwargs check_parameters ||= options.is_a?(Hash) && options.delete(:check_parameters) url_string = URI::DEFAULT_PARSER.unescape(url_for(options)).force_encoding(Encoding::BINARY) # We ignore any extra parameters in the request_uri if the # submitted URL doesn't have any either. This lets the function # work with things like ?order=asc # the behaviour can be disabled with check_parameters: true request_uri = url_string.index("?") || check_parameters ? request.fullpath : request.path request_uri = URI::DEFAULT_PARSER.unescape(request_uri).force_encoding(Encoding::BINARY) if %r{^\w+://}.match?(url_string) request_uri = +"#{request.protocol}#{request.host_with_port}#{request_uri}" end remove_trailing_slash!(url_string) remove_trailing_slash!(request_uri) url_string == request_uri end
def current_page?(*args) # :nodoc:
def current_page?(*args) # :nodoc: options = args.pop options.is_a?(Hash) ? _current_page?(*args, **options) : _current_page?(*args, options) end
def link_to(name = nil, options = nil, html_options = nil, &block)
# => Visit Other Site
link_to "Visit Other Site", "http://www.rubyonrails.org/", data: { confirm: "Are you sure?" }
# => Remove Profile
link_to "Remove Profile", profile_path(@profile), method: :delete
===== Rails UJS Examples
name for a disabled version of the link.
* :disable_with - Value of this parameter will be used as the
link is processed normally, otherwise no action is taken.
resulting text would be question?). If the user accepts, the
to prompt with the question specified (in this case, the
* confirm: "question?" - This will allow @rails/ujs
@rails/ujs also integrated with the following +:data+ options:
the link.
to make an Ajax request to the URL in question instead of following
* remote: true - This will allow @rails/ujs
the request object's methods for post?, delete?, patch?, or put?.
POST behavior, you should check for it in your controller's action by using
disabled clicking the link will have no effect. If you are relying on the
to using GET. If href: '#' is used and the user has JavaScript
Note that if the user has JavaScript disabled, the request will fall back
while spidering your site). Supported verbs are :post, :delete, :patch, and :put.
in dangerous actions like deleting a record (which search bots can follow
the HTTP verb specified. Useful for having links perform a POST operation
create an HTML form and immediately submit the form for processing using
* method: symbol of HTTP verb - This modifier will dynamically
this library is no longer on by default. This library integrated with the following options:
Prior to Rails 7, Rails shipped with a JavaScript library called @rails/ujs on by default. Following Rails 7,
==== Deprecated: Rails UJS Attributes
# => External link
link_to "External link", "http://www.rubyonrails.org/", target: "_blank", rel: "nofollow"
You can set any link attributes such as target, rel, type:
# => Nonsense search
link_to "Nonsense search", searches_path(foo: "bar", baz: "quux")
# => Ruby on Rails search
link_to "Ruby on Rails search", controller: "searches", query: "ruby on rails"
# => Comment wall
link_to "Comment wall", profile_path(@profile, anchor: "wall")
+link_to+ can also produce links with anchors or query strings:
# => WRONG!
link_to "WRONG!", controller: "articles", id: "news", class: "article"
Leaving the hash off gives the wrong link:
# => Articles
link_to "Articles", { controller: "articles" }, id: "news", class: "article"
Be careful when using the older argument style, as an extra literal hash is needed:
# => Articles
link_to "Articles", articles_path, id: "news", class: "article"
Classes and ids for CSS are easy to produce:
David -- Check it out!
# =>
<% end %>
<%= @profile.name %> -- Check it out!
<%= link_to(@profile) do %>
You can use a block as well if your link target is hard to fit into the name parameter. ERB example:
# => Eileen
link_to @profile
+to_s+ method returning a default value or a model instance attribute
More concise yet, when +name+ is an Active Record model that defines a
# => http://www.example.com
link_to nil, "http://example.com"
When name is +nil+ the href is presented instead
# => Profiles
link_to "Profiles", controller: "profiles"
is better than
# => Profiles
link_to "Profiles", profiles_path
Similarly,
# => Profile
link_to "Profile", controller: "profiles", action: "show", id: @profile
in place of the older more verbose, non-resource-oriented
# => Profile
link_to "Profile", @profile
or the even pithier
# => Profile
link_to "Profile", profile_path(@profile)
your application on resources and use
and newer RESTful routes. Current Rails style favors RESTful routes whenever possible, so base
Because it relies on +url_for+, +link_to+ supports both older-style controller/action/id arguments
==== Examples
* :data - This option can be used to add custom data attributes.
==== Options
link_to(active_record_model)
end
# name
link_to(url, html_options = {}) do
end
# name
link_to(options = {}, html_options = {}) do
# url_options, except :method, is passed to url_for
link_to(body, url_options = {}, html_options = {})
# posts_path
# url is a String; you can use URL helpers like
link_to(body, url, html_options = {})
==== Signatures
the value of the link itself will become the name.
will be used in place of a referrer if none exists). If +nil+ is passed as the name
of an options hash will generate a link to the referrer (a JavaScript back link
value of the \String as the href for the link. Using a :back \Symbol instead
pass a \String instead of an options hash, which generates an anchor element that uses the
See the valid options in the documentation for +url_for+. It's also possible to
Creates an anchor element of the given +name+ using a URL created by the set of +options+.
def link_to(name = nil, options = nil, html_options = nil, &block) html_options, options, name = options, name, block if block_given? options ||= {} html_options = convert_options_to_data_attributes(options, html_options) url = url_target(name, options) html_options["href"] ||= url content_tag("a", name || url, html_options, &block) end
def link_to_if(condition, name, options = {}, html_options = {}, &block)
# If they are logged in...
# => Login
# If the user isn't logged in...
%>
end
link_to(@current_user.login, { controller: "accounts", action: "show", id: @current_user })
link_to_if(@current_user.nil?, "Login", { controller: "sessions", action: "new" }) do
<%=
# => Login
# If the user isn't logged in...
<%= link_to_if(@current_user.nil?, "Login", { controller: "sessions", action: "new" }) %>
==== Examples
accepts the name or the full argument list for +link_to_if+.
returned. To specialize the default behavior, you can pass a block that
+options+ if +condition+ is true, otherwise only the name is
Creates a link tag of the given +name+ using a URL created by the set of
def link_to_if(condition, name, options = {}, html_options = {}, &block) if condition link_to(name, options, html_options) else if block_given? block.arity <= 1 ? capture(name, &block) : capture(name, options, html_options, &block) else ERB::Util.html_escape(name) end end end
def link_to_remote_options?(options)
def link_to_remote_options?(options) if options.is_a?(Hash) options.delete("remote") || options.delete(:remote) end end
def link_to_unless(condition, name, options = {}, html_options = {}, &block)
# If not...
# => Reply
# If the user is logged in...
%>
end
link_to(name, { controller: "accounts", action: "signup" })
link_to_unless(@current_user.nil?, "Reply", { action: "reply" }) do |name|
<%=
# => Reply
# If the user is logged in...
<%= link_to_unless(@current_user.nil?, "Reply", { action: "reply" }) %>
==== Examples
accepts the name or the full argument list for +link_to_unless+.
than just the plaintext link text), you can pass a block that
returned. To specialize the default behavior (i.e., show a login link rather
+options+ unless +condition+ is true, in which case only the name is
Creates a link tag of the given +name+ using a URL created by the set of
def link_to_unless(condition, name, options = {}, html_options = {}, &block) link_to_if !condition, name, options, html_options, &block end
def link_to_unless_current(name, options = {}, html_options = {}, &block)
end
link_to("Go back", { controller: "posts", action: "index" })
link_to_unless_current("Comment", { controller: "comments", action: "new" }) do
<%=
"Go Back" link instead of a link to the comments page, we could do something like this...
action is the action given. So, if we had a comments page and wanted to render a
The implicit block given to +link_to_unless_current+ is evaluated if the current
def link_to_unless_current(name, options = {}, html_options = {}, &block) link_to_unless current_page?(options), name, options, html_options, &block end
def mail_to(email_address, name = nil, html_options = {}, &block)
Email me: me@domain.com
# =>
<% end %>
Email me: me@domain.com
<%= mail_to "me@domain.com" do %>
You can use a block as well if your link target is hard to fit into the name parameter. ERB example:
# => me@domain.com
subject: "This is an example email"
mail_to "me@domain.com", cc: "ccaddress@domain.com",
# => My email
mail_to "me@domain.com", "My email"
# => me@domain.com
mail_to "me@domain.com"
==== Examples
install the +actionview-encoded_mail_to+ gem.
in order to hinder email harvesters. To take advantage of these options,
Prior to Rails 4.0, +mail_to+ provided options for encoding the address
==== Obfuscation
* :reply_to - Preset the Reply-To field of the email.
* :bcc - Blind Carbon Copy additional recipients on the email.
* :cc - Carbon Copy additional recipients on the email.
* :body - Preset the body of the email.
* :subject - Preset the subject line of the email.
==== Options
passing special keys to +html_options+.
+mail_to+ has several methods for customizing the email itself by
HTML attributes for the link can be passed in +html_options+.
also used as the name of the link unless +name+ is specified. Additional
Creates a mailto link tag to the specified +email_address+, which is
def mail_to(email_address, name = nil, html_options = {}, &block) html_options, name = name, nil if name.is_a?(Hash) html_options = (html_options || {}).stringify_keys extras = %w{ cc bcc body subject reply_to }.map! { |item| option = html_options.delete(item).presence || next "#{item.dasherize}=#{ERB::Util.url_encode(option)}" }.compact extras = extras.empty? ? "" : "?" + extras.join("&") encoded_email_address = ERB::Util.url_encode(email_address).gsub("%40", "@") html_options["href"] = "mailto:#{encoded_email_address}#{extras}" content_tag("a", name || email_address, html_options, &block) end
def method_for_options(options)
def method_for_options(options) if options.is_a?(Array) method_for_options(options.last) elsif options.respond_to?(:persisted?) options.persisted? ? :patch : :post elsif options.respond_to?(:to_model) method_for_options(options.to_model) end end
def method_not_get_method?(method)
def method_not_get_method?(method) return false unless method (STRINGIFIED_COMMON_METHODS[method] || method.to_s.downcase) != "get" end
def method_tag(method)
def method_tag(method) tag("input", type: "hidden", name: "_method", value: method.to_s, autocomplete: "off") end
def phone_to(phone_number, name = nil, html_options = {}, &block)
Phone me:
# =>
<% end %>
Phone me:
<%= phone_to "1234567890" do %>
You can use a block as well if your link target is hard to fit into the name parameter. \ERB example:
# => 1234567890
phone_to "1234567890", country_code: "01"
# => Phone me
phone_to "1234567890", "Phone me"
# => 1234567890
phone_to "1234567890"
==== Examples
* :country_code - Prepends the country code to the phone number
==== Options
Additional HTML attributes for the link can be passed via +html_options+.
phone number.
country_code: "01" will prepend +01 to the linked
given country code to the linked phone number. For example,
A +country_code+ option is supported, which prepends a plus sign and the
the link.
If +name+ is not specified, +phone_number+ will be used as the name of
prepopulated with the phone number.
link is clicked, the default app to make phone calls is opened and
Creates a TEL anchor link tag to the specified +phone_number+. When the
def phone_to(phone_number, name = nil, html_options = {}, &block) html_options, name = name, nil if name.is_a?(Hash) html_options = (html_options || {}).stringify_keys country_code = html_options.delete("country_code").presence country_code = country_code.nil? ? "" : "+#{ERB::Util.url_encode(country_code)}" encoded_phone_number = ERB::Util.url_encode(phone_number) html_options["href"] = "tel:#{country_code}#{encoded_phone_number}" content_tag("a", name || phone_number, html_options, &block) end
def remove_trailing_slash!(url_string)
def remove_trailing_slash!(url_string) trailing_index = (url_string.index("?") || 0) - 1 url_string[trailing_index] = "" if url_string[trailing_index] == "/" end
def sms_to(phone_number, name = nil, html_options = {}, &block)
Text me:
# =>
<% end %>
Text me:
<%= sms_to "5155555785" do %>
You can use a block as well if your link target is hard to fit into the name parameter. \ERB example:
# => 5155555785
sms_to "5155555785", body: "I have a question about your product."
# => Text me
sms_to "5155555785", "Text me"
# => 5155555785
sms_to "5155555785", country_code: "01"
# => 5155555785
sms_to "5155555785"
==== Examples
* :body - Preset the body of the message.
* :country_code - Prepend the country code to the phone number.
==== Options
Additional HTML attributes for the link can be passed via +html_options+.
phone number.
country_code: "01" will prepend +01 to the linked
given country code to the linked phone number. For example,
A +country_code+ option is supported, which prepends a plus sign and the
the link.
If +name+ is not specified, +phone_number+ will be used as the name of
the contents of the message will be preset to +body+.
message to the linked phone number. If the +body+ option is specified,
link is clicked, the default SMS messaging app is opened ready to send a
Creates an SMS anchor link tag to the specified +phone_number+. When the
def sms_to(phone_number, name = nil, html_options = {}, &block) html_options, name = name, nil if name.is_a?(Hash) html_options = (html_options || {}).stringify_keys country_code = html_options.delete("country_code").presence country_code = country_code ? "+#{ERB::Util.url_encode(country_code)}" : "" body = html_options.delete("body").presence body = body ? "?&body=#{ERB::Util.url_encode(body)}" : "" encoded_phone_number = ERB::Util.url_encode(phone_number) html_options["href"] = "sms:#{country_code}#{encoded_phone_number};#{body}" content_tag("a", name || phone_number, html_options, &block) end
def to_form_params(attribute, namespace = nil)
to_form_params({ name: 'Denmark' }, 'country')
An optional namespace can be passed to enclose key names:
# => [{name: 'countries[]', value: 'Denmark'}, {name: 'countries[]', value: 'Sweden'}]
to_form_params(countries: ['Denmark', 'Sweden']})
# => [{name: 'country[name]', value: 'Denmark'}]
to_form_params(country: { name: 'Denmark' })
# => [{name: 'name', value: 'David'}, {name: 'nationality', value: 'Danish'}]
to_form_params(name: 'David', nationality: 'Danish')
suitable for use as the names and values of form input fields:
Returns an array of hashes each containing :name and :value keys
def to_form_params(attribute, namespace = nil) attribute = if attribute.respond_to?(:permitted?) attribute.to_h else attribute end params = [] case attribute when Hash attribute.each do |key, value| prefix = namespace ? "#{namespace}[#{key}]" : key params.push(*to_form_params(value, prefix)) end when Array array_prefix = "#{namespace}[]" attribute.each do |value| params.push(*to_form_params(value, array_prefix)) end else params << { name: namespace.to_s, value: attribute.to_param } end params.sort_by { |pair| pair[:name] } end
def token_tag(token = nil, form_options: {})
def token_tag(token = nil, form_options: {}) if token != false && defined?(protect_against_forgery?) && protect_against_forgery? token = if token == true || token.nil? form_authenticity_token(form_options: form_options.merge(authenticity_token: token)) else token end tag(:input, type: "hidden", name: request_forgery_protection_token.to_s, value: token, autocomplete: "off") else "" end end
def url_for(options = nil) # :nodoc:
Basic implementation of url_for to allow use helpers without routes existence
def url_for(options = nil) # :nodoc: case options when String options when :back _back_url else raise ArgumentError, "arguments passed to url_for can't be handled. Please require " \ "routes or provide your own implementation" end end
def url_target(name, options)
def url_target(name, options) if name.respond_to?(:model_name) && options.is_a?(Hash) && options.empty? url_for(name) else url_for(options) end end