juicer 1.0.3 → 1.0.4

data/History.txt

@@ -1,3 +1,11 @@
+== 1.0.4 / 2010-05-26
+* Brought to you by Elliott Wood, two-fish.com
+* Added "rails" cache-buster type for cache-buster stamps that are identical
+  to those generated by Rails'
+* --all-hosts-local is no longer dependent upon command-line positioning.
+* Ensured that URLs don't receive two cache busters, even when asset
+  host cycling is used.
+
 == 1.0.3 / 2010-04-15
 * Update YUI Compressor installer to find the download link in YUI's updated markup
   Pacthed by Olle Jonsson (http://ollehost.dk/blog/)

data/Readme.rdoc

@@ -4,6 +4,7 @@ Official URL: http://github.com/cjohansen/juicer/tree/master
 Christian Johansen (http://www.cjohansen.no) and contributors:
 
 * Morgan Roderick (http://roderick.dk)
+* Elliott Wood  (http://two-fish.com)
 * Pavel Valodzka (http://github.com/valodzka)
 * Daniel Stockman (http://evocateur.org/)
 * Aaron Suggs (http://ktheory.com)
@@ -69,15 +70,19 @@ Juicer supports so-called cache busters. A cache buster is a pattern in a path
 whose only purpose is to "trick" browsers to redownload a file when it has
 changed in cases where a far future expires header is used.
 
-There are two types of cache busters; soft ones add a parameter to the URL, like
-so: http://assets/images/1.png?cb1234567890, ie the letters "cb" (as in cache
-buster) and then the timestamp of the files mtime.
+There are three types of cache busters.  Soft cache busters (the default) add a
+parameter to the URL, like so: http://assets/images/1.png?jcb=1234567890, ie the 
+letters "jcb" (as in Juicer Cache Buster) and then the timestamp of the files mtime.
+
+Rails cache busters are similar, except they leave out the parameter name.  This
+mimics the behavior of the image_tag helper in the Ruby on Rails framework, so that
+images called from both CSS and from Rails views will have identical URLs.
 
 Unfortunately, the popular web proxy Squid shipped for some time with a default
 configuration which would not treat a URL as a "new" URL if the only thing changed
 was the GET parameters. For this reason Juicer provides hard cache busters.
 
-Hard cache busters result in URLs such as: http://assets/images/1-cb1234567890.png,
+Hard cache busters result in URLs such as: http://assets/images/1-jcb1234567890.png,
 ie URLs that require either renaming of files, or (more conveniently) a web
 server configuration that will forward URLs to the right files anyway.
 
@@ -287,6 +292,9 @@ Will tell you about other dependencies that might be missing on your system.
 * Aaron Suggs (http://ktheory.com)
   Added support for depending on directories
   Fixed installers on 1.0 branch
+* Elliott Wood (http://two-fish.com)
+  Added "rails" cache buster type
+  Fixed issues with asset host cycling
 
 == LICENSE:
 

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.0.4

data/lib/juicer.rb

@@ -3,7 +3,7 @@ require "logger"
 module Juicer
 
   # :stopdoc:
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   LOGGER = Logger.new(STDOUT)

data/lib/juicer/asset/path.rb

@@ -265,7 +265,7 @@ module Juicer
         hosts.each do |host|
           return path if path !~ @@scheme_pattern
 
-          path.sub!(%r{^#{host}}, '')
+          path = path.sub(%r{^#{host}}, '')
         end
 
         return path

data/lib/juicer/cache_buster.rb

@@ -80,15 +80,18 @@ module Juicer
     #
     def self.path(file, type = :soft, parameter = DEFAULT_PARAMETER)
       return file if file =~ /data:.*;base64/
+      type = [:soft, :hard, :rails].include?(type) ? type : :soft
+      parameter = nil if type == :rails
       file = self.clean(file, parameter)
       filename = file.split("?").first
       raise ArgumentError.new("#{file} could not be found") unless File.exists?(filename)
       mtime = File.mtime(filename).to_i
-      type = [:soft, :hard].include?(type) ? type : :soft
 
       if type == :soft
         parameter = "#{parameter}=".sub(/^=$/, '')
         return "#{file}#{file.index('?') ? '&' : '?'}#{parameter}#{mtime}"
+      elsif type == :rails
+        return "#{file}#{file.index('?') ? '' : "?#{mtime}"}"
       end
 
       file.sub(/(\.[^\.]+$)/, "-#{parameter}#{mtime}" + '\1')
@@ -116,16 +119,29 @@ module Juicer
       self.path(file, :soft, parameter)
     end
 
+    #
+    # Add a Rails-style cache buster to a filename. Results in filenames of the
+    # form: <tt>file.suffix?[timestamp]</tt>, ie <tt>images/logo.png?1234567890</tt>
+    # which is the format used by Rails' image_tag helper.
+    #
+    def self.rails(file)
+      self.path(file, :rails)
+    end
+    
     #
     # Remove cache buster from a URL for a given parameter name. Parameter name is
     # "cb" by default.
     #
     def self.clean(file, parameter = DEFAULT_PARAMETER)
-      query_param = "#{parameter}".length == 0 ? "" : "#{parameter}="
-      new_file = file.sub(/#{query_param}\d+&?/, "").sub(/(\?|&)$/, "")
-      return new_file unless new_file == file
+      if "#{parameter}".length == 0
+        return file.sub(/\?\d+$/, '')
+      else
+        query_param = "#{parameter}="
+        new_file = file.sub(/#{query_param}\d+&?/, "").sub(/(\?|&)$/, "")
+        return new_file unless new_file == file
 
-      file.sub(/-#{parameter}\d+(\.\w+)($|\?)/, '\1\2')
+        file.sub(/-#{parameter}\d+(\.\w+)($|\?)/, '\1\2')
+      end
     end
   end
 end

data/lib/juicer/command/merge.rb

@@ -68,15 +68,17 @@ the compressor the path should be the path to where the jar file is found.
           opt.on("-l", "--local-hosts hosts", "Host names that are served from --document-root (can be given cache busters). Comma separated") do |hosts|
             @local_hosts = hosts.split(",")
           end
-          opt.on("", "--all-hosts-local", "Treat all hosts as local (ie served from --document-root") { |t| @local_hosts = @hosts }
+          opt.on("", "--all-hosts-local", "Treat all hosts as local (ie served from --document-root)") { @all_hosts_local = true }
           opt.on("-r", "--relative-urls", "Convert all referenced URLs to relative URLs. Requires --document-root if\n" +
                            (" " * 37) + "absolute URLs are used. Only valid for CSS files") { |t| @relative_urls = true }
           opt.on("-b", "--absolute-urls", "Convert all referenced URLs to absolute URLs. Requires --document-root.\n" +
                            (" " * 37) + "Works with cycled asset hosts. Only valid for CSS files") { |t| @absolute_urls = true }
           opt.on("-d", "--document-root dir", "Path to resolve absolute URLs relative to") { |path| @document_root = path }
-          opt.on("-c", "--cache-buster type", "none, soft or hard. Default is soft, which adds timestamps to referenced\n" +
-                           (" " * 37) + "URLs as query parameters. None leaves URLs untouched and hard alters file names") do |type|
-            @cache_buster = [:soft, :hard].include?(type.to_sym) ? type.to_sym : nil
+          opt.on("-c", "--cache-buster type", "none, soft, rails, or hard. Default is soft, which adds timestamps to\n" +
+                           (" " * 37) + "reference URLs as query parameters. None leaves URLs untouched, rails adds\n" + 
+                           (" " * 37) + "timestamps in the same format as Rails' image_tag helper, and hard alters\n" +
+                           (" " * 37) + "file names") do |type|
+            @cache_buster = [:soft, :hard, :rails].include?(type.to_sym) ? type.to_sym : nil
           end
           opt.on("-e", "--embed-images type", "none or data_uri. Default is none. Data_uri embeds images using Base64 encoding\n" +
                            (" " * 37) + "None leaves URLs untouched. Candiate images must be flagged with '?embed=true to be considered") do |embed|
@@ -92,6 +94,9 @@ the compressor the path should be the path to where the jar file is found.
           @log.fatal "Please provide atleast one input file"
           raise SystemExit.new("Please provide atleast one input file")
         end
+        
+        # Copy hosts to local_hosts if --all-hosts-local was specified
+        @local_hosts = @hosts if @all_hosts_local
 
         # Figure out which file to output to
         output = output(files.first)

data/lib/juicer/merger/stylesheet_merger.rb

@@ -58,7 +58,6 @@ module Juicer
 
         content.scan(/url\([\s"']*([^\)"'\s]*)[\s"']*\)/m).uniq.collect do |url|
           url = url.first
-          puts "URL: #{url}"
           path = resolve_path(url, dir)
           content.gsub!(/\([\s"']*#{url}[\s"']*\)/m, "(#{path})") unless path == url
         end

data/lib/juicer/minifyer/closure_compiler.rb

@@ -62,7 +62,7 @@ module Juicer
 
         out_dir = File.dirname(output)
         FileUtils.mkdir_p(out_dir) unless File.exists?(out_dir)
-        result = execute(%Q{-jar "#{locate_jar}"#{jar_args} -js_output_file "#{output}" -js "#{file}"})
+        execute(%Q{-jar "#{locate_jar}"#{jar_args} --js_output_file "#{output}" --js "#{file}"})
 
         File.delete(file) if use_tmp
       end

data/test/data/css/test3.css

@@ -0,0 +1,12 @@
+body {
+    background: url(http://assets1/images/1.png);
+}
+
+h1 {
+    background: url(http://assets2/css/2.gif);
+    background: url(http://assets3/a1.css) 0 0 no-repeat;
+}
+
+h2 {
+   background: url(http://assets2/css/2.gif) no-repeat;
+}

data/test/test_helper.rb

@@ -147,6 +147,23 @@ p { background: url(/a2.css); }
 
         mkfile(@dir, 'path_test2.css', css)
 
+        css = <<-CSS
+body {
+    background: url(http://assets1/images/1.png);
+}
+
+h1 {
+    background: url(http://assets2/css/2.gif);
+    background: url(http://assets3/a1.css) 0 0 no-repeat;
+}
+
+h2 {
+   background: url(http://assets2/css/2.gif) no-repeat;
+}
+        CSS
+        
+        mkfile(css_dir, 'test3.css', css)
+
         mkfile(@dir, 'Changelog.txt', "2008.02.09 | stb-base 1.29\n\nFEATURE: Core  | Bla bla bla bla bla\nFEATURE: UI: | Bla bla bla bla bla\n\n\n2008.02.09 | stb-base 1.29\n\nFEATURE: Core  | Bla bla bla bla bla\nFEATURE: UI: | Bla bla bla bla bla\n")
 
         # my_app.js depends on the pkg directory

data/test/unit/juicer/cache_buster_test.rb

@@ -26,10 +26,17 @@ class CacheBusterTest < Test::Unit::TestCase
       assert_equal @filename, Juicer::CacheBuster.clean("#@filename?1234567890", nil)
     end
 
+    should "not destroy numeric file names with no cache buster name" do
+      @numeric_filename = "815.gif"
+      File.open(@numeric_filename, "w") { |f| f.puts "Testing" }
+      assert_equal @numeric_filename, Juicer::CacheBuster.clean("#@numeric_filename?1234567890", nil)
+      File.delete(@numeric_filename)
+    end
+
     should "remove cache buster query parameters with custom name" do
       assert_equal @filename, Juicer::CacheBuster.clean("#@filename?cb=1234567890", :cb)
     end
-
+    
     should "remove hard cache buster" do
       assert_equal @filename, Juicer::CacheBuster.clean(@filename.sub(/(\.txt)/, '-jcb1234567890\1'))
     end
@@ -72,6 +79,23 @@ class CacheBusterTest < Test::Unit::TestCase
     end
   end
 
+  context "creating rails-style cache busters" do
+    should "clean file before adding new cache buster" do
+      cache_buster = "1234567890"
+      assert_no_match /#{cache_buster}/, Juicer::CacheBuster.rails("#@filename?#{cache_buster}")
+    end
+
+    should "append no cache buster when parameters exist" do
+      parameters = "id=1"
+      assert_match /#{parameters}/, Juicer::CacheBuster.rails("#@filename?#{parameters}")
+    end
+
+    should "include only mtime as query parameter" do
+      mtime = File.mtime(@filename).to_i
+      assert_equal "#@filename?#{mtime}", Juicer::CacheBuster.rails(@filename)
+    end
+  end
+
   context "hard cache busters" do
     setup { @filename.sub!(/\.txt/, '') }
     teardown { @filename = "#@filename.txt" }

data/test/unit/juicer/css_cache_buster_test.rb

@@ -37,6 +37,15 @@ class TestCssCacheBuster < Test::Unit::TestCase
 
       assert_no_match /2\.gif\?jcb=\d+\?jcb=/, File.read(file)
     end
+
+    should "not add multiple cache busters when asset host cycling is used" do
+      file = path("css/test3.css")
+      buster = Juicer::CssCacheBuster.new( { :hosts => [ 'http://assets1', 'http://assets2', 'http://assets3' ], :document_root => './test/data' } )
+      buster.save file
+
+      assert_no_match /2\.gif\?jcb=\d+\?jcb=/, File.read(file)
+    end
+
   end
 
   context "absolute paths" do
@@ -75,6 +84,18 @@ class TestCssCacheBuster < Test::Unit::TestCase
     end
   end
 
+  context "rails cache busters" do
+    should "should append mtime to urls" do
+      File.open(path("a2.css"), "w") { |f| f.puts "" }
+      file = path("path_test2.css")
+      output = path("path_test3.css")
+      buster = Juicer::CssCacheBuster.new :document_root => path(""), :type => :rails
+      buster.save file, output
+
+      buster.urls(output).each { |asset| assert_match /\?\d+$/, asset.path }
+    end
+  end
+  
   context "hard cache busters" do
     should "should alter file name" do
       File.open(path("a2.css"), "w") { |f| f.puts "" }

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Christian Johansen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-15 00:00:00 +02:00
+date: 2010-05-31 00:00:00 +02:00
 default_executable: juicer
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -178,6 +178,7 @@ files:
 - test/data/css/2.gif
 - test/data/css/test.css
 - test/data/css/test2.css
+- test/data/css/test3.css
 - test/data/d1.css
 - test/data/images/1.png
 - test/data/my_app.js