asset_hat 0.1.0

data/config/assets.yml

@@ -0,0 +1,59 @@
+# This belongs in your app's `config` directory. Configure your bundles
+# below; no `.css` or `.js` suffixes needed. Example:
+#
+#     css:
+#       engine: cssmin
+#       bundles:
+#         application:
+#           - reset
+#           - application
+#           - clearfix
+#         admin:
+#           - reset
+#           - admin
+#           - clearfix
+#     js:
+#       engine: jsmin
+#       vendors:
+#         jquery:
+#           version: 1.4
+#       bundles:
+#         plugins:
+#           - init
+#           - third-party-plugin.min
+#             # Here, the suffix `.min` indicates that the code has already
+#             # been minified, and should not be re-minified.
+#         common:
+#           - utilities
+#           - application
+
+css:
+  engine: cssmin
+  bundles:
+    css-bundle-1:
+      - css-file-1-1
+      - css-file-1-2
+      - css-file-1-3
+    css-bundle-2:
+      - css-file-2-1
+      - css-file-2-2
+      - css-file-2-3
+    css-bundle-3:
+      - css-file-3-1
+      - css-file-3-2
+      - css-file-3-3
+js:
+  engine: jsmin
+  bundles:
+    js-bundle-1:
+      - js-file-1-1
+      - js-file-1-2
+      - js-file-1-3
+    js-bundle-2:
+      - js-file-2-1
+      - js-file-2-2
+      - js-file-2-3
+    js-bundle-3:
+      - js-file-3-1
+      - js-file-3-2
+      - js-file-3-3

data/lib/asset_hat.rb

@@ -0,0 +1,85 @@
+%w[css js vcs].each do |x|
+  require File.join(File.dirname(__FILE__), 'asset_hat', x)
+end
+
+module AssetHat
+  RAILS_ROOT      = File.join(File.dirname(__FILE__), '..') unless defined?(RAILS_ROOT)
+  TYPES           = [:css, :js]
+  ASSETS_DIR      = defined?(Rails.public_path) ? Rails.public_path : 'public'
+  JAVASCRIPTS_DIR = "#{ASSETS_DIR}/javascripts"
+  STYLESHEETS_DIR = "#{ASSETS_DIR}/stylesheets"
+  CONFIG_FILEPATH = File.join(RAILS_ROOT, 'config', 'assets.yml')
+
+  def self.config
+    @@config ||= YAML.load(File.open(CONFIG_FILEPATH, 'r'))
+  end
+
+  def self.assets_dir(type)
+    case type.to_sym
+    when :css ; STYLESHEETS_DIR
+    when :js  ; JAVASCRIPTS_DIR
+    end
+  end
+
+  def self.asset_exists?(filename, type)
+    # Process arguments
+    type = type.to_sym
+    unless TYPES.include?(type)
+      raise "Unknown type \"#{type}\"; should be one of: #{TYPES.join(', ')}."
+      return
+    end
+
+    @@asset_exists ||= TYPES.inject({}) do |hsh, known_type|
+      hsh.merge!(known_type => {})
+    end
+    if @@asset_exists[type][filename].nil?
+      @@asset_exists[type][filename] =
+        File.exist?(File.join(self.assets_dir(type), filename))
+    end
+    @@asset_exists[type][filename]
+  end
+
+  def self.cache? ; ActionController::Base.perform_caching ; end
+
+  def self.min_filepath(filepath, extension)
+    filepath.sub(/([^\.]*).#{extension}$/, "\\1.min.#{extension}")
+  end
+
+  def self.bundle_filenames(bundle, type)
+    # Usage:
+    #
+    #     AssetHat.bundle_filenames('application', :css)
+    #       # => ['reset', 'application', 'clearfix']
+    #     AssetHat.bundle_filenames('non-existent-file', :css)
+    #       # => nil
+
+    # Process arguments
+    unless TYPES.include?(type.to_sym)
+      raise "Unknown type \"#{type}\"; should be one of: #{TYPES.join(', ')}."
+      return
+    end
+
+    self.config[type.to_s]['bundles'][bundle] rescue nil
+  end
+
+  def self.bundle_filepaths(bundle, type)
+    # Usage:
+    #
+    #     AssetHat.bundle_filenames('application', :css)
+    #       # => ['reset', 'application', 'clearfix']
+    #     AssetHat.bundle_filenames('non-existent-file', :css)
+    #       # => nil
+
+    # Process arguments
+    unless TYPES.include?(type.to_sym)
+      raise "Unknown type \"#{type}\"; should be one of: #{TYPES.join(', ')}."
+      return
+    end
+
+    dir = self.assets_dir(type)
+    filenames = self.bundle_filenames(bundle, type)
+    filepaths = filenames.present? ?
+      filenames.map { |fn| File.join(dir, "#{fn}.#{type}") } : nil
+  end
+
+end

data/lib/asset_hat/css.rb

@@ -0,0 +1,76 @@
+require 'cssmin'
+  # - http://github.com/rgrove/cssmin
+  # - http://gemcutter.org/gems/cssmin
+
+module AssetHat
+  module CSS
+    ENGINES = [:weak, :cssmin]
+
+    def self.min_filepath(filepath)
+      AssetHat.min_filepath(filepath, 'css')
+    end
+
+    def self.minify(input_string, options={})
+      options.reverse_merge!(:engine => :cssmin)
+
+      options[:engine] = options[:engine].to_sym
+      unless ENGINES.include?(options[:engine])
+        raise %Q{
+          Unknown CSS minification engine '#{options[:engine]}'.
+          Allowed: #{ENGINES.map{ |e| "'#{e}'" }.join(', ')}
+        }.strip.gsub(/\s+/, ' ') and return
+      end
+
+      AssetHat::CSS::Engines.send(options[:engine], input_string)
+    end
+
+    # def self.add_asset_mtimes(css)
+    #   css.gsub(/url[\s]*\((\/images\/[^)]+)\)/) do |match|
+    #     src = $1
+    #     mtime = File.mtime(File.join(Rails.public_path, src))
+    #     "url(#{src}?#{mtime.to_i})"
+    #   end
+    # end
+
+    def self.add_asset_commit_ids(css)
+      css.gsub(/url[\s]*\((\/images\/[^)]+)\)/) do |match|
+        src = $1
+        filepath = File.join(Rails.public_path, src)
+        commit_id = AssetHat.last_commit_id(filepath)
+        commit_id.present? ? "url(#{src}?#{commit_id})" : "url(#{src})"
+      end
+    end
+
+    def self.add_asset_hosts(css, asset_host)
+      return if asset_host.blank?
+      css.gsub(/url[\s]*\((\/images\/[^)]+)\)/) do |match|
+        src = $1
+        "url(#{(asset_host =~ /%d/) ? asset_host % (src.hash % 4) : asset_host}#{src})"
+      end
+    end
+
+    module Engines
+      def self.weak(input_string)
+        input   = StringIO.new(input_string)
+        output  = StringIO.new
+
+        input.each do |line|
+          # Remove indentation and trailing whitespace (including line breaks)
+          line.strip!
+          next if line.blank?
+
+          output.write line
+        end
+
+        output.rewind
+        output.read
+      end
+
+      def self.cssmin(input_string)
+        CSSMin.minify(input_string)
+      end
+    end
+
+  end
+
+end

data/lib/asset_hat/js.rb

@@ -0,0 +1,86 @@
+require 'jsmin'
+  # - http://github.com/rgrove/jsmin
+  # - http://gemcutter.org/gems/jsmin
+
+module AssetHat
+  module JS
+    ENGINES = [:weak, :jsmin]
+    VENDORS = [:jquery]
+      # TODO: Support jQuery UI, Prototype, MooTools, etc.
+
+    def self.min_filepath(filepath)
+      AssetHat.min_filepath(filepath, 'js')
+    end
+
+    def self.minify(input_string, options={})
+      options.reverse_merge!(:engine => :jsmin)
+
+      options[:engine] = options[:engine].to_sym
+      unless ENGINES.include?(options[:engine])
+        raise %Q{
+          Unknown JS minification engine '#{options[:engine]}'.
+          Allowed: #{ENGINES.map{ |e| "'#{e}'" }.join(', ')}
+        }.strip.gsub(/\s+/, ' ') and return
+      end
+
+      AssetHat::JS::Engines.send(options[:engine], input_string)
+    end
+
+    module Engines
+      def self.weak(input_string)
+        input   = StringIO.new(input_string)
+        output  = StringIO.new
+
+        input.each do |line|
+          # Remove indentation and trailing whitespace
+          line.strip!
+          next if line.blank?
+
+          # Skip single-line comments
+          next if !(line =~ /^\/\//).nil?
+          # TODO: Also skip single-line comments that began mid-line, but not
+          #       inside a string or regex
+
+          # TODO: Skip multi-line comments
+          # - Should not strip from within a string or regex
+          # - Should not strip comments that begin with `/*!` (e.g., licenses)
+
+          output.write(line + "\n")
+        end
+
+        output.rewind
+        output.read
+      end
+
+      def self.jsmin(input_string)
+        JSMin.minify(input_string)
+      end
+    end # module Engines
+
+    module Vendors
+      JQUERY_DEFAULT_VERSION = '1.4'
+
+      def self.source_for(vendor, options={})
+        version = options[:version]
+        if version.blank?
+          version = begin
+            AssetHat.config['js']['vendors'][vendor.to_s]['version']
+          rescue
+            AssetHat::JS::Vendors.const_get(
+              :"#{vendor.to_s.upcase}_DEFAULT_VERSION")
+          end
+        end
+
+        case vendor
+        when :jquery
+          src = ActionController::Base.consider_all_requests_local ?
+            "jquery-#{version}.min.js" :
+            "http://ajax.googleapis.com/ajax/libs/jquery/#{version}/jquery.min.js"
+        end
+        src
+      end
+    end # module Vendors
+
+  end
+
+end

data/lib/asset_hat/tasks.rb

@@ -0,0 +1,296 @@
+require 'rake/testtask'
+require 'active_support'
+require 'action_controller'
+require 'action_view'
+require File.join(File.dirname(__FILE__), %w[.. asset_hat])
+
+
+
+unless defined?(RAILS_ROOT)
+  RAILS_ROOT = File.join(File.dirname(__FILE__), '..', '..')
+end
+
+task :default => :test
+
+desc 'Run tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+
+namespace :asset_hat do
+  desc 'Minifies all CSS and JS bundles'
+  task :minify do
+    Rake::Task['asset_hat:css:minify'].invoke # Generate all CSS bundles
+    Rake::Task['asset_hat:js:minify'].invoke  # Generate all JS bundles
+  end
+
+  desc 'Prepare configuration file'
+  task :config do
+    template_filepath =
+      File.join(File.dirname(__FILE__), '..', '..', AssetHat::CONFIG_FILEPATH)
+    target_filepath = File.join(RAILS_ROOT, AssetHat::CONFIG_FILEPATH)
+
+    if File.exists?(target_filepath)
+      print "Replace #{target_filepath}? (y/n) "
+      response = STDIN.gets.chomp
+      unless response.downcase == 'y'
+        puts 'Aborted.' ; exit
+      end
+    end
+
+    FileUtils.cp(template_filepath, target_filepath)
+    puts "Wrote to #{target_filepath}"
+  end
+
+  namespace :css do
+    # desc 'Adds mtimes to asset URLs in CSS'
+    # task :add_asset_mtimes, :filename, :verbose do |t, args|
+    #   if args.filename.blank?
+    #     raise 'Usage: rake asset_hat:css:add_asset_mtimes[filename.css]' and return
+    #   end
+    #
+    #   args.with_defaults :verbose => true
+    #
+    #   css = File.open(args.filename, 'r') { |f| f.read }
+    #   css = AssetHat::CSS.add_asset_mtimes(css)
+    #   File.open(args.filename, 'w') { |f| f.write css }
+    #
+    #   puts "- Added asset mtimes to #{args.filename}" if args.verbose
+    # end
+
+    desc 'Adds commit IDs to asset URLs in CSS for cache busting'
+    task :add_asset_commit_ids, :filename, :verbose do |t, args|
+      if args.filename.blank?
+        raise 'Usage: rake asset_hat:css:add_asset_commit_ids[filename.css]' and return
+      end
+
+      args.with_defaults :verbose => true
+
+      css = File.open(args.filename, 'r') { |f| f.read }
+      css = AssetHat::CSS.add_asset_commit_ids(css)
+      File.open(args.filename, 'w') { |f| f.write css }
+
+      puts "- Added asset commit IDs to #{args.filename}" if args.verbose
+    end
+
+    desc 'Adds hosts to asset URLs in CSS'
+    task :add_asset_hosts, :filename, :verbose, :needs => :environment do |t, args|
+      if args.filename.blank?
+        raise 'Usage: rake asset_hat:css:add_asset_hosts[filename.css]' and return
+      end
+
+      args.with_defaults :verbose => true
+
+      asset_host = ActionController::Base.asset_host
+      if asset_host.blank?
+        raise "This environment (#{ENV['RAILS_ENV']}) doesn't have an `asset_host` configured."
+        return
+      end
+
+      css = File.open(args.filename, 'r') { |f| f.read }
+      css = AssetHat::CSS.add_asset_hosts(css, asset_host)
+      File.open(args.filename, 'w') { |f| f.write css }
+
+      puts "- Added asset hosts to #{args.filename}" if args.verbose
+    end
+
+    desc 'Minifies one CSS file'
+    task :minify_file, :filepath, :verbose do |t, args|
+      if args.filepath.blank?
+        raise 'Usage: rake asset_hat:css:minify_file[path/to/filename.css]' and return
+      end
+
+      args.with_defaults :verbose => false
+      min_options = {
+        :engine => AssetHat.config['css']['engine']
+      }.reject { |k,v| v.blank? }
+
+      input   = File.open(args.filepath, 'r').read
+      output  = AssetHat::CSS.minify(input, min_options)
+
+      # Write minified content to file
+      target_filepath = AssetHat::CSS.min_filepath(args.filepath)
+      File.open(target_filepath, 'w') { |f| f.write output }
+
+      # Print results
+      puts "- Minified to #{target_filepath}" if args.verbose
+    end
+
+    desc 'Minifies one CSS bundle'
+    task :minify_bundle, :bundle, :needs => :environment do |t, args|
+      if args.bundle.blank?
+        raise 'Usage: rake asset_hat:css:minify_bundle[application]' and return
+      end
+
+      config = AssetHat.config
+      old_bundle_size = 0.0
+      new_bundle_size = 0.0
+      min_options = {
+        :engine => config['css']['engine']
+      }.reject { |k,v| v.blank? }
+
+      # Get bundle filenames
+      filenames = config['css']['bundles'][args.bundle]
+      if filenames.empty?
+        raise "No CSS files are specified for the #{args.bundle} bundle in #{AssetHat::CONFIG_FILEPATH}."
+        return
+      end
+      filepaths = filenames.map do |filename|
+        File.join('public', 'stylesheets', "#{filename}.css")
+      end
+      bundle_filepath = AssetHat::CSS.min_filepath(File.join(
+        'public', 'stylesheets', 'bundles', "#{args.bundle}.css"))
+
+      # Concatenate and process output
+      output = ''
+      asset_host = ActionController::Base.asset_host
+      filepaths.each do |filepath|
+        file_output = File.open(filepath, 'r').read
+        old_bundle_size += file_output.size
+
+        file_output = AssetHat::CSS.minify(file_output, min_options)
+        file_output = AssetHat::CSS.add_asset_commit_ids(file_output)
+        if asset_host.present?
+          file_output = AssetHat::CSS.add_asset_hosts(file_output, asset_host)
+        end
+
+        new_bundle_size += file_output.size
+        output << file_output + "\n"
+      end
+      FileUtils.makedirs(File.dirname(bundle_filepath))
+      File.open(bundle_filepath, 'w') { |f| f.write output }
+
+      # Print results
+      percent_saved = 1 - (new_bundle_size / old_bundle_size)
+      puts "\nWrote CSS bundle: #{bundle_filepath}"
+      filepaths.each do |filepath|
+        puts "        contains: #{filepath}"
+      end
+      if old_bundle_size > 0
+        engine = "(Engine: #{min_options[:engine]})"
+        puts "        MINIFIED: #{'%.1f' % (percent_saved * 100)}% #{engine}"
+      end
+    end
+
+    desc 'Concatenates and minifies all CSS bundles'
+    task :minify do
+      # Get input bundles
+      config = AssetHat.config
+      if config['css'].blank? || config['css']['bundles'].blank?
+        puts "You need to set up CSS bundles in #{AssetHat::CONFIG_FILEPATH}."
+        exit
+      end
+      bundles = config['css']['bundles'].keys
+
+      # Minify bundles
+      bundles.each do |bundle|
+        Rake::Task['asset_hat:css:minify_bundle'].reenable
+        Rake::Task['asset_hat:css:minify_bundle'].invoke(bundle)
+      end
+    end
+
+  end # namespace :css
+
+  namespace :js do
+    desc 'Minifies one JS file'
+    task :minify_file, :filepath, :verbose do |t, args|
+      if args.filepath.blank?
+        raise 'Usage: rake asset_hat:js:minify_file[filepath.js]' and return
+      end
+
+      args.with_defaults :verbose => false
+      min_options = {
+        :engine => AssetHat.config['js']['engine']
+      }.reject { |k,v| v.blank? }
+
+      if args.verbose && args.filepath.match(/\.min\.js$/)
+        puts "#{args.filepath} is already minified."
+        exit 1
+      end
+
+      input   = File.open(args.filepath, 'r').read
+      output  = AssetHat::JS.minify(input, min_options)
+
+      # Write minified content to file
+      target_filepath = AssetHat::JS.min_filepath(args.filepath)
+      File.open(target_filepath, 'w') { |f| f.write output }
+
+      # Print results
+      puts "- Minified to #{target_filepath}" if args.verbose
+    end
+
+    desc 'Minifies one JS bundle'
+    task :minify_bundle, :bundle do |t, args|
+      if args.bundle.blank?
+        raise 'Usage: rake asset_hat:js:minify_bundle[application]' and return
+      end
+
+      config = AssetHat.config
+      old_bundle_size = 0.0
+      new_bundle_size = 0.0
+      min_options = {
+        :engine => config['js']['engine']
+      }.reject { |k,v| v.blank? }
+
+      # Get bundle filenames
+      filenames = config['js']['bundles'][args.bundle]
+      if filenames.empty?
+        raise "No JS files are specified for the #{args.bundle} bundle in #{AssetHat::CONFIG_FILEPATH}."
+        return
+      end
+      filepaths = filenames.map do |filename|
+        File.join('public', 'javascripts', "#{filename}.js")
+      end
+      bundle_filepath = AssetHat::JS.min_filepath(File.join(
+        'public', 'javascripts', 'bundles', "#{args.bundle}.js"))
+
+      # Concatenate and process output
+      output = ''
+      filepaths.each do |filepath|
+        file_output = File.open(filepath, 'r').read
+        old_bundle_size += file_output.size
+        unless filepath =~ /\.min\.js$/ # Already minified
+          file_output = AssetHat::JS.minify(file_output, min_options)
+        end
+        new_bundle_size += file_output.size
+        output << file_output + "\n"
+      end
+      FileUtils.makedirs(File.dirname(bundle_filepath))
+      File.open(bundle_filepath, 'w') { |f| f.write output }
+
+      # Print results
+      percent_saved = 1 - (new_bundle_size / old_bundle_size)
+      puts "\n Wrote JS bundle: #{bundle_filepath}"
+      filepaths.each do |filepath|
+        puts "        contains: #{filepath}"
+      end
+      if old_bundle_size > 0
+        engine = "(Engine: #{min_options[:engine]})"
+        puts "        MINIFIED: #{'%.1f' % (percent_saved * 100)}% #{engine}"
+      end
+    end
+
+    desc 'Concatenates and minifies all JS bundles'
+    task :minify do
+      # Get input bundles
+      config = AssetHat.config
+      if config['js'].blank? || config['js']['bundles'].blank?
+        puts "You need to set up JS bundles in #{AssetHat::CONFIG_FILEPATH}."
+        exit
+      end
+      bundles = config['js']['bundles'].keys
+
+      # Minify bundles
+      bundles.each do |bundle|
+        Rake::Task['asset_hat:js:minify_bundle'].reenable
+        Rake::Task['asset_hat:js:minify_bundle'].invoke(bundle)
+      end
+    end
+
+  end # namespace :js
+
+end # namespace :asset_hat