Merge pull request #227 from didip/master

Refactor of Jammit

Author: jashkenas

Gemfile

@@ -3,11 +3,14 @@ source 'http://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem "rake", "0.9.2"
-  gem "rails", "2.3.11"
-  gem "yui-compressor", "0.9.3"
-  gem "closure-compiler", "1.1.5"
-  gem "uglifier", "0.4.0"
+  gem "rake", "0.9.2.2"
+  gem "rails", "2.3.14"
+  gem "cssmin", "1.0.2"
+  gem "jsmin", "1.0.1"
+  gem "yui-compressor", "0.9.6"
+  gem "closure-compiler", "1.1.6"
+  gem "uglifier", "1.2.4"
+  gem "sass", "3.1.7"
 end
 
 group :development do

doc/Jammit/Compressor.html

@@ -234,7 +234,7 @@ <h2>Constant Summary</h2>
 <span class='rbrace token'>}</span>
 </pre></dd>
 
-        <dt id="DEFAULT_OPTIONS-constant" class="">DEFAULT_OPTIONS =
+        <dt id="JAVASCRIPT_DEFAULT_OPTIONS-constant" class="">JAVASCRIPT_DEFAULT_OPTIONS =
 
         </dt>
         <dd><pre class="code"><span class='lbrace token'>{</span>

jammit.gemspec

@@ -26,7 +26,8 @@ Gem::Specification.new do |s|
                          '--main'     << 'README' <<
                          '--all'
 
-  s.add_dependency 'yui-compressor',    ['>= 0.9.3']
+  s.add_dependency 'cssmin', ['>= 1.0.2']
+  s.add_dependency 'jsmin',  ['>= 1.0.1']
 
   s.files = Dir['lib/**/*', 'bin/*', 'rails/*', 'jammit.gemspec', 'LICENSE', 'README']
 end

lib/jammit.rb

@@ -4,28 +4,32 @@
 # to all of the configuration options.
 module Jammit
 
-  VERSION               = "0.6.5"
+  VERSION                       = "0.6.5"
 
-  ROOT                  = File.expand_path(File.dirname(__FILE__) + '/..')
+  ROOT                          = File.expand_path(File.dirname(__FILE__) + '/..')
 
-  ASSET_ROOT            = File.expand_path((defined?(Rails) && Rails.root.to_s.length > 0) ? Rails.root : ENV['RAILS_ROOT'] || ".") unless defined?(ASSET_ROOT)
+  ASSET_ROOT                    = File.expand_path((defined?(Rails) && Rails.root.to_s.length > 0) ? Rails.root : ENV['RAILS_ROOT'] || ".") unless defined?(ASSET_ROOT)
 
-  DEFAULT_PUBLIC_ROOT   = (defined?(Rails) && Rails.public_path.to_s.length > 0) ? Rails.public_path : File.join(ASSET_ROOT, 'public') unless defined?(PUBLIC_ROOT)
+  DEFAULT_PUBLIC_ROOT           = (defined?(Rails) && Rails.public_path.to_s.length > 0) ? Rails.public_path : File.join(ASSET_ROOT, 'public') unless defined?(PUBLIC_ROOT)
 
-  DEFAULT_CONFIG_PATH   = File.join(ASSET_ROOT, 'config', 'assets.yml')
+  DEFAULT_CONFIG_PATH           = File.join(ASSET_ROOT, 'config', 'assets.yml')
 
-  DEFAULT_PACKAGE_PATH  = "assets"
+  DEFAULT_PACKAGE_PATH          = "assets"
 
-  DEFAULT_JST_SCRIPT    = File.join(ROOT, 'lib/jammit/jst.js')
+  DEFAULT_JST_SCRIPT            = File.join(ROOT, 'lib/jammit/jst.js')
 
-  DEFAULT_JST_COMPILER  = "template"
+  DEFAULT_JST_COMPILER          = "template"
 
-  DEFAULT_JST_NAMESPACE = "window.JST"
+  DEFAULT_JST_NAMESPACE         = "window.JST"
 
-  COMPRESSORS           = [:yui, :closure, :uglifier]
+  JAVASCRIPT_COMPRESSORS        = [:jsmin, :yui, :closure, :uglifier]
+
+  DEFAULT_JAVASCRIPT_COMPRESSOR = :jsmin
+
+  CSS_COMPRESSORS               = [:cssmin, :yui, :sass]
+
+  DEFAULT_CSS_COMPRESSOR        = :cssmin
 
-  DEFAULT_COMPRESSOR    = :yui
-  
   # Extension matchers for JavaScript and JST, which need to be disambiguated.
   JS_EXTENSION          = /\.js\Z/
   DEFAULT_JST_EXTENSION = "jst"
@@ -50,17 +54,20 @@ class << self
     attr_reader   :configuration, :template_function, :template_namespace,
                   :embed_assets, :package_assets, :compress_assets, :gzip_assets,
                   :package_path, :mhtml_enabled, :include_jst_script, :config_path,
-                  :javascript_compressor, :compressor_options, :css_compressor_options,
-                  :template_extension, :template_extension_matcher, :allow_debugging,
+                  :javascript_compressor, :compressor_options, :css_compressor,
+                  :css_compressor_options, :template_extension,
+                  :template_extension_matcher, :allow_debugging,
                   :rewrite_relative_paths, :public_root
-    attr_accessor :compressors
+    attr_accessor :javascript_compressors, :css_compressors
   end
 
   # The minimal required configuration.
   @configuration  = {}
   @public_root    = DEFAULT_PUBLIC_ROOT
   @package_path   = DEFAULT_PACKAGE_PATH
-  @compressors    = COMPRESSORS
+
+  @javascript_compressors = JAVASCRIPT_COMPRESSORS
+  @css_compressors        = CSS_COMPRESSORS
 
   # Load the complete asset configuration from the specified @config_path@.
   # If we're loading softly, don't let missing configuration error out.
@@ -86,6 +93,7 @@ def self.load_configuration(config_path, soft=false)
     @compressor_options     = symbolize_keys(conf[:compressor_options] || {})
     @css_compressor_options = symbolize_keys(conf[:css_compressor_options] || {})
     set_javascript_compressor(conf[:javascript_compressor])
+    set_css_compressor(conf[:css_compressor])
     set_package_assets(conf[:package_assets])
     set_template_function(conf[:template_function])
     set_template_namespace(conf[:template_namespace])
@@ -149,7 +157,13 @@ def self.set_public_root(public_root=nil)
   # Ensure that the JavaScript compressor is a valid choice.
   def self.set_javascript_compressor(value)
     value = value && value.to_sym
-    @javascript_compressor = compressors.include?(value) ? value : DEFAULT_COMPRESSOR
+    @javascript_compressor = javascript_compressors.include?(value) ? value : DEFAULT_JAVASCRIPT_COMPRESSOR
+  end
+
+  # Ensure that the CSS compressor is a valid choice.
+  def self.set_css_compressor(value)
+    value = value && value.to_sym
+    @css_compressor = css_compressors.include?(value) ? value : DEFAULT_CSS_COMPRESSOR
   end
 
   # Turn asset packaging on or off, depending on configuration and environment.

lib/jammit/compressor.rb

@@ -41,26 +41,39 @@ class Compressor
     JST_START       = "(function(){"
     JST_END         = "})();"
 
-    COMPRESSORS = {
-      :yui      => YUI::JavaScriptCompressor,
-      :closure  => Jammit.compressors.include?(:closure)  ? Closure::Compiler : nil,
-      :uglifier => Jammit.compressors.include?(:uglifier) ? Jammit::Uglifier  : nil
+    JAVASCRIPT_COMPRESSORS = {
+      :jsmin    => Jammit.javascript_compressors.include?(:jsmin)  ? Jammit::JsminCompressor : nil,
+      :yui      => Jammit.javascript_compressors.include?(:yui)  ? YUI::JavaScriptCompressor : nil,
+      :closure  => Jammit.javascript_compressors.include?(:closure)  ? Closure::Compiler : nil,
+      :uglifier => Jammit.javascript_compressors.include?(:uglifier) ? Jammit::Uglifier  : nil
     }
 
-    DEFAULT_OPTIONS = {
+    CSS_COMPRESSORS = {
+      :cssmin   => Jammit.css_compressors.include?(:cssmin) ? Jammit::CssminCompressor : nil,
+      :yui      => Jammit.css_compressors.include?(:yui) ? YUI::CssCompressor : nil,
+      :sass     => Jammit.css_compressors.include?(:sass) ? Jammit::SassCompressor : nil
+     }
+
+    JAVASCRIPT_DEFAULT_OPTIONS = {
+      :jsmin    => {},
       :yui      => {:munge => true},
       :closure  => {},
       :uglifier => {:copyright => false}
     }
 
-    # The css compressor is always the YUI Compressor. JS compression can be
-    # provided with YUI Compressor, Google Closure Compiler or UglifyJS.
+    # CSS compression can be provided with YUI Compressor or sass. JS
+    # compression can be provided with YUI Compressor, Google Closure
+    # Compiler or UglifyJS.
     def initialize
-      Jammit.check_java_version
-      @css_compressor = YUI::CssCompressor.new(Jammit.css_compressor_options || {})
-      flavor          = Jammit.javascript_compressor || Jammit::DEFAULT_COMPRESSOR
-      @options        = DEFAULT_OPTIONS[flavor].merge(Jammit.compressor_options || {})
-      @js_compressor  = COMPRESSORS[flavor].new(@options)
+      if Jammit.javascript_compressors.include?(:yui) || Jammit.javascript_compressors.include?(:closure) || Jammit.css_compressors.include?(:yui)
+        Jammit.check_java_version
+      end
+
+      css_flavor      = Jammit.css_compressor || Jammit::DEFAULT_CSS_COMPRESSOR
+      @css_compressor = CSS_COMPRESSORS[css_flavor].new(Jammit.css_compressor_options || {})
+      js_flavor       = Jammit.javascript_compressor || Jammit::DEFAULT_JAVASCRIPT_COMPRESSOR
+      @options        = JAVASCRIPT_DEFAULT_OPTIONS[js_flavor].merge(Jammit.compressor_options || {})
+      @js_compressor  = JAVASCRIPT_COMPRESSORS[js_flavor].new(@options)
     end
 
     # Concatenate together a list of JavaScript paths, and pass them through the
@@ -172,7 +185,7 @@ def with_mhtml(css, asset_url)
       end
       [MHTML_START, mhtml, MHTML_END, css].flatten.join('')
     end
-    
+
     # Return a rewritten asset URL for a new stylesheet -- the asset should
     # be tagged for embedding if embeddable, and referenced at the correct level
     # if relative.

lib/jammit/cssmin_compressor.rb

@@ -0,0 +1,10 @@
+# Wraps CSSMin compressor to use the same API as the rest of
+# Jammit's compressors.
+class Jammit::CssminCompressor
+  def initialize(options = {})
+  end
+
+  def compress(css)
+    CSSMin.minify(css)
+  end
+end

lib/jammit/dependencies.rb

@@ -7,28 +7,45 @@
 require 'pathname'
 require 'fileutils'
 
-# Include YUI as the default
-require 'yui/compressor'
+# Try Uglifier.
+begin
+  require 'uglifier'
+  require 'jammit/uglifier'
+rescue LoadError
+  Jammit.javascript_compressors.delete :uglifier
+end
+
+# Try YUI
+begin
+  require 'yui/compressor'
+rescue LoadError
+  Jammit.javascript_compressors.delete :yui
+  Jammit.css_compressors.delete :yui
+end
 
 # Try Closure.
 begin
   require 'closure-compiler'
 rescue LoadError
-  Jammit.compressors.delete :closure
+  Jammit.javascript_compressors.delete :closure
 end
 
-# Try Uglifier.
+# Try Sass
 begin
-  require 'uglifier'
+  require 'sass'
+  require 'jammit/sass_compressor'
 rescue LoadError
-  Jammit.compressors.delete :uglifier
+  Jammit.css_compressors.delete :sass
 end
 
 # Load initial configuration before the rest of Jammit.
 Jammit.load_configuration(Jammit::DEFAULT_CONFIG_PATH, true) if defined?(Rails)
 
 # Jammit Core:
-require 'jammit/uglifier' if Jammit.compressors.include? :uglifier
+require 'jsmin'
+require 'cssmin'
+require 'jammit/jsmin_compressor'
+require 'jammit/cssmin_compressor'
 require 'jammit/compressor'
 require 'jammit/packager'
 

lib/jammit/jsmin_compressor.rb

@@ -0,0 +1,10 @@
+# Wraps JSMin compressor to use the same API as the rest of
+# Jammit's compressors.
+class Jammit::JsminCompressor
+  def initialize(options = {})
+  end
+
+  def compress(js)
+    JSMin.minify(js)
+  end
+end

lib/jammit/packager.rb

@@ -14,7 +14,6 @@ class Packager
     # Jammit.configuration. When assets.yml is being changed on the fly,
     # create a new Packager.
     def initialize
-      @compressor     = Compressor.new
       @force          = false
       @package_names  = nil
       @config = {
@@ -71,21 +70,25 @@ def individual_urls(package, extension)
       package_for(package, extension)[:urls]
     end
 
+    def compressor
+      @compressor ||= Compressor.new
+    end
+
     # Return the compressed contents of a stylesheet package.
     def pack_stylesheets(package, variant=nil, asset_url=nil)
-      @compressor.compress_css(package_for(package, :css)[:paths], variant, asset_url)
+      compressor.compress_css(package_for(package, :css)[:paths], variant, asset_url)
     end
 
     # Return the compressed contents of a javascript package.
     def pack_javascripts(package)
-      @compressor.compress_js(package_for(package, :js)[:paths])
+      compressor.compress_js(package_for(package, :js)[:paths])
     end
 
     # Return the compiled contents of a JST package.
     def pack_templates(package)
-      @compressor.compile_jst(package_for(package, :js)[:paths])
+      compressor.compile_jst(package_for(package, :js)[:paths])
     end
-  
+
 
     private
 
@@ -109,7 +112,7 @@ def glob_files(glob)
     def path_to_url
       @path_to_url ||= /\A#{Regexp.escape(ASSET_ROOT)}(\/?#{Regexp.escape(Jammit.public_root.sub(ASSET_ROOT, ''))})?/
     end
-    
+
     # Get the latest mtime of a list of files (plus the config path).
     def latest_mtime(paths)
       paths += [Jammit.config_path]

lib/jammit/sass_compressor.rb

@@ -0,0 +1,17 @@
+# Wraps sass' css compressor to use the same API as the rest of
+# Jammit's compressors.
+class Jammit::SassCompressor
+  # Creates a new sass compressor. Jammit::SassCompressor doesn't use
+  # any options, the +options+ parameter is there for API
+  # compatibility.
+  def initialize(options = {})
+  end
+
+  # Compresses +css+ using sass' CSS parser, and returns the
+  # compressed css.
+  def compress(css)
+    root_node = ::Sass::SCSS::CssParser.new(css).parse
+    root_node.options = {:style => :compressed}
+    root_node.render.strip
+  end
+end