asset_packager 0.1.0

data/lib/synthesis/asset_package.rb

@@ -0,0 +1,212 @@
+module Synthesis
+  class AssetPackage
+
+    # class variables
+    @@asset_packages_yml = $asset_packages_yml || 
+      (File.exists?("#{RAILS_ROOT}/config/asset_packages.yml") ? YAML.load_file("#{RAILS_ROOT}/config/asset_packages.yml") : nil)
+  
+    # singleton methods
+    class << self
+      
+      def merge_environments=(environments)
+        @@merge_environments = environments
+      end
+      
+      def merge_environments
+        @@merge_environments ||= ["production"]
+      end
+      
+      def parse_path(path)
+        /^(?:(.*)\/)?([^\/]+)$/.match(path).to_a
+      end
+
+      def find_by_type(asset_type)
+        @@asset_packages_yml[asset_type].map { |p| self.new(asset_type, p) }
+      end
+
+      def find_by_target(asset_type, target)
+        package_hash = @@asset_packages_yml[asset_type].find {|p| p.keys.first == target }
+        package_hash ? self.new(asset_type, package_hash) : nil
+      end
+
+      def find_by_source(asset_type, source)
+        path_parts = parse_path(source)
+        package_hash = @@asset_packages_yml[asset_type].find do |p|
+          key = p.keys.first
+          p[key].include?(path_parts[2]) && (parse_path(key)[1] == path_parts[1])
+        end
+        package_hash ? self.new(asset_type, package_hash) : nil
+      end
+
+      def targets_from_sources(asset_type, sources)
+        package_names = Array.new
+        sources.each do |source|
+          package = find_by_target(asset_type, source) || find_by_source(asset_type, source)
+          package_names << (package ? package.current_file : source)
+        end
+        package_names.uniq
+      end
+
+      def sources_from_targets(asset_type, targets)
+        source_names = Array.new
+        targets.each do |target|
+          package = find_by_target(asset_type, target)
+          source_names += (package ? package.sources.collect do |src|
+            package.target_dir.gsub(/^(.+)$/, '\1/') + src
+          end : target.to_a)
+        end
+        source_names.uniq
+      end
+
+      def build_all
+        @@asset_packages_yml.keys.each do |asset_type|
+          @@asset_packages_yml[asset_type].each { |p| self.new(asset_type, p).build }
+        end
+      end
+
+      def delete_all
+        @@asset_packages_yml.keys.each do |asset_type|
+          @@asset_packages_yml[asset_type].each { |p| self.new(asset_type, p).delete_previous_build }
+        end
+      end
+
+      def create_yml
+        unless File.exists?("#{RAILS_ROOT}/config/asset_packages.yml")
+          asset_yml = Hash.new
+
+          asset_yml['javascripts'] = [{"base" => build_file_list("#{RAILS_ROOT}/public/javascripts", "js")}]
+          asset_yml['stylesheets'] = [{"base" => build_file_list("#{RAILS_ROOT}/public/stylesheets", "css")}]
+
+          File.open("#{RAILS_ROOT}/config/asset_packages.yml", "w") do |out|
+            YAML.dump(asset_yml, out)
+          end
+
+          log "config/asset_packages.yml example file created!"
+          log "Please reorder files under 'base' so dependencies are loaded in correct order."
+        else
+          log "config/asset_packages.yml already exists. Aborting task..."
+        end
+      end
+
+    end
+    
+    # instance methods
+    attr_accessor :asset_type, :target, :target_dir, :sources
+  
+    def initialize(asset_type, package_hash)
+      target_parts = self.class.parse_path(package_hash.keys.first)
+      @target_dir = target_parts[1].to_s
+      @target = target_parts[2].to_s
+      @sources = package_hash[package_hash.keys.first]
+      @asset_type = asset_type
+      @asset_path = ($asset_base_path ? "#{$asset_base_path}/" : "#{RAILS_ROOT}/public/") +
+          "#{@asset_type}#{@target_dir.gsub(/^(.+)$/, '/\1')}"
+      @extension = get_extension
+      @file_name = "#{@target}_packaged.#{@extension}"
+      @full_path = File.join(@asset_path, @file_name)
+    end
+  
+    def package_exists?
+      File.exists?(@full_path)
+    end
+
+    def current_file
+      build unless package_exists?
+
+      path = @target_dir.gsub(/^(.+)$/, '\1/')
+      "#{path}#{@target}_packaged"
+    end
+
+    def build
+      delete_previous_build
+      create_new_build
+    end
+
+    def delete_previous_build
+      File.delete(@full_path) if File.exists?(@full_path)
+    end
+
+    private
+      def create_new_build
+        new_build_path = "#{@asset_path}/#{@target}_packaged.#{@extension}"
+        if File.exists?(new_build_path)
+          log "Latest version already exists: #{new_build_path}"
+        else
+          File.open(new_build_path, "w") {|f| f.write(compressed_file) }
+          log "Created #{new_build_path}"
+        end
+      end
+
+      def merged_file
+        merged_file = ""
+        @sources.each {|s| 
+          File.open("#{@asset_path}/#{s}.#{@extension}", "r") { |f| 
+            merged_file += f.read + "\n" 
+          }
+        }
+        merged_file
+      end
+    
+      def compressed_file
+        case @asset_type
+          when "javascripts" then compress_js(merged_file)
+          when "stylesheets" then compress_css(merged_file)
+        end
+      end
+
+      def compress_js(source)
+        jsmin_path = "#{RAILS_ROOT}/vendor/plugins/asset_packager/lib"
+        tmp_path = "#{RAILS_ROOT}/tmp/#{@target}_packaged"
+      
+        # write out to a temp file
+        File.open("#{tmp_path}_uncompressed.js", "w") {|f| f.write(source) }
+      
+        # compress file with JSMin library
+        `ruby #{jsmin_path}/jsmin.rb <#{tmp_path}_uncompressed.js >#{tmp_path}_compressed.js \n`
+
+        # read it back in and trim it
+        result = ""
+        File.open("#{tmp_path}_compressed.js", "r") { |f| result += f.read.strip }
+  
+        # delete temp files if they exist
+        File.delete("#{tmp_path}_uncompressed.js") if File.exists?("#{tmp_path}_uncompressed.js")
+        File.delete("#{tmp_path}_compressed.js") if File.exists?("#{tmp_path}_compressed.js")
+
+        result
+      end
+  
+      def compress_css(source)
+        source.gsub!(/\s+/, " ")           # collapse space
+        source.gsub!(/\/\*(.*?)\*\//, "")  # remove comments - caution, might want to remove this if using css hacks
+        source.gsub!(/\} /, "}\n")         # add line breaks
+        source.gsub!(/\n$/, "")            # remove last break
+        source.gsub!(/ \{ /, " {")         # trim inside brackets
+        source.gsub!(/; \}/, "}")          # trim inside brackets
+        source
+      end
+
+      def get_extension
+        case @asset_type
+          when "javascripts" then "js"
+          when "stylesheets" then "css"
+        end
+      end
+      
+      def log(message)
+        self.class.log(message)
+      end
+      
+      def self.log(message)
+        puts message
+      end
+
+      def self.build_file_list(path, extension)
+        re = Regexp.new(".#{extension}\\z")
+        file_list = Dir.new(path).entries.delete_if { |x| ! (x =~ re) }.map {|x| x.chomp(".#{extension}")}
+        # reverse javascript entries so prototype comes first on a base rails app
+        file_list.reverse! if extension == "js"
+        file_list
+      end
+   
+  end
+end

data/lib/synthesis/asset_package_helper.rb

@@ -0,0 +1,39 @@
+module Synthesis
+  module AssetPackageHelper
+    
+    def should_merge?
+      AssetPackage.merge_environments.include?(RAILS_ENV)
+    end
+
+    def javascript_include_merged(*sources)
+      options = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { }
+
+      if sources.include?(:defaults) 
+        sources = sources[0..(sources.index(:defaults))] + 
+          ['prototype', 'effects', 'dragdrop', 'controls'] + 
+          (File.exists?("#{RAILS_ROOT}/public/javascripts/application.js") ? ['application'] : []) + 
+          sources[(sources.index(:defaults) + 1)..sources.length]
+        sources.delete(:defaults)
+      end
+
+      sources.collect!{|s| s.to_s}
+      sources = (should_merge? ? 
+        AssetPackage.targets_from_sources("javascripts", sources) : 
+        AssetPackage.sources_from_targets("javascripts", sources))
+        
+      sources.collect {|source| javascript_include_tag(source, options) }.join("\n")
+    end
+
+    def stylesheet_link_merged(*sources)
+      options = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { }
+
+      sources.collect!{|s| s.to_s}
+      sources = (should_merge? ? 
+        AssetPackage.targets_from_sources("stylesheets", sources) : 
+        AssetPackage.sources_from_targets("stylesheets", sources))
+
+      sources.collect { |source| stylesheet_link_tag(source, options) }.join("\n")    
+    end
+
+  end
+end

data/tasks/asset_packager_tasks.rake

@@ -0,0 +1,23 @@
+require 'yaml'
+require File.dirname(__FILE__) + '/../lib/synthesis/asset_package'
+
+namespace :asset do
+  namespace :packager do
+
+    desc "Merge and compress assets"
+    task :build_all do
+      Synthesis::AssetPackage.build_all
+    end
+
+    desc "Delete all asset builds"
+    task :delete_all do
+      Synthesis::AssetPackage.delete_all
+    end
+    
+    desc "Generate asset_packages.yml from existing assets"
+    task :create_yml do
+      Synthesis::AssetPackage.create_yml
+    end
+    
+  end
+end

data/test/asset_package_helper_development_test.rb

@@ -0,0 +1,100 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+ENV['RAILS_ENV'] = "development"
+require File.dirname(__FILE__) + '/../../../../config/environment'
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+
+require 'action_controller/test_process'
+
+ActionController::Base.logger = nil
+ActionController::Routing::Routes.reload rescue nil
+
+$asset_packages_yml = YAML.load_file("#{RAILS_ROOT}/vendor/plugins/asset_packager/test/asset_packages.yml")
+$asset_base_path = "#{RAILS_ROOT}/vendor/plugins/asset_packager/test/assets"
+
+class AssetPackageHelperDevelopmentTest < Test::Unit::TestCase
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::AssetTagHelper
+  include Synthesis::AssetPackageHelper
+
+  def setup
+    Synthesis::AssetPackage.any_instance.stubs(:log)
+
+    @controller = Class.new do
+      def request
+        @request ||= ActionController::TestRequest.new
+      end
+    end.new
+  end
+  
+  def build_js_expected_string(*sources)
+    sources.map {|s| javascript_include_tag(s) }.join("\n")
+  end
+    
+  def build_css_expected_string(*sources)
+    sources.map {|s| stylesheet_link_tag(s) }.join("\n")
+  end
+    
+  def test_js_basic
+    assert_dom_equal build_js_expected_string("prototype"),
+      javascript_include_merged("prototype")
+  end
+
+  def test_js_multiple_packages
+    assert_dom_equal build_js_expected_string("prototype", "foo"), 
+      javascript_include_merged("prototype", "foo")
+  end
+  
+  def test_js_unpackaged_file
+    assert_dom_equal build_js_expected_string("prototype", "foo", "not_part_of_a_package"), 
+      javascript_include_merged("prototype", "foo", "not_part_of_a_package")
+  end
+  
+  def test_js_multiple_from_same_package
+    assert_dom_equal build_js_expected_string("prototype", "effects", "controls", "not_part_of_a_package", "foo"), 
+      javascript_include_merged("prototype", "effects", "controls", "not_part_of_a_package", "foo")
+  end
+
+  def test_js_by_package_name
+    assert_dom_equal build_js_expected_string("prototype", "effects", "controls", "dragdrop"), 
+      javascript_include_merged(:base)
+  end
+  
+  def test_js_multiple_package_names
+    assert_dom_equal build_js_expected_string("prototype", "effects", "controls", "dragdrop", "foo", "bar", "application"), 
+      javascript_include_merged(:base, :secondary)
+  end
+
+  def test_css_basic
+    assert_dom_equal build_css_expected_string("screen"),
+      stylesheet_link_merged("screen")
+  end
+
+  def test_css_multiple_packages
+    assert_dom_equal build_css_expected_string("screen", "foo", "subdir/bar"), 
+      stylesheet_link_merged("screen", "foo", "subdir/bar")
+  end
+  
+  def test_css_unpackaged_file
+    assert_dom_equal build_css_expected_string("screen", "foo", "not_part_of_a_package", "subdir/bar"), 
+      stylesheet_link_merged("screen", "foo", "not_part_of_a_package", "subdir/bar")
+  end
+  
+  def test_css_multiple_from_same_package
+    assert_dom_equal build_css_expected_string("screen", "header", "not_part_of_a_package", "foo", "bar", "subdir/foo", "subdir/bar"), 
+      stylesheet_link_merged("screen", "header", "not_part_of_a_package", "foo", "bar", "subdir/foo", "subdir/bar")
+  end
+
+  def test_css_by_package_name
+    assert_dom_equal build_css_expected_string("screen", "header"), 
+      stylesheet_link_merged(:base)
+  end
+  
+  def test_css_multiple_package_names
+    assert_dom_equal build_css_expected_string("screen", "header", "foo", "bar", "subdir/foo", "subdir/bar"), 
+      stylesheet_link_merged(:base, :secondary, "subdir/styles")
+  end
+  
+end

data/test/asset_package_helper_production_test.rb

@@ -0,0 +1,140 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require File.dirname(__FILE__) + '/../../../../config/environment'
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+
+require 'action_controller/test_process'
+
+ActionController::Base.logger = nil
+ActionController::Routing::Routes.reload rescue nil
+
+$asset_packages_yml = YAML.load_file("#{RAILS_ROOT}/vendor/plugins/asset_packager/test/asset_packages.yml")
+$asset_base_path = "#{RAILS_ROOT}/vendor/plugins/asset_packager/test/assets"
+
+class AssetPackageHelperProductionTest < Test::Unit::TestCase
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::AssetTagHelper
+  include Synthesis::AssetPackageHelper
+
+  cattr_accessor :packages_built
+
+  def setup
+    Synthesis::AssetPackage.any_instance.stubs(:log)
+    self.stubs(:should_merge?).returns(true)
+
+    @controller = Class.new do
+      def request
+        @request ||= ActionController::TestRequest.new
+      end
+    end.new
+
+    build_packages_once
+  end
+
+  def build_packages_once
+    unless @@packages_built
+      Synthesis::AssetPackage.build_all
+      @@packages_built = true
+    end
+  end
+  
+  def build_js_expected_string(*sources)
+    sources.map {|s| javascript_include_tag(s) }.join("\n")
+  end
+    
+  def build_css_expected_string(*sources)
+    sources.map {|s| stylesheet_link_tag(s) }.join("\n")
+  end
+
+  def test_js_basic
+    current_file = Synthesis::AssetPackage.find_by_source("javascripts", "prototype").current_file
+    assert_dom_equal build_js_expected_string(current_file),
+      javascript_include_merged("prototype")
+  end
+
+  def test_js_multiple_packages
+    current_file1 = Synthesis::AssetPackage.find_by_source("javascripts", "prototype").current_file
+    current_file2 = Synthesis::AssetPackage.find_by_source("javascripts", "foo").current_file
+
+    assert_dom_equal build_js_expected_string(current_file1, current_file2), 
+      javascript_include_merged("prototype", "foo")
+  end
+  
+  def test_js_unpackaged_file
+    current_file1 = Synthesis::AssetPackage.find_by_source("javascripts", "prototype").current_file
+    current_file2 = Synthesis::AssetPackage.find_by_source("javascripts", "foo").current_file
+    
+    assert_dom_equal build_js_expected_string(current_file1, current_file2, "not_part_of_a_package"), 
+      javascript_include_merged("prototype", "foo", "not_part_of_a_package")
+  end
+  
+  def test_js_multiple_from_same_package
+    current_file1 = Synthesis::AssetPackage.find_by_source("javascripts", "prototype").current_file
+    current_file2 = Synthesis::AssetPackage.find_by_source("javascripts", "foo").current_file
+
+    assert_dom_equal build_js_expected_string(current_file1, "not_part_of_a_package", current_file2), 
+      javascript_include_merged("prototype", "effects", "controls", "not_part_of_a_package", "foo")
+  end
+  
+  def test_js_by_package_name
+    package_name = Synthesis::AssetPackage.find_by_target("javascripts", "base").current_file
+    assert_dom_equal build_js_expected_string(package_name), 
+      javascript_include_merged(:base)
+  end
+  
+  def test_js_multiple_package_names
+    package_name1 = Synthesis::AssetPackage.find_by_target("javascripts", "base").current_file
+    package_name2 = Synthesis::AssetPackage.find_by_target("javascripts", "secondary").current_file
+    assert_dom_equal build_js_expected_string(package_name1, package_name2), 
+      javascript_include_merged(:base, :secondary)
+  end
+  
+  def test_css_basic
+    current_file = Synthesis::AssetPackage.find_by_source("stylesheets", "screen").current_file
+    assert_dom_equal build_css_expected_string(current_file),
+      stylesheet_link_merged("screen")
+  end
+
+  def test_css_multiple_packages
+    current_file1 = Synthesis::AssetPackage.find_by_source("stylesheets", "screen").current_file
+    current_file2 = Synthesis::AssetPackage.find_by_source("stylesheets", "foo").current_file
+    current_file3 = Synthesis::AssetPackage.find_by_source("stylesheets", "subdir/bar").current_file
+
+    assert_dom_equal build_css_expected_string(current_file1, current_file2, current_file3), 
+      stylesheet_link_merged("screen", "foo", "subdir/bar")
+  end
+  
+  def test_css_unpackaged_file
+    current_file1 = Synthesis::AssetPackage.find_by_source("stylesheets", "screen").current_file
+    current_file2 = Synthesis::AssetPackage.find_by_source("stylesheets", "foo").current_file
+    
+    assert_dom_equal build_css_expected_string(current_file1, current_file2, "not_part_of_a_package"), 
+      stylesheet_link_merged("screen", "foo", "not_part_of_a_package")
+  end
+  
+  def test_css_multiple_from_same_package
+    current_file1 = Synthesis::AssetPackage.find_by_source("stylesheets", "screen").current_file
+    current_file2 = Synthesis::AssetPackage.find_by_source("stylesheets", "foo").current_file
+    current_file3 = Synthesis::AssetPackage.find_by_source("stylesheets", "subdir/bar").current_file
+
+    assert_dom_equal build_css_expected_string(current_file1, "not_part_of_a_package", current_file2, current_file3), 
+      stylesheet_link_merged("screen", "header", "not_part_of_a_package", "foo", "bar", "subdir/foo", "subdir/bar")
+  end
+  
+  def test_css_by_package_name
+    package_name = Synthesis::AssetPackage.find_by_target("stylesheets", "base").current_file
+    assert_dom_equal build_css_expected_string(package_name), 
+      stylesheet_link_merged(:base)
+  end
+  
+  def test_css_multiple_package_names
+    package_name1 = Synthesis::AssetPackage.find_by_target("stylesheets", "base").current_file
+    package_name2 = Synthesis::AssetPackage.find_by_target("stylesheets", "secondary").current_file
+    package_name3 = Synthesis::AssetPackage.find_by_target("stylesheets", "subdir/styles").current_file
+    assert_dom_equal build_css_expected_string(package_name1, package_name2, package_name3), 
+      stylesheet_link_merged(:base, :secondary, "subdir/styles")
+  end
+  
+end