Skip to content
This repository
tree: fb39249f36
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 299 lines (279 sloc) 14.603 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
require 'active_support/core_ext/array/extract_options'
require 'active_support/core_ext/hash/keys'
require 'action_view/helpers/asset_url_helper'
require 'action_view/helpers/tag_helper'

module ActionView
  # = Action View Asset Tag Helpers
  module Helpers #:nodoc:
    # This module provides methods for generating HTML that links views to assets such
    # as images, javascripts, stylesheets, and feeds. These methods do not verify
    # the assets exist before linking to them:
    #
    # image_tag("rails.png")
    # # => <img alt="Rails" src="/assets/rails.png" />
    # stylesheet_link_tag("application")
    # # => <link href="/assets/application.css?body=1" media="screen" rel="stylesheet" />
    #
    module AssetTagHelper
      extend ActiveSupport::Concern

      include AssetUrlHelper
      include TagHelper

      # Returns an HTML script tag for each of the +sources+ provided.
      #
      # Sources may be paths to JavaScript files. Relative paths are assumed to be relative
      # to <tt>assets/javascripts</tt>, full paths are assumed to be relative to the document
      # root. Relative paths are idiomatic, use absolute paths only when needed.
      #
      # When passing paths, the ".js" extension is optional.
      #
      # You can modify the HTML attributes of the script tag by passing a hash as the
      # last argument.
      #
      # When the Asset Pipeline is enabled, you can pass the name of your manifest as
      # source, and include other JavaScript or CoffeeScript files inside the manifest.
      #
      # javascript_include_tag "xmlhr"
      # # => <script src="/assets/xmlhr.js?1284139606"></script>
      #
      # javascript_include_tag "xmlhr.js"
      # # => <script src="/assets/xmlhr.js?1284139606"></script>
      #
      # javascript_include_tag "common.javascript", "/elsewhere/cools"
      # # => <script src="/assets/common.javascript?1284139606"></script>
      # # <script src="/elsewhere/cools.js?1423139606"></script>
      #
      # javascript_include_tag "http://www.example.com/xmlhr"
      # # => <script src="http://www.example.com/xmlhr"></script>
      #
      # javascript_include_tag "http://www.example.com/xmlhr.js"
      # # => <script src="http://www.example.com/xmlhr.js"></script>
      #
      def javascript_include_tag(*sources)
        options = sources.extract_options!.stringify_keys
        sources.uniq.map { |source|
          tag_options = {
            "src" => path_to_javascript(source)
          }.merge(options)
          content_tag(:script, "", tag_options)
        }.join("\n").html_safe
      end

      # Returns a stylesheet link tag for the sources specified as arguments. If
      # you don't specify an extension, <tt>.css</tt> will be appended automatically.
      # You can modify the link attributes by passing a hash as the last argument.
      # For historical reasons, the 'media' attribute will always be present and defaults
      # to "screen", so you must explicitely set it to "all" for the stylesheet(s) to
      # apply to all media types.
      #
      # When the Asset Pipeline is enabled, the helper is usually employed to load the manifest
      # file to be processed by it.
      #
      # stylesheet_link_tag "style"
      # # => <link href="/assets/style.css" media="screen" rel="stylesheet" />
      #
      # stylesheet_link_tag "style.css"
      # # => <link href="/assets/style.css" media="screen" rel="stylesheet" />
      #
      # stylesheet_link_tag "http://www.example.com/style.css"
      # # => <link href="http://www.example.com/style.css" media="screen" rel="stylesheet" />
      #
      # stylesheet_link_tag "style", media: "all"
      # # => <link href="/assets/style.css" media="all" rel="stylesheet" />
      #
      # stylesheet_link_tag "style", media: "print"
      # # => <link href="/assets/style.css" media="print" rel="stylesheet" />
      #
      # stylesheet_link_tag "random.styles", "/css/stylish"
      # # => <link href="/assets/random.styles" media="screen" rel="stylesheet" />
      # # <link href="/css/stylish.css" media="screen" rel="stylesheet" />
      #
      def stylesheet_link_tag(*sources)
        options = sources.extract_options!.stringify_keys
        sources.uniq.map { |source|
          tag_options = {
            "rel" => "stylesheet",
            "media" => "screen",
            "href" => path_to_stylesheet(source)
          }.merge(options)
          tag(:link, tag_options)
        }.join("\n").html_safe
      end

      # Returns a link tag that browsers and news readers can use to auto-detect
      # an RSS or Atom feed. The +type+ can either be <tt>:rss</tt> (default) or
      # <tt>:atom</tt>. Control the link options in url_for format using the
      # +url_options+. You can modify the LINK tag itself in +tag_options+.
      #
      # ==== Options
      # * <tt>:rel</tt> - Specify the relation of this link, defaults to "alternate"
      # * <tt>:type</tt> - Override the auto-generated mime type
      # * <tt>:title</tt> - Specify the title of the link, defaults to the +type+
      #
      # auto_discovery_link_tag
      # # => <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/controller/action" />
      # auto_discovery_link_tag(:atom)
      # # => <link rel="alternate" type="application/atom+xml" title="ATOM" href="http://www.currenthost.com/controller/action" />
      # auto_discovery_link_tag(:rss, {action: "feed"})
      # # => <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.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.currenthost.com/controller/feed" />
      # auto_discovery_link_tag(:rss, {controller: "news", action: "feed"})
      # # => <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/news/feed" />
      # auto_discovery_link_tag(:rss, "http://www.example.com/feed.rss", {title: "Example RSS"})
      # # => <link rel="alternate" type="application/rss+xml" title="Example RSS" href="http://www.example.com/feed" />
      def auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {})
        if !(type == :rss || type == :atom) && tag_options[:type].blank?
          message = "You have passed type other than :rss or :atom to auto_discovery_link_tag and haven't supplied " +
                    "the :type option key. This behavior is deprecated and will be remove in Rails 4.1. You should pass " +
                    ":type option explicitly if you want to use other types, for example: " +
                    "auto_discovery_link_tag(:xml, '/feed.xml', :type => 'application/xml')"
          ActiveSupport::Deprecation.warn message
        end

        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

      # Returns a link loading a favicon file. You may specify a different file
      # in the first argument. The helper accepts an additional options hash where
      # you can override "rel" and "type".
      #
      # ==== Options
      # * <tt>:rel</tt> - Specify the relation of this link, defaults to 'shortcut icon'
      # * <tt>:type</tt> - Override the auto-generated mime type, defaults to 'image/vnd.microsoft.icon'
      #
      # favicon_link_tag '/myicon.ico'
      # # => <link href="/assets/favicon.ico" rel="shortcut icon" type="image/vnd.microsoft.icon" />
      #
      # 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'
      # # => <link href="/assets/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

      # Returns an HTML image tag for the +source+. The +source+ can be a full
      # path or a file.
      #
      # ==== Options
      # You can add HTML attributes using the +options+. The +options+ supports
      # three additional keys for convenience and conformance:
      #
      # * <tt>:alt</tt> - If no alt text is given, the file name part of the
      # +source+ is used (capitalized and without the extension)
      # * <tt>:size</tt> - Supplied as "{Width}x{Height}" or "{Number}", so "30x45" becomes
      # width="30" and height="45", and "50" becomes width="50" and height="50".
      # <tt>:size</tt> will be ignored if the value is not in the correct format.
      #
      # image_tag("icon")
      # # => <img alt="Icon" src="/assets/icon" />
      # image_tag("icon.png")
      # # => <img alt="Icon" src="/assets/icon.png" />
      # image_tag("icon.png", size: "16x10", alt: "Edit Entry")
      # # => <img src="/assets/icon.png" width="16" height="10" alt="Edit Entry" />
      # image_tag("/icons/icon.gif", size: "16")
      # # => <img src="/icons/icon.gif" width="16" height="16" alt="Icon" />
      # image_tag("/icons/icon.gif", height: '32', width: '32')
      # # => <img alt="Icon" height="32" src="/icons/icon.gif" width="32" />
      # image_tag("/icons/icon.gif", class: "menu_icon")
      # # => <img alt="Icon" class="menu_icon" src="/icons/icon.gif" />
      def image_tag(source, options={})
        options = options.symbolize_keys

        src = options[:src] = path_to_image(source)

        unless src =~ /^(?:cid|data):/ || src.blank?
          options[:alt] = options.fetch(:alt){ image_alt(src) }
        end

        if size = options.delete(:size)
          options[:width], options[:height] = size.split("x") if size =~ %r{\A\d+x\d+\z}
          options[:width] = options[:height] = size if size =~ %r{\A\d+\z}
        end

        tag("img", options)
      end

      # Returns a string suitable for an html image tag alt attribute.
      # +src+ is meant to be an image file path.
      # It removes the basename of the file path and the digest, if any.
      def image_alt(src)
        File.basename(src, '.*').sub(/-[[:xdigit:]]{32}\z/, '').capitalize
      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:
      #
      # * <tt>:poster</tt> - Set an image (like a screenshot) to be shown
      # before the video loads. The path is calculated like the +src+ of +image_tag+.
      # * <tt>:size</tt> - Supplied as "{Width}x{Height}", so "30x45" becomes
      # width="30" and height="45". <tt>:size</tt> will be ignored if the
      # value is not in the correct format.
      #
      # video_tag("trailer")
      # # => <video src="/videos/trailer" />
      # video_tag("trailer.ogg")
      # # => <video src="/videos/trailer.ogg" />
      # video_tag("trailer.ogg", controls: true, autobuffer: true)
      # # => <video autobuffer="autobuffer" controls="controls" src="/videos/trailer.ogg" />
      # video_tag("trailer.m4v", size: "16x10", poster: "screenshot.png")
      # # => <video src="/videos/trailer.m4v" width="16" height="10" poster="/assets/screenshot.png" />
      # video_tag("/trailers/hd.avi", size: "16x16")
      # # => <video src="/trailers/hd.avi" width="16" height="16" />
      # video_tag("/trailers/hd.avi", height: '32', width: '32')
      # # => <video height="32" src="/trailers/hd.avi" width="32" />
      # video_tag("trailer.ogg", "trailer.flv")
      # # => <video><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video>
      # video_tag(["trailer.ogg", "trailer.flv"])
      # # => <video><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video>
      # video_tag(["trailer.ogg", "trailer.flv"], size: "160x120")
      # # => <video height="120" width="160"><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video>
      def video_tag(*sources)
        multiple_sources_tag('video', sources) do |options|
          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
        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.
      #
      # audio_tag("sound")
      # # => <audio src="/audios/sound" />
      # audio_tag("sound.wav")
      # # => <audio src="/audios/sound.wav" />
      # audio_tag("sound.wav", autoplay: true, controls: true)
      # # => <audio autoplay="autoplay" controls="controls" src="/audios/sound.wav" />
      # audio_tag("sound.wav", "sound.mid")
      # # => <audio><source src="/audios/sound.wav" /><source src="/audios/sound.mid" /></audio>
      def audio_tag(*sources)
        multiple_sources_tag('audio', sources)
      end

      private
        def multiple_sources_tag(type, sources)
          options = sources.extract_options!.symbolize_keys
          sources.flatten!

          yield options if block_given?

          if sources.size > 1
            content_tag(type, options) do
              safe_join sources.map { |source| tag("source", :src => send("path_to_#{type}", source)) }
            end
          else
            options[:src] = send("path_to_#{type}", sources.first)
            content_tag(type, nil, options)
          end
        end
    end
  end
end
Something went wrong with that request. Please try again.