From 1c129f8f8ea5b10605ad77af6064c983584d463d Mon Sep 17 00:00:00 2001 From: Josh Kalderimis Date: Sun, 14 Nov 2010 22:13:17 +0100 Subject: separated the asset id methods to a separate module, removed some dupliation with the various path methods, and moved the base asset tag methods to a base module so the asset id module can play nice with the path generation --- .../lib/action_view/helpers/asset_tag_helper.rb | 409 +-------------------- .../helpers/asset_tag_helpers/asset_id_caching.rb | 67 ++++ .../asset_tag_helpers/base_asset_helpers.rb | 330 +++++++++++++++++ .../helpers/asset_tag_helpers/helper_methods.rb | 67 ++++ .../asset_tag_helpers/javascript_tag_helpers.rb | 13 +- .../asset_tag_helpers/stylesheet_tag_helpers.rb | 13 +- 6 files changed, 486 insertions(+), 413 deletions(-) create mode 100644 actionpack/lib/action_view/helpers/asset_tag_helpers/asset_id_caching.rb create mode 100644 actionpack/lib/action_view/helpers/asset_tag_helpers/base_asset_helpers.rb create mode 100644 actionpack/lib/action_view/helpers/asset_tag_helpers/helper_methods.rb (limited to 'actionpack/lib/action_view') diff --git a/actionpack/lib/action_view/helpers/asset_tag_helper.rb b/actionpack/lib/action_view/helpers/asset_tag_helper.rb index 858fff2882..065df849a4 100644 --- a/actionpack/lib/action_view/helpers/asset_tag_helper.rb +++ b/actionpack/lib/action_view/helpers/asset_tag_helper.rb @@ -2,8 +2,10 @@ require 'thread' require 'cgi' require 'action_view/helpers/url_helper' require 'action_view/helpers/tag_helper' +require 'action_view/helpers/asset_tag_helpers/base_asset_helpers' require 'action_view/helpers/asset_tag_helpers/javascript_tag_helpers' require 'action_view/helpers/asset_tag_helpers/stylesheet_tag_helpers' +require 'action_view/helpers/asset_tag_helpers/asset_id_caching' require 'active_support/core_ext/file' require 'active_support/core_ext/object/blank' require 'active_support/core_ext/string/output_safety' @@ -197,413 +199,10 @@ module ActionView # RewriteEngine On # RewriteRule ^/release-\d+/(images|javascripts|stylesheets)/(.*)$ /$1/$2 [L] module AssetTagHelper + include BaseAssetHelpers include JavascriptTagHelpers include StylesheetTagHelpers - - # You can enable or disable the asset tag timestamps cache. - # With the cache enabled, the asset tag helper methods will make fewer - # expensive file system calls. However this prevents you from modifying - # any asset files while the server is running. - # - # ActionView::Helpers::AssetTagHelper.cache_asset_timestamps = false - mattr_accessor :cache_asset_timestamps - - # 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. - def image_path(source) - compute_public_path(source, 'images') - end - alias_method :path_to_image, :image_path # aliased to avoid conflicts with an image_path named route - - # 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 - def video_path(source) - compute_public_path(source, 'videos') - end - alias_method :path_to_video, :video_path # aliased to avoid conflicts with a video_path named route - - # 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.avi - # audio_path("sounds/horse.wav") # => /audios/sounds/horse.avi - # audio_path("/sounds/horse.wav") # => /sounds/horse.avi - # audio_path("http://www.railsapplication.com/sounds/horse.wav") # => http://www.railsapplication.com/sounds/horse.wav - def audio_path(source) - compute_public_path(source, 'audios') - end - alias_method :path_to_audio, :audio_path # aliased to avoid conflicts with an audio_path named route - - # 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") # => - # Icon - # image_tag("icon.png") # => - # Icon - # image_tag("icon.png", :size => "16x10", :alt => "Edit Entry") # => - # Edit Entry - # image_tag("/icons/icon.gif", :size => "16x16") # => - # Icon - # image_tag("/icons/icon.gif", :height => '32', :width => '32') # => - # Icon - # image_tag("/icons/icon.gif", :class => "menu_icon") # => - # Icon - # image_tag("mouse.png", :mouseover => "/images/mouse_over.png") # => - # Mouse - # image_tag("mouse.png", :mouseover => image_path("mouse_over.png")) # => - # Mouse - 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") # => - #