actionpack 3.0.20 → 3.1.0.beta1

data/lib/action_view/helpers/asset_tag_helpers/asset_include_tag.rb

@@ -0,0 +1,147 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/file'
+require 'action_view/helpers/tag_helper'
+
+module ActionView
+  module Helpers
+    module AssetTagHelper
+
+      class AssetIncludeTag
+        include TagHelper
+
+        attr_reader :config, :asset_paths
+        class_attribute :expansions
+
+        def self.inherited(base)
+          base.expansions = { }
+        end
+
+        def initialize(config, asset_paths)
+          @config = config
+          @asset_paths = asset_paths
+        end
+
+        def asset_name
+          raise NotImplementedError
+        end
+
+        def extension
+          raise NotImplementedError
+        end
+
+        def custom_dir
+          raise NotImplementedError
+        end
+
+        def asset_tag(source, options)
+          raise NotImplementedError
+        end
+
+        def include_tag(*sources)
+          options = sources.extract_options!.stringify_keys
+          concat  = options.delete("concat")
+          cache   = concat || options.delete("cache")
+          recursive = options.delete("recursive")
+
+          if concat || (config.perform_caching && cache)
+            joined_name = (cache == true ? "all" : cache) + ".#{extension}"
+            joined_path = File.join((joined_name[/^#{File::SEPARATOR}/] ? config.assets_dir : custom_dir), joined_name)
+            unless config.perform_caching && File.exists?(joined_path)
+              write_asset_file_contents(joined_path, compute_paths(sources, recursive))
+            end
+            asset_tag(joined_name, options)
+          else
+            sources = expand_sources(sources, recursive)
+            ensure_sources!(sources) if cache
+            sources.collect { |source| asset_tag(source, options) }.join("\n").html_safe
+          end
+        end
+
+        private
+
+          def path_to_asset(source, include_host = true)
+            asset_paths.compute_public_path(source, asset_name.to_s.pluralize, extension, include_host)
+          end
+
+          def compute_paths(*args)
+            expand_sources(*args).collect { |source| asset_paths.compute_public_path(source, asset_name.pluralize, extension, false) }
+          end
+
+          def expand_sources(sources, recursive)
+            if sources.first == :all
+              collect_asset_files(custom_dir, ('**' if recursive), "*.#{extension}")
+            else
+              sources.inject([]) do |list, source|
+                determined_source = determine_source(source, expansions)
+                update_source_list(list, determined_source)
+              end
+            end
+          end
+
+          def update_source_list(list, source)
+            case source
+            when String
+              list.delete(source)
+              list << source
+            when Array
+              updated_sources = source - list
+              list.concat(updated_sources)
+            end
+          end
+
+          def ensure_sources!(sources)
+            sources.each do |source|
+              asset_file_path!(path_to_asset(source, false))
+            end
+          end
+
+          def collect_asset_files(*path)
+            dir = path.first
+
+            Dir[File.join(*path.compact)].collect do |file|
+              file[-(file.size - dir.size - 1)..-1].sub(/\.\w+$/, '')
+            end.sort
+          end
+
+          def determine_source(source, collection)
+            case source
+            when Symbol
+              collection[source] || raise(ArgumentError, "No expansion found for #{source.inspect}")
+            else
+              source
+            end
+          end
+
+          def join_asset_file_contents(paths)
+            paths.collect { |path| File.read(asset_file_path!(path, true)) }.join("\n\n")
+          end
+
+          def write_asset_file_contents(joined_asset_path, asset_paths)
+            FileUtils.mkdir_p(File.dirname(joined_asset_path))
+            File.atomic_write(joined_asset_path) { |cache| cache.write(join_asset_file_contents(asset_paths)) }
+
+            # Set mtime to the latest of the combined files to allow for
+            # consistent ETag without a shared filesystem.
+            mt = asset_paths.map { |p| File.mtime(asset_file_path(p)) }.max
+            File.utime(mt, mt, joined_asset_path)
+          end
+
+          def asset_file_path(path)
+            File.join(config.assets_dir, path.split('?').first)
+          end
+
+          def asset_file_path!(path, error_if_file_is_uri = false)
+            if asset_paths.is_uri?(path)
+              raise(Errno::ENOENT, "Asset file #{path} is uri and cannot be merged into single file") if error_if_file_is_uri
+            else
+              absolute_path = asset_file_path(path)
+              raise(Errno::ENOENT, "Asset file not found at '#{absolute_path}'" ) unless File.exist?(absolute_path)
+              return absolute_path
+            end
+          end
+      end
+
+    end
+  end
+end

data/lib/action_view/helpers/asset_tag_helpers/asset_paths.rb

@@ -0,0 +1,101 @@
+require 'active_support/core_ext/file'
+require 'action_view/helpers/asset_paths'
+
+module ActionView
+  module Helpers
+    module AssetTagHelper
+
+      class AssetPaths < ActionView::Helpers::AssetPaths #:nodoc:
+        # You can enable or disable the asset tag ids cache.
+        # With the cache enabled, the asset tag helper methods will make fewer
+        # expensive file system calls (the default implementation checks the file
+        # system timestamp). However this prevents you from modifying any asset
+        # files while the server is running.
+        #
+        #   ActionView::Helpers::AssetTagHelper::AssetPaths.cache_asset_ids = false
+        mattr_accessor :cache_asset_ids
+
+        # Add or change an asset id in the asset id cache. This can be used
+        # for SASS on Heroku.
+        # :api: public
+        def add_to_asset_ids_cache(source, asset_id)
+          self.asset_ids_cache_guard.synchronize do
+            self.asset_ids_cache[source] = asset_id
+          end
+        end
+
+      private
+
+        def rewrite_extension(source, dir, ext)
+          source_ext = File.extname(source)
+
+          source_with_ext = 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_with_ext || source
+        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, dir)
+          source = "/#{dir}/#{source}" unless source[0] == ?/
+          path = config.asset_path
+
+          if path && path.respond_to?(:call)
+            return path.call(source)
+          elsif path && path.is_a?(String)
+            return path % [source]
+          end
+
+          asset_id = rails_asset_id(source)
+          if asset_id.empty?
+            source
+          else
+            "#{source}?#{asset_id}"
+          end
+        end
+
+        mattr_accessor :asset_ids_cache
+        self.asset_ids_cache = {}
+
+        mattr_accessor :asset_ids_cache_guard
+        self.asset_ids_cache_guard = Mutex.new
+
+        # Use the RAILS_ASSET_ID environment variable or the source's
+        # modification time as its cache-busting asset id.
+        def rails_asset_id(source)
+          if asset_id = ENV["RAILS_ASSET_ID"]
+            asset_id
+          else
+            if self.cache_asset_ids && (asset_id = self.asset_ids_cache[source])
+              asset_id
+            else
+              path = File.join(config.assets_dir, source)
+              asset_id = File.exist?(path) ? File.mtime(path).to_i.to_s : ''
+
+              if self.cache_asset_ids
+                add_to_asset_ids_cache(source, asset_id)
+              end
+
+              asset_id
+            end
+          end
+        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
+
+        def rewrite_host_and_protocol(source, has_request)
+          source = rewrite_relative_url_root(source, controller.config.relative_url_root) if has_request
+          super(source, has_request)
+        end
+      end
+
+    end
+  end
+end

data/lib/action_view/helpers/asset_tag_helpers/javascript_tag_helpers.rb

@@ -0,0 +1,200 @@
+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", "", { "type" => Mime::JS, "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 <tt>symbol</tt>
+          # is passed to <tt>javascript_include_tag</tt>. This method is typically intended
+          # to be called from plugin initialization to register javascript files
+          # that the plugin installed in <tt>public/javascripts</tt>.
+          #
+          #   ActionView::Helpers::AssetTagHelper.register_javascript_expansion :monkey => ["head", "body", "tail"]
+          #
+          #   javascript_include_tag :monkey # =>
+          #     <script type="text/javascript" src="/javascripts/head.js"></script>
+          #     <script type="text/javascript" src="/javascripts/body.js"></script>
+          #     <script type="text/javascript" src="/javascripts/tail.js"></script>
+          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.
+        #
+        # ==== Examples
+        #   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)
+          if config.use_sprockets
+            asset_path(source, 'js')
+          else
+            asset_paths.compute_public_path(source, 'javascripts', 'js')
+          end
+        end
+        alias_method :path_to_javascript, :javascript_path # aliased to avoid conflicts with a javascript_path 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 <tt>public/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.
+        #
+        # If the application is not using the asset pipeline, to include the default JavaScript
+        # expansion pass <tt>:defaults</tt> as source. By default, <tt>:defaults</tt> loads jQuery,
+        # and that can be overridden in <tt>config/application.rb</tt>:
+        #
+        #   config.action_view.javascript_expansions[:defaults] = %w(foo.js bar.js)
+        #
+        # When using <tt>:defaults</tt>, if an <tt>application.js</tt> file exists in
+        # <tt>public/javascripts</tt> 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.
+        #
+        # ==== Examples
+        #   javascript_include_tag "xmlhr"
+        #   # => <script type="text/javascript" src="/javascripts/xmlhr.js?1284139606"></script>
+        #
+        #   javascript_include_tag "xmlhr.js"
+        #   # => <script type="text/javascript" src="/javascripts/xmlhr.js?1284139606"></script>
+        #
+        #   javascript_include_tag "common.javascript", "/elsewhere/cools"
+        #   # => <script type="text/javascript" src="/javascripts/common.javascript?1284139606"></script>
+        #   #    <script type="text/javascript" src="/elsewhere/cools.js?1423139606"></script>
+        #
+        #   javascript_include_tag "http://www.example.com/xmlhr"
+        #   # => <script type="text/javascript" src="http://www.example.com/xmlhr.js?1284139606"></script>
+        #
+        #   javascript_include_tag "http://www.example.com/xmlhr.js"
+        #   # => <script type="text/javascript" src="http://www.example.com/xmlhr.js?1284139606"></script>
+        #
+        #   javascript_include_tag :defaults
+        #   # => <script type="text/javascript" src="/javascripts/jquery.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/rails.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/application.js?1284139606"></script>
+        #
+        # * = The application.js file is only referenced if it exists
+        #
+        # You can also include all JavaScripts in the +javascripts+ directory using <tt>:all</tt> as the source:
+        #
+        #   javascript_include_tag :all
+        #   # => <script type="text/javascript" src="/javascripts/jquery.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/rails.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/application.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/shop.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/checkout.js?1284139606"></script>
+        #
+        # 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 <tt>public/javascripts</tt>, you should
+        # explicitly set <tt>:recursive</tt>:
+        #
+        #   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
+        # <tt>config.perform_caching</tt> is set to true (which is the case by default for the Rails
+        # production environment, but not for the development environment).
+        #
+        # ==== Examples
+        #
+        #   # assuming config.perform_caching is false
+        #   javascript_include_tag :all, :cache => true
+        #   # => <script type="text/javascript" src="/javascripts/jquery.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/rails.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/application.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/shop.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/checkout.js?1284139606"></script>
+        #
+        #   # assuming config.perform_caching is true
+        #   javascript_include_tag :all, :cache => true
+        #   # => <script type="text/javascript" src="/javascripts/all.js?1344139789"></script>
+        #
+        #   # assuming config.perform_caching is false
+        #   javascript_include_tag "jquery", "cart", "checkout", :cache => "shop"
+        #   # => <script type="text/javascript" src="/javascripts/jquery.js?1284139606"></script>
+        #   #    <script type="text/javascript" src="/javascripts/cart.js?1289139157"></script>
+        #   #    <script type="text/javascript" src="/javascripts/checkout.js?1299139816"></script>
+        #
+        #   # assuming config.perform_caching is true
+        #   javascript_include_tag "jquery", "cart", "checkout", :cache => "shop"
+        #   # => <script type="text/javascript" src="/javascripts/shop.js?1299139816"></script>
+        #
+        # The <tt>:recursive</tt> option is also available for caching:
+        #
+        #   javascript_include_tag :all, :cache => true, :recursive => true
+        def javascript_include_tag(*sources)
+          if config.use_sprockets
+            sprockets_javascript_include_tag(*sources)
+          else
+            @javascript_include ||= JavascriptIncludeTag.new(config, asset_paths)
+            @javascript_include.include_tag(*sources)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_view/helpers/asset_tag_helpers/stylesheet_tag_helpers.rb

@@ -0,0 +1,152 @@
+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 StylesheetIncludeTag < AssetIncludeTag
+        def asset_name
+          'stylesheet'
+        end
+
+        def extension
+          'css'
+        end
+
+        def asset_tag(source, options)
+          tag("link", { "rel" => "stylesheet", "type" => Mime::CSS, "media" => "screen", "href" => ERB::Util.html_escape(path_to_asset(source)) }.merge(options), false, false)
+        end
+
+        def custom_dir
+          config.stylesheets_dir
+        end
+      end
+
+
+      module StylesheetTagHelpers
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          # Register one or more stylesheet files to be included when <tt>symbol</tt>
+          # is passed to <tt>stylesheet_link_tag</tt>. This method is typically intended
+          # to be called from plugin initialization to register stylesheet files
+          # that the plugin installed in <tt>public/stylesheets</tt>.
+          #
+          #   ActionView::Helpers::AssetTagHelper.register_stylesheet_expansion :monkey => ["head", "body", "tail"]
+          #
+          #   stylesheet_link_tag :monkey # =>
+          #     <link href="/stylesheets/head.css"  media="screen" rel="stylesheet" type="text/css" />
+          #     <link href="/stylesheets/body.css"  media="screen" rel="stylesheet" type="text/css" />
+          #     <link href="/stylesheets/tail.css"  media="screen" rel="stylesheet" type="text/css" />
+          def register_stylesheet_expansion(expansions)
+            style_expansions = StylesheetIncludeTag.expansions
+            expansions.each do |key, values|
+              style_expansions[key] = (style_expansions[key] || []) | Array(values)
+            end
+          end
+        end
+
+        # Computes the path to a stylesheet asset in the public stylesheets directory.
+        # If the +source+ filename has no extension, <tt>.css</tt> will be appended (except for explicit URIs).
+        # Full paths from the document root will be passed through.
+        # Used internally by +stylesheet_link_tag+ to build the stylesheet path.
+        #
+        # ==== Examples
+        #   stylesheet_path "style"                                  # => /stylesheets/style.css
+        #   stylesheet_path "dir/style.css"                          # => /stylesheets/dir/style.css
+        #   stylesheet_path "/dir/style.css"                         # => /dir/style.css
+        #   stylesheet_path "http://www.example.com/css/style"       # => http://www.example.com/css/style
+        #   stylesheet_path "http://www.example.com/css/style.css"   # => http://www.example.com/css/style.css
+        def stylesheet_path(source)
+          if config.use_sprockets
+            asset_path(source, 'css')
+          else
+            asset_paths.compute_public_path(source, 'stylesheets', 'css')
+          end
+        end
+        alias_method :path_to_stylesheet, :stylesheet_path # aliased to avoid conflicts with a stylesheet_path named route
+
+        # 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.
+        #
+        # ==== Examples
+        #   stylesheet_link_tag "style" # =>
+        #     <link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" />
+        #
+        #   stylesheet_link_tag "style.css" # =>
+        #     <link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" />
+        #
+        #   stylesheet_link_tag "http://www.example.com/style.css" # =>
+        #     <link href="http://www.example.com/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 "style", :media => "print" # =>
+        #     <link href="/stylesheets/style.css" media="print" 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" />
+        #
+        # You can also include all styles in the stylesheets directory using <tt>:all</tt> as the source:
+        #
+        #   stylesheet_link_tag :all # =>
+        #     <link href="/stylesheets/style1.css"  media="screen" rel="stylesheet" type="text/css" />
+        #     <link href="/stylesheets/styleB.css"  media="screen" rel="stylesheet" type="text/css" />
+        #     <link href="/stylesheets/styleX2.css" media="screen" rel="stylesheet" type="text/css" />
+        #
+        # If you want Rails to search in all the subdirectories under stylesheets, you should explicitly set <tt>:recursive</tt>:
+        #
+        #   stylesheet_link_tag :all, :recursive => true
+        #
+        # == Caching multiple stylesheets into one
+        #
+        # You can also cache multiple stylesheets into one file, which requires less HTTP connections 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). Examples:
+        #
+        # ==== Examples
+        #   stylesheet_link_tag :all, :cache => true # when config.perform_caching is false =>
+        #     <link href="/stylesheets/style1.css"  media="screen" rel="stylesheet" type="text/css" />
+        #     <link href="/stylesheets/styleB.css"  media="screen" rel="stylesheet" type="text/css" />
+        #     <link href="/stylesheets/styleX2.css" media="screen" rel="stylesheet" type="text/css" />
+        #
+        #   stylesheet_link_tag :all, :cache => true # when config.perform_caching is true =>
+        #     <link href="/stylesheets/all.css"  media="screen" rel="stylesheet" type="text/css" />
+        #
+        #   stylesheet_link_tag "shop", "cart", "checkout", :cache => "payment" # when config.perform_caching is false =>
+        #     <link href="/stylesheets/shop.css"  media="screen" rel="stylesheet" type="text/css" />
+        #     <link href="/stylesheets/cart.css"  media="screen" rel="stylesheet" type="text/css" />
+        #     <link href="/stylesheets/checkout.css" media="screen" rel="stylesheet" type="text/css" />
+        #
+        #   stylesheet_link_tag "shop", "cart", "checkout", :cache => "payment" # when config.perform_caching is true =>
+        #     <link href="/stylesheets/payment.css"  media="screen" rel="stylesheet" type="text/css" />
+        #
+        # The <tt>:recursive</tt> option is also available for caching:
+        #
+        #   stylesheet_link_tag :all, :cache => true, :recursive => true
+        #
+        # To force concatenation (even in development mode) set <tt>:concat</tt> to true. This is useful if
+        # you have too many stylesheets for IE to load.
+        #
+        #   stylesheet_link_tag :all, :concat => true
+        #
+        def stylesheet_link_tag(*sources)
+          if config.use_sprockets
+            sprockets_stylesheet_link_tag(*sources)
+          else
+            @stylesheet_include ||= StylesheetIncludeTag.new(config, asset_paths)
+            @stylesheet_include.include_tag(*sources)
+          end
+        end
+
+      end
+
+    end
+  end
+end