juicer 0.2.6 → 1.0.0

data/lib/juicer/dependency_resolver/javascript_dependency_resolver.rb

@@ -0,0 +1,23 @@
+require "juicer/dependency_resolver/dependency_resolver"
+
+module Juicer
+  # Resolves @depends and @depend statements in comments in JavaScript files.
+  # Only the first comment in a JavaScript file is parsed
+  #
+  class JavaScriptDependencyResolver < DependencyResolver
+    @@depends_pattern = /\@depends?\s+([^\s\'\"\;]+)/
+
+    private
+    def parse(line, imported_file = nil)
+      return $1 if line =~ @@depends_pattern
+
+      # If we have already skimmed through some @depend/@depends or a
+      # closing comment we're done.
+      throw :done unless imported_file.nil? || !(line =~ /\*\//)
+    end
+
+    def extension
+      ".js"
+    end
+  end
+end

data/lib/juicer/ext/logger.rb

@@ -0,0 +1,5 @@
+class Logger
+  def format_message(severity, datetime, progname, msg)
+    "#{msg}\n"
+  end
+end

data/lib/juicer/ext/string.rb

@@ -0,0 +1,47 @@
+#
+# Additions to core Ruby objects
+#
+
+class String
+
+  unless String.method_defined?(:camel_case)
+    #
+    # Turn an underscored string into camel case, ie this_becomes -> ThisBecomes
+    #
+    def camel_case
+      self.split("_").inject("") { |str, piece| str + piece.capitalize }
+    end
+  end
+
+  unless String.method_defined?(:to_class)
+    #
+    # Treat a string as a class name and return the class. Optionally provide a
+    # module to look up the class in.
+    #
+    def to_class(mod = nil)
+      res = "#{mod}::#{self}".sub(/^::/, "").split("::").inject(Object) do |mod, obj|
+        raise "No such class/module" unless mod.const_defined?(obj)
+        mod = mod.const_get(obj)
+      end
+    end
+  end
+
+  unless String.method_defined?(:classify)
+    #
+    # Turn a string in either underscore or camel case form into a class directly
+    #
+    def classify(mod = nil)
+      self.camel_case.to_class(mod)
+    end
+  end
+
+  unless String.method_defined?(:underscore)
+    #
+    # Turn a camelcase string into underscore string
+    #
+    def underscore
+      self.split(/([A-Z][^A-Z]*)/).find_all { |str| str != "" }.join("_").downcase
+    end
+  end
+end
+

data/lib/juicer/ext/symbol.rb

@@ -0,0 +1,15 @@
+class Symbol
+  #
+  # Converts symbol to string and calls String#camel_case
+  #
+  def camel_case
+    self.to_s.camel_case
+  end
+
+  #
+  # Converts symbol to string and calls String#classify
+  #
+  def classify(mod = nil)
+    self.to_s.classify(mod)
+  end
+end

data/lib/juicer/image_embed.rb

@@ -0,0 +1,129 @@
+require "juicer/chainable"
+require "juicer/cache_buster"
+require "juicer/asset/path_resolver"
+
+module Juicer
+  #
+  # The ImageEmbed is a tool that can parse a CSS file and substitute all
+  # referenced URLs by a data uri
+  # 
+  # - data uri (http://en.wikipedia.org/wiki/Data_URI_scheme)
+  # 
+  # Only local resources will be processed this way, external resources referenced
+  # by absolute urls will be left alone
+  # 
+  class ImageEmbed
+    include Juicer::Chainable
+
+    # The maximum supported limit for modern browsers, See the Readme.rdoc for details
+    SIZE_LIMIT = 32768
+    
+    #
+    # Returns the size limit
+    #
+    def size_limit
+      SIZE_LIMIT
+    end
+
+    def initialize(options = {})
+      @document_root = options[:document_root]
+      @document_root.sub!(%r{/?$}, "") if @document_root # Remove trailing slash
+      @type = options[:type] || :none
+      @contents = nil
+      @hosts = options[:hosts]
+      @path_resolver = Juicer::Asset::PathResolver.new(:document_root => options[:document_root],
+                                                       :hosts => options[:hosts])
+    end
+
+    #
+    # Update file. If no +output+ is provided, the input file is overwritten
+    #
+    def save(file, output = nil)
+      return unless @type == :data_uri
+
+      output_file = output || file
+      @contents = File.read(file)
+      used = []
+
+      @path_resolver = Juicer::Asset::PathResolver.new(:document_root => @document_root,
+                                                       :hosts => @hosts,
+                                                       :base => File.dirname(file))
+
+      assets = urls(file)
+
+      # TODO: Remove "?embed=true" from duplicate urls
+      duplicates = duplicate_urls(assets)
+
+      if duplicates.length > 0
+        Juicer::LOGGER.warn("Duplicate image urls detected, these images will not be embedded: #{duplicates.collect { |v| v.gsub('?embed=true', '') }.inspect}") 
+      end
+
+      assets.each do |asset|
+        begin
+          next if used.include?(asset) || duplicates.include?(asset.path)
+          used << asset
+
+          # make sure we do not exceed SIZE_LIMIT
+          new_path = embed_data_uri(asset.filename)
+
+          if new_path.length < SIZE_LIMIT
+            # replace the url in the css file with the data uri
+            @contents.gsub!(asset.path, embed_data_uri(asset.path))
+          else
+            Juicer::LOGGER.warn("The final data uri for the image located at #{asset.path.gsub('?embed=true', '')} exceeds #{SIZE_LIMIT} and will not be embedded to maintain compatability.") 
+          end
+        rescue Errno::ENOENT
+          puts "Unable to locate file #{asset.path}, skipping image embedding"
+        end
+      end
+
+      File.open(output || file, "w") { |f| f.puts @contents }
+      @contents = nil
+    end
+
+    chain_method :save
+            
+    def embed_data_uri( path )
+      new_path = path
+      
+      if path.match( /\?embed=true$/ )
+        supported_file_matches = path.match( /(?:\.)(png|gif|jpg|jpeg)(?:\?embed=true)$/i )
+        filetype = supported_file_matches[1] if supported_file_matches
+        
+        if ( filetype )        
+          filename = path.gsub('?embed=true','')      
+
+          # check if file exists, throw an error if it doesn't exist
+          if File.exist?( filename )
+            
+            # read contents of file into memory              
+            content = File.read( filename )
+            content_type = "image/#{filetype}"
+            
+            # encode the url
+            new_path = Datafy::make_data_uri( content, content_type )
+          else
+            puts "Unable to locate file #{filename} on local file system, skipping image embedding"
+          end
+        end
+      end
+      return new_path
+    end
+
+    #
+    # Returns all referenced URLs in +file+.
+    #
+    def urls(file)
+      @contents = File.read(file) unless @contents
+
+      @contents.scan(/url\([\s"']*([^\)"'\s]*)[\s"']*\)/m).collect do |match|
+        @path_resolver.resolve(match.first)
+      end
+    end
+
+    private
+    def duplicate_urls(urls)
+      urls.inject({}) { |h,v| h[v.path] = h[v.path].to_i+1; h }.reject{ |k,v| v == 1 }.keys
+    end
+  end
+end

data/lib/juicer/install/base.rb

@@ -1,7 +1,7 @@
-require 'hpricot'
+require 'nokogiri'
 require 'open-uri'
 require 'fileutils'
-require File.expand_path(File.join(File.dirname(__FILE__), %w[.. .. juicer])) unless defined?(Juicer)
+require "juicer"
 
 module Juicer
   module Install

data/lib/juicer/install/closure_compiler_installer.rb

@@ -0,0 +1,69 @@
+require "juicer"
+require "juicer/install/base"
+require "zip/zip"
+
+module Juicer
+  module Install
+    #
+    # Install and uninstall routines for the Google Closure Compiler.
+    # Installation downloads the Closure Compiler distribution, unzips it and
+    # storesthe jar file on disk along with the README.
+    #
+    class ClosureCompilerInstaller < Base
+      def initialize(install_dir = Juicer.home)
+        super(install_dir)
+        @latest = nil
+        @website = "http://code.google.com/p/closure-compiler/downloads/list"
+        @download_link = "http://closure-compiler.googlecode.com/files/compiler-%s.zip"
+      end
+
+      #
+      # Install the Closure Compiler. Downloads the distribution and keeps the jar
+      # file inside PATH/closure_compiler/bin and the README in
+      # PATH/closere_compiler/yyyymmdd/ where yyyymmdd is the version, most recent if
+      # not specified otherwise.
+      #
+      # Path defaults to environment variable $JUICER_HOME or default Juicer
+      # home
+      #
+      def install(version = nil)
+        version = super(version)
+        base = "closure-compiler-#{version}"
+        filename = download(@download_link % version)
+        target = File.join(@install_dir, path)
+
+        Zip::ZipFile.open(filename) do |file|
+          file.extract("README", File.join(target, version, "README"))
+          file.extract("compiler.jar", File.join(target, "bin", "#{base}.jar"))
+        end
+      end
+
+      #
+      # Uninstalls the given version of Closure Compiler. If no location is
+      # provided the environment variable $JUICER_HOME or Juicers default home
+      # directory is used.
+      #
+      # If no version is provided the most recent version is assumed.
+      #
+      # If there are no more files left in INSTALLATION_PATH/closure_compiler, the
+      # whole directory is removed.
+      #
+      def uninstall(version = nil)
+        super(version) do |dir, version|
+          File.delete(File.join(dir, "bin/closure-compiler-#{version}.jar"))
+        end
+      end
+
+      #
+      # Check which version is the most recent
+      #
+      def latest
+        return @latest if @latest
+        webpage = Nokogiri::HTML(open(@website))
+        @latest = (webpage / "//table[@id='resultstable']//td/a[contains(@href, 'compiler')]").map{|link|
+          link.get_attribute('href')[/\d{8}/].to_i
+        }.sort.last.to_s
+      end
+    end
+  end
+end

data/lib/juicer/install/jslint_installer.rb

@@ -1,5 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), %w[.. .. juicer])) unless defined?(Juicer)
-require File.expand_path(File.join(File.dirname(__FILE__), "base"))
+require "juicer"
+require "juicer/install/base"
 require "zip/zip"
 
 module Juicer
@@ -28,7 +28,7 @@ module Juicer
       def install(version = nil)
         version = super(version)
         filename = download(File.join(@website, "rhino/jslint.js"))
-        File.copy(filename, File.join(@install_dir, path, "bin", "jslint-#{version}.js"))
+        FileUtils.copy(filename, File.join(@install_dir, path, "bin", "jslint-#{version}.js"))
       end
 
       #

data/lib/juicer/install/rhino_installer.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), %w[.. .. juicer])) unless defined?(Juicer)
+require "juicer"
+require "juicer/install/base"
 require "zip/zip"
 
 module Juicer
@@ -12,7 +13,7 @@ module Juicer
       def initialize(install_dir = Juicer.home)
         super(install_dir)
         @latest = "1_7R2-RC1"
-        @website = "ftp://ftp.mozilla.org/pub/mozilla.org/js/"
+        @website = "http://ftp.mozilla.org/pub/mozilla.org/js/"
       end
 
       #

data/lib/juicer/install/yui_compressor_installer.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), %w[.. .. juicer])) unless defined?(Juicer)
+require "juicer"
+require "juicer/install/base"
 require "zip/zip"
 
 module Juicer
@@ -58,7 +59,7 @@ module Juicer
       #
       def latest
         return @latest if @latest
-        webpage = Hpricot(open(@website))
+        webpage = Nokogiri::HTML(open(@website))
         @latest = (webpage / "//h2[@id='yuicompressor']/../../../..//a")[0].get_attribute("href").match(/(\d\.\d\.\d)/)[1]
       end
     end

data/lib/juicer/jslint.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "binary"))
+require "juicer/binary"
 
 module Juicer
   #

data/lib/juicer/merger/base.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "chainable"))
+require "juicer/chainable"
 
 # Merge several files into one single output file
 module Juicer

data/lib/juicer/merger/javascript_merger.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-['base', 'javascript_dependency_resolver'].each do |lib|
-  require File.expand_path(File.join(File.dirname(__FILE__), lib))
-end
+require "juicer/merger/base"
+require "juicer/dependency_resolver/javascript_dependency_resolver"
 
 module Juicer
   module Merger
@@ -22,7 +21,7 @@ end
 # or similar.
 #
 if $0 == __FILE__
-  return puts("Usage: javascript_merger.rb file[...] output") if $*.length < 2
+  puts("Usage: javascript_merger.rb file[...] output") and exit if $*.length < 2
 
   fm = JavaScriptMerger.new()
   fm << $*[0..-2]

data/lib/juicer/merger/stylesheet_merger.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
-['base', 'css_dependency_resolver'].each do |lib|
-  require File.expand_path(File.join(File.dirname(__FILE__), lib))
-end
-
+require "juicer/merger/base"
+require "juicer/dependency_resolver/css_dependency_resolver"
 require 'pathname'
 
 module Juicer
@@ -15,7 +13,7 @@ module Juicer
       # Constructor
       #
       # Options:
-      # * <tt>:web_root</tt> - Path to web root if there is any @import statements
+      # * <tt>:document_root</tt> - Path to web root if there is any @import statements
       #   using absolute URLs
       #
       def initialize(files = [], options = {})
@@ -25,8 +23,8 @@ module Juicer
         @host_num = 0
         @use_absolute = options.key?(:absolute_urls) ? options[:absolute_urls] : false
         @use_relative = options.key?(:relative_urls) ? options[:relative_urls] : false
-        @web_root = options[:web_root]
-        @web_root = File.expand_path(@web_root).sub(/\/?$/, "") if @web_root # Make sure path doesn't end in a /
+        @document_root = options[:document_root]
+        @document_root = File.expand_path(@document_root).sub(/\/?$/, "") if @document_root # Make sure path doesn't end in a /
       end
 
      private
@@ -42,10 +40,10 @@ module Juicer
       # The options hash decides how Juicer recalculates referenced URLs:
       #
       #   options[:absolute_urls] When true, all paths are converted to absolute
-      #                           URLs. Requires options[:web_root] to define
+      #                           URLs. Requires options[:document_root] to define
       #                           root directory to resolve absolute URLs from.
       #   options[:relative_urls] When true, all paths are converted to relative
-      #                           paths. Requires options[:web_root] to define
+      #                           paths. Requires options[:document_root] to define
       #                           root directory to resolve absolute URLs from.
       #
       # If none if these are set then relative URLs are recalculated to match
@@ -55,7 +53,7 @@ module Juicer
       # for all absolute URLs regardless of absolute/relative URL strategy.
       #
       def merge(file)
-        content = super.gsub(/^\s*\@import\s("|')(.*)("|')\;?/, '')
+        content = super.gsub(/^\s*@import(?:\surl\(|\s)(['"]?)([^\?'"\)\s]+)(\?(?:[^'"\)]+)?)?\1\)?(?:[^?;]+)?;?/i, "")
         dir = File.expand_path(File.dirname(file))
 
         content.scan(/url\([\s"']*([^\)"'\s]*)[\s"']*\)/m).uniq.collect do |url|
@@ -75,15 +73,15 @@ module Juicer
 
         # Absolute URLs
         if url =~ %r{^/} && @use_relative
-          raise ArgumentError.new("Unable to handle absolute URLs without :web_root option") if !@web_root
-          path = Pathname.new(File.join(@web_root, url)).relative_path_from(@root).to_s
+          raise ArgumentError.new("Unable to handle absolute URLs without :document_root option") if !@document_root
+          path = Pathname.new(File.join(@document_root, url)).relative_path_from(@root).to_s
         end
 
         # All URLs that don't start with a protocol
         if url !~ %r{^/} && url !~ %r{^[a-z]+://}
           if @use_absolute
-            raise ArgumentError.new("Unable to handle absolute URLs without :web_root option") if !@web_root
-            path = File.expand_path(File.join(dir, url)).sub(@web_root, "")         # Make absolute
+            raise ArgumentError.new("Unable to handle absolute URLs without :document_root option") if !@document_root
+            path = File.expand_path(File.join(dir, url)).sub(@document_root, "")         # Make absolute
           else
             path = Pathname.new(File.join(dir, url)).relative_path_from(@root).to_s # ...or redefine relative ref
           end
@@ -104,7 +102,7 @@ end
 # Run file from command line
 #
 if $0 == __FILE__
-  return puts("Usage: stylesheet_merger.rb file[...] output") if $*.length < 2
+  puts("Usage: stylesheet_merger.rb file[...] output") and exit if $*.length < 2
 
   fm = Juicer::Merger::StylesheetMerger.new()
   fm << $*[0..-2]