rack-zippy 0.1.0 → 1.0.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.0 / 2013-08-22
+
+Production-ready release
+
+-  Only set years-old cache-friendly last-modified header on assets with max-age of at least 1 month
+
 ## 0.1.0 / 2013-08-21
 
-Initial release
+Initial release

data/README.md

@@ -37,3 +37,11 @@ application's public/ directory and will respond with sensible caching headers.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Releasing a new gem
+
+1. Increment version in lib/rack-zippy/version.rb in line with semantic versioning
+2. Update CHANGELOG.md
+3. Tests pass? (`rake test`)
+4. Build the gem (`rake build`)
+5. Release on rubygems.org (`rake release`)
+

data/lib/rack-zippy/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Zippy
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/rack-zippy.rb

@@ -1,4 +1,4 @@
-require "rack-zippy/version"
+require 'rack-zippy/version'
 
 module Rack
   module Zippy
@@ -18,11 +18,8 @@ module Rack
           file_path = "#{@asset_root}#{path_info}"
 
           if ::File.exists?(file_path)
-            headers = {
-                'Content-Type'  => Rack::Mime.mime_type(::File.extname(path_info)),
-                'Last-Modified' => 'Mon, 10 Jan 2005 10:00:00 GMT',
-                'Cache-Control' => "public, max-age=#{max_age_in_secs(path_info)}"
-            }
+            headers = { 'Content-Type'  => Rack::Mime.mime_type(::File.extname(path_info)) }
+            headers.merge! cache_headers(path_info)
 
             gzipped_file_path = "#{file_path}.gz"
             gzipped_file_present = ::File.exists?(gzipped_file_path)
@@ -66,6 +63,27 @@ module Rack
 
       ILLEGAL_PATH_REGEX = /(\.\.|\/\.)/
 
+      # Old last-modified headers encourage caching via browser heuristics. Use it for year-long cached assets.
+      CACHE_FRIENDLY_LAST_MODIFIED = 'Mon, 10 Jan 2005 10:00:00 GMT'
+
+      def cache_headers(path_info)
+        case path_info
+          when PRECOMPILED_ASSETS_SUBDIR_REGEX
+            lifetime = :year
+            last_modified = CACHE_FRIENDLY_LAST_MODIFIED
+          when '/favicon.ico'
+            lifetime = :month
+            last_modified = CACHE_FRIENDLY_LAST_MODIFIED
+          else
+            lifetime = :day
+        end
+
+        headers = { 'Cache-Control' => "public, max-age=#{SECONDS_IN[lifetime]}" }
+        headers['Last-Modified'] = last_modified if last_modified
+
+        return headers
+      end
+
       def serve?(path_info)
         is_compilable_asset = (path_info =~ PRECOMPILED_ASSETS_SUBDIR_REGEX)
         if is_compilable_asset
@@ -78,19 +96,6 @@ module Rack
         !::Rails.configuration.assets.compile
       end
 
-      def max_age_in_secs(path_info)
-        case path_info
-          when PRECOMPILED_ASSETS_SUBDIR_REGEX
-            max_age = SECONDS_IN[:year]
-          when '/favicon.ico'
-            max_age = SECONDS_IN[:month]
-          else
-            max_age = SECONDS_IN[:day]
-        end
-
-        return max_age
-      end
-
       def client_accepts_gzip?(rack_env)
         rack_env['HTTP_ACCEPT_ENCODING'] =~ ACCEPTS_GZIP_REGEX
       end

data/test/asset_server_test.rb

@@ -20,6 +20,18 @@ class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
     Rack::Zippy::AssetServer.new(rack_app)
   end
 
+  def test_cache_friendly_last_modified_is_not_set_for_files_outside_of_assets_subdir
+    get '/robots.txt'
+    assert_response_ok
+    assert_last_modified nil
+  end
+
+  def test_cache_friendly_last_modified_is_set_for_root_favicon_as_it_rarely_changes
+    get '/favicon.ico'
+    assert_response_ok
+    assert_cache_friendly_last_modified
+  end
+
   def test_does_not_serve_assets_subdir_request_when_assets_compile_enabled
     ::Rails.configuration.assets.compile = true
     get '/assets/application.css'
@@ -90,21 +102,20 @@ class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
     get '/favicon.ico'
     assert_response_ok
     assert_cache_max_age :month
-    assert_cache_friendly_last_modified
   end
 
   def test_responds_with_day_long_cache_headers_for_robots_txt
     get '/robots.txt'
     assert_response_ok
     assert_cache_max_age :day
-    assert_cache_friendly_last_modified
+    assert_last_modified nil
   end
 
   def test_responds_with_day_long_cache_headers_for_root_html_requests
     get '/thanks.html'
     assert_response_ok
     assert_cache_max_age :day
-    assert_cache_friendly_last_modified
+    assert_last_modified nil
   end
 
   def test_max_cache_and_vary_accept_encoding_headers_present_for_css_requests_by_non_gzip_clients
@@ -229,6 +240,10 @@ class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
 
   DURATIONS_IN_SECS = {:year => 31536000, :month => 2678400, :day => 86400}.freeze
 
+  def assert_last_modified(expected)
+    assert_equal expected, last_response.headers['last-modified']
+  end
+
   def env_for_gzip_capable_client
     {'HTTP_ACCEPT_ENCODING' => 'deflate,gzip,sdch'}
   end
@@ -241,9 +256,9 @@ class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
     assert_equal "public, max-age=#{DURATIONS_IN_SECS[duration]}", last_response.headers['cache-control']
   end
 
-  # Browsers favour caching assets with older Last Modified dates IIRC
+  # Browser caching heuristics favour assets with older Last Modified dates IIRC
   def assert_cache_friendly_last_modified
-    assert_equal 'Mon, 10 Jan 2005 10:00:00 GMT', last_response.headers['last-modified']
+    assert_last_modified 'Mon, 10 Jan 2005 10:00:00 GMT'
   end
 
   def assert_underlying_app_responded

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-zippy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies: []
 description: Rack middleware for serving static gzipped assets generated by the Rails
   asset pipeline