require 'active_support/concern' require 'active_support/core_ext/file' require 'action_view/helpers/asset_tag_helpers/asset_include_tag' module ActionView module Helpers module AssetTagHelper class JavascriptIncludeTag < AssetIncludeTag def asset_name 'javascript' end def extension 'js' end def asset_tag(source, options) content_tag("script", "", { "src" => path_to_asset(source) }.merge(options)) end def custom_dir config.javascripts_dir end private def expand_sources(sources, recursive = false) if sources.include?(:all) all_asset_files = (collect_asset_files(custom_dir, ('**' if recursive), "*.#{extension}") - ['application']) << 'application' ((determine_source(:defaults, expansions).dup & all_asset_files) + all_asset_files).uniq else expanded_sources = sources.inject([]) do |list, source| determined_source = determine_source(source, expansions) update_source_list(list, determined_source) end add_application_js(expanded_sources, sources) expanded_sources end end def add_application_js(expanded_sources, sources) if sources.include?(:defaults) && File.exist?(File.join(custom_dir, "application.#{extension}")) expanded_sources.delete('application') expanded_sources << "application" end end end module JavascriptTagHelpers extend ActiveSupport::Concern module ClassMethods # Register one or more javascript files to be included when symbol # is passed to javascript_include_tag. This method is typically intended # to be called from plugin initialization to register javascript files # that the plugin installed in public/javascripts. # # ActionView::Helpers::AssetTagHelper.register_javascript_expansion :monkey => ["head", "body", "tail"] # # javascript_include_tag :monkey # => # # # def register_javascript_expansion(expansions) js_expansions = JavascriptIncludeTag.expansions expansions.each do |key, values| js_expansions[key] = (js_expansions[key] || []) | Array(values) end end end # Computes the path to a javascript asset in the public javascripts directory. # If the +source+ filename has no extension, .js will be appended (except for explicit URIs) # Full paths from the document root will be passed through. # Used internally by javascript_include_tag to build the script path. # # javascript_path "xmlhr" # => /javascripts/xmlhr.js # javascript_path "dir/xmlhr.js" # => /javascripts/dir/xmlhr.js # javascript_path "/dir/xmlhr" # => /dir/xmlhr.js # javascript_path "http://www.example.com/js/xmlhr" # => http://www.example.com/js/xmlhr # javascript_path "http://www.example.com/js/xmlhr.js" # => http://www.example.com/js/xmlhr.js def javascript_path(source) asset_paths.compute_public_path(source, 'javascripts', :ext => 'js') end alias_method :path_to_javascript, :javascript_path # aliased to avoid conflicts with a javascript_path named route # Computes the full URL to a javascript asset in the public javascripts directory. # This will use +javascript_path+ internally, so most of their behaviors will be the same. def javascript_url(source) URI.join(current_host, path_to_javascript(source)).to_s end alias_method :url_to_javascript, :javascript_url # aliased to avoid conflicts with a javascript_url named route # 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 public/javascripts, 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. # # If the application is not using the asset pipeline, to include the default JavaScript # expansion pass :defaults as source. By default, :defaults loads jQuery, # and that can be overridden in config/application.rb: # # config.action_view.javascript_expansions[:defaults] = %w(foo.js bar.js) # # When using :defaults, if an application.js file exists in # public/javascripts it will be included as well at the end. # # You can modify the HTML attributes of the script tag by passing a hash as the # last argument. # # javascript_include_tag "xmlhr" # # => # # javascript_include_tag "xmlhr.js" # # => # # javascript_include_tag "common.javascript", "/elsewhere/cools" # # => # # # # javascript_include_tag "http://www.example.com/xmlhr" # # => # # javascript_include_tag "http://www.example.com/xmlhr.js" # # => # # javascript_include_tag :defaults # # => # # # # # # You can also include all JavaScripts in the +javascripts+ directory using :all as the source: # # javascript_include_tag :all # # => # # # # # # # # # # Note that your defaults of choice will be included first, so they will be available to all subsequently # included files. # # If you want Rails to search in all the subdirectories under public/javascripts, you should # explicitly set :recursive: # # javascript_include_tag :all, :recursive => true # # == Caching multiple JavaScripts into one # # You can also cache multiple JavaScripts into one file, which requires less HTTP connections to download # and can better be compressed by gzip (leading to faster transfers). Caching will only happen if # config.perform_caching is set to true (which is the case by default for the Rails # production environment, but not for the development environment). # # # assuming config.perform_caching is false # javascript_include_tag :all, :cache => true # # => # # # # # # # # # # # assuming config.perform_caching is true # javascript_include_tag :all, :cache => true # # => # # # assuming config.perform_caching is false # javascript_include_tag "jquery", "cart", "checkout", :cache => "shop" # # => # # # # # # # assuming config.perform_caching is true # javascript_include_tag "jquery", "cart", "checkout", :cache => "shop" # # => # # The :recursive option is also available for caching: # # javascript_include_tag :all, :cache => true, :recursive => true def javascript_include_tag(*sources) @javascript_include ||= JavascriptIncludeTag.new(config, asset_paths) @javascript_include.include_tag(*sources) end end end end end