action_dispatch-gz_static 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# ActionDispatch::GzStatic
+
+ActionDispatch::GzStatic is a derivative of ActionDispatch::Static, that has
+been modified to serve the .gz files that are created by the Rails asset
+precompiler.
+
+If you are using Rails to serve static assets in production, and
+you are using the asset precompiler, then it is probably a good idea to use this
+gem. If you running on Heroku's Cedar stack, this includes you.
+
+ActionDispatch::GzStatic is a better solution that using Rack::Deflater on your
+static assets, because this has the undesirable side effect of recompressing
+assets that are already compressed, such as images.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'action_dispatch-gz_static'
+
+Add this to application.rb:
+
+    # The railtie initializer will look for ActionDispatch::Static, and swap it
+    # with ActionDispatch::GzStatic
+    config.serve_static_assets = true
+
+    # This isn't required, but is generally a good idea.
+    config.static_cache_control = "public, max-age=#{1.month.to_i}"

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end

data/action_dispatch-gz_static.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "action_dispatch-gz_static"
+  gem.version       = '0.0.1'
+  gem.authors       = ["Jonathan Baudanza"]
+  gem.email         = ["jon@jonb.org"]
+  gem.description   = %q{Serves the .gz files that are created by the asset precompiler}
+  gem.summary       = %q{Serves the .gz files that are created by the asset precompiler}
+  gem.homepage      = "https://github.com/jbaudanza/action_dispatch-gz_static"
+
+  gem.add_dependency('actionpack', '>= 3.1.0', '< 4')
+  gem.add_dependency('railties', '>= 3.1.0', '< 4')
+
+  gem.files         = `git ls-files`.split($/).collect{ |str| str[0] == '"' ? eval(str) : str }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/action_dispatch/gz_railtie.rb

@@ -0,0 +1,9 @@
+module ActionDispatch
+  class GzRailtie < Rails::Railtie
+    initializer "gz_static.install_middleware" do |app|
+      app.middleware.swap ::ActionDispatch::Static, ::ActionDispatch::GzStatic,
+          app.paths['public'].first,
+          app.config.static_cache_control
+    end
+  end
+end

data/lib/action_dispatch/gz_static.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+require 'rack/utils'
+require 'rack/mime'
+require 'rack/file'
+require 'active_support/core_ext/uri'
+
+require 'action_dispatch/gz_railtie' if defined?(Rails)
+
+module ActionDispatch
+  class GzStatic
+    def initialize(app, root, cache_control=nil)
+      @app           = app
+      @root          = root.chomp('/')
+      @compiled_root = /^#{Regexp.escape(@root)}/
+      @file_server   = ::Rack::File.new(@root, cache_control)
+    end
+
+    def match?(path)
+      path = path.dup
+
+      full_path = path.empty? ? @root : File.join(@root, escape_glob_chars(unescape_path(path)))
+      paths = "#{full_path}#{ext}"
+
+      matches = Dir[paths]
+      matches.detect { |m| File.file?(m) }
+    end
+
+    def call(env)
+      case env['REQUEST_METHOD']
+      when 'GET', 'HEAD'
+        path = env['PATH_INFO'].chomp('/')
+        if match = match?(path)
+
+          compressed_match = "#{match}.gz"
+          compressed_exists = File.file?(compressed_match)
+            
+          wants_compressed = !!(env['HTTP_ACCEPT_ENCODING'] =~ /\bgzip\b/)
+
+          if wants_compressed && compressed_exists
+            mime = Rack::Mime.mime_type(::File.extname(match), 'text/plain')
+            match = compressed_match
+          end
+
+          match.sub!(@compiled_root, '')
+          env["PATH_INFO"] = ::Rack::Utils.escape(match)
+          status, headers, body = @file_server.call(env)
+
+          if compressed_exists
+            headers['Vary'] = 'Accept-Encoding'
+
+            if wants_compressed
+              headers['Content-Encoding'] = 'gzip'
+              headers['Content-Type'] = mime if mime
+            end
+          end
+
+          return [status, headers, body]
+        end
+      end
+
+      @app.call(env)
+    end
+
+    def ext
+      @ext ||= begin
+        #ext = ::ActionController::Base.default_static_extension
+        ext = ".html"
+        "{,#{ext},/index#{ext}}"
+      end
+    end
+
+    def unescape_path(path)
+      URI.parser.unescape(path)
+    end
+
+    def escape_glob_chars(path)
+      path.force_encoding('binary') if path.respond_to? :force_encoding
+      path.gsub(/[*?{}\[\]]/, "\\\\\\&")
+    end
+  end
+end

data/test/gz_static_test.rb

@@ -0,0 +1,179 @@
+# encoding: utf-8
+require 'minitest/autorun'
+require 'rbconfig'
+require 'active_support'
+require 'action_dispatch/gz_static'
+require 'rack/mock'
+require 'zlib'
+
+PUBLIC_LOAD_PATH = File.join(File.dirname(__FILE__), 'public')
+
+module StaticTests
+  def test_serves_dynamic_content
+    assert_equal "Hello, World!", get("/nofile").body
+  end
+
+  def test_handles_urls_with_bad_encoding
+    assert_equal "Hello, World!", get("/doorkeeper%E3E4").body
+  end
+
+  def test_sets_cache_control
+    response = get("/index.html")
+    assert_html "/index.html", response
+    assert_equal "public, max-age=60", response.headers["Cache-Control"]
+  end
+
+  def test_serves_static_index_at_root
+    assert_html "/index.html", get("/index.html")
+    assert_html "/index.html", get("/index")
+    assert_html "/index.html", get("/")
+    assert_html "/index.html", get("")
+  end
+
+  def test_serves_static_file_in_directory
+    assert_html "/foo/bar.html", get("/foo/bar.html")
+    assert_html "/foo/bar.html", get("/foo/bar/")
+    assert_html "/foo/bar.html", get("/foo/bar")
+  end
+
+  def test_serves_static_index_file_in_directory
+    assert_html "/foo/index.html", get("/foo/index.html")
+    assert_html "/foo/index.html", get("/foo/")
+    assert_html "/foo/index.html", get("/foo")
+  end
+
+  def test_served_static_file_with_non_english_filename
+    assert_html "means hello in Japanese\n", get("/foo/#{Rack::Utils.escape("こんにちは.html")}")
+  end
+
+
+  def test_serves_static_file_with_exclamation_mark_in_filename
+    with_static_file "/foo/foo!bar.html" do |file|
+      assert_html file, get("/foo/foo%21bar.html")
+      assert_html file, get("/foo/foo!bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_dollar_sign_in_filename
+    with_static_file "/foo/foo$bar.html" do |file|
+      assert_html file, get("/foo/foo%24bar.html")
+      assert_html file, get("/foo/foo$bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_ampersand_in_filename
+    with_static_file "/foo/foo&bar.html" do |file|
+      assert_html file, get("/foo/foo%26bar.html")
+      assert_html file, get("/foo/foo&bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_apostrophe_in_filename
+    with_static_file "/foo/foo'bar.html" do |file|
+      assert_html file, get("/foo/foo%27bar.html")
+      assert_html file, get("/foo/foo'bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_parentheses_in_filename
+    with_static_file "/foo/foo(bar).html" do |file|
+      assert_html file, get("/foo/foo%28bar%29.html")
+      assert_html file, get("/foo/foo(bar).html")
+    end
+  end
+
+  def test_serves_static_file_with_plus_sign_in_filename
+    with_static_file "/foo/foo+bar.html" do |file|
+      assert_html file, get("/foo/foo%2Bbar.html")
+      assert_html file, get("/foo/foo+bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_comma_in_filename
+    with_static_file "/foo/foo,bar.html" do |file|
+      assert_html file, get("/foo/foo%2Cbar.html")
+      assert_html file, get("/foo/foo,bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_semi_colon_in_filename
+    with_static_file "/foo/foo;bar.html" do |file|
+      assert_html file, get("/foo/foo%3Bbar.html")
+      assert_html file, get("/foo/foo;bar.html")
+    end
+  end
+
+  def test_serves_static_file_with_at_symbol_in_filename
+    with_static_file "/foo/foo@bar.html" do |file|
+      assert_html file, get("/foo/foo%40bar.html")
+      assert_html file, get("/foo/foo@bar.html")
+    end
+  end
+
+  def test_serves_uncompressed_file
+    response = get('/compressed.html')
+    assert_equal 200, response.status
+    assert_html "Hello, static file", response
+    assert_equal "Accept-Encoding", response.headers['Vary']
+    assert_nil response.headers['Content-Encoding']
+  end
+
+  def test_serves_compressed_file
+    response = get('/compressed.html', 'HTTP_ACCEPT_ENCODING' => 'gzip')
+    assert_equal 200, response.status
+    gz = Zlib::GzipReader.new(StringIO.new(response.body))
+    assert_equal "Hello, static file", gz.read
+    assert_equal "Accept-Encoding", response.headers['Vary']
+    assert_equal "gzip", response.headers['Content-Encoding']
+    assert_equal "text/html", response.headers['Content-Type']
+  end
+
+  # Windows doesn't allow \ / : * ? " < > | in filenames
+  unless RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+    def test_serves_static_file_with_colon
+      with_static_file "/foo/foo:bar.html" do |file|
+        assert_html file, get("/foo/foo%3Abar.html")
+        assert_html file, get("/foo/foo:bar.html")
+      end
+    end
+
+    def test_serves_static_file_with_asterisk
+      with_static_file "/foo/foo*bar.html" do |file|
+        assert_html file, get("/foo/foo%2Abar.html")
+        assert_html file, get("/foo/foo*bar.html")
+      end
+    end
+  end
+
+  private
+
+    def assert_html(body, response)
+      assert_equal body, response.body
+      assert_equal "text/html", response.headers["Content-Type"]
+    end
+
+    def get(path, opts={})
+      Rack::MockRequest.new(@app).request("GET", path, opts)
+    end
+
+    def with_static_file(file)
+      path = PUBLIC_LOAD_PATH + file
+      File.open(path, "wb+") { |f| f.write(file) }
+      yield file
+    ensure
+      File.delete(path)
+    end
+end
+
+class StaticTest < ActiveSupport::TestCase
+  DummyApp = lambda { |env|
+    [200, {"Content-Type" => "text/plain"}, ["Hello, World!"]]
+  }
+  App = ActionDispatch::GzStatic.new(DummyApp, PUBLIC_LOAD_PATH, "public, max-age=60")
+
+  def setup
+    @app = App
+  end
+
+  include StaticTests
+end

data/test/public/.gitignore

@@ -0,0 +1 @@
+absolute/*

data/test/public/404.html

@@ -0,0 +1 @@
+404 error fixture

data/test/public/500.da.html

@@ -0,0 +1 @@
+500 localized error fixture

data/test/public/500.html

@@ -0,0 +1 @@
+500 error fixture

data/test/public/compressed.html

@@ -0,0 +1 @@
+Hello, static file

data/test/public/elsewhere/cools.js

@@ -0,0 +1 @@
+// cools.js

data/test/public/elsewhere/file.css

@@ -0,0 +1 @@
+/*file.css*/

data/test/public/foo/bar.html

@@ -0,0 +1 @@
+/foo/bar.html

data/test/public/foo/baz.css

@@ -0,0 +1,3 @@
+body {
+background: #000;
+}

data/test/public/foo/index.html

@@ -0,0 +1 @@
+/foo/index.html

data/test/public/foo//343/201/223/343/202/223/343/201/253/343/201/241/343/201/257.html

@@ -0,0 +1 @@
+means hello in Japanese

data/test/public/index.html

@@ -0,0 +1 @@
+/index.html

data/test/public/javascripts/application.js

@@ -0,0 +1 @@
+// application js

data/test/public/javascripts/bank.js

@@ -0,0 +1 @@
+// bank js

data/test/public/javascripts/common.javascript

@@ -0,0 +1 @@
+// common.javascript

data/test/public/javascripts/controls.js

@@ -0,0 +1 @@
+// controls js

data/test/public/javascripts/dragdrop.js

@@ -0,0 +1 @@
+// dragdrop js

data/test/public/javascripts/effects.js

@@ -0,0 +1 @@
+// effects js

data/test/public/javascripts/prototype.js

@@ -0,0 +1 @@
+// prototype js

data/test/public/javascripts/robber.js

@@ -0,0 +1 @@
+// robber js

data/test/public/javascripts/subdir/subdir.js

@@ -0,0 +1 @@
+// subdir js

data/test/public/javascripts/version.1.0.js

@@ -0,0 +1 @@
+// version.1.0 js

data/test/public/stylesheets/bank.css

@@ -0,0 +1 @@
+/* bank.css */

data/test/public/stylesheets/random.styles

@@ -0,0 +1 @@
+/* random.styles */

data/test/public/stylesheets/robber.css

@@ -0,0 +1 @@
+/* robber.css */

data/test/public/stylesheets/subdir/subdir.css

@@ -0,0 +1 @@
+/* subdir.css */

data/test/public/stylesheets/version.1.0.css

@@ -0,0 +1 @@
+/* version.1.0.css */

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: action_dispatch-gz_static
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Baudanza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-27 00:00:00.000000000 -08:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &2160710380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160710380
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &2160708340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160708340
+description: Serves the .gz files that are created by the asset precompiler
+email:
+- jon@jonb.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- action_dispatch-gz_static.gemspec
+- lib/action_dispatch/gz_railtie.rb
+- lib/action_dispatch/gz_static.rb
+- test/gz_static_test.rb
+- test/public/.gitignore
+- test/public/404.html
+- test/public/500.da.html
+- test/public/500.html
+- test/public/compressed.html
+- test/public/compressed.html.gz
+- test/public/elsewhere/cools.js
+- test/public/elsewhere/file.css
+- test/public/foo/bar.html
+- test/public/foo/baz.css
+- test/public/foo/index.html
+- test/public/foo/こんにちは.html
+- test/public/images/rails.png
+- test/public/index.html
+- test/public/javascripts/application.js
+- test/public/javascripts/bank.js
+- test/public/javascripts/common.javascript
+- test/public/javascripts/controls.js
+- test/public/javascripts/dragdrop.js
+- test/public/javascripts/effects.js
+- test/public/javascripts/prototype.js
+- test/public/javascripts/robber.js
+- test/public/javascripts/subdir/subdir.js
+- test/public/javascripts/version.1.0.js
+- test/public/stylesheets/bank.css
+- test/public/stylesheets/random.styles
+- test/public/stylesheets/robber.css
+- test/public/stylesheets/subdir/subdir.css
+- test/public/stylesheets/version.1.0.css
+has_rdoc: true
+homepage: https://github.com/jbaudanza/action_dispatch-gz_static
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Serves the .gz files that are created by the asset precompiler
+test_files:
+- test/gz_static_test.rb
+- test/public/.gitignore
+- test/public/404.html
+- test/public/500.da.html
+- test/public/500.html
+- test/public/compressed.html
+- test/public/compressed.html.gz
+- test/public/elsewhere/cools.js
+- test/public/elsewhere/file.css
+- test/public/foo/bar.html
+- test/public/foo/baz.css
+- test/public/foo/index.html
+- test/public/foo/こんにちは.html
+- test/public/images/rails.png
+- test/public/index.html
+- test/public/javascripts/application.js
+- test/public/javascripts/bank.js
+- test/public/javascripts/common.javascript
+- test/public/javascripts/controls.js
+- test/public/javascripts/dragdrop.js
+- test/public/javascripts/effects.js
+- test/public/javascripts/prototype.js
+- test/public/javascripts/robber.js
+- test/public/javascripts/subdir/subdir.js
+- test/public/javascripts/version.1.0.js
+- test/public/stylesheets/bank.css
+- test/public/stylesheets/random.styles
+- test/public/stylesheets/robber.css
+- test/public/stylesheets/subdir/subdir.css
+- test/public/stylesheets/version.1.0.css