nanoc-cachebuster 0.1.2 → 0.2.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/HISTORY.md

@@ -1,5 +1,16 @@
-# 0.0.1
+# 0.2.0
+
+* Nanoc 3.3 compatibility (by John Nishinaga)
+
+# 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

@@ -29,7 +29,9 @@ install this gem:
 
 Then load it via your project Gemfile or in `./lib/default.rb`:
 
-    require 'nanoc3/cachebuster'
+```ruby
+require 'nanoc/cachebuster'
+```
 
 Usage
 =====
@@ -41,21 +43,27 @@ replace any references to the regularly-named file to the rewritten one.
 
 So, when you include a stylesheet:
 
-    <link rel="stylesheet" href="styles.css">
+```html
+<link rel="stylesheet" href="styles.css">
+```
 
 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
+```ruby
+# in your ./lib/default.rb
+include Nanoc::Helpers::CacheBusting
+# in ./Rules
+route '/styles/' do
+  fp = fingerprint(item[:filename])
+  item.identifier.chop + fp + '.css'
+end
+```
 
 The filter will change your HTML on compilation to:
 
-    <link rel="stylesheet" href="styles-cb7a4bb98ef.css">
+```html
+<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.
@@ -79,3 +87,4 @@ Credits
 
 * **Author**: Arjan van der Gaag <arjan@arjanvandergaag.nl>
 * **License**: MIT License (same as Ruby, see LICENSE)
+* **With contributions from**: John Nishinaga

data/Rakefile

@@ -1,19 +1,12 @@
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require 'nanoc3/cachebuster/version'
-
-task :build do
-  sh 'gem build nanoc-cachebuster.gemspec'
-end
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 
-desc 'Install the gem locally'
-task :install => :build do
-  sh "gem install nanoc-cachebuster-#{Nanoc3::Cachebuster::VERSION}.gem"
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
 
-task :push do
-  sh 'git push origin master'
-  sh 'git push --tags'
-end
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'nanoc/cachebuster/version'
 
 task :log do
   changes = `git log --oneline $(git describe --abbrev=0 2>/dev/null)..HEAD`
@@ -23,7 +16,7 @@ task :log do
   path = File.expand_path('../HISTORY.md', __FILE__)
 
   original_content = File.read(path)
-  addition = "# #{Nanoc3::Cachebuster::VERSION}\n\n#{changes}"
+  addition = "# #{Nanoc::Cachebuster::VERSION}\n\n#{changes}"
   puts addition
 
   File.open(path, 'w') do |f|
@@ -31,14 +24,9 @@ task :log do
   end
 end
 
-desc 'Push code upstream, build and publish the gem'
-task :release => [:install, :push] do
-  sh "gem push nanoc-cachebuster-#{Nanoc3::Cachebuster::VERSION}.gem"
-end
-
 desc 'Print current version number'
 task :version do
-  puts Nanoc3::Cachebuster::VERSION
+  puts Nanoc::Cachebuster::VERSION
 end
 
 class Version
@@ -60,7 +48,7 @@ class Version
   end
 
   def write
-    file = File.expand_path('../lib/nanoc3/cachebuster/version.rb', __FILE__)
+    file = File.expand_path('../lib/nanoc/cachebuster/version.rb', __FILE__)
     original_contents = File.read(file)
     File.open(file, 'w') do |f|
       f.write original_contents.gsub(/VERSION = ('|")\d+\.\d+\.\d+\1/, "VERSION = '#{to_s}'")
@@ -74,17 +62,17 @@ namespace :version do
   namespace :bump do
     desc 'Bump a major version'
     task :major do
-      Version.new(Nanoc3::Cachebuster::VERSION).bump(:major).write
+      Version.new(Nanoc::Cachebuster::VERSION).bump(:major).write
     end
 
     desc 'Bump a minor version'
     task :minor do
-      Version.new(Nanoc3::Cachebuster::VERSION).bump(:minor).write
+      Version.new(Nanoc::Cachebuster::VERSION).bump(:minor).write
     end
 
     desc 'Bump a patch version'
     task :patch do
-      Version.new(Nanoc3::Cachebuster::VERSION).bump(:patch).write
+      Version.new(Nanoc::Cachebuster::VERSION).bump(:patch).write
     end
   end
 end

data/lib/{nanoc3 → nanoc}/cachebuster.rb

@@ -1,7 +1,7 @@
-require 'nanoc3'
+require 'nanoc'
 require 'digest'
 
-module Nanoc3
+module Nanoc
   module Cachebuster
     autoload :VERSION,  'cachebuster/version'
 

data/lib/{nanoc3 → nanoc}/cachebuster/strategy.rb

@@ -1,6 +1,6 @@
 require 'pathname'
 
-module Nanoc3
+module Nanoc
   module Cachebuster
     # The Strategy is a way to deal with an input file. The Cache busting filter
     # will use a strategy to process all references. You may want to use different
@@ -17,7 +17,7 @@ module Nanoc3
 
       def self.for(kind, site, item)
         klass = @subclasses[kind]
-        raise Nanoc3::Cachebuster::NoSuchStrategy.new "No strategy found for #{kind}" unless klass
+        raise Nanoc::Cachebuster::NoSuchStrategy.new "No strategy found for #{kind}" unless klass
         klass.new(site, item)
       end
 
@@ -28,12 +28,12 @@ module Nanoc3
       # future portability we might as well carry the entire site object
       # over.
       #
-      # @return <Nanoc3::Site>
+      # @return <Nanoc::Site>
       attr_reader :site
 
       # The Nanoc item we are currently filtering.
       #
-      # @return <Nanoc3::Item>
+      # @return <Nanoc::Item>
       attr_reader :current_item
 
       def initialize(site, current_item)
@@ -70,12 +70,12 @@ module Nanoc3
 
         matching_item = site.items.find do |i|
           next unless i.path # some items don't have an output path. Ignore those.
-          i.path.sub(/#{Nanoc3::Cachebuster::CACHEBUSTER_PREFIX}[a-zA-Z0-9]{9}(?=\.)/o, '') == path
+          i.path.sub(/#{Nanoc::Cachebuster::CACHEBUSTER_PREFIX}[a-zA-Z0-9]{9}(?=\.)/o, '') == path
         end
 
         # Raise an exception to indicate we should leave this reference alone
         unless matching_item
-          raise Nanoc3::Cachebuster::NoSuchSourceFile, 'No source file found matching ' + input_path
+          raise Nanoc::Cachebuster::NoSuchSourceFile, 'No source file found matching ' + input_path
         end
 
         # keep using an absolute path if the input reference did so...
@@ -83,8 +83,8 @@ module Nanoc3
 
         # ... if not, recreate the relative path to referenced file from
         # the current file path.
-        current_path = Pathname.new(File.dirname(current_item.path))
-        target_path  = Pathname.new(File.dirname(matching_item.path))
+        current_path = Pathname.new(File.dirname(current_item.path.sub(/^\//, '')))
+        target_path  = Pathname.new(File.dirname(matching_item.path.sub(/^\//, '')))
         output_reference = target_path.relative_path_from(current_path).join(File.basename(matching_item.path))
       end
 
@@ -110,7 +110,7 @@ module Nanoc3
         if current_item[:content_filename]
           File.expand_path(File.join(File.dirname(current_item[:content_filename]), path)).sub(/^#{Dir.pwd}/, '').sub(/^\/content/, '')
         else
-          File.dirname(current_item.path)
+          File.expand_path(File.dirname(current_item.path), path)
         end
       end
     end
@@ -124,14 +124,14 @@ module Nanoc3
         ('|"|)         # Then either a single, double or no quote at all
         (
           ([^'")]+)    # The file basename, and below the extension
-          \.(#{Nanoc3::Cachebuster::FILETYPES_TO_FINGERPRINT.join('|')})
+          \.(#{Nanoc::Cachebuster::FILETYPES_TO_FINGERPRINT.join('|')})
         )
         \1             # Repeat the same quote as at the start
         \)             # And cose the url()
       /ix
 
       def apply(m, quote, filename, basename, extension)
-        m.sub(filename, output_filename(filename))
+        m.sub(filename, output_filename(filename).to_s)
       end
     end
 
@@ -146,7 +146,7 @@ module Nanoc3
         (                 # Capture the entire reference
           [^'"]+          # Anything but something that would close the attribute
                           # And then the extension:
-          (\.(?:#{Nanoc3::Cachebuster::FILETYPES_TO_FINGERPRINT.join('|')}))
+          (\.(?:#{Nanoc::Cachebuster::FILETYPES_TO_FINGERPRINT.join('|')}))
         )
         \2                # Repeat the opening quote
       /ix

data/lib/nanoc/cachebuster/version.rb

@@ -0,0 +1,5 @@
+module Nanoc
+  module Cachebuster
+    VERSION = '0.2.0'
+  end
+end

data/lib/nanoc/filters.rb

@@ -0,0 +1,4 @@
+module Nanoc::Filters
+  autoload 'CacheBuster', 'nanoc/filters/cache_buster'
+  Nanoc::Filter.register '::Nanoc::Filters::CacheBuster', :cache_buster
+end

data/lib/{nanoc3 → nanoc}/filters/cache_buster.rb

@@ -1,15 +1,15 @@
-module Nanoc3
+module Nanoc
   module Filters
-    class CacheBuster < Nanoc3::Filter
+    class CacheBuster < Nanoc::Filter
       identifier :cache_buster
 
       def run(content, options = {})
         kind = options[:strategy] || (stylesheet? ? :css : :html)
-        strategy = Nanoc3::Cachebuster::Strategy.for(kind , site, item)
+        strategy = Nanoc::Cachebuster::Strategy.for(kind , site, item)
         content.gsub(strategy.class::REGEX) do |m|
           begin
             strategy.apply m, $1, $2, $3, $4
-          rescue Nanoc3::Cachebuster::NoSuchSourceFile
+          rescue Nanoc::Cachebuster::NoSuchSourceFile
             m
           end
         end
@@ -22,10 +22,10 @@ module Nanoc3
       # This is a simple check for filetypes, but you can override what strategy to use
       # with the filter options. This provides a default.
       #
-      # @see Nanoc3::Cachebuster::FILETYPES_CONSIDERED_CSS
+      # @see Nanoc::Cachebuster::FILETYPES_CONSIDERED_CSS
       # @return <Bool>
       def stylesheet?
-        Nanoc3::Cachebuster::FILETYPES_CONSIDERED_CSS.include?(item[:extension].to_s)
+        Nanoc::Cachebuster::FILETYPES_CONSIDERED_CSS.include?(item[:extension].to_s)
       end
     end
   end

data/lib/nanoc/helpers.rb

@@ -0,0 +1,3 @@
+module Nanoc::Helpers
+  autoload 'CacheBusting', 'nanoc/helpers/cache_busting'
+end

data/lib/{nanoc3 → nanoc}/helpers/cache_busting.rb

@@ -1,4 +1,4 @@
-module Nanoc3
+module Nanoc
   module Helpers
     module CacheBusting
 
@@ -15,7 +15,7 @@ module Nanoc3
       # @param <Item> item is the item to test
       # @return <Boolean>
       def cachebust?(item)
-        Nanoc3::Cachebuster.should_apply_fingerprint_to_file?(item)
+        Nanoc::Cachebuster.should_apply_fingerprint_to_file?(item)
       end
 
       # Get a unique fingerprint for a file's content. This currently uses
@@ -25,7 +25,7 @@ module Nanoc3
       # @param <String> filename is the path to the file to fingerprint.
       # @return <String> file fingerprint
       def fingerprint(filename)
-        Nanoc3::Cachebuster.fingerprint_file(filename)
+        Nanoc::Cachebuster.fingerprint_file(filename)
       end
     end
   end

data/nanoc-cachebuster.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path('../lib', __FILE__)
-require 'nanoc3/cachebuster/version'
+require 'nanoc/cachebuster/version'
 
 Gem::Specification.new do |s|
   s.name        = 'nanoc-cachebuster'
-  s.version     = Nanoc3::Cachebuster::VERSION
+  s.version     = Nanoc::Cachebuster::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Arjan van der Gaag']
   s.email       = ['arjan@arjanvandergaag.nl']
@@ -31,4 +31,8 @@ EOS
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
+  
+  s.add_runtime_dependency 'nanoc', '>= 3.3.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
 end

data/spec/{nanoc3 → nanoc}/filters/cache_buster_spec.rb

@@ -1,8 +1,13 @@
+require 'spec_helper'
 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
@@ -44,12 +49,12 @@ class MockItem
   end
 end
 
-describe Nanoc3::Filters::CacheBuster do
+describe Nanoc::Filters::CacheBuster do
   before(:each) do
     Digest::MD5.stub!(:hexdigest).and_return('123456789')
   end
 
-  let(:subject) { Nanoc3::Filters::CacheBuster.new context }
+  let(:subject) { Nanoc::Filters::CacheBuster.new context }
   let(:content) { item.content }
   let(:item)    { MockItem.css_file }
   let(:target)  { MockItem.image_file }
@@ -65,7 +70,7 @@ describe Nanoc3::Filters::CacheBuster do
   end
 
   describe 'filter interface' do
-    it { should be_kind_of(Nanoc3::Filter) }
+    it { should be_kind_of(Nanoc::Filter) }
     it { should respond_to(:run) }
 
     it 'should accept a string and an options Hash' do
@@ -142,6 +147,16 @@ describe Nanoc3::Filters::CacheBuster do
 
       it_should_not_filter %Q{background: url(foo.png);}
     end
+    
+    # Needs documentation on what this test is actually testing, and thinking on convention.
+    # This is currently responding to the else on line 113 of cachebuster#strategy.rb which is not adding the cb hash to the end of the file name.
+    # Need to discover under what condition does an item has no :content_filename and consider what is best convention to handle this case.
+    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

data/spec/{nanoc3 → nanoc}/helpers/cache_busting_spec.rb

@@ -1,7 +1,7 @@
-describe Nanoc3::Helpers::CacheBusting do
+describe Nanoc::Helpers::CacheBusting do
   let(:subject) do
     o = Object.new
-    o.extend Nanoc3::Helpers::CacheBusting
+    o.extend Nanoc::Helpers::CacheBusting
   end
 
   describe '#should_cachebust?' do

data/spec/spec_helper.rb

@@ -1,2 +1 @@
-require 'nanoc3/cachebuster'
-
+require 'nanoc/cachebuster'

metadata

@@ -1,98 +1,128 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nanoc-cachebuster
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
 platform: ruby
-authors: 
+authors:
 - Arjan van der Gaag
 autorequire: 
 bindir: bin
 cert_chain: []
+date: 2012-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: &70096428299300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70096428299300
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70096428298460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70096428298460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70096428297900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70096428297900
+description: ! 'Your website should use far-future expires headers on static assets,
+  to make
 
-date: 2011-05-27 00:00:00 Z
-dependencies: []
+  the best use of client-side caching. But when a file is cached, updates won''t
 
-description: |
-  Your website should use far-future expires headers on static assets, to make
-  the best use of client-side caching. But when a file is cached, updates won't
   get picked up. Cache busting is the practice of making the filename of a
+
   cached asset unique to its content, so it can be cached without having to
+
   worry about future changes.
-  
+
+
   This gem adds a filter and some helper methods to Nanoc, the static site
+
   generator, to simplify the process of making asset filenames unique. It helps
+
   you output fingerprinted filenames, and refer to them from your source files.
-  
+
+
   It works on images, javascripts and stylesheets. It is extracted from the
+
   nanoc-template project at http://github.com/avdgaag/nanoc-template.
 
-email: 
+'
+email:
 - arjan@arjanvandergaag.nl
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
+- Gemfile
 - HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
-- lib/nanoc3/cachebuster.rb
-- lib/nanoc3/cachebuster/strategy.rb
-- lib/nanoc3/cachebuster/version.rb
-- lib/nanoc3/filters.rb
-- lib/nanoc3/filters/cache_buster.rb
-- lib/nanoc3/helpers.rb
-- lib/nanoc3/helpers/cache_busting.rb
+- lib/nanoc/cachebuster.rb
+- lib/nanoc/cachebuster/strategy.rb
+- lib/nanoc/cachebuster/version.rb
+- lib/nanoc/filters.rb
+- lib/nanoc/filters/cache_buster.rb
+- lib/nanoc/helpers.rb
+- lib/nanoc/helpers/cache_busting.rb
 - nanoc-cachebuster.gemspec
-- spec/nanoc3/filters/cache_buster_spec.rb
-- spec/nanoc3/helpers/cache_busting_spec.rb
+- spec/nanoc/filters/cache_buster_spec.rb
+- spec/nanoc/helpers/cache_busting_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/avdgaag/nanoc_cachebuster
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -1070542068596424145
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -1070542068596424145
 requirements: []
-
 rubyforge_project: nanoc-cachebuster
-rubygems_version: 1.7.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Adds filters and helpers for cache busting to Nanoc
-test_files: 
-- spec/nanoc3/filters/cache_buster_spec.rb
-- spec/nanoc3/helpers/cache_busting_spec.rb
+test_files:
+- spec/nanoc/filters/cache_buster_spec.rb
+- spec/nanoc/helpers/cache_busting_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/nanoc3/cachebuster/version.rb

@@ -1,5 +0,0 @@
-module Nanoc3
-  module Cachebuster
-    VERSION = '0.1.2'
-  end
-end

data/lib/nanoc3/filters.rb

@@ -1,4 +0,0 @@
-module Nanoc3::Filters
-  autoload 'CacheBuster', 'nanoc3/filters/cache_buster'
-  Nanoc3::Filter.register '::Nanoc3::Filters::CacheBuster', :cache_buster
-end

data/lib/nanoc3/helpers.rb

@@ -1,3 +0,0 @@
-module Nanoc3::Helpers
-  autoload 'CacheBusting', 'nanoc3/helpers/cache_busting'
-end