dynamic_assets 0.4.1 → 0.5.0

data/README.rdoc

@@ -22,9 +22,10 @@ Out of the box it can (optionally):
   penalty of downloading your admin styles.)
 * Allow CSS assets to refer to static images through relative URLs. That is, it doesn't break URLs
   embedded in CSS.
-* Invalidate caches and CDNs by inserting a timestamp into the asset URL path instead of using the
-  Rails scheme of appending a URL parameter. Some asset servers (notably Amazon CloudFront) will
-  drop parameters from the URL, so cache-busting requires path-changing.
+* Invalidate caches and CDNs by inserting a SHA1 signature into the asset URL path instead of using the
+  Rails scheme of appending a URL timestamp. Some asset servers (notably Amazon CloudFront) will
+  drop parameters from the URL, so cache-busting requires path-changing, and since assets are often
+  moved from machine to machine, modification times can be unreliable.
 * Honor Rails' scheme for asset hosts.
 
 It seems that Rails 3.1 will offer many of these features off-the-shelf, which is
@@ -192,11 +193,11 @@ If no :media attribute is supplied, stylesheet_asset_tag will use "screen".
 
 == Performance
 
-In production, assets can typically be cached aggressively. Like Rails,
-dynamic_assets adds a URL parameter to the asset path that will change
-if any of the underlying assets is modified, forcing clients to reload
-the asset. With action caching and/or an external cache like Varnish or
-a CDN, dynamic assets are quite speedy because you generate them rarely.
+In production, assets can typically be cached aggressively. dynamic_assets
+adds a signature to the asset path, and since it's based on the last-modified
+time of the underlying assets, clients will be forced to reload to reload
+assets when they change. With caching, dynamic assets are quite speedy
+because you generate them rarely.
 
 But during development they can be annoying <em>if</em> you set your
 environment to maximum slowness. The sweet spot for my dev configuration

data/app/helpers/dynamic_assets_helpers.rb

@@ -1,67 +1,67 @@
 
 module DynamicAssetsHelpers
 
-    def stylesheet_asset_tag(group_key, http_attributes = {})
-      DynamicAssets::Manager.asset_references_for_group_key(:stylesheets, group_key).map do |asset_ref|
+  def stylesheet_asset_tag(group_key, http_attributes = {})
+    DynamicAssets::Manager.asset_references_for_group_key(:stylesheets, group_key).map do |asset_ref|
 
-        tag :link, {
-          :type   => "text/css",
-          :rel    => "stylesheet",
-          :media  => "screen",
-          :href   => asset_url(asset_ref)
-        }.merge!(http_attributes)
+      tag :link, {
+        :type   => "text/css",
+        :rel    => "stylesheet",
+        :media  => "screen",
+        :href   => asset_url(asset_ref)
+      }.merge!(http_attributes)
 
-      end.join.html_safe
-    end
+    end.join.html_safe
+  end
 
-    def javascript_asset_tag(group_key, http_attributes = {})
-      DynamicAssets::Manager.asset_references_for_group_key(:javascripts, group_key).map do |asset_ref|
+  def javascript_asset_tag(group_key, http_attributes = {})
+    DynamicAssets::Manager.asset_references_for_group_key(:javascripts, group_key).map do |asset_ref|
 
-        content_tag :script, "", {
-          :type => "text/javascript",
-          :src  => asset_url(asset_ref)
-        }.merge!(http_attributes)
+      content_tag :script, "", {
+        :type => "text/javascript",
+        :src  => asset_url(asset_ref)
+      }.merge!(http_attributes)
 
-      end.join.html_safe
-    end
+    end.join.html_safe
+  end
 
 
-  protected
+protected
 
-    def asset_path(asset_ref)
-      path_args = []
-      path_args << asset_ref.name
-      path_args << { :timestamp => asset_ref.mtime.to_i.to_s } if asset_ref.mtime.present?
+  def asset_path(asset_ref)
+    path_args = []
+    path_args << asset_ref.name
+    path_args << { :signature => asset_ref.signature } if asset_ref.signature.present?
 
-      case asset_ref
-      when DynamicAssets::StylesheetReference then stylesheet_asset_path *path_args
-      when DynamicAssets::JavascriptReference then javascript_asset_path *path_args
-      else raise "Unknown asset type: #{asset_ref}"
-      end
+    case asset_ref
+    when DynamicAssets::StylesheetReference then stylesheet_asset_path *path_args
+    when DynamicAssets::JavascriptReference then javascript_asset_path *path_args
+    else raise "Unknown asset type: #{asset_ref}"
     end
+  end
 
-    def asset_url(asset_ref)
-      path = asset_path asset_ref
-      path = "/" + path unless path[0,1] == "/"
+  def asset_url(asset_ref)
+    path = asset_path asset_ref
+    path = "/" + path unless path[0,1] == "/"
 
-      host = compute_asset_host path
-      host ? "#{host}#{path}" : path
-    end
+    host = compute_asset_host path
+    host ? "#{host}#{path}" : path
+  end
 
-    # Extracted from Rails' AssetTagHelper, where it's private
-    def compute_asset_host(source)
-      if host = config.asset_host
-        if host.is_a?(Proc) || host.respond_to?(:call)
-          case host.is_a?(Proc) ? host.arity : host.method(:call).arity
-          when 2
-            request = controller.respond_to?(:request) && controller.request
-            host.call(source, request)
-          else
-            host.call(source)
-          end
+  # Extracted from Rails' AssetTagHelper, where it's private
+  def compute_asset_host(source)
+    if host = config.asset_host
+      if host.is_a?(Proc) || host.respond_to?(:call)
+        case host.is_a?(Proc) ? host.arity : host.method(:call).arity
+        when 2
+          request = controller.respond_to?(:request) && controller.request
+          host.call(source, request)
         else
-          (host =~ /%d/) ? host % (source.hash % 4) : host
+          host.call(source)
         end
+      else
+        (host =~ /%d/) ? host % (source.hash % 4) : host
       end
     end
+  end
 end

data/config/routes.rb

@@ -1,20 +1,18 @@
 
 Rails.application.routes.draw do
 
-  match '/assets/javascripts(/:timestamp)/:name.:format' => 'assets#show_javascript',
+  match '/assets/javascripts(/v/:signature)/:name.:format' => 'assets#show_javascript',
     :as => :javascript_asset,
     :format => "js",              # Important for action-caching non-HTML resources
     :constraints => {
-      :name => /[^ ]+/,           # By default, route segments can't have dots. We allow all but space.
-      :timestamp => /\d+/
+      :name => /[^ ]+/            # By default, route segments can't have dots. We allow all but space.
     }
 
-  match '/assets/stylesheets(/:timestamp)/:name.:format' => 'assets#show_stylesheet',
+  match '/assets/stylesheets(/v/:signature)/:name.:format' => 'assets#show_stylesheet',
     :as => :stylesheet_asset,
     :format => "css",             # Important for action-caching non-HTML resources
     :constraints => {             # By default, segments can't have dots. We allow all but space.
-      :name => /[^ ]+/,
-      :timestamp => /\d+/
+      :name => /[^ ]+/
     }
 
 end

data/lib/dynamic_assets/reference.rb

@@ -57,8 +57,13 @@ module DynamicAssets
       s
     end
 
-    def mtime
-      paths.map { |p| File.mtime p }.max
+    def signature
+      # Note that the signature is based on the context-free
+      # content. The context must depend on external factors
+      # in the route, like the domain name, since the signature
+      # will not change when the context changes.
+
+      Digest::SHA1.hexdigest content
     end
 
     def minify(content_string)
@@ -105,7 +110,7 @@ module DynamicAssets
     def read_member(member_name)
       path = path_for_member_name member_name
       content_string = get_raw_content path
-      content_string = ERB.new(content_string).result(@context) if path_is_erb?(path)
+      content_string = ERB.new(content_string).result(@context) if @context && path_is_erb?(path)
       content_string
     end
 

data/lib/dynamic_assets/reference/stylesheet_reference.rb

@@ -42,10 +42,6 @@ module DynamicAssets
       else raise "unknown format #{format}"
       end
 
-      # PENDING: we could do something similar to insert the asset host,
-      # although we'd need to pass some context (namely the request) down
-      # from the controller to compute the asset host in the same way Rails
-      # does.
       transform_urls member_name, content_string
     end
 

data/spec/helpers/dynamic_assets_helpers_spec.rb

@@ -22,9 +22,9 @@ describe DynamicAssetsHelpers do
         before do
           DynamicAssets::Manager.stub(:asset_references_for_group_key).with(:stylesheets, group_key).
             and_return [
-              DynamicAssets::StylesheetReference.new.tap { |r| r.stub(:name => "a", :mtime => 123) },
-              DynamicAssets::StylesheetReference.new.tap { |r| r.stub(:name => "b", :mtime => 456) },
-              DynamicAssets::StylesheetReference.new.tap { |r| r.stub(:name => "c", :mtime => 789) }
+              DynamicAssets::StylesheetReference.new.tap { |r| r.stub(:name => "a", :signature => 123) },
+              DynamicAssets::StylesheetReference.new.tap { |r| r.stub(:name => "b", :signature => 456) },
+              DynamicAssets::StylesheetReference.new.tap { |r| r.stub(:name => "c", :signature => 789) }
             ]
         end
 
@@ -56,10 +56,10 @@ describe DynamicAssetsHelpers do
         context "when config.asset_host is nil" do
           before { helper.config.asset_host.should be_nil }
 
-          it "is three tags with hrefs derived from the asset name and mtime" do
-            should contain_string 'href="/assets/stylesheets/123/a.css"'
-            should contain_string 'href="/assets/stylesheets/456/b.css"'
-            should contain_string 'href="/assets/stylesheets/789/c.css"'
+          it "is three tags with hrefs derived from the asset name and signature" do
+            should contain_string 'href="/assets/stylesheets/v/123/a.css"'
+            should contain_string 'href="/assets/stylesheets/v/456/b.css"'
+            should contain_string 'href="/assets/stylesheets/v/789/c.css"'
           end
         end
 
@@ -67,9 +67,9 @@ describe DynamicAssetsHelpers do
           before { helper.config.stub(:asset_host).and_return "http://a.example.com" }
 
           it "is three tags with hrefs whose host is a.example.com" do
-            should contain_string 'href="http://a.example.com/assets/stylesheets/123/a.css"'
-            should contain_string 'href="http://a.example.com/assets/stylesheets/456/b.css"'
-            should contain_string 'href="http://a.example.com/assets/stylesheets/789/c.css"'
+            should contain_string 'href="http://a.example.com/assets/stylesheets/v/123/a.css"'
+            should contain_string 'href="http://a.example.com/assets/stylesheets/v/456/b.css"'
+            should contain_string 'href="http://a.example.com/assets/stylesheets/v/789/c.css"'
           end
         end
 
@@ -77,9 +77,9 @@ describe DynamicAssetsHelpers do
           before { helper.config.stub(:asset_host).and_return "http://a%d.example.com" }
 
           it "is three tags with hrefs whose host is a[0-3].example.com" do
-            should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/123\/a.css"/
-            should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/456\/b.css"/
-            should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/789\/c.css"/
+            should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/v\/123\/a.css"/
+            should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/v\/456\/b.css"/
+            should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/v\/789\/c.css"/
           end
         end
       end
@@ -106,9 +106,9 @@ describe DynamicAssetsHelpers do
         before do
           DynamicAssets::Manager.stub(:asset_references_for_group_key).with(:javascripts, group_key).
             and_return [
-              DynamicAssets::JavascriptReference.new.tap { |r| r.stub(:name => "a", :mtime => 123) },
-              DynamicAssets::JavascriptReference.new.tap { |r| r.stub(:name => "b", :mtime => 456) },
-              DynamicAssets::JavascriptReference.new.tap { |r| r.stub(:name => "c", :mtime => 789) }
+              DynamicAssets::JavascriptReference.new.tap { |r| r.stub(:name => "a", :signature => 123) },
+              DynamicAssets::JavascriptReference.new.tap { |r| r.stub(:name => "b", :signature => 456) },
+              DynamicAssets::JavascriptReference.new.tap { |r| r.stub(:name => "c", :signature => 789) }
             ]
         end
 
@@ -131,10 +131,10 @@ describe DynamicAssetsHelpers do
         context "when config.asset_host is nil" do
           before { helper.config.asset_host.should be_nil }
 
-          it "is three tags with srcs derived from the asset name and mtime" do
-            should contain_string 'src="/assets/javascripts/123/a.js"'
-            should contain_string 'src="/assets/javascripts/456/b.js"'
-            should contain_string 'src="/assets/javascripts/789/c.js"'
+          it "is three tags with srcs derived from the asset name and signature" do
+            should contain_string 'src="/assets/javascripts/v/123/a.js"'
+            should contain_string 'src="/assets/javascripts/v/456/b.js"'
+            should contain_string 'src="/assets/javascripts/v/789/c.js"'
           end
         end
 
@@ -142,9 +142,9 @@ describe DynamicAssetsHelpers do
           before { helper.config.stub(:asset_host).and_return "http://a.example.com" }
 
           it "is three tags with srcs whose host is a.example.com" do
-            should contain_string 'src="http://a.example.com/assets/javascripts/123/a.js"'
-            should contain_string 'src="http://a.example.com/assets/javascripts/456/b.js"'
-            should contain_string 'src="http://a.example.com/assets/javascripts/789/c.js"'
+            should contain_string 'src="http://a.example.com/assets/javascripts/v/123/a.js"'
+            should contain_string 'src="http://a.example.com/assets/javascripts/v/456/b.js"'
+            should contain_string 'src="http://a.example.com/assets/javascripts/v/789/c.js"'
           end
         end
 
@@ -152,9 +152,9 @@ describe DynamicAssetsHelpers do
           before { helper.config.stub(:asset_host).and_return "http://a%d.example.com" }
 
           it "is three tags with srcs whose host is a[0-3].example.com" do
-            should =~ /src="http:\/\/a[0-3].example.com\/assets\/javascripts\/123\/a.js"/
-            should =~ /src="http:\/\/a[0-3].example.com\/assets\/javascripts\/456\/b.js"/
-            should =~ /src="http:\/\/a[0-3].example.com\/assets\/javascripts\/789\/c.js"/
+            should =~ /src="http:\/\/a[0-3].example.com\/assets\/javascripts\/v\/123\/a.js"/
+            should =~ /src="http:\/\/a[0-3].example.com\/assets\/javascripts\/v\/456\/b.js"/
+            should =~ /src="http:\/\/a[0-3].example.com\/assets\/javascripts\/v\/789\/c.js"/
           end
         end
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dynamic_assets
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Robert Davis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-27 00:00:00 -05:00
+date: 2011-05-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,15 +72,15 @@ dependencies:
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 111
+        hash: -1848230051
         segments: 
-        - 0
-        - 4
         - 1
-        - 2
-        version: 0.4.1.2
+        - 0
+        - 0
+        - beta1
+        version: 1.0.0.beta1
   requirement: *id004
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -89,14 +89,15 @@ dependencies:
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 977940571
         segments: 
         - 2
-        - 5
+        - 6
         - 0
-        version: 2.5.0
+        - rc6
+        version: 2.6.0.rc6
   requirement: *id005
 - !ruby/object:Gem::Dependency 
   prerelease: false