rails_asset_packager 0.1.0

data/lib/tasks/asset_packager_tasks.rake

@@ -0,0 +1,90 @@
+require 'yaml'
+require File.dirname(__FILE__) + '/../rails_asset_packager/asset_package'
+
+namespace :asset do
+  namespace :packager do
+
+    desc "Merge and compress assets"
+    task :build_all do
+      RailsAssetPackager::AssetPackage.build_all
+    end
+
+    desc "Delete all asset builds"
+    task :delete_all do
+      RailsAssetPackager::AssetPackage.delete_all
+    end
+
+    desc "Generate asset_packages.yml from existing assets"
+    task :create_yml do
+      RailsAssetPackager::AssetPackage.create_yml
+    end
+
+  end
+  
+  namespace :cache do
+    S3_CONFIG = YAML.load_file(File.join(Rails.root, "config/s3.yml"))[Rails.env] rescue nil || {}
+    ASSET_PKG_CONFIG = YAML.load_file(File.join(Rails.root, "config/asset_packages.yml")) rescue nil || {}
+
+    desc "start aws"
+    task :aws do
+      require 'aws/s3'
+
+      AWS::S3::Base.establish_connection!(
+        :access_key_id => S3_CONFIG['access_key_id'],
+        :secret_access_key => S3_CONFIG['secret_access_key']
+      )
+    end
+
+    desc "update s3"
+    task :s3 => :aws do
+      prefix = ''
+
+      files = []
+
+      ASSET_PKG_CONFIG.keys.each do |set|
+        if set == 'javascripts' || set == 'stylesheets'
+          ext = (set == 'javascripts') ? "js" : "css"
+          
+          ASSET_PKG_CONFIG[set].each do |val|
+            val.keys.each do |val|
+              files << "./public/#{set}/#{val}_packaged.#{ext}"
+            end
+          end
+        elsif set == 'uploads'
+          ASSET_PKG_CONFIG[set].each do |val|
+            if File.directory?("./public/#{val}")
+              files = files + Dir.glob("./public/#{val}/**/*.*")
+            end
+          end
+          
+          files.uniq!
+        end
+      end
+
+      files.each do |f|
+        next if File.directory?(f)
+        puts f
+
+        key = f.gsub(/\.\/public/, prefix)
+        puts " -> %s" % key
+
+        AWS::S3::S3Object.store(
+          key,
+          File.open(f),
+          S3_CONFIG['bucket'],
+          :access => :public_read,
+          'Cache-Control' => 'max-age=315360000',
+          'x-amz-storage-class' => 'REDUCED_REDUNDANCY'
+        )
+      end
+    end  
+
+    desc "cache assets and update s3 for production"
+    task :production do
+      Rake::Task['asset:packager:delete_all'].invoke
+      Rake::Task['asset:packager:build_all'].invoke
+      Rake::Task['asset:cache:s3'].invoke
+
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'rails_asset_packager'

data/rails_asset_packager.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rails_asset_packager/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails_asset_packager"
+  s.version     = RailsAssetPackager::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Scott Becker","Katherine G Pe","James Thompson"]
+  s.email       = ["","","james@plainprograms.com"]
+  s.homepage    = "http://rubygems.org/gems/rails_asset_packager"
+  s.summary     = %q{Javascript and CSS asset compression for Rails}
+  s.description = %q{A tool to compress Javascript and CSS assets for production Rals applications.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "aws-s3", "~> 0.6.2"
+end

data/test/asset_package_helper_development_test.rb

@@ -0,0 +1,102 @@
+$:.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
+
+class AssetPackageHelperDevelopmentTest < Test::Unit::TestCase
+  include ActionController::Assertions::DomAssertions
+  include ActionController::TestCase::Assertions
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::AssetTagHelper
+  include RailsAssetPackager::AssetPackageHelper
+
+  def setup
+    RailsAssetPackager::AssetPackage.asset_base_path    = "#{Rails.root}/vendor/plugins/asset_packager/test/assets"
+    RailsAssetPackager::AssetPackage.asset_packages_yml = YAML.load_file("#{Rails.root}/vendor/plugins/asset_packager/test/asset_packages.yml")
+
+    RailsAssetPackager::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,142 @@
+$:.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
+
+class AssetPackageHelperProductionTest < Test::Unit::TestCase
+  include ActionController::Assertions::DomAssertions
+  include ActionController::TestCase::Assertions
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::AssetTagHelper
+  include RailsAssetPackager::AssetPackageHelper
+
+  cattr_accessor :packages_built
+
+  def setup
+    RailsAssetPackager::AssetPackage.asset_base_path    = "#{Rails.root}/vendor/plugins/asset_packager/test/assets"
+    RailsAssetPackager::AssetPackage.asset_packages_yml = YAML.load_file("#{Rails.root}/vendor/plugins/asset_packager/test/asset_packages.yml")
+
+    RailsAssetPackager::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
+      RailsAssetPackager::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 = RailsAssetPackager::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 = RailsAssetPackager::AssetPackage.find_by_source("javascripts", "prototype").current_file
+    current_file2 = RailsAssetPackager::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 = RailsAssetPackager::AssetPackage.find_by_source("javascripts", "prototype").current_file
+    current_file2 = RailsAssetPackager::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 = RailsAssetPackager::AssetPackage.find_by_source("javascripts", "prototype").current_file
+    current_file2 = RailsAssetPackager::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 = RailsAssetPackager::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 = RailsAssetPackager::AssetPackage.find_by_target("javascripts", "base").current_file
+    package_name2 = RailsAssetPackager::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 = RailsAssetPackager::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 = RailsAssetPackager::AssetPackage.find_by_source("stylesheets", "screen").current_file
+    current_file2 = RailsAssetPackager::AssetPackage.find_by_source("stylesheets", "foo").current_file
+    current_file3 = RailsAssetPackager::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 = RailsAssetPackager::AssetPackage.find_by_source("stylesheets", "screen").current_file
+    current_file2 = RailsAssetPackager::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 = RailsAssetPackager::AssetPackage.find_by_source("stylesheets", "screen").current_file
+    current_file2 = RailsAssetPackager::AssetPackage.find_by_source("stylesheets", "foo").current_file
+    current_file3 = RailsAssetPackager::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 = RailsAssetPackager::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 = RailsAssetPackager::AssetPackage.find_by_target("stylesheets", "base").current_file
+    package_name2 = RailsAssetPackager::AssetPackage.find_by_target("stylesheets", "secondary").current_file
+    package_name3 = RailsAssetPackager::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

data/test/asset_packager_test.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/../../../../config/environment'
+require 'test/unit'
+require 'mocha'
+
+class AssetPackagerTest < Test::Unit::TestCase
+  include RailsAssetPackager
+  
+  def setup
+    RailsAssetPackager::AssetPackage.asset_base_path    = "#{Rails.root}/vendor/plugins/asset_packager/test/assets"
+    RailsAssetPackager::AssetPackage.asset_packages_yml = YAML.load_file("#{Rails.root}/vendor/plugins/asset_packager/test/asset_packages.yml")
+
+    RailsAssetPackager::AssetPackage.any_instance.stubs(:log)
+    RailsAssetPackager::AssetPackage.build_all
+  end
+  
+  def teardown
+    RailsAssetPackager::AssetPackage.delete_all
+  end
+  
+  def test_find_by_type
+    js_asset_packages = RailsAssetPackager::AssetPackage.find_by_type("javascripts")
+    assert_equal 2, js_asset_packages.length
+    assert_equal "base", js_asset_packages[0].target
+    assert_equal ["prototype", "effects", "controls", "dragdrop"], js_asset_packages[0].sources
+  end
+  
+  def test_find_by_target
+    package = RailsAssetPackager::AssetPackage.find_by_target("javascripts", "base")
+    assert_equal "base", package.target
+    assert_equal ["prototype", "effects", "controls", "dragdrop"], package.sources
+  end
+  
+  def test_find_by_source
+    package = RailsAssetPackager::AssetPackage.find_by_source("javascripts", "controls")
+    assert_equal "base", package.target
+    assert_equal ["prototype", "effects", "controls", "dragdrop"], package.sources
+  end
+  
+  def test_delete_and_build
+    RailsAssetPackager::AssetPackage.delete_all
+    js_package_names = Dir.new("#{RailsAssetPackager::AssetPackage.asset_base_path}/javascripts").entries.delete_if { |x| ! (x =~ /\A\w+_packaged.js/) }
+    css_package_names = Dir.new("#{RailsAssetPackager::AssetPackage.asset_base_path}/stylesheets").entries.delete_if { |x| ! (x =~ /\A\w+_packaged.css/) }
+    css_subdir_package_names = Dir.new("#{RailsAssetPackager::AssetPackage.asset_base_path}/stylesheets/subdir").entries.delete_if { |x| ! (x =~ /\A\w+_packaged.css/) }
+    
+    assert_equal 0, js_package_names.length
+    assert_equal 0, css_package_names.length
+    assert_equal 0, css_subdir_package_names.length
+
+    RailsAssetPackager::AssetPackage.build_all
+    js_package_names = Dir.new("#{RailsAssetPackager::AssetPackage.asset_base_path}/javascripts").entries.delete_if { |x| ! (x =~ /\A\w+_packaged.js/) }.sort
+    css_package_names = Dir.new("#{RailsAssetPackager::AssetPackage.asset_base_path}/stylesheets").entries.delete_if { |x| ! (x =~ /\A\w+_packaged.css/) }.sort
+    css_subdir_package_names = Dir.new("#{RailsAssetPackager::AssetPackage.asset_base_path}/stylesheets/subdir").entries.delete_if { |x| ! (x =~ /\A\w+_packaged.css/) }.sort
+    
+    assert_equal 2, js_package_names.length
+    assert_equal 2, css_package_names.length
+    assert_equal 1, css_subdir_package_names.length
+    assert js_package_names[0].match(/\Abase_packaged.js\z/)
+    assert js_package_names[1].match(/\Asecondary_packaged.js\z/)
+    assert css_package_names[0].match(/\Abase_packaged.css\z/)
+    assert css_package_names[1].match(/\Asecondary_packaged.css\z/)
+    assert css_subdir_package_names[0].match(/\Astyles_packaged.css\z/)
+  end
+  
+  def test_js_names_from_sources
+    package_names = RailsAssetPackager::AssetPackage.targets_from_sources("javascripts", ["prototype", "effects", "noexist1", "controls", "foo", "noexist2"])
+    assert_equal 4, package_names.length
+    assert package_names[0].match(/\Abase_packaged\z/)
+    assert_equal package_names[1], "noexist1"
+    assert package_names[2].match(/\Asecondary_packaged\z/)
+    assert_equal package_names[3], "noexist2"
+  end
+  
+  def test_css_names_from_sources
+    package_names = RailsAssetPackager::AssetPackage.targets_from_sources("stylesheets", ["header", "screen", "noexist1", "foo", "noexist2"])
+    assert_equal 4, package_names.length
+    assert package_names[0].match(/\Abase_packaged\z/)
+    assert_equal package_names[1], "noexist1"
+    assert package_names[2].match(/\Asecondary_packaged\z/)
+    assert_equal package_names[3], "noexist2"
+  end
+  
+  def test_should_return_merge_environments_when_set
+    RailsAssetPackager::AssetPackage.merge_environments = ["staging", "production"]
+    assert_equal ["staging", "production"], RailsAssetPackager::AssetPackage.merge_environments
+  end
+
+  def test_should_only_return_production_merge_environment_when_not_set
+    assert_equal ["production"], RailsAssetPackager::AssetPackage.merge_environments
+  end
+  
+end

data/test/asset_packages.yml

@@ -0,0 +1,20 @@
+javascripts:
+- base:
+  - prototype
+  - effects
+  - controls
+  - dragdrop
+- secondary:
+  - foo
+  - bar
+  - application
+stylesheets:
+- base:
+  - screen
+  - header
+- secondary:
+  - foo
+  - bar
+- subdir/styles:
+  - foo
+  - bar

data/test/assets/javascripts/application.js

@@ -0,0 +1,2 @@
+// Place your application-specific JavaScript functions and classes here
+// This file is automatically included by javascript_include_tag :defaults

data/test/assets/javascripts/bar.js

@@ -0,0 +1,4 @@
+bar bar bar
+bar bar bar
+bar bar bar
+