ee_jammit 0.6.6

data/lib/jammit/controller.rb

@@ -0,0 +1,97 @@
+require 'action_controller'
+
+module Jammit
+
+  # The JammitController is added to your Rails application when the Gem is
+  # loaded. It takes responsibility for /assets, and dynamically packages any
+  # missing or uncached asset packages.
+  class Controller < ActionController::Base
+
+    VALID_FORMATS   = [:css, :js]
+
+    SUFFIX_STRIPPER = /-(datauri|mhtml)\Z/
+
+    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.
+    def package
+      parse_request
+      template_ext = Jammit.template_extension.to_sym
+      case @extension
+      when :js
+        render :js => (@contents = Jammit.packager.pack_javascripts(@package))
+      when template_ext
+        render :js => (@contents = Jammit.packager.pack_templates(@package))
+      when :css
+        render :text => generate_stylesheets, :content_type => 'text/css'
+      end
+      cache_package if perform_caching && (@extension != template_ext)
+    rescue Jammit::PackageNotFound
+      package_not_found
+    end
+
+
+    private
+
+    # Tells the Jammit::Packager to cache and gzip an asset package. We can't
+    # just use the built-in "cache_page" because we need to ensure that
+    # the timestamp that ends up in the MHTML is also on the cached file.
+    def cache_package
+      dir = File.join(page_cache_directory, Jammit.package_path)
+      Jammit.packager.cache(@package, @extension, @contents, dir, @variant, @mtime)
+    end
+
+    # Generate the complete, timestamped, MHTML url -- if we're rendering a
+    # dynamic MHTML package, we'll need to put one URL in the response, and a
+    # different one into the cached package.
+    def prefix_url(path)
+      host = request.port == 80 ? request.host : request.host_with_port
+      "#{request.protocol}#{host}#{path}"
+    end
+
+    # If we're generating MHTML/CSS, return a stylesheet with the absolute
+    # request URL to the client, and cache a version with the timestamped cache
+    # URL swapped in.
+    def generate_stylesheets
+      return @contents = Jammit.packager.pack_stylesheets(@package, @variant) unless @variant == :mhtml
+      @mtime      = Time.now
+      request_url = prefix_url(request.fullpath)
+      cached_url  = prefix_url(Jammit.asset_url(@package, @extension, @variant, @mtime))
+      css         = Jammit.packager.pack_stylesheets(@package, @variant, request_url)
+      @contents   = css.gsub(request_url, cached_url) if perform_caching
+      css
+    end
+
+    # Extracts the package name, extension (:css, :js), and variant (:datauri,
+    # :mhtml) from the incoming URL.
+    def parse_request
+      pack       = params[:package]
+      @extension = params[:extension].to_sym
+      raise PackageNotFound unless (VALID_FORMATS + [Jammit.template_extension.to_sym]).include?(@extension)
+      if Jammit.embed_assets
+        suffix_match = pack.match(SUFFIX_STRIPPER)
+        @variant = Jammit.embed_assets && suffix_match && suffix_match[1].to_sym
+        pack.sub!(SUFFIX_STRIPPER, '')
+      end
+      @package = pack.to_sym
+    end
+
+    # Render the 404 page, if one exists, for any packages that don't.
+    def package_not_found
+      return render(:file => NOT_FOUND_PATH, :status => 404) if File.exists?(NOT_FOUND_PATH)
+      render :text => "<h1>404: \"#{@package}\" asset package not found.</h1>", :status => 404
+    end
+
+  end
+
+end
+
+# Make the Jammit::Controller available to Rails as a top-level controller.
+::JammitController = Jammit::Controller
+
+if defined?(Rails) && Rails.env.development?
+  ActionController::Base.class_eval do
+    append_before_filter { Jammit.reload! }
+  end
+end

data/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

data/lib/jammit/dependencies.rb

@@ -0,0 +1,61 @@
+# Standard Library Dependencies:
+require 'uri'
+require 'erb'
+require 'zlib'
+require 'yaml'
+require 'base64'
+require 'pathname'
+require 'fileutils'
+
+# 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.javascript_compressors.delete :closure
+end
+
+# Try Sass
+begin
+  require 'sass'
+  require 'jammit/sass_compressor'
+rescue LoadError
+  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 'jsmin'
+require 'cssmin'
+require 'jammit/jsmin_compressor'
+require 'jammit/cssmin_compressor'
+require 'jammit/compressor'
+require 'jammit/packager'
+require 'jammit/helper'
+require 'jammit/middleware'
+
+# Jammit Rails Integration:
+if defined?(Rails)
+  require 'jammit/controller'
+  require 'jammit/helper'
+  require 'jammit/railtie'
+  require 'jammit/routes'
+end
+

data/lib/jammit/helper.rb

@@ -0,0 +1,88 @@
+module Jammit
+
+  # The Jammit::Helper module, which is made available to every view, provides
+  # helpers for writing out HTML tags for asset packages. In development you
+  # get the ordered list of source files -- in any other environment, a link
+  # to the cached packages.
+  module Helper
+
+    DATA_URI_START = "<!--[if (!IE)|(gte IE 8)]><!-->" unless defined?(DATA_URI_START)
+    DATA_URI_END   = "<!--<![endif]-->"                unless defined?(DATA_URI_END)
+    MHTML_START    = "<!--[if lte IE 7]>"              unless defined?(MHTML_START)
+    MHTML_END      = "<![endif]-->"                    unless defined?(MHTML_END)
+
+    # If embed_assets is turned on, writes out links to the Data-URI and MHTML
+    # versions of the stylesheet package, otherwise the package is regular
+    # compressed CSS, and in development the stylesheet URLs are passed verbatim.
+    def include_stylesheets(*packages)
+      options = packages.extract_options!
+      return html_safe(individual_stylesheets(packages, options)) unless should_package?
+      disabled = (options.delete(:embed_assets) == false) || (options.delete(:embed_images) == false)
+      return html_safe(packaged_stylesheets(packages, options)) if disabled || !Jammit.embed_assets
+      return html_safe(embedded_image_stylesheets(packages, options))
+    end
+
+    # 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, options
+      }.join("\n")
+    end
+
+    # Writes out the URL to the concatenated and compiled JST file -- we always
+    # have to pre-process it, even in development.
+    def include_templates(*packages)
+      raise DeprecationError, "Jammit 0.5+ no longer supports separate packages for templates.\nYou can include your JST alongside your JS, and use include_javascripts."
+    end
+
+
+    private
+
+    def should_package?
+      Jammit.package_assets && !(Jammit.allow_debugging && params[:debug_assets])
+    end
+
+    def html_safe(string)
+      string.respond_to?(:html_safe) ? string.html_safe : string
+    end
+
+    # HTML tags, in order, for all of the individual stylesheets.
+    def individual_stylesheets(packages, options)
+      tags_with_options(packages, options) {|p| Jammit.packager.individual_urls(p.to_sym, :css) }
+    end
+
+    # HTML tags for the stylesheet packages.
+    def packaged_stylesheets(packages, options)
+      tags_with_options(packages, options) {|p| Jammit.asset_url(p, :css) }
+    end
+
+    # HTML tags for the 'datauri', and 'mhtml' versions of the packaged
+    # stylesheets, using conditional comments to load the correct variant.
+    def embedded_image_stylesheets(packages, options)
+      datauri_tags = tags_with_options(packages, options) {|p| Jammit.asset_url(p, :css, :datauri) }
+      ie_tags = Jammit.mhtml_enabled ?
+                tags_with_options(packages, options) {|p| Jammit.asset_url(p, :css, :mhtml) } :
+                packaged_stylesheets(packages, options)
+      [DATA_URI_START, datauri_tags, DATA_URI_END, MHTML_START, ie_tags, MHTML_END].join("\n")
+    end
+
+    # 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
+      }.flatten.map {|package|
+        stylesheet_link_tag package, options
+      }.join("\n")
+    end
+
+  end
+
+end
+
+# Include the Jammit asset helpers in all views, a-la ApplicationHelper.
+::ActionView::Base.send(:include, Jammit::Helper) if defined?(::ActionView)

data/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

data/lib/jammit/jst.js

@@ -0,0 +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(/\\/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/middleware.rb

@@ -0,0 +1,115 @@
+module Jammit
+
+  # Rack Middle that allows Jammit to integrate with any Rack compatible web
+  # framework.  It takes responsibility for /assets, and dynamically packages
+  # any missing or uncached asset packages.
+
+  class Middleware
+
+    VALID_FORMATS   = [:css, :js]
+
+    SUFFIX_STRIPPER = /-(datauri|mhtml)\Z/
+
+    PUBLIC_ROOT     = defined?(Jammit.public_root) ? Jammit.public_root : PUBLIC_ROOT
+    NOT_FOUND_PATH  = "#{PUBLIC_ROOT}/404.html"
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      if matches = %r(^/#{Jammit.package_path}/(.*)\.(.*)).match(env['PATH_INFO'])
+        package(matches[1].to_s, matches[2] || "none")
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    # The "package" action receives all requests for asset packages that haven't
+    # yet been cached. The package will be built, cached, and gzipped.
+    def package(package, extension)
+      parse_request(package, extension)
+      template_ext = Jammit.template_extension.to_sym
+      result = []
+
+      headers = {
+        'Cache-Control' => "public, max-age=#{(60*60*24*365.25*10).to_i}",
+        'Expires' => (Time.now + 60*60*24*365.25*10).httpdate
+      }
+
+      case @extension
+      when :js
+        @contents = Jammit.packager.pack_javascripts(@package)
+        @contents = @contents.to_js if @contents.respond_to?(:to_js)
+        result = [
+          200,
+          headers.merge({
+            'Content-Type' => Rack::Mime.mime_type(".js")
+          }),
+          [@contents]
+        ]
+      when template_ext
+        @contents = Jammit.packager.pack_templates(@package)
+        @contents = @contents.to_js if @contents.respond_to?(:to_js)
+        [
+          200,
+          headers.merge({
+            'Content-Type' => Rack::Mime.mime_type(".js")
+          }),
+          [@contents]
+        ]
+      when :css
+        [
+          200,
+          headers.merge({
+            'Content-Type' => Rack::Mime.mime_type(".css")
+          }),
+          [generate_stylesheets]
+        ]
+      end
+    rescue Jammit::PackageNotFound
+      [404, {'Content-Type' => 'text/plain'}, ['Not found']]
+    end
+
+    # Generate the complete, timestamped, MHTML url -- if we're rendering a
+    # dynamic MHTML package, we'll need to put one URL in the response, and a
+    # different one into the cached package.
+    def prefix_url(path)
+      host = request.port == 80 ? request.host : request.host_with_port
+      "#{request.protocol}#{host}#{path}"
+    end
+
+    # If we're generating MHTML/CSS, return a stylesheet with the absolute
+    # request URL to the client, and cache a version with the timestamped cache
+    # URL swapped in.
+    def generate_stylesheets
+      return @contents = Jammit.packager.pack_stylesheets(@package, @variant) unless @variant == :mhtml
+      @mtime      = Time.now
+      request_url = prefix_url(request.fullpath)
+      cached_url  = prefix_url(Jammit.asset_url(@package, @extension, @variant, @mtime))
+      css         = Jammit.packager.pack_stylesheets(@package, @variant, request_url)
+      # @contents   = css.gsub(request_url, cached_url) if perform_caching
+      css
+    end
+
+    # Extracts the package name, extension (:css, :js), and variant (:datauri,
+    # :mhtml) from the incoming URL.
+    def parse_request(pack, extension)
+      @extension = extension.to_sym
+      raise PackageNotFound unless (VALID_FORMATS + [Jammit.template_extension.to_sym]).include?(@extension)
+      if Jammit.embed_assets
+        suffix_match = pack.match(SUFFIX_STRIPPER)
+        @variant = Jammit.embed_assets && suffix_match && suffix_match[1].to_sym
+        pack.sub!(SUFFIX_STRIPPER, '')
+      end
+      @package = pack.to_sym
+    end
+
+  end
+end

data/lib/jammit/packager.rb

@@ -0,0 +1,179 @@
+module Jammit
+
+  # The Jammit::Packager resolves the configuration file into lists of real
+  # assets that get merged into individual asset packages. Given the compiled
+  # contents of an asset package, the Packager knows how to cache that package
+  # with the correct timestamps.
+  class Packager
+
+    # 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
+
+    # 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
+      @force          = false
+      @package_names  = nil
+      @config = {
+        :css => (Jammit.configuration[:stylesheets] || {}),
+        :js  => (Jammit.configuration[:javascripts] || {})
+      }
+      @packages = {
+        :css => create_packages(@config[:css]),
+        :js  => create_packages(@config[:js])
+      }
+    end
+
+    # Ask the packager to precache all defined assets, along with their gzip'd
+    # versions. In order to prebuild the MHTML stylesheets, we need to know the
+    # base_url, because IE only supports MHTML with absolute references.
+    # 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(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)
+        if Jammit.embed_assets
+          cache(p, 'css', pack_stylesheets(p, :datauri), output_dir, :datauri)
+          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
+        end
+      end
+    end
+
+    # 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=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) }
+      if Jammit.gzip_assets
+        files << zip_name = "#{file_name}.gz"
+        Zlib::GzipWriter.open(zip_name, Zlib::BEST_COMPRESSION) {|f| f.write(contents) }
+      end
+      File.utime(mtime, mtime, *files)
+    end
+
+    # Get the list of individual assets for a package.
+    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)
+    end
+
+    # Return the compressed contents of a javascript package.
+    def pack_javascripts(package)
+      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])
+    end
+
+
+    private
+
+    # Look up a package asset list by name, raising an exception if the
+    # package has gone missing.
+    def package_for(package, extension)
+      pack = @packages[extension] && @packages[extension][package]
+      pack || not_found(package, extension)
+    end
+
+    # Absolute globs are absolute -- relative globs are relative to ASSET_ROOT.
+    # Print a warning if no files were found that match the glob.
+    def glob_files(glob)
+      absolute = Pathname.new(glob).absolute?
+      paths = Dir[absolute ? glob : File.join(ASSET_ROOT, glob)].sort
+      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)
+      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
+      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)]
+        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
+        else
+          since = cached.map {|file| File.mtime(file) }.min
+          config_mtime > since || pack[:paths].any? {|src| File.mtime(src) > since }
+        end
+      end
+    end
+
+    # Compiles the list of assets that goes into each package. Runs an
+    # ordered list of Dir.globs, taking the merged unique result.
+    # If there are JST files in this package we need to add an extra
+    # path for when package_assets is off (e.g. in a dev environment).
+    # This package (e.g. /assets/package-name.jst) will never exist as
+    # an actual file but will be dynamically generated by Jammit on
+    # every request.
+    def create_packages(config)
+      packages = {}
+      return packages if !config
+      config.each do |name, globs|
+        globs                  ||= []
+        packages[name]         = {}
+        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] += [Jammit.asset_url(name, Jammit.template_extension)]
+        else
+          packages[name][:urls] = paths.map {|path| path.sub(path_to_url, '') }
+        end
+      end
+      packages
+    end
+
+    # Raise a PackageNotFound exception for missing packages...
+    def not_found(package, extension)
+      raise PackageNotFound, "assets.yml does not contain a \"#{package}\" #{extension.to_s.upcase} package"
+    end
+
+  end
+
+end