rack-zippy 2.0.0 → 2.0.1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.0.1 / 2014-12-15
+- New `:max_age_fallback` (in seconds) option
+
 ## 2.0.0 / 2014-12-07
 - Rack Zippy now works cleanly with all Rack apps, including Rails apps ([#23](https://github.com/eliotsykes/rack-zippy/issues/23))
 - Decomposed AssetServer into AssetServer, ServeableFile, and AssetCompiler classes

data/README.md

@@ -66,6 +66,24 @@ In `config.ru`:
 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.
 
+### Options
+
+#### max_age_fallback
+
+`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:
+
+```ruby
+max_age_in_secs = 10*60 # 10 mins = 600 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
+```
 
 ## Troubleshooting
 
@@ -75,6 +93,12 @@ Check your environment (in config/environments/) does not have `serve_static_ass
 
     config.serve_static_assets = false # Oops! Should be set to true for rack-zippy
 
+##### 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
+
 
 ## Contributing
 
@@ -112,18 +136,19 @@ Cleanup time! When you’re finished testing, delete the local override and set
 
 ## Contributors
 
-- [Eliot Sykes](https://github.com/eliotsykes)
-- [Kieran Topping](https://github.com/ktopping)
-- [Luke Wendling](https://github.com/lukewendling)
+- Eliot Sykes https://eliotsykes.com
+- Kieran Topping https://github.com/ktopping
+- Luke Wendling https://github.com/lukewendling
 
 
 ## Releasing a new gem
 
-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 and Contributors in README.md
+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` version and date. Update Contributors in `README.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'.
-7. Commit and push the updated lib/rack-zippy/version.rb.
+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/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/lib/rack-zippy.rb

@@ -14,7 +14,7 @@ module Rack
 
       HTTP_STATUS_CODE_OK = 200
 
-      def initialize(app, asset_root=nil)
+      def initialize(app, asset_root=nil, options={})
         if asset_root.nil?
           if RailsAssetCompiler.rails_env?
             asset_root = ::Rails.public_path
@@ -24,8 +24,11 @@ module Rack
           end
         end
         @app = app
-        @asset_root = asset_root
-        @asset_compiler = resolve_asset_compiler
+
+        @options = {
+          :asset_compiler => resolve_asset_compiler,
+          :asset_root => asset_root
+        }.merge(options)
       end
 
       def call(env)
@@ -33,12 +36,15 @@ module Rack
 
         return not_found_response if path_info =~ ILLEGAL_PATH_REGEX
 
-        serveable_file = ServeableFile.find_first(
+        serveable_file_options = {
             :path_info => path_info,
-            :asset_root => @asset_root,
-            :asset_compiler => @asset_compiler,
-            :include_gzipped => client_accepts_gzip?(env)
-        )
+            :asset_root => asset_root,
+            :asset_compiler => asset_compiler,
+            :include_gzipped => client_accepts_gzip?(env),
+            :max_age_fallback => @options[:max_age_fallback]
+        }
+
+        serveable_file = ServeableFile.find_first(serveable_file_options)
 
         if serveable_file
           return [HTTP_STATUS_CODE_OK, serveable_file.headers, serveable_file.response_body]
@@ -47,6 +53,10 @@ module Rack
         @app.call(env)
       end
 
+      def asset_root
+        @options[:asset_root]
+      end
+
       private
 
       ACCEPTS_GZIP_REGEX = /\bgzip\b/
@@ -62,6 +72,10 @@ module Rack
         return asset_compiler_class.new
       end
 
+      def asset_compiler
+        @options[:asset_compiler]
+      end
+
       def not_found_response
         [404, {}, ['Not Found']]
       end

data/lib/rack-zippy/serveable_file.rb

@@ -11,6 +11,7 @@ module Rack
         @full_path_info = options[:full_path_info]
         @has_encoding_variants = options[:has_encoding_variants]
         @is_gzipped = options[:is_gzipped]
+        @max_age_fallback = options[:max_age_fallback] || SECONDS_IN[:day]
       end
 
       def headers
@@ -26,17 +27,17 @@ module Rack
 
       def cache_headers
         case full_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
+        when PRECOMPILED_ASSETS_SUBDIR_REGEX
+          lifetime_in_secs = SECONDS_IN[:year]
+          last_modified = CACHE_FRIENDLY_LAST_MODIFIED
+        when '/favicon.ico'
+          lifetime_in_secs = SECONDS_IN[:month]
+          last_modified = CACHE_FRIENDLY_LAST_MODIFIED
+        else
+          lifetime_in_secs = @max_age_fallback
         end
 
-        headers = { 'Cache-Control' => "public, max-age=#{SECONDS_IN[lifetime]}" }
+        headers = { 'Cache-Control' => "public, max-age=#{lifetime_in_secs}" }
         headers['Last-Modified'] = last_modified if last_modified
 
         return headers
@@ -49,7 +50,7 @@ module Rack
       def self.find_first(options)
         asset_compiler = options[:asset_compiler]
         path_info = options[:path_info].chomp('/')
-        
+
         return nil if asset_compiler.compiles?(path_info)
 
         asset_root = options[:asset_root]
@@ -77,20 +78,19 @@ module Rack
 
         has_encoding_variants = gzipped_file_present
 
+        init_options = {
+          :path => file_path,
+          :full_path_info => full_path_info,
+          :has_encoding_variants => has_encoding_variants,
+          :max_age_fallback => options[:max_age_fallback]
+        }
+
         if include_gzipped && gzipped_file_present
-          return ServeableFile.new(
-              :path => gzipped_file_path,
-              :full_path_info => full_path_info,
-              :has_encoding_variants => has_encoding_variants,
-              :is_gzipped => true
-          )
+          init_options[:path] = gzipped_file_path
+          init_options[:is_gzipped] = true
         end
 
-        return ServeableFile.new(
-            :path => file_path,
-            :full_path_info => full_path_info,
-            :has_encoding_variants => has_encoding_variants
-        )
+        return ServeableFile.new(init_options)
       end
 
       def self.has_static_extension?(path)
@@ -116,15 +116,15 @@ module Rack
       end
       alias_method :eql?, :==
 
-      private
+        private
 
       # 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'
 
       SECONDS_IN = {
-          :day => 24*60*60,
-          :month => 31*(24*60*60),
-          :year => 365*(24*60*60)
+        :day => 24*60*60,
+        :month => 31*(24*60*60),
+        :year => 365*(24*60*60)
       }.freeze
 
       DEFAULT_STATIC_EXTENSION = '.html'.freeze

data/lib/rack-zippy/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Zippy
-    VERSION = '2.0.0'
+    VERSION = '2.0.1'
   end
 end

data/test/asset_server_test.rb

@@ -14,6 +14,7 @@ module Rack
 
       def teardown
         revert_to_original_working_directory
+        @app = nil
       end
 
       def test_serves_static_file_as_directory
@@ -43,14 +44,12 @@ module Rack
       end
 
       def test_rails_asset_compiler_set_when_rails_environment_detected
-        asset_compiler = app.instance_variable_get('@asset_compiler')
-        assert_equal RailsAssetCompiler, asset_compiler.class
+        assert_equal RailsAssetCompiler, app.send(:asset_compiler).class
       end
 
       def test_null_asset_compiler_set_when_no_rails_environment_detected
         exit_rails_env
-        asset_compiler = app.instance_variable_get('@asset_compiler')
-        assert_equal NullAssetCompiler, asset_compiler.class
+        assert_equal NullAssetCompiler, app.send(:asset_compiler).class
       end
 
       def test_request_for_non_asset_path_beginning_with_assets_dir_name_bypasses_middleware
@@ -255,23 +254,36 @@ module Rack
 
       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.instance_variable_get('@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.instance_variable_get('@asset_root')
+        assert_equal '/unexpected/absolute/path/to/public', asset_server.asset_root
+      end
+
+      def test_asset_server_accepts_max_age_fallback_option
+        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']
       end
 
       private
 
       def app
+        return @app if @app
         if in_rails_env?
-          return AssetServer.new(create_rack_app)
+          @app = AssetServer.new(create_rack_app)
+        else
+          # In a pure rack app, non-Rails env
+          @app = AssetServer.new(create_rack_app, asset_root)
         end
-        # In a pure rack app, non-Rails env
-        return AssetServer.new(create_rack_app, asset_root)
+        return @app
       end
 
       def create_rack_app

data/test/serveable_file_test.rb

@@ -30,6 +30,24 @@ module Rack
         assert_last_modified cache_headers, nil
       end
 
+      def test_max_age_fallback_used_for_cache_headers
+        
+        ten_mins_in_secs = 10*60
+
+        serveable_file = ServeableFile.new(
+          :full_path_info => "/thanks.html",
+          :path => "#{asset_root}/thanks.html",
+          :has_encoding_variants => false,
+          :is_gzipped => false,
+          :max_age_fallback => ten_mins_in_secs
+        )
+
+        cache_headers = serveable_file.cache_headers
+
+        assert_cache_max_age cache_headers, ten_mins_in_secs
+        assert_last_modified cache_headers, nil
+      end
+
       def test_cache_max_age_is_month_for_root_favicon
         serveable_file = ServeableFile.new(
           :full_path_info => "/favicon.ico",
@@ -460,7 +478,8 @@ module Rack
       end
 
       def assert_cache_max_age(headers, expected_duration)
-        assert_equal "public, max-age=#{DURATIONS_IN_SECS[expected_duration]}", headers['Cache-Control']
+        duration_in_secs = DURATIONS_IN_SECS[expected_duration] || expected_duration
+        assert_equal "public, max-age=#{duration_in_secs}", headers['Cache-Control']
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-zippy
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,13 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-07 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies: []
 description: Rack middleware for serving static gzipped assets generated by the Rails
   asset pipeline
 email:
 - e@jetbootlabs.com
-executables: []
+executables:
+- rake
 extensions: []
 extra_rdoc_files: []
 files:
@@ -26,6 +27,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/rake
 - lib/rack-zippy.rb
 - lib/rack-zippy/asset_compiler.rb
 - lib/rack-zippy/serveable_file.rb
@@ -63,12 +65,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1213525352478824492
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1213525352478824492
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2