static_signature 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.rvmrc
+.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in static_signature.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brendon Murphy
+
+MIT License
+
+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,60 @@
+# StaticSignature
+
+Rack Middleware for adding query string cache busting signatures on
+script and style assets.  This is accomplished by parsing html responses
+and appending an md5 hexdigest of file contents to the querystring.
+
+In other words it turns this:
+```html
+<link href="/stylesheets/screen.css" rel="stylesheet">
+```
+
+into this:
+```html
+<link href="/stylesheets/screen.css?4a75c99cdc76e7e0f3f3a0d6a44338a4" rel="stylesheet">
+```
+
+This is intended to be a very limited implementation and makes a few
+assumptions:
+
+* You are OK with Nokogiri parsing and modifying all text/html responses
+* The markup all uses simple urls that don't already have query params or
+  such appended already
+* Query params style cachebusting gotchas aren't going to pose a big problem
+  for you
+
+If you need a more feature rich implementation, Sprockets/AssetPipeline would
+better fit the bill.  This is intended for getting small, sinatra-esque apps
+up quickly where the gorilla isn't needed yet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'static_signature'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install static_signature
+
+## Usage
+
+Enable the middleware providing the path to your static assets directory:
+
+```ruby
+use StaticSignature::Middleware, :static_dir => File.join(File.dirname(__FILE__), "public")
+```
+
+Note the `static_dir` option is mandatory and must be an absolute path.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/static_signature.rb

@@ -0,0 +1,56 @@
+require "static_signature/version"
+require "thread"
+require "nokogiri"
+
+module StaticSignature
+  class Middleware
+    def initialize(app, options = {})
+      @app = app
+      @static_dir = options.fetch(:static_dir)
+      @mutex = Mutex.new
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      status, headers, response = @app.call(env)
+
+      if headers["Content-Type"] !~ /text\/html/
+        [status, headers, response]
+      else
+        body = ""
+        response.each do |part|
+          body << part
+        end
+        doc = Nokogiri::HTML(body)
+        bust_tag(doc, "link", "href")
+        bust_tag(doc, "script", "src")
+        body = doc.to_html
+        headers["Content-Length"] = body.bytesize.to_s
+        [status, headers, [body]]
+      end
+    end
+
+    def bust_tag(doc, tag_name, attribute)
+      doc.search(tag_name).each do |node|
+        if node[attribute] && ! node[attribute].include?("//")
+          node[attribute] += "?#{asset_signature(node[attribute])}"
+        end
+      end
+    end
+
+    def asset_signature(path)
+      full_path = File.join(@static_dir, path)
+
+      @mutex.synchronize {
+        signature_cache[path] ||= Digest::MD5.hexdigest(File.read(full_path))
+      }
+    end
+
+    def signature_cache
+      Thread.current[:_signature_cache] ||= {}
+    end
+  end
+end

data/lib/static_signature/version.rb

@@ -0,0 +1,3 @@
+module StaticSignature
+  VERSION = "0.0.1"
+end

data/static_signature.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/static_signature/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brendon Murphy"]
+  gem.email         = ["xternal1+github@gmail.com"]
+  gem.description   = %q{Rack Middleware for adding query string cache busting signatures on
+script and style assets}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  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.name          = "static_signature"
+  gem.require_paths = ["lib"]
+  gem.version       = StaticSignature::VERSION
+
+  gem.add_dependency("nokogiri")
+  gem.add_development_dependency("rack-test")
+end

data/test/data/css/app.css

@@ -0,0 +1,3 @@
+body {
+  color: black;
+}

data/test/data/js/app.js

@@ -0,0 +1 @@
+alert("test");

data/test/middleware_test.rb

@@ -0,0 +1,61 @@
+require_relative "test_helper"
+
+class MiddlewareTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  # Read first so we don't exhaust DATA
+  # after a single test
+  TEST_HTML = DATA.read.freeze
+
+  def app
+    Rack::Builder.new do
+      use StaticSignature::Middleware, :static_dir => File.join(File.dirname(__FILE__), "data")
+      run lambda { |env| [200, {'Content-Type' => "text/html"}, [TEST_HTML]]}
+    end
+  end
+
+  def response_doc
+    Nokogiri::HTML(last_response.body)
+  end
+
+  def test_link_tag_busting
+    get "/"
+    node = response_doc.search("link").first
+    assert_equal "/css/app.css?b7a03f662ff6716c8a95cad9299de15e", node["href"]
+  end
+
+  def test_script_tag_busting
+    get "/"
+    node = response_doc.search("script").first
+    assert_equal "/js/app.js?0677e7d10a89eb91d1292cbe35036a15", node["src"]
+  end
+
+  def test_skip_protocol_busting
+    get "/"
+    assert_match /asset\.js\Z/, response_doc.search("script")[1]["src"]
+    assert_match /vendor\.js\Z/, response_doc.search("script")[2]["src"]
+  end
+
+  def test_end_tags_intact
+    get "/"
+    assert_match %r{</body>}, last_response.body
+    assert_match %r{</html>}, last_response.body
+  end
+end
+
+__END__
+
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Test HTML</title>
+    <link href="/css/app.css" rel="stylesheet" media="screen">
+  </head
+  <body>
+    <h1>Hello, world!</h1>
+    <script src="/js/app.js"></script>
+    <script src="http://www.example.com/js/asset.js"></script>
+    <script src="//www.example.com/js/vendor.js"></script>
+  </body>
+</html>
+

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require "minitest/unit"
+require "minitest/autorun"
+require "rack/test"
+require "nokogiri"
+
+require_relative "../lib/static_signature"

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: static_signature
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2151894720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151894720
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2151894160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151894160
+description: ! 'Rack Middleware for adding query string cache busting signatures on
+
+  script and style assets'
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/static_signature.rb
+- lib/static_signature/version.rb
+- static_signature.gemspec
+- test/data/css/app.css
+- test/data/js/app.js
+- test/middleware_test.rb
+- test/test_helper.rb
+homepage: ''
+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.8.15
+signing_key: 
+specification_version: 3
+summary: Rack Middleware for adding query string cache busting signatures on script
+  and style assets
+test_files:
+- test/data/css/app.css
+- test/data/js/app.js
+- test/middleware_test.rb
+- test/test_helper.rb