Merge branch 'master' into valid-mime-types

Author: Frank Macreery

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Jeremy Ashkenas, DocumentCloud
+Copyright (c) 2009-2011 Jeremy Ashkenas, DocumentCloud
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

index.html

@@ -93,7 +93,7 @@
     </p>
 
     <p>
-      <b>Current Version:</b> <a href="http://rubygems.org/gems/jammit/">0.6.3</a>
+      <b>Current Version:</b> <a href="http://rubygems.org/gems/jammit/">0.6.5</a>
     </p>
 
     <p>
@@ -692,6 +692,12 @@ <h2 id="jst">JavaScript Templates</h2>
 
     <h2 id="changes">Change Log</h2>
 
+    <p>
+      <b class="header">0.6.5</b> &mdash; <small><i>Nov 30, 2011</i></small><br />
+      Added the ability to pass HTML tag options to <tt>include_javascripts</tt>.
+      Fixed a bug that would always cause JS to be recompiled, regardless of mtimes.
+    </p>
+    
     <p>
       <b class="header">0.6.3</b> &mdash; <small><i>May 26, 2011</i></small><br />
       Quick bugfix release for Rails 3.1 compatibility, which changes the method

jammit.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name      = 'jammit'
-  s.version   = '0.6.3'         # Keep version in sync with jammit.rb
-  s.date      = '2011-05-26'
+  s.version   = '0.6.5'         # Keep version in sync with jammit.rb
+  s.date      = '2011-11-30'
 
   s.homepage    = "http://documentcloud.github.com/jammit/"
   s.summary     = "Industrial Strength Asset Packaging for Rails"

lib/jammit.rb

@@ -4,13 +4,13 @@
 # to all of the configuration options.
 module Jammit
 
-  VERSION               = "0.6.3"
+  VERSION               = "0.6.5"
 
   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)
 
-  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')
 
@@ -51,12 +51,14 @@ class << self
                   :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
+                  :template_extension, :template_extension_matcher, :allow_debugging,
+                  :public_root
     attr_accessor :compressors
   end
 
   # The minimal required configuration.
   @configuration  = {}
+  @public_root    = DEFAULT_PUBLIC_ROOT
   @package_path   = DEFAULT_PACKAGE_PATH
   @compressors    = COMPRESSORS
 
@@ -87,6 +89,7 @@ def self.load_configuration(config_path, soft=false)
     set_template_function(conf[:template_function])
     set_template_namespace(conf[:template_namespace])
     set_template_extension(conf[:template_extension])
+    set_public_root(conf[:public_root]) if conf[:public_root]
     symbolize_keys(conf[:stylesheets]) if conf[:stylesheets]
     symbolize_keys(conf[:javascripts]) if conf[:javascripts]
     check_for_deprecations
@@ -124,16 +127,24 @@ def self.package!(options={})
       :config_path    => Jammit::DEFAULT_CONFIG_PATH,
       :output_folder  => nil,
       :base_url       => nil,
+      :public_root    => nil,
       :force          => false
     }.merge(options)
     load_configuration(options[:config_path])
+    set_public_root(options[:public_root]) if options[:public_root]
     packager.force         = options[:force]
     packager.package_names = options[:package_names]
     packager.precache_all(options[:output_folder], options[:base_url])
   end
 
   private
 
+  # Allows command-line definition of `PUBLIC_ROOT`, for those using Jammit
+  # outside of Rails.
+  def self.set_public_root(public_root=nil)
+    @public_root = public_root if public_root
+  end
+
   # Ensure that the JavaScript compressor is a valid choice.
   def self.set_javascript_compressor(value)
     value = value && value.to_sym

lib/jammit/command_line.rb

@@ -66,6 +66,10 @@ def parse_options
         opts.on('-p', '--packages LIST', 'list of packages to build (ex: "core,ui", default: all)') do |package_names|
           @options[:package_names] = package_names.split(/,\s*/).map {|n| n.to_sym }
         end
+        opts.on('-P', '--public-root PATH', 'path to public assets (default: "public")') do |public_root|
+          puts "Option for PUBLIC_ROOT"
+          @options[:public_root] = public_root
+        end
         opts.on_tail('-v', '--version', 'display Jammit version') do
           puts "Jammit version #{Jammit::VERSION}"
           exit

lib/jammit/compressor.rb

@@ -187,14 +187,14 @@ def construct_asset_path(asset_path, css_path, variant)
     # not be relative, given the path of the stylesheet that contains it.
     def absolute_path(asset_pathname, css_pathname)
       (asset_pathname.absolute? ?
-        Pathname.new(File.join(PUBLIC_ROOT, asset_pathname)) :
+        Pathname.new(File.join(Jammit.public_root, asset_pathname)) :
         css_pathname.dirname + asset_pathname).cleanpath
     end
 
     # CSS assets that are referenced by relative paths, and are *not* being
     # embedded, must be rewritten relative to the newly-merged stylesheet path.
     def relative_path(absolute_path)
-      File.join('../', absolute_path.sub(PUBLIC_ROOT, ''))
+      File.join('../', absolute_path.sub(Jammit.public_root, ''))
     end
 
     # Similar to the AssetTagHelper's method of the same name, this will
@@ -246,7 +246,7 @@ def concatenate(paths)
 
     # `File.read`, but in "binary" mode.
     def read_binary_file(path)
-      File.open(path, 'rb') {|f| f.read }
+      File.open(path, 'rb:UTF-8') {|f| f.read }
     end
   end
 

lib/jammit/controller.rb

@@ -11,7 +11,7 @@ class Controller < ActionController::Base
 
     SUFFIX_STRIPPER = /-(datauri|mhtml)\Z/
 
-    NOT_FOUND_PATH  = "#{PUBLIC_ROOT}/404.html"
+    NOT_FOUND_PATH  = "#{Jammit.public_root}/404.html"
 
     # The "package" action receives all requests for asset packages that haven't
     # yet been cached. The package will be built, cached, and gzipped.

lib/jammit/helper.rb

@@ -25,10 +25,11 @@ def include_stylesheets(*packages)
     # Writes out the URL to the bundled and compressed javascript package,
     # except in development, where it references the individual scripts.
     def include_javascripts(*packages)
+      options = packages.extract_options!
       html_safe packages.map {|pack|
         should_package? ? Jammit.asset_url(pack, :js) : Jammit.packager.individual_urls(pack.to_sym, :js)
       }.flatten.map {|pack|
-        javascript_include_tag pack
+        javascript_include_tag pack, options
       }.join("\n")
     end
 
@@ -72,8 +73,8 @@ def embedded_image_stylesheets(packages, options)
     # Generate the stylesheet tags for a batch of packages, with options, by
     # yielding each package to a block.
     def tags_with_options(packages, options)
-      packages.dup.map {|package| 
-        yield package 
+      packages.dup.map {|package|
+        yield package
       }.flatten.map {|package|
         stylesheet_link_tag package, options
       }.join("\n")

lib/jammit/packager.rb

@@ -6,10 +6,6 @@ module Jammit
   # with the correct timestamps.
   class Packager
 
-    # In Rails, the difference between a path and an asset URL is "public".
-    PATH_DIFF   = PUBLIC_ROOT.sub(ASSET_ROOT, '')
-    PATH_TO_URL = /\A#{Regexp.escape(ASSET_ROOT)}(\/?#{Regexp.escape(PATH_DIFF)})?/
-
     # 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, :package_names
@@ -37,7 +33,7 @@ def initialize
     # Unless forced, will only rebuild assets whose source files have been
     # changed since their last package build.
     def precache_all(output_dir=nil, base_url=nil)
-      output_dir ||= File.join(PUBLIC_ROOT, Jammit.package_path)
+      output_dir ||= File.join(Jammit.public_root, Jammit.package_path)
       cacheable(:js, output_dir).each  {|p| cache(p, 'js',  pack_javascripts(p), output_dir) }
       cacheable(:css, output_dir).each do |p|
         cache(p, 'css', pack_stylesheets(p), output_dir)
@@ -89,6 +85,7 @@ def pack_javascripts(package)
     def pack_templates(package)
       @compressor.compile_jst(package_for(package, :js)[:paths])
     end
+  
 
     private
 
@@ -107,6 +104,11 @@ def glob_files(glob)
       Jammit.warn("No assets match '#{glob}'") if paths.empty?
       paths
     end
+
+    # In Rails, the difference between a path and an asset URL is "public".    
+    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)
@@ -125,8 +127,10 @@ def cacheable(extension, output_dir)
       return names.select do |name|
         pack        = package_for(name, extension)
         cached      = [Jammit.filename(name, extension)]
-        cached.push Jammit.filename(name, extension, :datauri) if Jammit.embed_assets
-        cached.push Jammit.filename(name, extension, :mhtml) if Jammit.mhtml_enabled
+        if extension == :css
+          cached.push Jammit.filename(name, extension, :datauri) if Jammit.embed_assets
+          cached.push Jammit.filename(name, extension, :mhtml) if Jammit.mhtml_enabled
+        end
         cached.map! {|file| File.join(output_dir, file) }
         if cached.any? {|file| !File.exists?(file) }
           true
@@ -153,10 +157,10 @@ def create_packages(config)
         paths                  = globs.flatten.uniq.map {|glob| glob_files(glob) }.flatten.uniq
         packages[name][:paths] = paths
         if !paths.grep(Jammit.template_extension_matcher).empty?
-          packages[name][:urls] = paths.grep(JS_EXTENSION).map {|path| path.sub(PATH_TO_URL, '') }
+          packages[name][:urls] = paths.grep(JS_EXTENSION).map {|path| path.sub(path_to_url, '') }
           packages[name][:urls] += [Jammit.asset_url(name, Jammit.template_extension)]
         else
-          packages[name][:urls] = paths.map {|path| path.sub(PATH_TO_URL, '') }
+          packages[name][:urls] = paths.map {|path| path.sub(path_to_url, '') }
         end
       end
       packages