heroku_rails_deflate 0.2.1 → 1.0.0

data/Gemfile

@@ -1,8 +1,11 @@
 source "http://rubygems.org"
 
 gem 'rack', '~> 1.4.5'
+gem 'actionpack', '~> 3.2.13'
+gem 'activesupport', '~> 3.2.13'
 
 group :development do
+  gem "rspec"
   gem "bundler"
   gem "jeweler"
 end

data/Gemfile.lock

@@ -1,22 +1,66 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    diff-lcs (1.2.2)
+    erubis (2.7.0)
     git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.1)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
+    journey (1.0.4)
     json (1.7.7)
+    multi_json (1.7.2)
     rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.2)
+      rack (>= 1.0)
     rake (10.0.4)
     rdoc (4.0.1)
       json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionpack (~> 3.2.13)
+  activesupport (~> 3.2.13)
   bundler
   jeweler
   rack (~> 1.4.5)
+  rspec

data/README.md

@@ -1,6 +1,47 @@
 # heroku\_rails\_deflate
 
-Activate Rack::Deflate and serve up precompiled, gzipped assets on Heroku
+The Heroku Cedar stack is not fronted by an asset server such as Varnish or nginx, and there is no automatic provision
+for using gzip compression for HTTP transfers. At the same time, the Rails 3.2 asset pipeline spends a lot
+of CPU cycles creating highly compressed versions of all our static assets. It would be great to use them!
+
+This gem activates Rack::Deflate for all requests. But the real coolness is the custom middleware that checks
+for the .gz version of precompiled assets and serves them up for you. We also eliminate conflict with Rack::Deflate
+by telling it not to compress these already compressed files. We also provide a sensible default for the Cache-Control
+header for these files. If you are using the asset digest in the filename (and you should), there is no reason
+why we can't set very high max-age, so we set it to one year by default.
+
+You should see a nice performance boost from the installation of this gem, without any additional work on your
+part. After you get done with this, you could take it to the next level by adding a CDN such as AWS CloudFront.
+
+## Installation
+
+* Add the gem to your app
+
+```ruby
+  gem 'heroku_rails_deflate', :group => :production
+```
+
+* Make sure asset caching is configured correctly in environments/production.rb:
+
+```ruby
+  config.serve_static_assets = true
+  config.assets.compress = true
+  config.assets.compile = true
+  config.assets.digest = true
+```
+
+* If you want a different max-age for your static assets, you can override the default:
+
+```ruby
+  config.static_cache_control = "public, max-age=31536000"
+```
+
+* You should precompile your assets prior to deploying to Heroku to save CPU cycles at request time:
+
+```ruby
+  RAILS_ENV=production rake assets:precompile
+```
+
 
 ## Contributing to heroku\_rails\_deflate
  
@@ -12,6 +53,10 @@ Activate Rack::Deflate and serve up precompiled, gzipped assets on Heroku
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+## Thanks
+
+This gem expands on code originally published in a [gist](https://gist.github.com/guyboltonking/2152663) by [guyboltonking](https://github.com/guyboltonking). 
+
 ## Copyright
 
 Copyright (c) 2013 Matt Olson. See LICENSE.txt for further details.

data/Rakefile

@@ -20,22 +20,13 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/mattolson/heroku_rails_deflate"
   gem.license = "MIT"
   gem.summary = %Q{Activate Rack::Deflate and serve up precompiled, gzipped assets on Heroku}
-  gem.description = %Q{Activate Rack::Deflate and serve up precompiled, gzipped assets on Heroku. This allows us to take advantage of higher compression ratios of prezipped files, and reduces CPU load at request time.}
+  gem.description = %Q{This gem is designed for use by Rails applications running on Heroku. For others, the better approach is to use a frontend server such as nginx or Apache. However, the Heroku Cedar stack is no longer fronted by a file server, and there is no automatic provision for gzipping responses. This gem activates Rack::Deflate for all requests. In addition, we serve up the gzipped versions of our precompiled assets, taking advantage of the higher compression ratio used during precompilation, and reducing CPU load at request time.}
   gem.email = "matt@mattolson.com"
   gem.authors = ["Matt Olson"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""

data/heroku_rails_deflate.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "heroku_rails_deflate"
-  s.version = "0.2.1"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Olson"]
-  s.date = "2013-04-02"
-  s.description = "Activate Rack::Deflate and serve up precompiled, gzipped assets on Heroku. This allows us to take advantage of higher compression ratios of prezipped files, and reduces CPU load at request time."
+  s.date = "2013-04-03"
+  s.description = "This gem is designed for use by Rails applications running on Heroku. For others, the better approach is to use a frontend server such as nginx or Apache. However, the Heroku Cedar stack is no longer fronted by a file server, and there is no automatic provision for gzipping responses. This gem activates Rack::Deflate for all requests. In addition, we serve up the gzipped versions of our precompiled assets, taking advantage of the higher compression ratio used during precompilation, and reducing CPU load at request time."
   s.email = "matt@mattolson.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -28,8 +28,11 @@ Gem::Specification.new do |s|
     "lib/heroku_rails_deflate/railtie.rb",
     "lib/heroku_rails_deflate/serve_zipped_assets.rb",
     "lib/heroku_rails_deflate/version.rb",
-    "test/helper.rb",
-    "test/test_heroku_rails_deflate.rb"
+    "spec/fixtures/assets/bender.jpg",
+    "spec/fixtures/assets/bender.jpg.gz",
+    "spec/fixtures/non-assets/bender.jpg",
+    "spec/fixtures/non-assets/bender.jpg.gz",
+    "spec/serve_zipped_assets_spec.rb"
   ]
   s.homepage = "http://github.com/mattolson/heroku_rails_deflate"
   s.licenses = ["MIT"]
@@ -42,15 +45,24 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rack>, ["~> 1.4.5"])
+      s.add_runtime_dependency(%q<actionpack>, ["~> 3.2.13"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.2.13"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
       s.add_dependency(%q<rack>, ["~> 1.4.5"])
+      s.add_dependency(%q<actionpack>, ["~> 3.2.13"])
+      s.add_dependency(%q<activesupport>, ["~> 3.2.13"])
+      s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
     s.add_dependency(%q<rack>, ["~> 1.4.5"])
+    s.add_dependency(%q<actionpack>, ["~> 3.2.13"])
+    s.add_dependency(%q<activesupport>, ["~> 3.2.13"])
+    s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
   end

data/lib/heroku_rails_deflate/serve_zipped_assets.rb

@@ -1,23 +1,14 @@
+require 'action_controller'
+require 'active_support/core_ext/uri'
 require 'action_dispatch/middleware/static'
 
 # Adapted from https://gist.github.com/guyboltonking/2152663
 module HerokuRailsDeflate
-  # Rails static middleware, but restricted to assets path
-  class FileHandler < ActionDispatch::FileHandler
-    def initialize(root, assets_path, cache_control)
-      @assets_path = assets_path.chomp('/') + '/'
-      super(root, cache_control)
-    end
-
-    def match?(path)
-      path.start_with?(@assets_path) && super(path)
-    end
-  end
-
   class ServeZippedAssets
-    def initialize(app, path, assets_path, cache_control=nil)
+    def initialize(app, root, assets_path, cache_control=nil)
       @app = app
-      @file_handler = FileHandler.new(path, assets_path, cache_control)
+      @assets_path = assets_path.chomp('/') + '/'
+      @file_handler = ActionDispatch::FileHandler.new(root, cache_control)
     end
 
     def call(env)
@@ -25,37 +16,37 @@ module HerokuRailsDeflate
         request = Rack::Request.new(env)
         encoding = Rack::Utils.select_best_encoding(%w(gzip identity), request.accept_encoding)
 
-          if encoding == 'gzip'
-            # See if gzipped version exists in assets directory
-            pathgz = env['PATH_INFO'] + '.gz'
-            if match = @file_handler.match?(pathgz)
-              # Get the filehandler to serve up the gzipped file, then strip the .gz suffix
-              env["PATH_INFO"] = match
-              status, headers, body = @file_handler.call(env)
-              path = env["PATH_INFO"] = env["PATH_INFO"].chomp('.gz')
-
-              # Set the Vary HTTP header.
-              vary = headers["Vary"].to_s.split(",").map { |v| v.strip }
-              unless vary.include?("*") || vary.include?("Accept-Encoding")
-                headers["Vary"] = vary.push("Accept-Encoding").join(",")
-              end
-
-              # Add encoding and type
-              headers['Content-Encoding'] = 'gzip'
-              headers['Content-Type'] = Rack::Mime.mime_type(File.extname(path), 'text/plain')
-              headers.delete('Content-Length')
-
-              # Update cache-control to add directive telling Rack::Deflate to leave it alone.
-              cache_control = headers['Cache-Control'].try(:to_s).try(:downcase)
-              if cache_control.nil?
-                headers['Cache-Control'] = 'no-transform'
-              elsif !cache_control.include?('no-transform')
-                headers['Cache-Control'] += ', no-transform'
-              end
+        if encoding == 'gzip'
+          # See if gzipped version exists in assets directory
+          compressed_path = env['PATH_INFO'] + '.gz'
+          if compressed_path.start_with?(@assets_path) && (match = @file_handler.match?(compressed_path))
+            # Get the FileHandler to serve up the gzipped file, then strip the .gz suffix
+            env["PATH_INFO"] = match
+            status, headers, body = @file_handler.call(env)
+            path = env["PATH_INFO"] = env["PATH_INFO"].chomp('.gz')
+
+            # Set the Vary HTTP header.
+            vary = headers["Vary"].to_s.split(",").map { |v| v.strip }
+            unless vary.include?("*") || vary.include?("Accept-Encoding")
+              headers["Vary"] = vary.push("Accept-Encoding").join(",")
+            end
 
-              return [status, headers, body]
+            # Add encoding and type
+            headers['Content-Encoding'] = 'gzip'
+            headers['Content-Type'] = Rack::Mime.mime_type(File.extname(path), 'text/plain')
+            headers.delete('Content-Length')
+
+            # Update cache-control to add directive telling Rack::Deflate to leave it alone.
+            cache_control = headers['Cache-Control'].try(:to_s).try(:downcase)
+            if cache_control.nil?
+              headers['Cache-Control'] = 'no-transform'
+            elsif !cache_control.include?('no-transform')
+              headers['Cache-Control'] += ', no-transform'
             end
+
+            return [status, headers, body]
           end
+        end
       end
 
       @app.call(env)

data/lib/heroku_rails_deflate/version.rb

@@ -1,8 +1,8 @@
 module HerokuRailsDeflate
   class Version
-    MAJOR = 0
-    MINOR = 2
-    PATCH = 1
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/spec/serve_zipped_assets_spec.rb

@@ -0,0 +1,51 @@
+require 'rack/mock'
+require 'rack/static'
+require 'heroku_rails_deflate/serve_zipped_assets'
+
+# Return a bogus response so we can detect rack passthrough
+class MockServer
+  def initialize; end
+  def call(env)
+    Rack::MockResponse.new(500, {'X-mock' => 'mocked!'}, 'ERROR')
+  end
+end
+
+describe HerokuRailsDeflate::ServeZippedAssets do
+  def process(path, cache_control='public, max-age=31536000')
+    root_path = File.expand_path('../fixtures', __FILE__)
+    request_env = Rack::MockRequest.env_for(path)
+    request_env['HTTP_ACCEPT_ENCODING'] = 'compress, gzip, deflate'
+    
+    deflate_server = described_class.new(MockServer.new, root_path, '/assets', cache_control)
+    deflate_server.call(request_env)
+  end
+
+  it "has correct content encoding" do
+    status, headers, body = process('/assets/bender.jpg')
+    status.should eq(200)
+    headers['Content-Encoding'].should eq('gzip')
+  end
+
+  it "has correct cache-control header" do
+    status, headers, body = process('/assets/bender.jpg')
+    status.should eq(200)
+    headers['Cache-Control'].should eq('public, max-age=31536000, no-transform')
+  end
+
+  it "should not modify existing cache-control header" do
+    status, headers, body = process('/assets/bender.jpg', 'private')
+    status.should eq(200)
+    headers['Cache-Control'].should eq('private, no-transform')
+  end
+
+  it "should create cache-control header if necessary" do
+    status, headers, body = process('/assets/bender.jpg', nil)
+    status.should eq(200)
+    headers['Cache-Control'].should eq('no-transform')
+  end
+
+  it "should not serve anything from non-asset directories" do
+    status, headers, body = process('/non-asset/bender.jpg', nil)
+    headers['X-mock'].should eq('mocked!')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku_rails_deflate
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -27,6 +27,54 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -59,9 +107,13 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Activate Rack::Deflate and serve up precompiled, gzipped assets on Heroku.
-  This allows us to take advantage of higher compression ratios of prezipped files,
-  and reduces CPU load at request time.
+description: This gem is designed for use by Rails applications running on Heroku.
+  For others, the better approach is to use a frontend server such as nginx or Apache.
+  However, the Heroku Cedar stack is no longer fronted by a file server, and there
+  is no automatic provision for gzipping responses. This gem activates Rack::Deflate
+  for all requests. In addition, we serve up the gzipped versions of our precompiled
+  assets, taking advantage of the higher compression ratio used during precompilation,
+  and reducing CPU load at request time.
 email: matt@mattolson.com
 executables: []
 extensions: []
@@ -80,8 +132,11 @@ files:
 - lib/heroku_rails_deflate/railtie.rb
 - lib/heroku_rails_deflate/serve_zipped_assets.rb
 - lib/heroku_rails_deflate/version.rb
-- test/helper.rb
-- test/test_heroku_rails_deflate.rb
+- spec/fixtures/assets/bender.jpg
+- spec/fixtures/assets/bender.jpg.gz
+- spec/fixtures/non-assets/bender.jpg
+- spec/fixtures/non-assets/bender.jpg.gz
+- spec/serve_zipped_assets_spec.rb
 homepage: http://github.com/mattolson/heroku_rails_deflate
 licenses:
 - MIT
@@ -97,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -257709888069161543
+      hash: 848461724416935905
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'heroku_rails_deflate'
-
-class Test::Unit::TestCase
-end

data/test/test_heroku_rails_deflate.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestHerokuRailsDeflate < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end