Changeset 6164

Timestamp:

02/18/07 23:54:20 (1 year ago)

Author:

david

Message:

Added caching option to AssetTagHelper#stylesheet_link_tag and AssetTagHelper#javascript_include_tag [DHH]

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_controller/base.rb (modified) (1 diff)
• trunk/actionpack/lib/action_view/helpers/asset_tag_helper.rb (modified) (6 diffs)
• trunk/actionpack/test/controller/render_test.rb (modified) (1 diff)
• trunk/actionpack/test/fixtures/public/javascripts/bank.js (added)
• trunk/actionpack/test/fixtures/public/javascripts/robber.js (added)
• trunk/actionpack/test/fixtures/public/stylesheets (added)
• trunk/actionpack/test/fixtures/public/stylesheets/bank.css (added)
• trunk/actionpack/test/fixtures/public/stylesheets/robber.css (added)
• trunk/actionpack/test/template/asset_tag_helper_test.rb (modified) (8 diffs)

trunk/actionpack/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Added caching option to AssetTagHelper#stylesheet_link_tag and AssetTagHelper#javascript_include_tag [DHH]. Examples:
+
+    stylesheet_link_tag :all, :cache => true # when ActionController::Base.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 ActionController::Base.perform_caching is true =>
+      <link href="/stylesheets/all.css"  media="screen" rel="Stylesheet" type="text/css" />
+
+  ...when caching is on, all.css is the concatenation of style1.css, styleB.css, and styleX2.css.
+  Same deal for JavaScripts.
-
-* Work around the two connection per host browser limit: use asset%d.myapp.com to distribute asset requests among asset[0123].myapp.com. Use a DNS wildcard or CNAMEs to map these hosts to your asset server. See http://www.die.net/musings/page_load_time/ for background.  [Jeremy Kemper]

trunk/actionpack/lib/action_controller/base.rb

@@ -880 +880 @@
-          if text.is_a?(String)
-            if response.headers['Status'][0..2] == '200' && !response.body.empty?
-||
+
-
-              if request.headers['HTTP_IF_NONE_MATCH'] == response.headers['Etag']

trunk/actionpack/lib/action_view/helpers/asset_tag_helper.rb

@@ -29 +29 @@
-    # for background.
-    module AssetTagHelper
+      ASSETS_DIR      = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/public" : "public"
+      JAVASCRIPTS_DIR = "#{ASSETS_DIR}/javascripts"
+      STYLESHEETS_DIR = "#{ASSETS_DIR}/stylesheets"
+      
-      # 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
@@ -94 +98 @@
-      #     ...
-      #     <script type="text/javascript" src="/javascripts/application.js"></script> *see below
+      #
+      # * = The application.js file is only referenced if it exists
+      #
+      # You can also include all javascripts in the javascripts directory using :all as the source:
+      #
+      #   javascript_include_tag :all # =>
+      #     <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>
+      #     <script type="text/javascript" src="/javascripts/shop.js"></script>
+      #     <script type="text/javascript" src="/javascripts/checkout.js"></script>
+      #
+      # Note that the default javascript files will be included first. So Prototype and Scriptaculous are available for
+      # all subsequently included files. They
+      #
+      # == Caching multiple javascripts into one
+      #
+      # You can also cache multiple javascripts into one file, which requires less HTTP connections and can better be
+      # compressed by gzip (leading to faster transfers). Caching will only happen if ActionController::Base.perform_caching
+      # is set to true (which is the case by default for the Rails production environment, but not for the development
+      # environment). Examples:
+      #
+      #   javascript_include_tag :all, :cache => true # when ActionController::Base.perform_caching is false =>
+      #     <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>
+      #     <script type="text/javascript" src="/javascripts/shop.js"></script>
+      #     <script type="text/javascript" src="/javascripts/checkout.js"></script>
+      #
+      #   javascript_include_tag :all, :cache => true # when ActionController::Base.perform_caching is true =>
+      #     <script type="text/javascript" src="/javascripts/all.js"></script>
+      #
+      #   javascript_include_tag "prototype", "cart", "checkout", :cache => "shop" # when ActionController::Base.perform_caching is false =>
+      #     <script type="text/javascript" src="/javascripts/prototype.js"></script>
+      #     <script type="text/javascript" src="/javascripts/cart.js"></script>
+      #     <script type="text/javascript" src="/javascripts/checkout.js"></script>
+      #
+      #   javascript_include_tag "prototype", "cart", "checkout", :cache => "shop" # when ActionController::Base.perform_caching is false =>
+      #     <script type="text/javascript" src="/javascripts/shop.js"></script>
-      def javascript_include_tag(*sources)
-        options = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      end
-
@@ -149 +201 @@
-      #     <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 stylesheet directory using :all 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" />
+      #
+      # == 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 ActionController::Base.perform_caching
+      # is set to true (which is the case by default for the Rails production environment, but not for the development
+      # environment). Examples:
+      #
+      #   stylesheet_link_tag :all, :cache => true # when ActionController::Base.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 ActionController::Base.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 ActionController::Base.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 ActionController::Base.perform_caching is true =>
+      #     <link href="/stylesheets/payment.css"  media="screen" rel="Stylesheet" type="text/css" />
-      def stylesheet_link_tag(*sources)
-        options = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { }
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      end
-
@@ -217 +321 @@
-        def compute_public_path(source, dir, ext)
-          source += ".#{ext}" if File.extname(source).blank?
+
-          if source =~ %r{^[-a-z]+://}
-            source
@@ -246 +351 @@
-        def rails_asset_id(source)
-          ENV["RAILS_ASSET_ID"] ||
-"#{RAILS_ROOT}/public/#{source}"
+File.join(ASSETS_DIR, source)
-        end
-
@@ -253 +358 @@
-        def rewrite_asset_path!(source)
-          asset_id = rails_asset_id(source)
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        end
-    end

trunk/actionpack/test/controller/render_test.rb

@@ -336 +336 @@
-  end
-
+  def test_etag_should_govern_renders_with_layouts_too
+    get :builder_layout_test
+    assert_equal etag_for("<wrapper>\n<html>\n  <p>Hello </p>\n<p>This is grand!</p>\n</html>\n</wrapper>\n"), @response.headers['Etag']
+  end
+
+
-  protected
-    def assert_deprecated_render(&block)

trunk/actionpack/test/template/asset_tag_helper_test.rb

@@ -7 +7 @@
-
-  def setup
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    @controller = Class.new do
@@ -24 +42 @@
-
-  def teardown
-Object.send(:remove_const, :RAILS_ROOT) if defined?(RAILS_ROOT)
+ActionController::Base.perform_caching = false
-    ENV["RAILS_ASSET_ID"] = nil
-  end
@@ -54 +72 @@
-    %(javascript_include_tag("xmlhr", :lang => "vbscript")) => %(<script lang="vbscript" src="/javascripts/xmlhr.js" type="text/javascript"></script>),
-    %(javascript_include_tag("common.javascript", "/elsewhere/cools")) => %(<script src="/javascripts/common.javascript" type="text/javascript"></script>\n<script src="/elsewhere/cools.js" type="text/javascript"></script>),
-
-
-
+
+
+
+
-  }
-
@@ -72 +91 @@
-    %(stylesheet_link_tag("dir/file")) => %(<link href="/stylesheets/dir/file.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(:all)) => %(<link href="/stylesheets/bank.css" media="screen" rel="Stylesheet" type="text/css" />\n<link href="/stylesheets/robber.css" media="screen" rel="Stylesheet" type="text/css" />),
+    %(stylesheet_link_tag(:all, :media => "all")) => %(<link href="/stylesheets/bank.css" media="all" rel="Stylesheet" type="text/css" />\n<link href="/stylesheets/robber.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" />\n<link href="/css/stylish.css" media="screen" rel="Stylesheet" type="text/css" />),
-    %(stylesheet_link_tag("http://www.example.com/styles/style")) => %(<link href="http://www.example.com/styles/style.css" media="screen" rel="Stylesheet" type="text/css" />)
@@ -107 +128 @@
-
-  def test_javascript_include_tag
-Object.send(:remove_const, :RAILS_ROOT) if defined?(RAILS_ROOT)
+ENV["RAILS_ASSET_ID"] = ""
-    JavascriptIncludeToTag.each { |method, tag| assert_dom_equal(tag, eval(method)) }
-    Object.send(:const_set, :RAILS_ROOT, File.dirname(__FILE__) + "/../fixtures/")
-
-    ENV["RAILS_ASSET_ID"] = "1"
@@ -116 +136 @@
-
-  def test_register_javascript_include_default
-Object.send(:remove_const, :RAILS_ROOT) if defined?(RAILS_ROOT)
+ENV["RAILS_ASSET_ID"] = ""
-    ActionView::Helpers::AssetTagHelper::register_javascript_include_default 'slider'
-
+\n<script src="/javascripts/application.js" type="text/javascript"></script>
-    ActionView::Helpers::AssetTagHelper::register_javascript_include_default 'lib1', '/elsewhere/blub/lib2'
-
+\n<script src="/javascripts/application.js" type="text/javascript"></script>
-  end
-  
@@ -128 +148 @@
-
-  def test_stylesheet_link_tag
+    ENV["RAILS_ASSET_ID"] = ""
-    StyleLinkToTag.each { |method, tag| assert_dom_equal(tag, eval(method)) }
-  end
@@ -169 +190 @@
-    image_tag(source)
-    assert_equal copy, source
+  end
+
+
+  def test_caching_javascript_include_tag_when_caching_on
+    ENV["RAILS_ASSET_ID"] = ""
+    ActionController::Base.perform_caching = true
+    
+    assert_dom_equal(
+      %(<script src="/javascripts/all.js" type="text/javascript"></script>),
+      javascript_include_tag(:all, :cache => true)
+    )
+
+    assert File.exists?(File.join(ActionView::Helpers::AssetTagHelper::JAVASCRIPTS_DIR, 'all.js'))
+    
+    assert_dom_equal(
+      %(<script src="/javascripts/money.js" type="text/javascript"></script>),
+      javascript_include_tag(:all, :cache => "money")
+    )
+
+    assert File.exists?(File.join(ActionView::Helpers::AssetTagHelper::JAVASCRIPTS_DIR, 'money.js'))
+  ensure
+    File.delete(File.join(ActionView::Helpers::AssetTagHelper::JAVASCRIPTS_DIR, 'all.js'))
+    File.delete(File.join(ActionView::Helpers::AssetTagHelper::JAVASCRIPTS_DIR, 'money.js'))
+  end
+  
+  def test_caching_javascript_include_tag_when_caching_off
+    ENV["RAILS_ASSET_ID"] = ""
+    ActionController::Base.perform_caching = false
+    
+    assert_dom_equal(
+      %(<script src="/javascripts/application.js" type="text/javascript"></script>\n<script src="/javascripts/bank.js" type="text/javascript"></script>\n<script src="/javascripts/robber.js" type="text/javascript"></script>),
+      javascript_include_tag(:all, :cache => true)
+    )
+
+    assert !File.exists?(File.join(ActionView::Helpers::AssetTagHelper::JAVASCRIPTS_DIR, 'all.js'))
+    
+    assert_dom_equal(
+      %(<script src="/javascripts/application.js" type="text/javascript"></script>\n<script src="/javascripts/bank.js" type="text/javascript"></script>\n<script src="/javascripts/robber.js" type="text/javascript"></script>),
+      javascript_include_tag(:all, :cache => "money")
+    )
+
+    assert !File.exists?(File.join(ActionView::Helpers::AssetTagHelper::JAVASCRIPTS_DIR, 'money.js'))
+  end
+
+  def test_caching_stylesheet_link_tag_when_caching_on
+    ENV["RAILS_ASSET_ID"] = ""
+    ActionController::Base.perform_caching = true
+    
+    assert_dom_equal(
+      %(<link href="/stylesheets/all.css" media="screen" rel="Stylesheet" type="text/css" />),
+      stylesheet_link_tag(:all, :cache => true)
+    )
+
+    assert File.exists?(File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR, 'all.css'))
+
+    assert_dom_equal(
+      %(<link href="/stylesheets/money.css" media="screen" rel="Stylesheet" type="text/css" />),
+      stylesheet_link_tag(:all, :cache => "money")
+    )
+
+    assert File.exists?(File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR, 'money.css'))
+  ensure
+    File.delete(File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR, 'all.css'))
+    File.delete(File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR, 'money.css'))
+  end
+  
+  def test_caching_stylesheet_include_tag_when_caching_off
+    ENV["RAILS_ASSET_ID"] = ""
+    ActionController::Base.perform_caching = false
+    
+    assert_dom_equal(
+      %(<link href="/stylesheets/bank.css" media="screen" rel="Stylesheet" type="text/css" />\n<link href="/stylesheets/robber.css" media="screen" rel="Stylesheet" type="text/css" />),
+      stylesheet_link_tag(:all, :cache => true)
+    )
+
+    assert !File.exists?(File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR, 'all.css'))
+    
+    assert_dom_equal(
+      %(<link href="/stylesheets/bank.css" media="screen" rel="Stylesheet" type="text/css" />\n<link href="/stylesheets/robber.css" media="screen" rel="Stylesheet" type="text/css" />),
+      stylesheet_link_tag(:all, :cache => "money")
+    )
+
+    assert !File.exists?(File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR, 'money.css'))
-  end
-end