heroku-deflater 0.4.2 → 0.5.0

data/README.md

@@ -1,7 +1,14 @@
 # heroku-deflater
 
 A simple rack middleware that enables compressing of your assets and application
-responses on Heroku, while not wasting CPU cycles on pointlessly gzipping images.
+responses on Heroku, while not wasting CPU cycles on pointlessly compressing images
+and other binary responses.
+
+It also includes code from https://github.com/mattolson/heroku_rails_deflate
+
+Before serving a file from disk to a gzip-enabled client, it will look for
+a precompressed file in the same location that ends in ".gz".
+The purpose is to avoid compressing the same file each time it is requested.
 
 ## Installing
 
@@ -11,7 +18,7 @@ Add to your Gemfile:
 
 
 ## Contributing to heroku-deflater
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/heroku-deflater.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "heroku-deflater"
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roman Shterenzon"]
@@ -27,7 +27,13 @@ Gem::Specification.new do |s|
     "heroku-deflater.gemspec",
     "lib/heroku-deflater.rb",
     "lib/heroku-deflater/railtie.rb",
+    "lib/heroku-deflater/serve_zipped_assets.rb",
     "lib/heroku-deflater/skip_binary.rb",
+    "spec/fixtures/assets/spec.js",
+    "spec/fixtures/assets/spec.js.gz",
+    "spec/fixtures/assets/spec2.js",
+    "spec/fixtures/non-assets/spec.js.gz",
+    "spec/serve_zipped_assets_spec.rb",
     "spec/skip_binary_spec.rb"
   ]
   s.homepage = "http://github.com/romanbsd/heroku-deflater"

data/lib/heroku-deflater/railtie.rb

@@ -1,11 +1,14 @@
 require 'rack/deflater'
 require 'heroku-deflater/skip_binary'
+require 'heroku-deflater/serve_zipped_assets'
 
 module HerokuDeflater
   class Railtie < Rails::Railtie
-    initializer "heroku_deflater.configure_rails_initialization" do |app|
+    initializer 'heroku_deflater.configure_rails_initialization' do |app|
       app.middleware.insert_before ActionDispatch::Static, Rack::Deflater
       app.middleware.insert_before ActionDispatch::Static, HerokuDeflater::SkipBinary
+      app.middleware.insert_before Rack::Deflater, HerokuDeflater::ServeZippedAssets,
+        app.paths['public'].first, app.config.assets.prefix, {'Cache-Control' => app.config.static_cache_control}
     end
 
     # Set default Cache-Control headers to one week.

data/lib/heroku-deflater/serve_zipped_assets.rb

@@ -0,0 +1,52 @@
+require 'action_controller'
+require 'active_support/core_ext/uri'
+require 'action_dispatch/middleware/static'
+
+# Adapted from https://gist.github.com/guyboltonking/2152663
+#
+# Taken from: https://github.com/mattolson/heroku_rails_deflate
+#
+
+module HerokuDeflater
+  class ServeZippedAssets
+    def initialize(app, root, assets_path, headers=nil)
+      @app = app
+      @assets_path = assets_path.chomp('/') + '/'
+      @file_handler = ActionDispatch::FileHandler.new(root, headers)
+    end
+
+    def call(env)
+      if env['REQUEST_METHOD'] == 'GET'
+        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
+          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)
+            env['PATH_INFO'].chomp!('.gz')
+
+            # Set the Vary HTTP header.
+            vary = headers['Vary'].to_s.split(',').map(&: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(env['PATH_INFO']), 'text/plain')
+
+            return [status, headers, body]
+          end
+        end
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/spec/fixtures/assets/spec.js

@@ -0,0 +1,6 @@
+// Fixture file
+(function() {
+  console.log("Hello world");
+  console.log("Hello world");
+  console.log("Hello world");
+})();

data/spec/fixtures/assets/spec2.js

@@ -0,0 +1,4 @@
+// Fixture file
+(function() {
+  console.log("Hello world");
+})();

data/spec/serve_zipped_assets_spec.rb

@@ -0,0 +1,60 @@
+require 'rack/mock'
+require 'rack/static'
+require 'heroku-deflater/serve_zipped_assets'
+
+describe HerokuDeflater::ServeZippedAssets do
+  def process(path, accept_encoding = 'compress, gzip, deflate')
+    env = Rack::MockRequest.env_for(path)
+    env['HTTP_ACCEPT_ENCODING'] = accept_encoding
+    app.call(env)
+  end
+
+  def app
+    @app ||= begin
+      root_path = File.expand_path('../fixtures', __FILE__)
+      headers = {'Cache-Control'=>'public, max-age=86400'}
+      mock = lambda { |env| [404, {'X-Cascade' => 'pass'}, []] }
+      described_class.new(mock, root_path, '/assets', headers)
+    end
+  end
+
+  it 'does nothing for clients which do not want gzip' do
+    status, headers, body = process('/assets/spec.js', nil)
+    status.should eq(404)
+  end
+
+  it 'handles the pre-gzipped assets' do
+    status, headers, body = process('/assets/spec.js')
+    status.should eq(200)
+  end
+
+  it 'has correct content type' do
+    status, headers, body = process('/assets/spec.js')
+    headers['Content-Type'].should eq('application/javascript')
+  end
+
+  it 'has correct content encoding' do
+    status, headers, body = process('/assets/spec.js')
+    headers['Content-Encoding'].should eq('gzip')
+  end
+
+  it 'has correct content length' do
+    status, headers, body = process('/assets/spec.js')
+    headers['Content-Length'].should eq('86')
+  end
+
+  it 'has correct cache control' do
+    status, headers, body = process('/assets/spec.js')
+    headers['Cache-Control'].should eq('public, max-age=86400')
+  end
+
+  it 'does not serve non-gzipped assets' do
+    status, headers, body = process('/assets/spec2.js')
+    status.should eq(404)
+  end
+
+  it 'does not serve anything from non-asset directories' do
+    status, headers, body = process('/non-assets/spec.js')
+    status.should eq(404)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku-deflater
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -77,7 +77,13 @@ files:
 - heroku-deflater.gemspec
 - lib/heroku-deflater.rb
 - lib/heroku-deflater/railtie.rb
+- lib/heroku-deflater/serve_zipped_assets.rb
 - lib/heroku-deflater/skip_binary.rb
+- spec/fixtures/assets/spec.js
+- spec/fixtures/assets/spec.js.gz
+- spec/fixtures/assets/spec2.js
+- spec/fixtures/non-assets/spec.js.gz
+- spec/serve_zipped_assets_spec.rb
 - spec/skip_binary_spec.rb
 homepage: http://github.com/romanbsd/heroku-deflater
 licenses:
@@ -94,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1218227889335563131
+      hash: 262510115416976857
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: