jammit 0.6.0 → 0.6.1

data/jammit.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name      = 'jammit'
-  s.version   = '0.6.0'         # Keep version in sync with jammit.rb
-  s.date      = '2010-11-8'
+  s.version   = '0.6.1'         # Keep version in sync with jammit.rb
+  s.date      = '2011-05-25'
 
   s.homepage    = "http://documentcloud.github.com/jammit/"
   s.summary     = "Industrial Strength Asset Packaging for Rails"
@@ -20,15 +20,13 @@ Gem::Specification.new do |s|
   s.require_paths     = ['lib']
   s.executables       = ['jammit']
 
-  s.has_rdoc          = true
   s.extra_rdoc_files  = ['README']
   s.rdoc_options      << '--title'    << 'Jammit' <<
                          '--exclude'  << 'test' <<
                          '--main'     << 'README' <<
                          '--all'
 
-  s.add_dependency 'yui-compressor',    ['>= 0.9.1']
-  s.add_dependency 'closure-compiler',  ['>= 0.1.0']
+  s.add_dependency 'yui-compressor',    ['>= 0.9.3']
 
   s.files = Dir['lib/**/*', 'bin/*', 'rails/*', 'jammit.gemspec', 'LICENSE', 'README']
 end

data/lib/jammit.rb

@@ -4,11 +4,11 @@ $LOAD_PATH.push File.expand_path(File.dirname(__FILE__))
 # to all of the configuration options.
 module Jammit
 
-  VERSION               = "0.6.0"
+  VERSION               = "0.6.1"
 
   ROOT                  = File.expand_path(File.dirname(__FILE__) + '/..')
 
-  ASSET_ROOT            = File.expand_path((defined?(Rails) && Rails.root.to_s.length > 0) ? 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)
 
   PUBLIC_ROOT           = (defined?(Rails) && Rails.public_path.to_s.length > 0) ? Rails.public_path : File.join(ASSET_ROOT, 'public') unless defined?(PUBLIC_ROOT)
 
@@ -22,7 +22,7 @@ module Jammit
 
   DEFAULT_JST_NAMESPACE = "window.JST"
 
-  AVAILABLE_COMPRESSORS = [:yui, :closure]
+  COMPRESSORS           = [:yui, :closure, :uglifier]
 
   DEFAULT_COMPRESSOR    = :yui
 
@@ -34,9 +34,10 @@ module Jammit
   # requested by a browser -- rendering a 404.
   class PackageNotFound < NameError; end
 
-  # Jammit raises a ConfigurationNotFound exception when you try to load the
-  # configuration of an assets.yml file that doesn't exist.
-  class ConfigurationNotFound < NameError; end
+  # Jammit raises a MissingConfiguration exception when you try to load the
+  # configuration of an assets.yml file that doesn't exist, or are missing 
+  # a piece of required configuration.
+  class MissingConfiguration < NameError; end
 
   # Jammit raises an OutputNotWritable exception if the output directory for
   # cached packages is locked.
@@ -46,24 +47,31 @@ module Jammit
   class DeprecationError < StandardError; end
 
   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
+    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
+    attr_accessor :compressors
   end
 
   # The minimal required configuration.
-  @configuration = {}
-  @package_path  = DEFAULT_PACKAGE_PATH
+  @configuration  = {}
+  @package_path   = DEFAULT_PACKAGE_PATH
+  @compressors    = COMPRESSORS
 
   # Load the complete asset configuration from the specified @config_path@.
   # If we're loading softly, don't let missing configuration error out.
   def self.load_configuration(config_path, soft=false)
     exists = config_path && File.exists?(config_path)
     return false if soft && !exists
-    raise ConfigurationNotFound, "could not find the \"#{config_path}\" configuration file" unless exists
+    raise MissingConfiguration, "could not find the \"#{config_path}\" configuration file" unless exists
     conf = YAML.load(ERB.new(File.read(config_path)).result)
+
+    # Optionally overwrite configuration based on the environment.
+    rails_env = defined?(Rails) ? Rails.env : ENV['RAILS_ENV']
+    conf.merge! conf.delete rails_env if conf.has_key? rails_env
+
     @config_path            = config_path
     @configuration          = symbolize_keys(conf)
     @package_path           = conf[:package_path] || DEFAULT_PACKAGE_PATH
@@ -81,7 +89,6 @@ module Jammit
     set_template_extension(conf[:template_extension])
     symbolize_keys(conf[:stylesheets]) if conf[:stylesheets]
     symbolize_keys(conf[:javascripts]) if conf[:javascripts]
-    check_java_version
     check_for_deprecations
     self
   end
@@ -120,7 +127,8 @@ module Jammit
       :force          => false
     }.merge(options)
     load_configuration(options[:config_path])
-    packager.force = options[:force]
+    packager.force         = options[:force]
+    packager.package_names = options[:package_names]
     packager.precache_all(options[:output_folder], options[:base_url])
   end
 
@@ -129,7 +137,7 @@ module Jammit
   # Ensure that the JavaScript compressor is a valid choice.
   def self.set_javascript_compressor(value)
     value = value && value.to_sym
-    @javascript_compressor = AVAILABLE_COMPRESSORS.include?(value) ? value : DEFAULT_COMPRESSOR
+    @javascript_compressor = compressors.include?(value) ? value : DEFAULT_COMPRESSOR
   end
 
   # Turn asset packaging on or off, depending on configuration and environment.
@@ -178,7 +186,9 @@ module Jammit
 
   # Jammit 0.5+ no longer supports separate template packages.
   def self.check_for_deprecations
-    raise DeprecationError, "Jammit 0.5+ no longer supports separate packages for templates.\nPlease fold your templates into the appropriate 'javascripts' package instead." if @configuration[:templates]
+    if @configuration[:templates]
+      raise DeprecationError, "Jammit 0.5+ no longer supports separate packages for templates.\nPlease fold your templates into the appropriate 'javascripts' package instead."
+    end
   end
 
   def self.warn(message)

data/lib/jammit/command_line.rb

@@ -63,6 +63,9 @@ Options:
         opts.on('-f', '--force', 'force a rebuild of all assets') do |force|
           @options[:force] = force
         end
+        opts.on('-p', '--packages PACKAGE_NAMES', 'comma-separated list of packages (ex: "core,embed", default: all packages)') do |package_names|
+          @options[:package_names] = package_names.split(/,\s*/).map {|n| n.to_sym }
+        end
         opts.on_tail('-v', '--version', 'display Jammit version') do
           puts "Jammit version #{Jammit::VERSION}"
           exit

data/lib/jammit/compressor.rb

@@ -42,19 +42,21 @@ module Jammit
     JST_END         = "})();"
 
     COMPRESSORS = {
-      :yui     => YUI::JavaScriptCompressor,
-      :closure => Closure::Compiler
+      :yui      => YUI::JavaScriptCompressor,
+      :closure  => Jammit.compressors.include?(:closure)  ? Closure::Compiler : nil,
+      :uglifier => Jammit.compressors.include?(:uglifier) ? Jammit::Uglifier  : nil
     }
 
     DEFAULT_OPTIONS = {
-      :yui     => {:munge => true},
-      :closure => {}
+      :yui      => {:munge => true},
+      :closure  => {},
+      :uglifier => {:copyright => false}
     }
 
-    # Creating a compressor initializes the internal YUI Compressor from
-    # the "yui-compressor" gem, or the internal Closure Compiler from the
-    # "closure-compiler" gem.
+    # The css compressor is always the YUI Compressor. 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 || {})
@@ -98,7 +100,7 @@ module Jammit
       base_path   = find_base_path(paths)
       compiled    = paths.map do |path|
         contents  = read_binary_file(path)
-        contents  = contents.gsub(/\n/, '').gsub("'", '\\\\\'')
+        contents  = contents.gsub(/\r?\n/, "\\n").gsub("'", '\\\\\'')
         name      = template_name(path, base_path)
         "#{namespace}['#{name}'] = #{Jammit.template_function}('#{contents}');"
       end

data/lib/jammit/controller.rb

@@ -1,3 +1,5 @@
+require 'action_controller'
+
 module Jammit
 
   # The JammitController is added to your Rails application when the Gem is

data/lib/jammit/dependencies.rb

@@ -7,14 +7,28 @@ require 'base64'
 require 'pathname'
 require 'fileutils'
 
-# Gem Dependencies:
+# Include YUI as the default
 require 'yui/compressor'
-require 'closure-compiler'
+
+# Try Closure.
+begin
+  require 'closure-compiler'
+rescue LoadError
+  Jammit.compressors.delete :closure
+end
+
+# Try Uglifier.
+begin
+  require 'uglifier'
+rescue LoadError
+  Jammit.compressors.delete :uglifier
+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 'jammit/compressor'
 require 'jammit/packager'
 

data/lib/jammit/jst.js

@@ -1 +1 @@
-var template = function(str){var fn = new Function('obj', 'var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push(\''+str.replace(/[\r\t\n]/g, " ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');"); return fn;};
+var template = function(str){var fn = new Function('obj', 'var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push(\''+str.replace(/\\/g, '\\\\').replace(/'/g, "\\'").replace(/<%=([\s\S]+?)%>/g,function(match,code){return "',"+code.replace(/\\'/g, "'")+",'";}).replace(/<%([\s\S]+?)%>/g,function(match,code){return "');"+code.replace(/\\'/g, "'").replace(/[\r\n\t]/g,' ')+"__p.push('";}).replace(/\r/g,'\\r').replace(/\n/g,'\\n').replace(/\t/g,'\\t')+"');}return __p.join('');");return fn;};

data/lib/jammit/packager.rb

@@ -12,14 +12,15 @@ module Jammit
 
     # Set force to false to allow packages to only be rebuilt when their source
     # files have changed since the last time their package was built.
-    attr_accessor :force
+    attr_accessor :force, :package_names
 
     # Creating a new Packager will rebuild the list of assets from the
     # Jammit.configuration. When assets.yml is being changed on the fly,
     # create a new Packager.
     def initialize
-      @compressor = Compressor.new
-      @force = false
+      @compressor     = Compressor.new
+      @force          = false
+      @package_names  = nil
       @config = {
         :css => (Jammit.configuration[:stylesheets] || {}),
         :js  => (Jammit.configuration[:javascripts] || {})
@@ -42,8 +43,9 @@ module Jammit
         cache(p, 'css', pack_stylesheets(p), output_dir)
         if Jammit.embed_assets
           cache(p, 'css', pack_stylesheets(p, :datauri), output_dir, :datauri)
-          if Jammit.mhtml_enabled && base_url
-            mtime = Time.now
+          if Jammit.mhtml_enabled
+            raise MissingConfiguration, "A --base-url option is required in order to generate MHTML." unless base_url
+            mtime = latest_mtime package_for(p, :css)[:paths]
             asset_url = "#{base_url}#{Jammit.asset_url(p, :css, :mhtml, mtime)}"
             cache(p, 'css', pack_stylesheets(p, :mhtml, asset_url), output_dir, :mhtml, mtime)
           end
@@ -54,9 +56,10 @@ module Jammit
     # Caches a single prebuilt asset package and gzips it at the highest
     # compression level. Ensures that the modification time of both both
     # variants is identical, for web server caching modules, as well as MHTML.
-    def cache(package, extension, contents, output_dir, suffix=nil, mtime=Time.now)
+    def cache(package, extension, contents, output_dir, suffix=nil, mtime=nil)
       FileUtils.mkdir_p(output_dir) unless File.exists?(output_dir)
       raise OutputNotWritable, "Jammit doesn't have permission to write to \"#{output_dir}\"" unless File.writable?(output_dir)
+      mtime ||= latest_mtime package_for(package, extension.to_sym)[:paths]
       files = []
       files << file_name = File.join(output_dir, Jammit.filename(package, extension, suffix))
       File.open(file_name, 'wb+') {|f| f.write(contents) }
@@ -104,14 +107,21 @@ module Jammit
       Jammit.warn("No assets match '#{glob}'") if paths.empty?
       paths
     end
+    
+    # Get the latest mtime of a list of files (plus the config path).
+    def latest_mtime(paths)
+      paths += [Jammit.config_path]
+      paths.map {|p| File.mtime(p) }.max || Time.now
+    end
 
     # Return a list of all of the packages that should be cached. If "force" is
     # true, this is all of them -- otherwise only the packages that are missing
     # or whose source files have changed since the last package build.
     def cacheable(extension, output_dir)
       names = @packages[extension].keys
-      return names if @force
+      names = names.select {|n| @package_names.include? n } if @package_names
       config_mtime = File.mtime(Jammit.config_path)
+      return names if @force
       return names.select do |name|
         pack        = package_for(name, extension)
         cached      = [Jammit.filename(name, extension)]

data/lib/jammit/uglifier.rb

@@ -0,0 +1,3 @@
+class Jammit::Uglifier < ::Uglifier
+  alias :compress :compile
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jammit
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Jeremy Ashkenas
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-08 00:00:00 -05:00
-default_executable: 
+date: 2011-05-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: yui-compressor
@@ -26,30 +25,14 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 57
+        hash: 61
         segments: 
         - 0
         - 9
-        - 1
-        version: 0.9.1
+        - 3
+        version: 0.9.3
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: closure-compiler
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 1
-        - 0
-        version: 0.1.0
-  type: :runtime
-  version_requirements: *id002
 description: "    Jammit is an industrial strength asset packaging library for Rails,\n    providing both the CSS and JavaScript concatenation and compression that\n    you'd expect, as well as YUI Compressor and Closure Compiler compatibility,\n    ahead-of-time gzipping, built-in JavaScript template support, and optional\n    Data-URI / MHTML image embedding.\n"
 email: jeremy@documentcloud.org
 executables: 
@@ -68,13 +51,13 @@ files:
 - lib/jammit/packager.rb
 - lib/jammit/railtie.rb
 - lib/jammit/routes.rb
+- lib/jammit/uglifier.rb
 - lib/jammit.rb
 - bin/jammit
 - rails/routes.rb
 - jammit.gemspec
 - LICENSE
 - README
-has_rdoc: true
 homepage: http://documentcloud.github.com/jammit/
 licenses: []
 
@@ -110,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: jammit
-rubygems_version: 1.4.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Industrial Strength Asset Packaging for Rails