asset_fingerprinter 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,57 @@
+# Asset Fingerprinter
+
+Give credit where credit is due: this gem was Inspired by Eliot Sykes' asset_fingerprinter Rails plugin. We needed something a little more robust at Poll Everywhere that would work outside of Rails in our compass/sass deploymennt pref-flight compilations, so we wrote this little honey.
+
+Humans are stupid and sloppy, so this library is well tested via spec and put through the production ringer at Poll Everywhere.
+
+# Installation
+
+Standalone:
+
+    gem install asset_fingerprinter
+
+Gemfile:
+
+    gem 'asset_fingerprinter'
+
+# Getting Started
+
+The Asset Fingerprint gem was designed to work in any environment including Rails and the compass compiler.
+
+## Rails 2.x
+
+Holy Caw! We made this work with Rails 2.x because we're old school. Well, almost old school; we assume that you hacked your Rails 2.x install to use Gemfiles. Just add:
+
+  gem 'asset_fingerprinter'
+
+to your Rails 2.x Gemfile and we take care of the rest through some hickity-hack magic.
+
+## Rails 3.x
+
+Change the asset_path_template in config/environments/production.rb
+    
+    config.action_controller.asset_path_template = AssetFingerprinter.path_rewriter
+
+Meh, no hack wizardry here. Curse ya Rails 3!
+
+# Ha! I'm way more advanced then that...
+
+Cool, we are too. If you want to get down and dirty with AssetFingerprint, RTFSC and discover configuration that looks like:
+
+    pr = PathRewriter.new do |pr|
+      pr.fingerprinter = Fingerprinter::Digest.new     # Whatever, give us a proc or something that response to .call
+      pr.fingerprinter.root = File.dirname(__FILE__)   # Turns out you need a file root for file digesting.
+      pr.pattern = PathRewriter::Format::Filename      # Newbs use the query string cachebusters, we use use Filename rewriter, but you can go nuts here with anything that responds to .call
+    end
+
+    # OMG! It threw a file digest into my file name
+    pr.call('/images/i_am.will') # => '/images/i-am-will-fp-abc3984928abfedf3e2309sb.will'
+
+    # Heh, its not a magic bullet, You still need to configure nginx or Apache 
+    # to rewrite this path. Its totally worth it though.
+
+# Be a super hero. Help the world
+
+We'll entertain your pull requests if you have specs around whatever you throw our way. Otherwise we spit at you! 
+
+No, We're really interested in more fingerprinting strategies, integrations with other frameworks, and other ways that make serving up HTTP assets ubber fast.

data/asset_fingerprinter.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Steel Fu, Brad Gessler"]
   s.email       = ["steel@polleverywhere.com, brad@polleverywhere.com"]
   s.homepage    = "http://www.polleverywhere.com/"
-  s.summary     = %q{A Gem inspired by the Rails AssetFingerPrinter plugin}
-  s.description = %q{An effecient HTTP cache buster}
+  s.summary     = %q{A Gem inspired by the Rails AssetFingerPrinter plugin.}
+  s.description = %q{The most efficient HTTP cache buster plugin evar.}
 
   s.rubyforge_project = "asset_fingerprinter"
 

data/lib/asset_fingerprinter.rb

@@ -1,4 +1,27 @@
 module AssetFingerprinter
+  autoload :Integration,    'asset_fingerprinter/integration'
   autoload :Fingerprinter,  'asset_fingerprinter/fingerprinter'
   autoload :PathRewriter,   'asset_fingerprinter/path_rewriter'
+
+  # A default path rewriter to keep things sane
+  def self.path_rewriter
+    @path_rewriter ||= PathRewriter.new do |pr|
+      pr.fingerprinter = Fingerprinter::Digest.new
+      pr.pattern = PathRewriter::Format::QueryString
+    end
+  end
+  
+  # A default way to call a rewrite
+  def self.rewrite(path)
+    path_rewriter.call(path)
+  end
+  
+  # Fake out a configuration block
+  def self.config
+    yield path_rewriter if block_given?
+    path_rewriter
+  end
+
+  # Figure out if we're running in a Rails 2.x environment
+  Integration.detect
 end

data/lib/asset_fingerprinter/fingerprinter.rb

@@ -3,13 +3,23 @@ require 'digest/md5'
 module AssetFingerprinter
   module Fingerprinter
     class Digest
+      attr_accessor :root
       # Digests a file and returns the cachebusted path
+      
       def initialize
-        @cache = Hash.new{ |hash,key| hash[key] = ::Digest::MD5.hexdigest(File.read(key)) }
+        @cache = Hash.new{ |hash,key|
+          hash[key] = ::Digest::MD5.hexdigest(File.read(root ? File.join(root, key) : key))
+        }
       end
-
+      
       def call(path)
-        @cache[path]
+        @cache[clean_path(path)]
+      end
+
+    private
+      # Remove query strings from the incoming path.
+      def clean_path(path)
+        path.split('?').first
       end
     end
   end

data/lib/asset_fingerprinter/integration.rb

@@ -0,0 +1,16 @@
+module AssetFingerprinter
+  module Integration
+    module Rails2
+      def self.integrate
+        require 'asset_fingerprinter/integration/rails2'
+        if AssetFingerprinter.path_rewriter.fingerprinter.respond_to? :root
+          AssetFingerprinter.path_rewriter.fingerprinter.root = File.join(Rails.root, 'public')
+        end
+      end
+    end
+    
+    def self.detect
+      Rails2.integrate if defined? Rails and Rails::VERSION::MAJOR == 2
+    end
+  end
+end

data/lib/asset_fingerprinter/integration/rails2.rb

@@ -0,0 +1,10 @@
+# A really stupid monkey path for Rails 2.x
+module ActionView
+  module Helpers
+    module AssetTagHelper
+      def rewrite_asset_path(path)
+        AssetFingerprinter.rewrite path
+      end
+    end
+  end
+end

data/lib/asset_fingerprinter/version.rb

@@ -1,3 +1,3 @@
 module AssetFingerprinter
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/asset_fingerprinter_spec.rb

@@ -1,10 +1,65 @@
 require 'spec_helper'
 require 'digest/md5'
 
+describe AssetFingerprinter do
+  it "should rewrite" do
+    AssetFingerprinter.rewrite(__FILE__).should match(/\.rb\?.+/)
+  end
+
+  it "should config" do
+    AssetFingerprinter.config do |c|
+      c.fingerprinter.should be_instance_of(Fingerprinter::Digest)
+      c.pattern.should eql(PathRewriter::Format::QueryString)
+    end
+  end
+end
+
+describe Integration do
+  context "Rails 2" do
+    # TODO setup the rails public dir here and tear it down after the test is done.
+
+    before(:each) do
+      Rails = Struct.new(:root).new(File.join(File.dirname(__FILE__), 'rails'))
+    end
+
+    after(:each) do
+      Object.send(:remove_const, :Rails)
+    end
+    
+    it "should replace rails rewrite_asset_path" do
+      scope = Class.new {
+        module ::ActionView
+          module Helpers
+            module AssetTagHelper
+              def rewrite_asset_path(path)
+                "poop"
+              end
+            end
+          end
+        end
+        
+        Integration::Rails2.integrate
+
+        include ActionView::Helpers::AssetTagHelper
+      }
+
+      scope.new.rewrite_asset_path('something.file').should_not eql('poop')
+    end
+  end
+end
+
 describe Fingerprinter::Digest do
+  before(:each) do
+    @file = __FILE__
+    @digest = Digest::MD5.hexdigest File.read(@file)
+  end
+
   it "should fingerprint a file" do
-    digest = Digest::MD5.hexdigest File.read(__FILE__)
-    Fingerprinter::Digest.new.call(__FILE__).should eql(digest)
+    Fingerprinter::Digest.new.call(@file).should eql(@digest)
+  end
+
+  it "should fingerprint paths with query string params" do
+    Fingerprinter::Digest.new.call("#{@file}?color=red&size=large").should eql(@digest)
   end
 end
 
@@ -18,14 +73,15 @@ describe PathRewriter do
   end
 
   it "should rewrite filename path" do
-    expected_path = File.expand_path(File.join(@dir, "#{@base}-fp-#{@digest}#{@ext}"))
+    expected_path = "#{@base}-fp-#{@digest}#{@ext}"
 
     pr = PathRewriter.new do |pr|
       pr.fingerprinter = Fingerprinter::Digest.new
+      pr.fingerprinter.root = File.dirname(__FILE__)
       pr.pattern = PathRewriter::Format::Filename
     end
-
-    pr.call(@path).should eql(expected_path)
+    
+    pr.call(@file).should eql(expected_path)
   end
 
   it "should rewrite queryname path" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: asset_fingerprinter
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Steel Fu, Brad Gessler
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-10 00:00:00 -07:00
+date: 2011-05-12 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: An effecient HTTP cache buster
+description: The most efficient HTTP cache buster plugin evar.
 email: 
 - steel@polleverywhere.com, brad@polleverywhere.com
 executables: []
@@ -32,13 +32,17 @@ files:
 - .gitignore
 - Gemfile
 - Guardfile
+- README.md
 - Rakefile
 - asset_fingerprinter.gemspec
 - lib/asset_fingerprinter.rb
 - lib/asset_fingerprinter/fingerprinter.rb
+- lib/asset_fingerprinter/integration.rb
+- lib/asset_fingerprinter/integration/rails2.rb
 - lib/asset_fingerprinter/path_rewriter.rb
 - lib/asset_fingerprinter/version.rb
 - spec/asset_fingerprinter_spec.rb
+- spec/rails/public/something.file
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://www.polleverywhere.com/
@@ -70,10 +74,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: asset_fingerprinter
-rubygems_version: 1.6.2
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: A Gem inspired by the Rails AssetFingerPrinter plugin
+summary: A Gem inspired by the Rails AssetFingerPrinter plugin.
 test_files: 
 - spec/asset_fingerprinter_spec.rb
+- spec/rails/public/something.file
 - spec/spec_helper.rb