asset_bundler 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+public/*

data/README.md

@@ -0,0 +1,46 @@
+AssetBundler
+============
+
+A simple asset bundling solution for Sinatra/Rack apps. Adapted from asset bundling functionality in ActionPack.
+
+Allows you to cache multiple javascripts or stylesheets into one file, so that scripts/styles can be downloaded
+with fewer HTTP connections. Bundling will only happen when ENV['RACK_ENV'] is "production" or "staging" (other
+bundling environments can be added via AssetBundler.bundle_environments).
+
+Last modified timestamps are added as a param to outputted script/style sources, so that far future expires headers
+can be leveraged. The [asset_timestamps_cache](http://github.com/gbuesing/asset_timestamps_cache) gem is a required dependency.
+
+
+ERB Examples:
+
+    <= javascript_include_tag "/scripts/one.js", "/scripts/two.js", :cache => "/scripts/all.js" %>
+
+    <= stylesheet_link_tag "/styles/one.css", "/styles/two.css", :cache => "/styles/all.css" %>
+
+
+output the following tags:
+
+    <script type="text/javascript" src="/scripts/all.js?1267564623"></script>
+
+    <link rel="stylesheet" href="/styles/all.css?1267564678" type="text/css">
+
+
+and creates the following files on first invocation (in the project root):
+
+    "public/scripts/all.js"
+
+    "public/styles/all.css"
+
+
+Sinatra setup example:
+
+    class MyApp < Sinatra::Base
+      helper AssetBundler::ViewHelper
+
+      # etc...
+    end
+
+
+Adding additional bundling environments:
+
+    AssetBundler.bundle_environments << "staging2"

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "asset_bundler"
+    gemspec.summary = "A simple asset bundling solution."
+    gemspec.description = "Adapted from asset bundling functionality in ActionPack."
+    gemspec.email = "gbuesing@gmail.com"
+    gemspec.homepage = "http://github.com/gbuesing/asset_bundler"
+    gemspec.authors = ["Geoff Buesing"]
+    gemspec.add_dependency('asset_timestamps_cache', '>= 0.1.1')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/asset_bundler.rb

@@ -0,0 +1,73 @@
+require 'asset_timestamps_cache'
+require 'fileutils'
+
+module AssetBundler
+
+  # Mix this in to view context for convenient access
+  module ViewHelper
+    def javascript_include_tag(*args)
+      AssetBundler.javascript_include_tag(*args)
+    end
+
+    def stylesheet_link_tag(*args)
+      AssetBundler.stylesheet_link_tag(*args)
+    end
+  end
+  
+  @@bundle_environments = ['production', 'staging']
+  
+  # Expose @@bundle_environments via class method so that you can add other bundle enviroments:
+  #
+  #   AssetBundler.bundle_environments << "staging2"
+  def self.bundle_environments
+    @@bundle_environments
+  end
+
+  def self.javascript_include_tag(*args)
+    bundled_asset_include_tag(*args) do |cache|
+      %{<script type="text/javascript" src="#{AssetTimestampsCache.timestamped_asset_path(cache)}"></script>}
+    end
+  end
+
+  def self.stylesheet_link_tag(*args)
+    bundled_asset_include_tag(*args) do |cache|
+      %{<link rel="stylesheet" href="#{AssetTimestampsCache.timestamped_asset_path(cache)}" type="text/css">}
+    end
+  end
+
+  private
+
+    def self.bundled_asset_include_tag(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      cache = opts.delete(:cache)
+
+      if cache && @@bundle_environments.include?(ENV['RACK_ENV'])
+        file_path = asset_file_path(cache)
+        unless File.exist?(file_path)
+          write_asset_file_contents(file_path, args)
+        end
+        yield cache
+      else
+        args.map {|f| yield f}.join("\n")
+      end
+    end
+
+    def self.join_asset_file_contents(paths)
+      paths.collect { |path| File.read(asset_file_path(path)) }.join("\n\n")
+    end
+
+    def self.write_asset_file_contents(joined_asset_path, asset_paths)
+      FileUtils.mkdir_p(File.dirname(joined_asset_path))
+      File.open(joined_asset_path, "w+") { |cache| cache.write(join_asset_file_contents(asset_paths)) }
+
+      # Set mtime to the latest of the combined files to allow for
+      # consistent ETag without a shared filesystem.
+      mt = asset_paths.map { |p| File.mtime(asset_file_path(p)) }.max
+      File.utime(mt, mt, joined_asset_path)
+    end
+
+    def self.asset_file_path(path)
+      File.join('public', path.to_s)
+    end
+
+end

data/test/fixtures/public/scripts/one.js

@@ -0,0 +1,2 @@
+// script one
+function one() {};

data/test/fixtures/public/scripts/three.js

@@ -0,0 +1,2 @@
+// script three
+function three() {};

data/test/fixtures/public/scripts/two.js

@@ -0,0 +1,2 @@
+// script two
+function two() {};

data/test/fixtures/public/styles/one.css

@@ -0,0 +1,2 @@
+/* style one */
+#one {}

data/test/fixtures/public/styles/three.css

@@ -0,0 +1,2 @@
+/* style three */
+#three {}

data/test/fixtures/public/styles/two.css

@@ -0,0 +1,2 @@
+/* style two */
+#two {}

data/test/test_asset_bundler.rb

@@ -0,0 +1,111 @@
+require 'test/unit'
+require 'rubygems'
+require 'asset_bundler'
+
+FileUtils.mkdir_p 'public'
+FileUtils.cp_r 'test/fixtures/public/scripts', 'public'
+FileUtils.cp_r 'test/fixtures/public/styles', 'public'
+
+class TestAssetBundler < Test::Unit::TestCase
+
+  class Foo; include(AssetBundler::ViewHelper); end
+
+  def setup
+    @old_rack_env, ENV['RACK_ENV'] = ENV['RACK_ENV'], 'production'
+    AssetTimestampsCache.clear
+    FileUtils.mkdir_p 'public'
+    @scope = Foo.new
+  end
+  
+  def teardown
+    ENV['RACK_ENV'] = @old_rack_env
+  end
+
+  def test_javascript_include_tag_html_output_without_cache
+    html = @scope.javascript_include_tag('/scripts/one.js', '/scripts/two.js', '/scripts/three.js')
+    expected = ['one', 'two', 'three'].map do |name|
+      mtime = File.mtime("public/scripts/#{name}.js").to_i
+      %(<script type="text/javascript" src="/scripts/#{name}.js?#{mtime}"></script>)
+    end.join("\n")
+    assert_equal expected, html
+  end
+
+  def test_stylesheet_link_tag_html_output_without_cache
+    html = @scope.stylesheet_link_tag('/styles/one.css', '/styles/two.css', '/styles/three.css')
+    expected = ['one', 'two', 'three'].map do |name|
+      mtime = File.mtime("public/styles/#{name}.css").to_i
+      %{<link rel="stylesheet" href="/styles/#{name}.css?#{mtime}" type="text/css">}
+    end.join("\n")
+    assert_equal expected, html
+  end
+
+  def test_javascript_include_tag_html_output_with_cache
+    html = @scope.javascript_include_tag('/scripts/one.js', '/scripts/two.js', '/scripts/three.js', :cache => '/scripts/all.js')
+    mtime = File.mtime("public/scripts/all.js").to_i
+    expected = %(<script type="text/javascript" src="/scripts/all.js?#{mtime}"></script>)
+    assert_equal expected, html
+  ensure
+    File.delete("public/scripts/all.js")
+  end
+
+  def test_stylesheet_link_tag_html_output_with_cache
+    html = @scope.stylesheet_link_tag('/styles/one.css', '/styles/two.css', '/styles/three.css', :cache => '/styles/all.css')
+    mtime = File.mtime("public/styles/all.css").to_i
+    expected = %{<link rel="stylesheet" href="/styles/all.css?#{mtime}" type="text/css">}
+    assert_equal expected, html
+  ensure
+    File.delete("public/styles/all.css")
+  end
+  
+  def test_javascript_include_tag_html_output_with_cache_does_not_bundle_in_development
+    with_rack_env 'development' do
+      html = @scope.javascript_include_tag('/scripts/one.js', '/scripts/two.js', '/scripts/three.js', :cache => '/scripts/all.js')
+      expected = ['one', 'two', 'three'].map do |name|
+        mtime = File.mtime("public/scripts/#{name}.js").to_i
+        %(<script type="text/javascript" src="/scripts/#{name}.js?#{mtime}"></script>)
+      end.join("\n")
+      assert_equal expected, html
+    end
+  end
+  
+  def test_stylesheet_link_tag_html_output_with_cache_does_not_bundle_in_development
+    with_rack_env 'development' do
+      html = @scope.stylesheet_link_tag('/styles/one.css', '/styles/two.css', '/styles/three.css', :cache => '/styles/all.css')
+      expected = ['one', 'two', 'three'].map do |name|
+        mtime = File.mtime("public/styles/#{name}.css").to_i
+        %{<link rel="stylesheet" href="/styles/#{name}.css?#{mtime}" type="text/css">}
+      end.join("\n")
+      assert_equal expected, html
+    end
+  end
+
+  def test_javascript_include_tag_html_output_with_cache_uses_latest_mtime
+    sleep 1
+    FileUtils.touch 'public/scripts/two.js'
+    @scope.javascript_include_tag('/scripts/one.js', '/scripts/two.js', '/scripts/three.js', :cache => '/scripts/all.js')
+    assert_equal File.mtime('public/scripts/two.js'), File.mtime('public/scripts/all.js')
+    assert File.mtime('public/scripts/one.js') < File.mtime('public/scripts/all.js')
+    assert File.mtime('public/scripts/three.js') < File.mtime('public/scripts/all.js')
+  ensure
+    File.delete("public/scripts/all.js")
+  end
+
+  def test_cached_javascript
+    @scope.javascript_include_tag('/scripts/one.js', '/scripts/two.js', '/scripts/three.js', :cache => '/scripts/all.js')
+    actual = File.read("public/scripts/all.js")
+    expected = ['one', 'two', 'three'].map do |name|
+      "// script #{name}\nfunction #{name}() {};"
+    end.join("\n\n")
+    assert_equal expected, actual
+  ensure
+    File.delete("public/scripts/all.js")
+  end
+
+  private
+    def with_rack_env(val)
+      old_env, ENV['RACK_ENV'] = ENV['RACK_ENV'], val
+      yield
+    ensure
+      ENV['RACK_ENV'] = old_env
+    end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: asset_bundler
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Geoff Buesing
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-05 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: asset_timestamps_cache
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id001
+description: Adapted from asset bundling functionality in ActionPack.
+email: gbuesing@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- VERSION
+- lib/asset_bundler.rb
+- test/fixtures/.DS_Store
+- test/fixtures/public/scripts/one.js
+- test/fixtures/public/scripts/three.js
+- test/fixtures/public/scripts/two.js
+- test/fixtures/public/styles/one.css
+- test/fixtures/public/styles/three.css
+- test/fixtures/public/styles/two.css
+- test/test_asset_bundler.rb
+has_rdoc: true
+homepage: http://github.com/gbuesing/asset_bundler
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple asset bundling solution.
+test_files: 
+- test/test_asset_bundler.rb