rack-digestif 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tim Lucas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+require 'bundler'
+
+desc "Run tests"
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.warning = true
+  t.verbose = true
+  t.test_files = FileList['spec/*_spec.rb']
+end
+
+Bundler::GemHelper.install_tasks

data/Readme.md

@@ -0,0 +1,52 @@
+Rack::Digestif
+==============
+
+A rack middleware that ensures Sprockets assets are served regardless of whether the asset digest matches.
+
+All asset URLs such as:
+
+    /assets/application-a1d0c6e83f027327d8461063f4ac58a6.css
+
+are rewritten to remove the digest:
+
+    /assets/application.css
+
+This works thanks to Sprockets compiling both digest and non-digest filenames in the assets directory.
+
+Why?
+----
+
+Sprockets (and the Rails asset pipeline) use MD5 hashes of files to create cache-busting URLs. These new URLs have one big disadvantage over the old query-string method: requests to assets with an out-of-date digest cause a 404, unlike the old method which would serve the asset file regardless of the correctness of the timestamp. This problem becomes particularly noticable during a deployment when a browser requests an asset but the digest has been updated on the server and so they receive a 404, resulting in an unstyled or javascript-less page.
+
+Luckily the fix is easy; Sprockets generates every compiled file with and without a digest, so all that's needed is to rewrite incoming requests to remove the digest from the path. You can do this in nginx or HTTP proxy, rack-rewrite, or using `Rack::Digestif`.
+
+Installation
+------------
+
+    $ gem install rack-digestif
+    
+Usage
+-----
+
+Add it to your Rackup `config.ru` file like so:
+
+    require 'rack/digestif'
+    use Rack::Digestif
+
+By default `Rack::Digestif` will rewrite all incoming URLs that have a digest. If you want to limit it to a given path, such as `/assets`, you simply pass the path as the first argument:
+
+    use Rack::Digestif, "/assets/"
+
+
+Rails Usage
+-----------
+
+Firstly add it to your `Gemfile`, and then add the middleware in `application.rb` like so:
+
+    config.middleware.insert_before ActionDispatch::Static, Rack::Digestif
+
+
+License
+-------
+
+See MIT-LICENSE for details.

data/lib/rack/digestif.rb

@@ -0,0 +1,16 @@
+module Rack
+  # Rack middleware which rewrites the REQUEST_PATH to remove the asset digest
+  class Digestif
+    PATTERN = /-[0-9a-z]{32}(\.[^.]+)\Z/.freeze
+    def initialize app, path=nil
+      @app = app
+      @path = path.freeze
+    end
+    def call env
+      if (not @path) || (@path && env["PATH_INFO"].index(@path) == 0)
+        env["PATH_INFO"].gsub! PATTERN, '\1'
+      end
+      @app.call env
+    end
+  end
+end

data/rack-digestif.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name = 'rack-digestif'
+  s.version = '0.1'
+
+  s.summary = "A rack middleware that ensures Sprockets assets are served regardless of whether the asset digest matches"
+  s.description = s.summary
+
+  s.author = 'Tim Lucas'
+  s.email = 't@toolmantim.com'
+  s.homepage = 'http://github.com/toolmantim/rack-digestif'
+
+  s.files        = Dir['Readme.md', 'MIT-LICENSE', 'Rakefile', 'rack-digestif.gemspec', 'lib/**/*']
+  s.test_files   = Dir['spec/*']
+  s.require_path = 'lib'
+  s.requirements << 'none'
+  
+  s.add_dependency 'rack'
+  
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "bundler"
+end

data/spec/rack_digestif_spec.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+
+require 'rack/digestif'
+require 'rack/mock'
+
+describe Rack::Digestif do
+
+  let(:base_app) { Proc.new {|env| [200, {}, Rack::Request.new(env).path]} }
+
+  def path_after_digestif request_path
+    Rack::MockRequest.new(app).get(request_path).body
+  end
+
+  describe "initialized no arguments" do
+    let(:app) { Rack::Digestif.new(base_app) }
+    it "must rewrite assets with digests" do
+      path_after_digestif("/path/f-c20ad4d76fe97759aa27a0c99bff6710.css").must_equal "/path/f.css"
+    end
+    it "mustn't rewrite assets without digests" do
+      path_after_digestif("/path/f.css").must_equal "/path/f.css"
+    end
+  end
+  
+  describe "initialized with a path argument" do
+    let(:app) { Rack::Digestif.new(base_app, "/custom-path/") }
+    it "must rewrite assets with digests in the custom path" do
+      path_after_digestif("/custom-path/f-c20ad4d76fe97759aa27a0c99bff6710.css").must_equal "/custom-path/f.css"
+    end
+    it "mustn't rewrite assets with digests outside the custom path" do
+      path_after_digestif("/other-path/f-c20ad4d76fe97759aa27a0c99bff6710.css").must_equal "/other-path/f-c20ad4d76fe97759aa27a0c99bff6710.css"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rack-digestif
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Tim Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70284270993820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70284270993820
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70284270993140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70284270993140
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70284270990840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70284270990840
+description: A rack middleware that ensures Sprockets assets are served regardless
+  of whether the asset digest matches
+email: t@toolmantim.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.md
+- MIT-LICENSE
+- Rakefile
+- rack-digestif.gemspec
+- lib/rack/digestif.rb
+- spec/rack_digestif_spec.rb
+homepage: http://github.com/toolmantim/rack-digestif
+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:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A rack middleware that ensures Sprockets assets are served regardless of
+  whether the asset digest matches
+test_files:
+- spec/rack_digestif_spec.rb