rack-zippy 1.0.1 → 1.1.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.0 / 2014-01-26
+- rack-zippy no longer blocks requests for assets that it cannot find on the filesystem. These
+  requests are now passed on to the app. ([#7](https://github.com/eliotsykes/rack-zippy/issues/7))
+
 ## 1.0.1 / 2013-09-06
 -  Fix error on request for assets root dir (fixes [#2](https://github.com/eliotsykes/rack-zippy/issues/2))
 -  Add MIT license to gemspec (fixes [#1](https://github.com/eliotsykes/rack-zippy/issues/1))

data/README.md

@@ -9,6 +9,10 @@ rack-zippy replaces the ActionDispatch::Static middleware used by Rails, which i
 the `rake assets:precompile` task. rack-zippy will serve non-gzipped assets where they are not available or not supported by the
 requesting client.
 
+For a fuller explanation of the how, why, and the kind of performance difference you can expect when using rack-zippy,
+see [Serving Compressed Assets with Heroku and Rack-Zippy](http://www.cheynewallace.com/serving-compressed-assets-with-heroku-rack-zippy/)
+(thanks to Cheyne Wallace).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,6 +32,14 @@ Add this line to config/application.rb:
 Follow the installation instructions above and rack-zippy will serve any static assets, including gzipped assets, from your
 application's public/ directory and will respond with sensible caching headers.
 
+## Troubleshooting
+
+##### 'assert_index': No such middleware to insert before: ActionDispatch::Static (RuntimeError)
+
+Check your environment (in config/environments/) does not have `serve_static_assets` set to false:
+
+    config.serve_static_assets = false # Oops! Should be set to true for rack-zippy
+
 ## Contributing
 
 1. Fork it
@@ -39,9 +51,9 @@ application's public/ directory and will respond with sensible caching headers.
 
 ## Releasing a new gem
 
-1. Increment version in lib/rack-zippy/version.rb in line with semantic versioning
+1. Update pre-release version to the release version in lib/rack-zippy/version.rb, e.g. '1.0.1.pre' becomes '1.0.1'
 2. Update CHANGELOG.md
 3. Tests pass? (`rake test`)
 4. Build the gem (`rake build`)
 5. Release on rubygems.org (`rake release`)
-
+6. Update version to the next pre-release version in lib/rack-zippy/version.rb, e.g. '1.0.1' becomes '1.0.2.pre'

data/lib/rack-zippy.rb

@@ -14,33 +14,25 @@ module Rack
         assert_legal_path path_info
 
         if serve?(path_info)
+          headers = { 'Content-Type'  => Rack::Mime.mime_type(::File.extname(path_info)) }
+          headers.merge! cache_headers(path_info)
 
-          file_path = "#{@asset_root}#{path_info}"
+          file_path = path_to_file(path_info)
+          gzipped_file_path = "#{file_path}.gz"
+          gzipped_file_present = ::File.exists?(gzipped_file_path) && ::File.readable?(gzipped_file_path)
 
-          if ::File.file?(file_path)
-            headers = { 'Content-Type'  => Rack::Mime.mime_type(::File.extname(path_info)) }
-            headers.merge! cache_headers(path_info)
+          if gzipped_file_present
+            headers['Vary'] = 'Accept-Encoding'
 
-            gzipped_file_path = "#{file_path}.gz"
-            gzipped_file_present = ::File.exists?(gzipped_file_path)
-
-            if gzipped_file_present
-              headers['Vary'] = 'Accept-Encoding'
-
-              if client_accepts_gzip?(env)
-                file_path = gzipped_file_path
-                headers['Content-Encoding'] = 'gzip'
-              end
+            if client_accepts_gzip?(env)
+              file_path = gzipped_file_path
+              headers['Content-Encoding'] = 'gzip'
             end
-
-            status = 200
-            headers['Content-Length'] = ::File.size(file_path).to_s
-            response_body = [::File.read(file_path)]
-          else
-            status = 404
-            headers = {}
-            response_body = ['Not Found']
           end
+
+          status = 200
+          headers['Content-Length'] = ::File.size(file_path).to_s
+          response_body = [::File.read(file_path)]
           return [status, headers, response_body]
         end
 
@@ -84,15 +76,28 @@ module Rack
         return headers
       end
 
+      def path_to_file(path_info)
+        "#{@asset_root}#{path_info}"
+      end
+
       def serve?(path_info)
-        is_assets_dir_or_below = (path_info =~ PRECOMPILED_ASSETS_SUBDIR_REGEX)
-        if is_assets_dir_or_below
-          return should_assets_be_compiled_already?
+        should_serve_from_filesystem = false
+
+        if has_static_extension?(path_info)
+          file_path = path_to_file(path_info)
+          is_serveable = ::File.file?(file_path) && ::File.readable?(file_path)
+
+          if is_serveable
+            is_outside_assets_dir = !(path_info =~ PRECOMPILED_ASSETS_SUBDIR_REGEX)
+            should_serve_from_filesystem = is_outside_assets_dir || block_asset_pipeline_from_generating_asset?
+          end
         end
-        return has_static_extension?(path_info)
+
+        return should_serve_from_filesystem
       end
 
-      def should_assets_be_compiled_already?
+      def block_asset_pipeline_from_generating_asset?
+        # config.assets.compile is normally false in production, and true in dev+test envs.
         !::Rails.configuration.assets.compile
       end
 

data/lib/rack-zippy/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Zippy
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
   end
 end

data/test/asset_server_test.rb

@@ -25,28 +25,28 @@ class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
     assert_underlying_app_responded
   end
 
-  def test_request_for_subdir_of_assets_responds_404_not_found
+  def test_request_for_subdir_of_assets_passed_onto_app
     ['/assets/blog', '/assets/blog/logos/'].each do |path|
       local_path = "public#{path}"
       assert File.directory?(local_path)
       get path
-      assert_not_found
+      assert_underlying_app_responded
     end
   end
 
-  def test_request_for_non_existent_subdir_of_assets_responds_404_not_found
+  def test_request_for_non_existent_subdir_of_assets_passed_onto_app
     ['/assets/ghost', '/assets/does/not/exist', '/assets/nothing-here/with-trailing-slash/'].each do |path|
       local_path = "public#{path}"
       assert !File.exists?(local_path)
       get path
-      assert_not_found
+      assert_underlying_app_responded
     end
   end
 
-  def test_request_for_assets_root_responds_404_not_found
+  def test_request_for_assets_root_passed_onto_app
     ['/assets/', '/assets'].each do |assets_root|
       get assets_root
-      assert_not_found "'#{assets_root}' assets root request should not be found"
+      assert_underlying_app_responded
     end
   end
 
@@ -68,8 +68,12 @@ class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
     assert_underlying_app_responded
   end
 
-  def test_serve_returns_true_if_request_has_static_extension
-    assert app.send(:serve?, '/about.html')
+  def test_serve_returns_true_if_request_has_static_extension_and_file_exists
+    assert app.send(:serve?, '/thanks.html')
+  end
+
+  def test_serve_returns_false_if_request_has_static_extension_and_file_does_not_exist
+    assert !app.send(:serve?, '/about.html')
   end
 
   def test_serve_returns_false_if_request_does_not_have_static_extension
@@ -85,15 +89,15 @@ class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
     assert !app.send(:serve?, '/assets/application.css')
   end
 
-  def test_should_assets_be_compiled_already_returns_false_if_assets_compile_enabled
+  def test_block_asset_pipeline_from_generating_asset_returns_false_if_assets_compile_enabled
     ::Rails.configuration.assets.compile = true
     assert ::Rails.configuration.assets.compile
-    assert !app.send(:should_assets_be_compiled_already?)
+    assert !app.send(:block_asset_pipeline_from_generating_asset?)
   end
 
-  def test_should_assets_be_compiled_already_returns_true_if_assets_compile_disabled
+  def test_block_asset_pipeline_from_generating_asset_returns_true_if_assets_compile_disabled
     assert !::Rails.configuration.assets.compile
-    assert app.send(:should_assets_be_compiled_already?)
+    assert app.send(:block_asset_pipeline_from_generating_asset?)
   end
 
   def test_responds_with_gzipped_css_to_gzip_capable_clients
@@ -231,9 +235,9 @@ class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
     assert_underlying_app_responded
   end
 
-  def test_does_not_pass_not_found_asset_requests_onto_app
+  def test_passes_not_found_asset_requests_onto_app
     get '/index.html'
-    assert_not_found
+    assert_underlying_app_responded
   end
 
   def test_responds_with_favicon_in_assets_dir
@@ -250,19 +254,19 @@ class Rack::Zippy::AssetServerTest < Test::Unit::TestCase
     assert_content_length 'public/favicon.ico'
   end
 
-  def test_responds_404_not_found_for_non_existent_image
+  def test_request_for_non_existent_image_passed_onto_app
     get '/assets/pot-of-gold.png'
-    assert_not_found
+    assert_underlying_app_responded
   end
 
-  def test_responds_404_not_found_for_non_existent_css
+  def test_request_for_non_existent_css_passed_onto_app
     get '/assets/unicorn.css'
-    assert_not_found
+    assert_underlying_app_responded
   end
 
-  def test_responds_404_not_found_for_non_existent_js
+  def test_request_for_non_existent_js_passed_onto_app
     get '/assets/dragon.js'
-    assert_not_found
+    assert_underlying_app_responded
   end
 
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-zippy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies: []
 description: Rack middleware for serving static gzipped assets generated by the Rails
   asset pipeline
@@ -55,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3051334136221018269
+      hash: 2781769223884308970
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3051334136221018269
+      hash: 2781769223884308970
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23