Module: ActionView::Helpers::AssetTagHelper
- Defined in:
- lib/action_view/helpers/asset_tag_helper.rb
Overview
Provides methods for linking a HTML page together with other assets, such as javascripts, stylesheets, and feeds.
Constant Summary collapse
- JAVASCRIPT_DEFAULT_SOURCES =
['prototype', 'effects', 'dragdrop', 'controls']
- @@javascript_default_sources =
JAVASCRIPT_DEFAULT_SOURCES.dup
Class Method Summary collapse
-
.register_javascript_include_default(*sources) ⇒ Object
Register one or more additional JavaScript files to be included when javascript_include_tag :defaults.
-
.reset_javascript_include_default ⇒ Object
:nodoc:.
Instance Method Summary collapse
-
#auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {}) ⇒ Object
Returns a link tag that browsers and news readers can use to auto-detect a RSS or ATOM feed for this page.
-
#image_path(source) ⇒ Object
Returns path to an image asset.
-
#image_tag(source, options = {}) ⇒ Object
Returns an image tag converting the
options
into html options on the tag, but with these special cases:. -
#javascript_include_tag(*sources) ⇒ Object
Returns a script include tag per source given as argument.
-
#javascript_path(source) ⇒ Object
Returns path to a javascript asset.
-
#stylesheet_link_tag(*sources) ⇒ Object
Returns a css link tag per source given as argument.
-
#stylesheet_path(source) ⇒ Object
Returns path to a stylesheet asset.
Class Method Details
.register_javascript_include_default(*sources) ⇒ Object
Register one or more additional JavaScript files to be included when
javascript_include_tag :defaults
is called. This method is intended to be called only from plugin initialization to register extra .js files the plugin installed in public/javascripts
.
84 85 86 |
# File 'lib/action_view/helpers/asset_tag_helper.rb', line 84 def self.register_javascript_include_default(*sources) @@javascript_default_sources.concat(sources) end |
.reset_javascript_include_default ⇒ Object
:nodoc:
88 89 90 |
# File 'lib/action_view/helpers/asset_tag_helper.rb', line 88 def self.reset_javascript_include_default #:nodoc: @@javascript_default_sources = JAVASCRIPT_DEFAULT_SOURCES.dup end |
Instance Method Details
#auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {}) ⇒ Object
Returns a link tag that browsers and news readers can use to auto-detect a RSS or ATOM feed for this page. The type
can either be :rss
(default) or :atom
and the options
follow the url_for style of declaring a link target.
Examples:
auto_discovery_link_tag # =>
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.curenthost.com/controller/action" />
auto_discovery_link_tag(:atom) # =>
<link rel="alternate" type="application/atom+xml" title="ATOM" href="http://www.curenthost.com/controller/action" />
auto_discovery_link_tag(:rss, {:action => "feed"}) # =>
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.curenthost.com/controller/feed" />
auto_discovery_link_tag(:rss, {:action => "feed"}, {:title => "My RSS"}) # =>
<link rel="alternate" type="application/rss+xml" title="My RSS" href="http://www.curenthost.com/controller/feed" />
21 22 23 24 25 26 27 28 29 |
# File 'lib/action_view/helpers/asset_tag_helper.rb', line 21 def auto_discovery_link_tag(type = :rss, = {}, = {}) tag( "link", "rel" => [:rel] || "alternate", "type" => [:type] || "application/#{type}+xml", "title" => [:title] || type.to_s.upcase, "href" => .is_a?(Hash) ? url_for(.merge(:only_path => false)) : ) end |
#image_path(source) ⇒ Object
Returns path to an image asset. Example:
The src
can be supplied as a…
-
full path, like “/my_images/image.gif”
-
file name, like “rss.gif”, that gets expanded to “/images/rss.gif”
-
file name without extension, like “logo”, that gets expanded to “/images/logo.png”
124 125 126 |
# File 'lib/action_view/helpers/asset_tag_helper.rb', line 124 def image_path(source) compute_public_path(source, 'images', 'png') end |
#image_tag(source, options = {}) ⇒ Object
Returns an image tag converting the options
into html options on the tag, but with these special cases:
-
:alt
- If no alt text is given, the file name part of thesrc
is used (capitalized and without the extension) -
:size
- Supplied as “XxY”, so “30x45” becomes width=“30” and height=“45”
The src
can be supplied as a…
-
full path, like “/my_images/image.gif”
-
file name, like “rss.gif”, that gets expanded to “/images/rss.gif”
-
file name without extension, like “logo”, that gets expanded to “/images/logo.png”
137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/action_view/helpers/asset_tag_helper.rb', line 137 def image_tag(source, = {}) .symbolize_keys! [:src] = image_path(source) [:alt] ||= File.basename([:src], '.*').split('.').first.capitalize if [:size] [:width], [:height] = [:size].split("x") .delete :size end tag("img", ) end |
#javascript_include_tag(*sources) ⇒ Object
Returns a script include tag per source given as argument. Examples:
javascript_include_tag "xmlhr" # =>
<script type="text/javascript" src="/javascripts/xmlhr.js"></script>
javascript_include_tag "common.javascript", "/elsewhere/cools" # =>
<script type="text/javascript" src="/javascripts/common.javascript"></script>
<script type="text/javascript" src="/elsewhere/cools.js"></script>
javascript_include_tag :defaults # =>
<script type="text/javascript" src="/javascripts/prototype.js"></script>
<script type="text/javascript" src="/javascripts/effects.js"></script>
...
<script type="text/javascript" src="/javascripts/application.js"></script> *see below
If there’s an application.js
file in your public/javascripts
directory, javascript_include_tag :defaults
will automatically include it. This file facilitates the inclusion of small snippets of JavaScript code, along the lines of controllers/application.rb
and helpers/application_helper.rb
.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/action_view/helpers/asset_tag_helper.rb', line 60 def javascript_include_tag(*sources) = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { } if sources.include?(:defaults) sources = sources[0..(sources.index(:defaults))] + @@javascript_default_sources.dup + sources[(sources.index(:defaults) + 1)..sources.length] sources.delete(:defaults) sources << "application" if defined?(RAILS_ROOT) && File.exists?("#{RAILS_ROOT}/public/javascripts/application.js") end sources.collect { |source| source = javascript_path(source) content_tag("script", "", { "type" => "text/javascript", "src" => source }.merge()) }.join("\n") end |
#javascript_path(source) ⇒ Object
Returns path to a javascript asset. Example:
javascript_path "xmlhr" # => /javascripts/xmlhr.js
34 35 36 |
# File 'lib/action_view/helpers/asset_tag_helper.rb', line 34 def javascript_path(source) compute_public_path(source, 'javascripts', 'js') end |
#stylesheet_link_tag(*sources) ⇒ Object
Returns a css link tag per source given as argument. Examples:
stylesheet_link_tag "style" # =>
<link href="/stylesheets/style.css" media="screen" rel="Stylesheet" type="text/css" />
stylesheet_link_tag "style", :media => "all" # =>
<link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" />
stylesheet_link_tag "random.styles", "/css/stylish" # =>
<link href="/stylesheets/random.styles" media="screen" rel="Stylesheet" type="text/css" />
<link href="/css/stylish.css" media="screen" rel="Stylesheet" type="text/css" />
110 111 112 113 114 115 116 |
# File 'lib/action_view/helpers/asset_tag_helper.rb', line 110 def stylesheet_link_tag(*sources) = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { } sources.collect { |source| source = stylesheet_path(source) tag("link", { "rel" => "Stylesheet", "type" => "text/css", "media" => "screen", "href" => source }.merge()) }.join("\n") end |
#stylesheet_path(source) ⇒ Object
Returns path to a stylesheet asset. Example:
stylesheet_path "style" # => /stylesheets/style.css
95 96 97 |
# File 'lib/action_view/helpers/asset_tag_helper.rb', line 95 def stylesheet_path(source) compute_public_path(source, 'stylesheets', 'css') end |