rack-zippy 3.0.1 → 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69996e12bfb698114f7dfea5d26a0837de4041c1
+  data.tar.gz: 123aca242bc132651dba0ee53d666efe05a2e4a9
+SHA512:
+  metadata.gz: 43c0d933b8b6129d9a18b733c05e309f6986b4d9251f98a658c19a9ff7925b80c817ee08c34b3cc0888e4640e3d96320bfb1d5371870610d01366301b491a8c6
+  data.tar.gz: a0a6d4e154724317cda6fe934babc845b6f51779a73fb22915abc01a1d14e7a76ff947303e4eadfcef5a59c5605758bfbe22523eb50f5bb97bba99dcc70126ce

data/CHANGELOG.md

@@ -1,8 +1,12 @@
+## 4.0.0 / 2015-10-20
+- Rack Zippy continues to support non-Rails Rack apps, though Rails support has ended in rack-zippy 4.0+. Rails 4.2+ now supports serving gzipped files directly. Configure your Rails 4.2+ app to use the `ActionDispatch::Static` middleware. If you absolutely need rack-zippy for your Rails app or can't upgrade to Rails 4.2+, try using an earlier rack-zippy version: `~> 3.0.1`
+- New dependency on actionpack gem. Rack Zippy decorates the `ActionDispatch::Static` middleware for non-Rails Rack apps to provide Rack Zippy's own choice of caching headers and whitelisting of permitted static file extensions.
+
 ## 3.0.1 / 2015-05-19
 - Allow paths with periods in the middle, but not if they immediately follow slash ([#46](https://github.com/eliotsykes/rack-zippy/pull/46)) @ssemakov
 
 ## 3.0.0 / 2015-04-18
-- POTENTIAL BREAKING CHANGE! `STATIC_EXTENSION_REGEX` has been removed and replaced with a `static_extensions` array. If your app monkey patched `STATIC_EXTENSTION_REGEX` to change the file extension whitelist, then you will need to update your app to use rack-zippy 3.x. Depending on how you patched, and your test coverage, your app could silently fail. Search your codebase for `STATIC_EXTENSION_REGEX` to ensure it is not used. If it is used, then migrate your patch to use the new `Rack::Zippy.config` method for configuring `static_extensions`: https://github.com/eliotsykes/rack-zippy#static_extensions 
+- POTENTIAL BREAKING CHANGE! `STATIC_EXTENSION_REGEX` has been removed and replaced with a `static_extensions` array. If your app monkey patched `STATIC_EXTENSTION_REGEX` to change the file extension whitelist, then you will need to update your app to use rack-zippy 3.x. Depending on how you patched, and your test coverage, your app could silently fail. Search your codebase for `STATIC_EXTENSION_REGEX` to ensure it is not used. If it is used, then migrate your patch to use the new `Rack::Zippy.config` method for configuring `static_extensions`: https://github.com/eliotsykes/rack-zippy#static_extensions
 - Make static extensions list configurable ([#45](https://github.com/eliotsykes/rack-zippy/pull/45)) Anton Petrunich
 
 ## 2.0.2 / 2014-12-15

data/Gemfile

@@ -2,9 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rack-zippy.gemspec
 gemspec
-
-group :development do
-  gem 'guard-test'
-  gem 'rack-test'
-  gem 'rake'
-end

data/README.md

@@ -1,45 +1,21 @@
-# rack-zippy
+# Hey fellow Rails developers, please read!
+
+**Want to use rack-zippy with a Rails v4.2 or greater app?**  
+Its recommended you don't! Rails 4.2+ now supports serving gzipped files directly so there's no need for rack-zippy in Rails 4.2+ apps.
 
-rack-zippy is a Rack middleware for serving static gzipped assets precompiled by the Rails asset pipeline into the public/assets directory. Use it
-on Heroku if you want to serve the precompiled gzipped assets to gzip-capable clients with sensible caching headers.
+**Want to use rack-zippy with a Rails v4.1 or less app?**  
+You'll need to use v3.0 of rack-zippy, see the README here: https://github.com/eliotsykes/rack-zippy/tree/v3.0.1
 
-By default, Rails + Heroku will not serve *.gz assets even though they are generated at deploy time.
+# rack-zippy
 
-rack-zippy replaces the `ActionDispatch::Static` middleware used by Rails, which is not capable of serving the gzipped assets created by
-the `rake assets:precompile` task. rack-zippy will serve non-gzipped assets where they are not available or not supported by the
-requesting client.
+rack-zippy v4+ is a Rack middleware for serving .gz files in Rack apps that are **not** Rails 4.2+ apps. (If you need to use rack-zippy in a Rails <= 4.1 app, then use v3.0 of rack-zippy, see README here: https://github.com/eliotsykes/rack-zippy/tree/v3.0.1)
 
-rack-zippy (since 2.0.0) has the same **convenient directory request handling** provided by `ActionDispatch::Static`, which means you can take advantage of this in any rack app:
+rack-zippy has convenient directory request handling:
 
 - Requests for `/` and `/index` respond with `public/index.html` if present
 - Requests for `/foo/` and `/foo` respond with first file present out of `public/foo.html`, `public/foo/index.html` (Same behaviour for subdirectories)
 
-Watch the [Web Dev Break podcast on rack-zippy](http://www.webdevbreak.com/specials/rack-zippy "Faster, friendlier assets with rack-zippy") to see how you can check if your app
-is currently serving uncompressed assets and how quick it is to setup rack-zippy:
-
-[ ![Faster, friendlier assets with rack-zippy](/video-player.png "Faster, friendlier assets with rack-zippy") ](http://www.webdevbreak.com/specials/rack-zippy "Faster, friendlier assets with rack-zippy")
-
-## Installation in Rails app
-
-Add this line to your application's Gemfile:
-
-    gem 'rack-zippy'
-
-And then execute:
-
-    $ bundle
-    
-In `config/environments/production.rb`, set `config.serve_static_assets` to `true`:
-
-    # Puts ActionDispatch::Static in middleware stack which we are going to replace with
-    # Rack::Zippy::AssetServer
-    config.serve_static_assets = true
-
-Create the file `config/initializers/rack_zippy.rb` and put this line in it:
-
-    Rails.application.config.middleware.swap(ActionDispatch::Static, Rack::Zippy::AssetServer)
-
-Now run `rake middleware` at the command line and make sure that `Rack::Zippy::AssetServer` is near the top of the outputted list. ActionDispatch::Static should not be in the list. Nicely done, rack-zippy is now installed in your app.
+rack-zippy decorates actionpack's `ActionDispatch::Static` middleware for non-Rails Rack apps to provide rack-zippy's own choice of caching headers and whitelisting of permitted static file extensions. (As an alternative to rack-zippy, you can use actionpack's `ActionDispatch::Static` directly without rack-zippy.)
 
 ## Installation in Rack app (that isn’t a Rails app)
 
@@ -72,24 +48,24 @@ application's public/ directory and will respond with sensible caching headers.
 
 `max_age_fallback`, is an integer value in seconds that should be used as the max_age fallback for files served by rack-zippy that live **outside** the `/assets` subdirectory *and* aren't `/favicon.ico`.
 
-A typical use for `max_age_fallback` is to define how long the cache lifetime for static HTML files served by rack-zippy should be. For one of my sites I have this set to 10 minutes:
+A typical use for `max_age_fallback` is to define how long the cache lifetime for static HTML files served by rack-zippy should be. For one of my sites I have this set to 15 minutes:
 
 ```ruby
-max_age_in_secs = 10*60 # 10 mins = 600 secs
+max_age_in_secs = 15*60 # 15 mins = 900 secs
 use Rack::Zippy::AssetServer, asset_root, max_age_fallback: max_age_in_secs
 ```
 
 Any files given the `max_age_fallback` would have the following `Cache-Control` header:
 
 ```
-Cache-Control: public, max-age=600
+Cache-Control: public, max-age=900
 ```
 
 ### Configuration
 
 #### Supported Extensions Whitelist
 
-rack-zippy handles only files with whitelisted extensions. Default extensions are stored in the `static_extensions` array with an entry for each of these: 
+rack-zippy handles only files with whitelisted extensions. Default extensions are stored in the `static_extensions` array with an entry for each of these:
 `css js html htm txt ico png jpg jpeg gif pdf svg zip gz eps psd ai woff woff2 ttf eot otf swf`
 
 You can modify this list to support other extensions by appending the lowercased file extension to the `static_extensions` array:
@@ -97,23 +73,26 @@ You can modify this list to support other extensions by appending the lowercased
 ```ruby
 Rack::Zippy.configure do |config|
   # Add support for the given extensions:
-  config.static_extensions.push('csv', 'xls', 'rtf', ...EXTENSIONS TO ADD...)
+  config.static_extensions.push('map', 'csv', 'xls', 'rtf', ...EXTENSIONS TO ADD...)
 end
 ```
 
-## Troubleshooting
+It is not recommended, however if you use rack-zippy 4.0+ with a Rails 4.2+ app, you can skip the rack-zippy rails version check and log output. Put the following in an initializer:
 
-##### 'assert_index': No such middleware to insert before: ActionDispatch::Static (RuntimeError)
+```ruby
+# config/initializers/zippy.rb
+Rack::Zippy::Railtie.skip_version_check = true
+```
 
-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
+## Troubleshooting
 
 ##### NameError: uninitialized constant Rack::Zippy
 
 - Check `Gemfile` doesn't limit rack-zippy to a subset of environment groups
 - Run `bundle install`
 - Check `Gemfile.lock` contains an entry for rack-zippy
+- Ensure `require 'rack-zippy'` is present near the top of `config.ru`
 
 
 ## Contributing
@@ -148,7 +127,18 @@ Cleanup time! When you’re finished testing, delete the local override and set
     # In your-app/Gemfile change rack-zippy dependency to this (or similar):
     gem 'rack-zippy', '~> 9.8.7' # Replace 9.8.7 with the rack-zippy release version you want to use.
 
+#### How to Run a Single Test
+
+```bash
+# Single test file
+ruby -Ilib:test test/assert_server_test.rb
 
+# Single test method
+ruby -Ilib:test test/assert_server_test.rb --name test_serves_static_file_as_directory
+
+# Test methods matching a regex
+ruby -Ilib:test test/assert_server_test.rb --name /serves_static/
+```
 
 ## Contributors
 
@@ -157,6 +147,7 @@ Cleanup time! When you’re finished testing, delete the local override and set
 - Luke Wendling https://github.com/lukewendling
 - Anton Petrunich https://github.com/solenko
 - ssemakov https://github.com/ssemakov
+- Kai Schlichting https://github.com/lacco
 
 ## Releasing a new gem
 
@@ -169,4 +160,3 @@ Cleanup time! When you’re finished testing, delete the local override and set
 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`.
 7. Add new heading to `CHANGELOG` for the next pre-release
 8. Commit and push the updated `lib/rack-zippy/version.rb` and `CHANGELOG` files.
-

data/lib/rack-zippy.rb

@@ -1,7 +1,7 @@
 require 'rack-zippy/version'
-require 'rack-zippy/asset_compiler'
-require 'rack-zippy/serveable_file'
 require 'rack-zippy/configuration'
+require 'rack-zippy/railtie' if defined?(Rails)
+require 'action_controller'
 
 module Rack
   module Zippy
@@ -9,77 +9,122 @@ module Rack
 
     define_setting :static_extensions, %w(css js html htm txt ico png jpg jpeg gif pdf svg zip gz eps psd ai woff woff2 ttf eot otf swf)
 
-    PRECOMPILED_ASSETS_SUBDIR_REGEX = /\A\/assets(?:\/|\z)/
+    ASSETS_SUBDIR_REGEX = /\A\/assets(?:\/|\z)/
 
     class AssetServer
 
-      HTTP_STATUS_CODE_OK = 200
+      attr_reader :static_middleware
 
-      def initialize(app, asset_root=nil, options={})
-        if asset_root.nil?
-          if RailsAssetCompiler.rails_env?
-            asset_root = ::Rails.public_path
-          else
-            raise ArgumentError.new 'Please specify asset_root when initializing Rack::Zippy::AssetServer ' +
-              '(asset_root is the path to your public directory, often the one with favicon.ico in it)'
-          end
-        end
-        @app = app
+      # @param app [#call(env)] the Rack app
+      # @param path [String] the path to the public directory, usually where favicon.ico lives
+      # @param max_age_fallback [Fixnum] time for Cache-Control header. Defaults to 1 day (in seconds).
+      def initialize(app, path, max_age_fallback: :day)
+        assert_path_valid path
 
-        @options = {
-          :asset_compiler => resolve_asset_compiler,
-          :asset_root => asset_root
-        }.merge(options)
+        cache_control = cache_control(max_age_fallback)
+
+        @app = app
+        blank_app = ->(env) { }
+        @static_middleware = ::ActionDispatch::Static.new(blank_app, path, cache_control)
       end
 
       def call(env)
-        path_info = env['PATH_INFO']
+        path_info = env[PATH_INFO]
+        return not_found_response if illegal_path?(path_info)
+
+        if try_static?(path_info)
+          static_response = static_middleware.call(env)
+        end
+
+        if static_response
+          after_static_responds(env, static_response)
+        else
+          @app.call(env)
+        end
+      end
 
-        return not_found_response if path_info =~ ILLEGAL_PATH_REGEX
+      private
 
-        serveable_file_options = {
-            :path_info => path_info,
-            :asset_root => asset_root,
-            :asset_compiler => asset_compiler,
-            :include_gzipped => client_accepts_gzip?(env),
-            :max_age_fallback => @options[:max_age_fallback]
-        }
+      ILLEGAL_PATH_REGEX = /(\/\.\.?)/
 
-        serveable_file = ServeableFile.find_first(serveable_file_options)
+      BLANK_PATH_MESSAGE = 'Please specify non-blank path when initializing rack-zippy middleware ' +
+        '(path leads to your public directory, often the one with favicon.ico in it)'
 
+      SECONDS_IN = {
+        day: 24*60*60,
+        month: 31*(24*60*60),
+        year: 365*(24*60*60)
+      }.freeze
 
-        if serveable_file
-          return [HTTP_STATUS_CODE_OK, serveable_file.headers, serveable_file.response_body]
-        end
+      # 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'.freeze
+
+      FAVICON_PATH = '/favicon.ico'.freeze
+      PATH_INFO = 'PATH_INFO'.freeze
+      CACHE_CONTROL = 'Cache-Control'.freeze
+      LAST_MODIFIED = 'Last-Modified'.freeze
 
-        @app.call(env)
+      def assert_path_valid(path)
+        raise ArgumentError, BLANK_PATH_MESSAGE if path.blank?
       end
 
-      def asset_root
-        @options[:asset_root]
+      def cache_control(max_age_fallback)
+        max_age_fallback = calc_max_age_fallback(max_age_fallback)
+        "public, max-age=#{max_age_fallback}"
       end
 
-      private
+      def calc_max_age_fallback(max_age_fallback)
+        max_age_fallback.is_a?(Symbol) ? SECONDS_IN.fetch(max_age_fallback) : max_age_fallback
+      end
 
-      ACCEPTS_GZIP_REGEX = /\bgzip\b/
+      def illegal_path?(path)
+        path =~ ILLEGAL_PATH_REGEX
+      end
 
-      ILLEGAL_PATH_REGEX = /(\/\.\.?)/
+      def not_found_response
+        [404, {}, ['Not Found']]
+      end
 
-      def client_accepts_gzip?(rack_env)
-        rack_env['HTTP_ACCEPT_ENCODING'] =~ ACCEPTS_GZIP_REGEX
+      def try_static?(path)
+        extension = extension(path)
+        try_default_extension = extension.nil?
+        try_default_extension || static_extension?(extension)
       end
 
-      def resolve_asset_compiler
-        asset_compiler_class = RailsAssetCompiler.rails_env? ? RailsAssetCompiler : NullAssetCompiler
-        return asset_compiler_class.new
+      def extension(path)
+        ext = ::File.extname(path).slice(1..-1)
+        ext.downcase! if ext
+        ext
       end
 
-      def asset_compiler
-        @options[:asset_compiler]
+      def static_extension?(extension)
+        Rack::Zippy.static_extensions.include? extension
       end
 
-      def not_found_response
-        [404, {}, ['Not Found']]
+      def after_static_responds(env, static_response)
+        path = ::Rack::Utils.unescape(env[PATH_INFO])
+        headers = static_response[1]
+        modify_headers(path, headers)
+        static_response
+      end
+
+      def modify_headers(path, headers)
+        case path
+        when ASSETS_SUBDIR_REGEX
+          lifetime_in_secs = SECONDS_IN[:year]
+          last_modified = CACHE_FRIENDLY_LAST_MODIFIED
+        when FAVICON_PATH
+          lifetime_in_secs = SECONDS_IN[:month]
+          last_modified = CACHE_FRIENDLY_LAST_MODIFIED
+        end
+
+        headers[CACHE_CONTROL] = "public, max-age=#{lifetime_in_secs}" if lifetime_in_secs
+
+        if last_modified
+          headers[LAST_MODIFIED] = last_modified
+        else
+          headers.delete(LAST_MODIFIED)
+        end
       end
 
     end

data/lib/rack-zippy/railtie.rb

@@ -0,0 +1,26 @@
+module Rack
+  module Zippy
+    class Railtie < ::Rails::Railtie
+
+      cattr_accessor :skip_version_check
+
+      def self.version_check
+        return if Rack::Zippy::Railtie.skip_version_check
+        if ::Rails.version.to_f >= minimum_rails_version_with_gzip_serving
+          puts "[rack-zippy] rack-zippy is not supported for this version of Rails. Rails now supports serving gzipped files using its own ActionDispatch::Static middleware. It is strongly recommended you remove rack-zippy from your app and use ActionDispatch::Static in its place."
+        else
+          puts "[rack-zippy] This version of rack-zippy does not support Rails. Your choices include: 1) [RECOMMENDED] Upgrade to Rails #{minimum_rails_version_with_gzip_serving} or above and use Rails' built-in ActionDispatch::Static middleware to serve gzipped files. or 2) Specify an earlier version of rack-zippy (~> '3.0.1') in your Gemfile that does support Rails"
+        end
+      end
+
+      def self.minimum_rails_version_with_gzip_serving
+        4.2
+      end
+
+      config.after_initialize do
+        Rack::Zippy::Railtie.version_check
+      end
+
+    end
+  end
+end

data/lib/rack-zippy/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Zippy
-    VERSION = '3.0.1'
+    VERSION = '4.0.0'
   end
 end

data/rack-zippy.gemspec

@@ -14,7 +14,14 @@ Gem::Specification.new do |gem|
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = []
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_dependency 'actionpack', '~> 4.2.4'
+
+  gem.add_development_dependency 'minitest', '~> 5.8.1'
+  gem.add_development_dependency 'guard-test', '~> 2.0.6'
+  gem.add_development_dependency 'rack-test', '~> 0.6.3'
+  gem.add_development_dependency 'rake'
 end

data/test/asset_server_test.rb

@@ -7,14 +7,23 @@ module Rack
 
       def setup
         ensure_correct_working_directory
-        enter_rails_env
-        ::Rails.public_path = Pathname.new(asset_root)
-        ::Rails.configuration.assets.compile = false
+        @original_extensions = Rack::Zippy.static_extensions.dup
       end
 
       def teardown
         revert_to_original_working_directory
         @app = nil
+        Rack::Zippy.static_extensions = @original_extensions
+      end
+
+      BLANK_PATHS = [nil, '', '   ']
+
+      BLANK_PATHS.each do |blank_path|
+        test "initializer prevents blank path: #{blank_path.inspect}" do
+          assert_raises ArgumentError do
+            AssetServer.new(create_rack_app, blank_path)
+          end
+        end
       end
 
       def test_serves_static_file_as_directory
@@ -39,15 +48,6 @@ module Rack
         assert_responds_with_html_file '', 'public/index.html'
       end
 
-      def test_rails_asset_compiler_set_when_rails_environment_detected
-        assert_equal RailsAssetCompiler, app.send(:asset_compiler).class
-      end
-
-      def test_null_asset_compiler_set_when_no_rails_environment_detected
-        exit_rails_env
-        assert_equal NullAssetCompiler, app.send(:asset_compiler).class
-      end
-
       def test_request_for_non_asset_path_beginning_with_assets_dir_name_bypasses_middleware
         get '/assets-are-great-but-im-not-one'
         assert_underlying_app_responded
@@ -90,12 +90,6 @@ module Rack
         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'
-        assert_underlying_app_responded
-      end
-
       def test_responds_with_gzipped_css_to_gzip_capable_clients
         params = {}
         get '/assets/application.css', params, env_for_gzip_capable_client
@@ -173,6 +167,7 @@ module Rack
         get '/assets/rails.png'
         assert_response_ok
         assert_nil last_response.headers['vary']
+        assert_nil last_response.headers['content-encoding']
       end
 
       def test_responds_not_found_if_path_contains_hidden_dir
@@ -255,38 +250,53 @@ module Rack
         assert_underlying_app_responded
       end
 
-      def test_asset_root_constructor_arg_accepts_string
-        asset_server = AssetServer.new(create_rack_app, '/custom/asset/root')
-        assert_equal '/custom/asset/root', asset_server.asset_root
-      end
-
-      def test_default_asset_root_is_rails_public_path
-        Rails.public_path = '/unexpected/absolute/path/to/public'
-        asset_server = AssetServer.new(create_rack_app)
-        assert_equal '/unexpected/absolute/path/to/public', asset_server.asset_root
-      end
-
-      def test_asset_server_accepts_max_age_fallback_option
+      def test_uses_max_age_fallback_in_cache_control
         fallback_in_secs = 1234
         @app = AssetServer.new(
           create_rack_app, asset_root, max_age_fallback: fallback_in_secs
         )
-        
+
         get '/thanks.html'
         assert_equal "public, max-age=1234", last_response.headers['cache-control']
+        assert_last_modified nil
+      end
+
+      def test_request_for_existing_file_with_unknown_extension_is_passed_onto_underlying_app
+        assert Rack::Zippy.static_extensions.delete("txt")
+        get '/robots.txt'
+        assert_underlying_app_responded
+      end
+
+      def test_request_for_file_with_configured_extension_successful
+        Rack::Zippy.static_extensions << 'csv'
+        get '/report.csv'
+        assert_response_ok
+        assert_content_type 'text/csv'
+        assert_content_length 'public/report.csv'
+      end
+
+      def test_default_extensions_includes_fonts
+        font_extensions = ['woff', 'woff2', 'ttf', 'eot', 'otf']
+        font_extensions.each do |ext|
+          assert_includes(Rack::Zippy.static_extensions, ext)
+        end
+      end
+
+      def test_default_extensions_includes_flash
+        assert_includes(Rack::Zippy.static_extensions, 'swf')
+      end
+
+      def test_responds_with_file_with_uppercase_chars_in_extension
+        get '/assets/loading.GiF'
+        assert_response_ok
+        assert_content_type 'image/gif'
+        assert_content_length 'public/assets/loading.GiF'
       end
 
       private
 
       def app
-        return @app if @app
-        if in_rails_env?
-          @app = AssetServer.new(create_rack_app)
-        else
-          # In a pure rack app, non-Rails env
-          @app = AssetServer.new(create_rack_app, asset_root)
-        end
-        return @app
+        @app ||= AssetServer.new(create_rack_app, asset_root)
       end
 
       def create_rack_app