require 'active_support/concern'
require 'action_view/helpers/asset_tag_helpers/helper_methods'
module ActionView
module Helpers
module AssetTagHelper
module BaseAssetHelpers
extend HelperMethods
# Returns a link tag that browsers and news readers can use to auto-detect
# an RSS or ATOM feed. The +type+ can either be :rss (default) or
# :atom. Control the link options in url_for format using the
# +url_options+. You can modify the LINK tag itself in +tag_options+.
#
# ==== Options
# * :rel - Specify the relation of this link, defaults to "alternate"
# * :type - Override the auto-generated mime type
# * :title - Specify the title of the link, defaults to the +type+
#
# ==== Examples
# auto_discovery_link_tag # =>
#
# auto_discovery_link_tag(:atom) # =>
#
# auto_discovery_link_tag(:rss, {:action => "feed"}) # =>
#
# auto_discovery_link_tag(:rss, {:action => "feed"}, {:title => "My RSS"}) # =>
#
# auto_discovery_link_tag(:rss, {:controller => "news", :action => "feed"}) # =>
#
# auto_discovery_link_tag(:rss, "http://www.example.com/feed.rss", {:title => "Example RSS"}) # =>
#
def auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {})
tag(
"link",
"rel" => tag_options[:rel] || "alternate",
"type" => tag_options[:type] || Mime::Type.lookup_by_extension(type.to_s).to_s,
"title" => tag_options[:title] || type.to_s.upcase,
"href" => url_options.is_a?(Hash) ? url_for(url_options.merge(:only_path => false)) : url_options
)
end
# Web browsers cache favicons. If you just throw a favicon.ico into the document
# root of your application and it changes later, clients that have it in their cache
# won't see the update. Using this helper prevents that because it appends an asset ID:
#
# <%= favicon_link_tag %>
#
# generates
#
#
#
# You may specify a different file in the first argument:
#
# <%= favicon_link_tag 'favicon.ico' %>
#
# That's passed to +path_to_image+ as is, so it gives
#
#
#
# The helper accepts an additional options hash where you can override "rel" and "type".
#
# For example, Mobile Safari looks for a different LINK tag, pointing to an image that
# will be used if you add the page to the home screen of an iPod Touch, iPhone, or iPad.
# The following call would generate such a tag:
#
# <%= favicon_link_tag 'mb-icon.png', :rel => 'apple-touch-icon', :type => 'image/png' %>
#
def favicon_link_tag(source='/favicon.ico', options={})
tag('link', {
:rel => 'shortcut icon',
:type => 'image/vnd.microsoft.icon',
:href => path_to_image(source)
}.merge(options.symbolize_keys))
end
# Computes the path to an image asset in the public images directory.
# Full paths from the document root will be passed through.
# Used internally by +image_tag+ to build the image path:
#
# image_path("edit") # => "/images/edit"
# image_path("edit.png") # => "/images/edit.png"
# image_path("icons/edit.png") # => "/images/icons/edit.png"
# image_path("/icons/edit.png") # => "/icons/edit.png"
# image_path("http://www.railsapplication.com/img/edit.png") # => "http://www.railsapplication.com/img/edit.png"
#
# If you have images as application resources this method may conflict with their named routes.
# The alias +path_to_image+ is provided to avoid that. Rails uses the alias internally, and
# plugin authors are encouraged to do so.
asset_path :image
# Computes the path to a video asset in the public videos directory.
# Full paths from the document root will be passed through.
# Used internally by +video_tag+ to build the video path.
#
# ==== Examples
# video_path("hd") # => /videos/hd
# video_path("hd.avi") # => /videos/hd.avi
# video_path("trailers/hd.avi") # => /videos/trailers/hd.avi
# video_path("/trailers/hd.avi") # => /trailers/hd.avi
# video_path("http://www.railsapplication.com/vid/hd.avi") # => http://www.railsapplication.com/vid/hd.avi
asset_path :video
# Computes the path to an audio asset in the public audios directory.
# Full paths from the document root will be passed through.
# Used internally by +audio_tag+ to build the audio path.
#
# ==== Examples
# audio_path("horse") # => /audios/horse
# audio_path("horse.wav") # => /audios/horse.wav
# audio_path("sounds/horse.wav") # => /audios/sounds/horse.wav
# audio_path("/sounds/horse.wav") # => /sounds/horse.wav
# audio_path("http://www.railsapplication.com/sounds/horse.wav") # => http://www.railsapplication.com/sounds/horse.wav
asset_path :audio
# Returns an html image tag for the +source+. The +source+ can be a full
# path or a file that exists in your public images directory.
#
# ==== Options
# You can add HTML attributes using the +options+. The +options+ supports
# three additional keys for convenience and conformance:
#
# * :alt - If no alt text is given, the file name part of the
# +source+ is used (capitalized and without the extension)
# * :size - Supplied as "{Width}x{Height}", so "30x45" becomes
# width="30" and height="45". :size will be ignored if the
# value is not in the correct format.
# * :mouseover - Set an alternate image to be used when the onmouseover
# event is fired, and sets the original image to be replaced onmouseout.
# This can be used to implement an easy image toggle that fires on onmouseover.
#
# ==== Examples
# image_tag("icon") # =>
#
# image_tag("icon.png") # =>
#
# image_tag("icon.png", :size => "16x10", :alt => "Edit Entry") # =>
#
# image_tag("/icons/icon.gif", :size => "16x16") # =>
#
# image_tag("/icons/icon.gif", :height => '32', :width => '32') # =>
#
# image_tag("/icons/icon.gif", :class => "menu_icon") # =>
#
# image_tag("mouse.png", :mouseover => "/images/mouse_over.png") # =>
#
# image_tag("mouse.png", :mouseover => image_path("mouse_over.png")) # =>
#
def image_tag(source, options = {})
options.symbolize_keys!
src = options[:src] = path_to_image(source)
unless src =~ /^cid:/
options[:alt] = options.fetch(:alt){ File.basename(src, '.*').capitalize }
end
if size = options.delete(:size)
options[:width], options[:height] = size.split("x") if size =~ %r{^\d+x\d+$}
end
if mouseover = options.delete(:mouseover)
options[:onmouseover] = "this.src='#{path_to_image(mouseover)}'"
options[:onmouseout] = "this.src='#{src}'"
end
tag("img", options)
end
# Returns an html video tag for the +sources+. If +sources+ is a string,
# a single video tag will be returned. If +sources+ is an array, a video
# tag with nested source tags for each source will be returned. The
# +sources+ can be full paths or files that exists in your public videos
# directory.
#
# ==== Options
# You can add HTML attributes using the +options+. The +options+ supports
# two additional keys for convenience and conformance:
#
# * :poster - Set an image (like a screenshot) to be shown
# before the video loads. The path is calculated like the +src+ of +image_tag+.
# * :size - Supplied as "{Width}x{Height}", so "30x45" becomes
# width="30" and height="45". :size will be ignored if the
# value is not in the correct format.
#
# ==== Examples
# video_tag("trailer") # =>
#
# video_tag("trailer.ogg") # =>
#
# video_tag("trailer.ogg", :controls => true, :autobuffer => true) # =>
#
# video_tag("trailer.m4v", :size => "16x10", :poster => "screenshot.png") # =>
#
# video_tag("/trailers/hd.avi", :size => "16x16") # =>
#
# video_tag("/trailers/hd.avi", :height => '32', :width => '32') # =>
#
# video_tag(["trailer.ogg", "trailer.flv"]) # =>
#
# video_tag(["trailer.ogg", "trailer.flv"] :size => "160x120") # =>
#
def video_tag(sources, options = {})
options.symbolize_keys!
options[:poster] = path_to_image(options[:poster]) if options[:poster]
if size = options.delete(:size)
options[:width], options[:height] = size.split("x") if size =~ %r{^\d+x\d+$}
end
if sources.is_a?(Array)
content_tag("video", options) do
sources.map { |source| tag("source", :src => source) }.join.html_safe
end
else
options[:src] = path_to_video(sources)
tag("video", options)
end
end
# Returns an html audio tag for the +source+.
# The +source+ can be full path or file that exists in
# your public audios directory.
#
# ==== Examples
# audio_tag("sound") # =>
#
# audio_tag("sound.wav") # =>
#
# audio_tag("sound.wav", :autoplay => true, :controls => true) # =>
#
def audio_tag(source, options = {})
options.symbolize_keys!
options[:src] = path_to_audio(source)
tag("audio", options)
end
private
def rewrite_extension(source, dir, ext)
source_ext = File.extname(source)
if source_ext.empty?
"#{source}.#{ext}"
elsif ext != source_ext[1..-1]
with_ext = "#{source}.#{ext}"
with_ext if File.exist?(File.join(config.assets_dir, dir, with_ext))
end || source
end
def rewrite_host_and_protocol(source, has_request)
host = compute_asset_host(source)
if has_request && host && !is_uri?(host)
host = "#{controller.request.protocol}#{host}"
end
"#{host}#{source}"
end
def rewrite_relative_url_root(source, relative_url_root)
relative_url_root && !source.starts_with?("#{relative_url_root}/") ? "#{relative_url_root}#{source}" : source
end
# Add the the extension +ext+ if not present. Return full URLs otherwise untouched.
# Prefix with /dir/ if lacking a leading +/+. Account for relative URL
# roots. Rewrite the asset path for cache-busting asset ids. Include
# asset host, if configured, with the correct request protocol.
def compute_public_path(source, dir, ext = nil, include_host = true)
return source if is_uri?(source)
source = rewrite_extension(source, dir, ext) if ext
source = "/#{dir}/#{source}" unless source[0] == ?/
if controller.respond_to?(:env) && controller.env["action_dispatch.asset_path"]
source = rewrite_asset_path(source, controller.env["action_dispatch.asset_path"])
end
source = rewrite_asset_path(source, config.asset_path)
has_request = controller.respond_to?(:request)
source = rewrite_relative_url_root(source, controller.config.relative_url_root) if has_request && include_host
source = rewrite_host_and_protocol(source, has_request) if include_host
source
end
def is_uri?(path)
path =~ %r{^[-a-z]+://|^cid:}
end
# Pick an asset host for this source. Returns +nil+ if no host is set,
# the host if no wildcard is set, the host interpolated with the
# numbers 0-3 if it contains %d (the number is the source hash mod 4),
# or the value returned from invoking the proc if it's a proc or the value from
# invoking call if it's an object responding to call.
def compute_asset_host(source)
if host = config.asset_host
if host.is_a?(Proc) || host.respond_to?(:call)
case host.is_a?(Proc) ? host.arity : host.method(:call).arity
when 2
request = controller.respond_to?(:request) && controller.request
host.call(source, request)
else
host.call(source)
end
else
(host =~ /%d/) ? host % (source.hash % 4) : host
end
end
end
# Break out the asset path rewrite in case plugins wish to put the asset id
# someplace other than the query string.
def rewrite_asset_path(source, path = nil)
if path && path.respond_to?(:call)
return path.call(source)
elsif path && path.is_a?(String)
return path % [source]
else
handle_asset_id(source)
end
end
# This is the default implementation
def handle_asset_id(source)
source
end
end
end
end
end
# image_tag("icon.png") # =>
# 
# image_tag("icon.png", :size => "16x10", :alt => "Edit Entry") # =>
# 
# image_tag("/icons/icon.gif", :height => '32', :width => '32') # =>
# 
# image_tag("mouse.png", :mouseover => image_path("mouse_over.png")) # =>
#