rack-cache-smash 1.0.0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/*
+*.iml
+.ruby-version
+vendor
+*.wip.txt

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0 / 2013-10-10
+
+Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-cache-smash.gemspec
+gemspec
+
+group :development do
+  gem 'rack'
+  gem 'rack-test'
+  gem 'timecop'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Eliot Sykes
+
+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/README.md

@@ -0,0 +1,51 @@
+# rack-cache-smash
+
+rack-cache-smash is a Rack middleware to cache bust **every** CSS and JS asset request, intended for development environments
+only and not recommended for production.
+
+Cache busting happens by modifying all HTML responses that contain paths to JS and CSS files. These file paths are appended
+with a timestamp query string parameter to force browsers to re-download the files for every single page load as they always have a unique URL.
+
+Admittedly, this is a sledgehammer of a middleware to overcome those browser caching issues that sometimes arise during development. I don't advise
+using it in production, and I doubt that you want to.
+
+At the time of writing this, I'm using rack-cache-smash during development to overcome a [problem in iOS 7.0.2 where incomplete asset downloads seem to be cached](http://tech.vg.no/2013/10/02/ios7-bug-shows-white-page-when-getting-304-not-modified-from-server/)
+and some weirdness I've seen in IE10 on Windows 8 with assets, 304 Not Modified responses, and SSL.
+
+
+## Installation
+
+Add the rack-cache-smash gem to the development group in your application's Gemfile:
+
+    group :development do
+        ...
+        gem 'rack-cache-smash'
+    end
+
+And then execute:
+
+    $ bundle
+
+For Rails apps, add this line to config/application.rb:
+
+    config.middleware.use(Rack::CacheSmash)
+
+For Rack apps that don't use Rails, then place Rack::CacheSmash earlier in your middleware stack than the middleware(s) that generates response HTML.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run tests (`rake test`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Releasing a new gem
+
+1. Increment version in lib/rack-cache-smash/version.rb in line with semantic versioning
+2. Update CHANGELOG.md
+3. Tests pass? (`rake test`)
+4. Build the gem (`rake build`)
+5. Release on rubygems.org (`rake release`)
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/lib/rack-cache-smash.rb

@@ -0,0 +1,42 @@
+require 'rack-cache-smash/version'
+
+module Rack
+  class CacheSmash
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      response = @app.call(env)
+      headers = response[1]
+      return response unless html_response?(headers)
+
+      status = response.first
+      original_body_arr = response.last
+      body_str = cache_bust_asset_paths_in_body(original_body_arr)
+      return [status, headers, [body_str]]
+    end
+
+    private
+
+    PATHS_TO_CACHE_SMASH_REGEXP = /(?<ext>\.(?:js|css))(?:(?:\?)(?<query_string>.*?))?(?<end_quote>['"])/
+    HTML_CONTENT_TYPE_REGEXP = /\Atext\/html.*\z/
+
+    def html_response?(headers)
+      headers['Content-Type'] =~ HTML_CONTENT_TYPE_REGEXP
+    end
+
+    def cache_bust_asset_paths_in_body(original_body_arr)
+      body_str = ''
+      original_body_arr.each { |part| body_str << part }
+      timestamp = Time.now.utc.to_i
+      body_str.gsub!(PATHS_TO_CACHE_SMASH_REGEXP) do |match|
+        query_string_suffix = $~[:query_string] ? "&#{$~[:query_string]}" : ''
+        "#{$~[:ext]}?cachesmasher=#{timestamp}#{query_string_suffix}#{$~[:end_quote]}"
+      end
+      return body_str
+    end
+
+  end
+end

data/lib/rack-cache-smash/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class CacheSmash
+    VERSION = '1.0.0'
+  end
+end

data/rack-cache-smash.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack-cache-smash/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-cache-smash"
+  gem.version       = Rack::CacheSmash::VERSION
+  gem.authors       = ["Eliot Sykes"]
+  gem.email         = ["e@jetbootlabs.com"]
+  gem.description   = %q{Rack middleware to cache bust every CSS and JS asset request}
+  gem.summary       = %q{Rack middleware to cache bust every CSS and JS asset request}
+  gem.homepage      = "https://github.com/eliotsykes/rack-cache-smash"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  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/test/rack_cache_smash_test.rb

@@ -0,0 +1,122 @@
+require_relative 'test_helper'
+
+class Rack::CacheSmashTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def setup
+    @body = nil
+    @headers = {'Content-Type' => 'text/html'}
+  end
+
+  def app
+    status = 200
+    rack_app = lambda { |env| [status, @headers, @body] }
+    Rack::CacheSmash.new(rack_app)
+  end
+
+  def test_js_path_gets_cache_busted
+    assert_body_transform(
+        [
+            '<html><head>',
+            '<script src="/assets/application.js"></head><body>',
+            'Hello</body></html>',
+        ],
+        "<html><head><script src=\"/assets/application.js?cachesmasher=[TIMESTAMP]\"></head><body>Hello</body></html>",
+    )
+  end
+
+  def test_css_path_gets_cache_busted
+    assert_body_transform(
+        [
+            '<html><head>',
+            "<link href='/assets/typography.css' rel='stylesheet' type='text/css'></head><body>",
+            'Hello</body></html>',
+        ],
+        "<html><head><link href='/assets/typography.css?cachesmasher=[TIMESTAMP]' rel='stylesheet' type='text/css'></head><body>Hello</body></html>"
+    )
+  end
+
+  def test_js_path_with_query_string_gets_cache_busted
+    assert_body_transform(
+        [
+            '<html><head>',
+            '<script src="/assets/angular.js?body=1"></head><body>',
+            'Hello</body></html>',
+        ],
+        "<html><head><script src=\"/assets/angular.js?cachesmasher=[TIMESTAMP]&body=1\"></head><body>Hello</body></html>",
+    )
+  end
+
+  def test_css_path_with_query_string_gets_cache_busted
+    assert_body_transform(
+        [
+            '<html><head>',
+            "<link href='/assets/layout.css?foo=bar&hello=world' rel='stylesheet' type='text/css'></head><body>",
+            'Hello</body></html>',
+        ],
+        "<html><head><link href='/assets/layout.css?cachesmasher=[TIMESTAMP]&foo=bar&hello=world' rel='stylesheet' type='text/css'></head><body>Hello</body></html>"
+    )
+  end
+
+  def test_multiple_asset_paths_get_cache_busted
+    assert_body_transform(
+        [
+            '<html><head>',
+            "<script src='https://somewhere.tld/some/path/to/analytics.js'>",
+            "<link href='/assets/layout.css?foo=bar&hello=world' rel='stylesheet' type='text/css'>",
+            "<link href='/assets/footer.css' rel='stylesheet' type='text/css'></head><body>",
+            'Hello<script type="text/javascript" src="jquery.js"><script type="text/javascript" src="plugin.js?woo=hoo"></body></html>'
+        ],
+        "<html><head><script src='https://somewhere.tld/some/path/to/analytics.js?cachesmasher=[TIMESTAMP]'>" +
+        "<link href='/assets/layout.css?cachesmasher=[TIMESTAMP]&foo=bar&hello=world' rel='stylesheet' type='text/css'>" +
+        "<link href='/assets/footer.css?cachesmasher=[TIMESTAMP]' rel='stylesheet' type='text/css'></head><body>" +
+        "Hello<script type=\"text/javascript\" src=\"jquery.js?cachesmasher=[TIMESTAMP]\">" +
+        "<script type=\"text/javascript\" src=\"plugin.js?cachesmasher=[TIMESTAMP]&woo=hoo\"></body></html>"
+    )
+  end
+
+  def test_does_not_modify_non_html_responses
+    @headers['Content-Type'] = 'text/plain'
+    @body = [
+        '<html><head>',
+        "<link href='/assets/typography.css' rel='stylesheet' type='text/css'></head><body>",
+        'Hello</body></html>',
+    ]
+    unmodified_body_str = @body.join('')
+
+    get '/'
+
+    assert_equal unmodified_body_str, last_response.body
+    assert_equal 'text/plain', last_response.headers['content-type']
+  end
+
+  def test_handles_html_content_type_with_charset_specified
+    @headers['Content-Type'] = 'text/html; charset=utf-8'
+    assert_body_transform(
+        [
+            '<html><head>',
+            '<script src="/assets/application.js"></head><body>',
+            'Hello</body></html>',
+        ],
+        "<html><head><script src=\"/assets/application.js?cachesmasher=[TIMESTAMP]\"></head><body>Hello</body></html>",
+    )
+  end
+
+  private
+
+  def assert_body_transform(original, result)
+    @body = original
+
+    Timecop.freeze do
+      get '/'
+
+      timestamp = Time.now.utc.to_i
+      assert_equal(
+          result.gsub('[TIMESTAMP]', timestamp.to_s),
+          last_response.body
+      )
+      assert_match /(text\/html)|(text\/html; charset=utf-8)/, last_response.headers['content-type']
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require :default, :development
+
+require 'test/unit'
+require 'rack/test'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rack-cache-smash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Eliot Sykes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies: []
+description: Rack middleware to cache bust every CSS and JS asset request
+email:
+- e@jetbootlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-cache-smash.rb
+- lib/rack-cache-smash/version.rb
+- rack-cache-smash.gemspec
+- test/rack_cache_smash_test.rb
+- test/test_helper.rb
+homepage: https://github.com/eliotsykes/rack-cache-smash
+licenses:
+- MIT
+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.8.23
+signing_key: 
+specification_version: 3
+summary: Rack middleware to cache bust every CSS and JS asset request
+test_files:
+- test/rack_cache_smash_test.rb
+- test/test_helper.rb