nanoc-cachebuster 0.1.0 → 0.1.1

data/HISTORY.md

@@ -1,5 +1,12 @@
-# 0.0.1
+# 0.1.1
+
+* Bugfix: no longer raise exception when an item has no content_filename attribute.
+
+# 0.1.0
 
 * No more re-calculation of fingerprints, just use the routed filename.
+
+# 0.1.0
+
 * Refactored into separate strategies.
-* First, direct extraction.
+* First, direct extraction.

data/README.md

@@ -34,31 +34,31 @@ Then load it via your project Gemfile or in `./lib/default.rb`:
 Usage
 =====
 
-This gem provides a Nanoc filter you can use to rewrite references to static
-assets in your source files. These will be picked up automatically.
+This gem provides a simple helper method you can use to rewrite the output
+filename of your static assets to include a content-based fingerprint.
+A simple filter will look up the output filename you have generated, and
+replace any references to the regularly-named file to the rewritten one.
 
 So, when you include a stylesheet:
 
     <link rel="stylesheet" href="styles.css">
 
-This filter will change that on compilation to:
-
-    <link rel="stylesheet" href="styles-cb7a4bb98ef.css">
-
-The adjusted filename changes every time the file itself changes, so you don't
-want to code that by hand in your Rules file. Instead, use the helper methods
-provided. First, include the helpers in your ./lib/default.rb:
+And you rewrite the output of the file to include a fingerprint:
 
+    # in your ./lib/default.rb
     include Nanoc3::Helpers::CacheBusting
+    # in ./Rules
+    route '/styles/' do
+      fp = fingerprint(item[:filename])
+      item.identifier.chop + fp + '.css'
+    end
 
-Then you can use `#should_cachebust?` and `#cachebusting_hash` in your routing
-rules to determine whether an item needs cachebusting, and get the fingerprint
-for it. So you can do something like:
+The filter will change your HTML on compilation to:
 
-    route 'styles' do
-      fp = cachebust?(item) ? fingerprint(item[:filename]) : ''
-      item.identifier.chop + fp + '.' + item[:extension]
-    end
+    <link rel="stylesheet" href="styles-cb7a4bb98ef.css">
+
+You get simple, content-based cachebusters for free. All that is left for you
+to do is set some far-future expires header in your server configuration.
 
 Development
 ===========

data/Rakefile

@@ -10,10 +10,6 @@ task :install => :build do
   sh "gem install nanoc-cachebuster-#{Nanoc3::Cachebuster::VERSION}.gem"
 end
 
-task :tag do
-  sh "git tag -a #{Nanoc3::Cachebuster::VERSION}"
-end
-
 task :push do
   sh 'git push origin master'
   sh 'git push --tags'
@@ -37,7 +33,7 @@ end
 
 desc 'Tag the code, push upstream, build and push the gem'
 task :release => [:install, :push] do
-  sh "gem push nanoc-cachebuster-#{Nanoc3::Cachebuster::VERSION}"
+  sh "gem push nanoc-cachebuster-#{Nanoc3::Cachebuster::VERSION}.gem"
 end
 
 desc 'Print current version number'

data/lib/nanoc3/cachebuster/strategy.rb

@@ -97,9 +97,16 @@ module Nanoc3
       #   an input file, such as a stylesheet or HTML page.
       # @return <String> path to the same file as the input path but relative
       #   to the site root.
+      # @todo make proper test case for this bug: items generated on the fly
+      #   do not have a content_filename attribute. Infer path from output
+      #   path.
       def absolutize(path)
         return path if path =~ /^\//
-        File.join(File.dirname(current_item[:content_filename]), path).sub(/^content/, '')
+        if current_item[:content_filename]
+          File.join(File.dirname(current_item[:content_filename]), path).sub(/^content/, '')
+        else
+          File.join(File.dirname(current_item.path), path)
+        end
       end
     end
 

data/lib/nanoc3/cachebuster/version.rb

@@ -1,5 +1,5 @@
 module Nanoc3
   module Cachebuster
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/spec/nanoc3/filters/cache_buster_spec.rb

@@ -3,6 +3,10 @@ require 'ostruct'
 class MockItem
   attr_reader :path, :content
 
+  def self.generated_css_file
+    new '/styles-cb123456789.css', 'example content', { :extension => 'css' }
+  end
+
   def self.css_file(content = 'example content')
     new '/styles-cb123456789.css', content, { :extension => 'css', :content_filename => 'content/styles.css' }
   end
@@ -133,6 +137,13 @@ describe Nanoc3::Filters::CacheBuster do
 
       it_should_not_filter %Q{background: url(foo.png);}
     end
+
+    describe 'when the current item has no content path' do
+      let(:target) { MockItem.image_file '/foo.png', '/../images/foo-cb123456789.png' }
+      let(:item) { MockItem.generated_css_file }
+
+      it_should_filter %Q{background: url("../images/foo.png");} => %Q{background: url("../images/foo-cb123456789.png");}
+    end
   end
 
   describe 'filtering HTML' do

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc-cachebuster
 version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: 
-  version: 0.1.0
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Arjan van der Gaag
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-21 00:00:00 Z
+date: 2011-05-24 00:00:00 Z
 dependencies: []
 
 description: |
@@ -66,12 +71,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
@@ -84,3 +95,4 @@ test_files:
 - spec/nanoc3/filters/cache_buster_spec.rb
 - spec/nanoc3/helpers/cache_busting_spec.rb
 - spec/spec_helper.rb
+has_rdoc: