asset_hat 0.1.0

data/lib/asset_hat/vcs.rb

@@ -0,0 +1,65 @@
+module AssetHat
+  def self.last_commit_id(*args)
+    # Usage:
+    #
+    #     AssetHat.last_commit_id('public/stylesheets/application.css')
+    #     AssetHat.last_commit_id('public/stylesheets/ie.css',
+    #                             'public/stylesheets/ie7.css',
+    #                             'public/stylesheets/ie6.css')
+    #
+    # Returns a string of the commit ID for the file with the most recent
+    # commit. If the file(s) cannot be found, `nil` is returned.
+
+    # Process arguments
+    options = args.extract_options!
+    options = options.symbolize_keys.reverse_merge(:vcs => :git)
+    filepaths = args.join(' ')
+
+    # Validate options
+    if options[:vcs] != :git
+      raise 'Git is currently the only supported VCS.' and return
+    end
+
+    @@last_commit_ids ||= {}
+    if @@last_commit_ids[filepaths].blank?
+      h = `git log -1 --pretty=format:%h #{filepaths} 2>/dev/null`
+        # `h` has either the abbreviated Git commit hash or an empty string
+      @@last_commit_ids[filepaths] = h if h.present?
+    end
+    @@last_commit_ids[filepaths]
+  end
+
+  def self.last_bundle_commit_id(bundle, type)
+    # Usage:
+    #
+    #     AssetHat.last_bundle_commit_id('application', :css)
+    #
+    # Returns a string of the latest commit ID for the given bundle, based
+    # on which of its files were most recently modified in the repository. If
+    # no ID can be found, `nil` is returned.
+
+    # Process arguments
+    type = type.to_sym
+    unless TYPES.include?(type)
+      raise "Unknown type \"#{type}\"; should be one of: #{TYPES.join(', ')}."
+      return
+    end
+
+    # Default to `{:css => {}, :js => {}}`
+    @@last_bundle_commit_ids ||=
+      TYPES.inject({}) { |hsh, t| hsh.merge(t => {}) }
+
+    if @@last_bundle_commit_ids[type][bundle].blank?
+      dir = self.assets_dir(type)
+      filepaths = self.bundle_filepaths(bundle, type)
+      if filepaths.present?
+        @@last_bundle_commit_ids[type][bundle] = self.last_commit_id(*filepaths)
+      end
+    end
+
+    @@last_bundle_commit_ids[type][bundle]
+  end
+
+  def self.last_commit_ids ; @@last_commit_ids ; end
+
+end

data/lib/asset_hat/version.rb

@@ -0,0 +1,11 @@
+module AssetHat
+  def self.version
+    data_filepath = File.join(File.dirname(__FILE__), %w[.. .. VERSION.yml])
+    data = YAML.load(File.open(data_filepath, 'r'))
+    [:major, :minor, :patch, :build].
+      map { |x| data[x] }.reject(&:blank?).join('.')
+  end
+
+  VERSION = self.version
+
+end

data/public/javascripts/bundles/js-bundle-1.min.js

@@ -0,0 +1,6 @@
+/* [placeholder] */
+
+/* [placeholder] */
+
+/* [placeholder] */
+

data/public/javascripts/bundles/js-bundle-2.min.js

@@ -0,0 +1,6 @@
+/* [placeholder] */
+
+/* [placeholder] */
+
+/* [placeholder] */
+

data/public/javascripts/bundles/js-bundle-3.min.js

@@ -0,0 +1,6 @@
+/* [placeholder] */
+
+/* [placeholder] */
+
+/* [placeholder] */
+

data/public/javascripts/js-file-1-1.js

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/javascripts/js-file-1-2.js

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/javascripts/js-file-1-3.js

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/javascripts/js-file-2-1.js

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/javascripts/js-file-2-2.js

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/javascripts/js-file-2-3.js

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/javascripts/js-file-3-1.js

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/javascripts/js-file-3-2.js

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/javascripts/js-file-3-3.js

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/stylesheets/bundles/css-bundle-1.min.css

@@ -0,0 +1,3 @@
+/* [placeholder] */
+/* [placeholder] */
+/* [placeholder] */

data/public/stylesheets/bundles/css-bundle-2.min.css

@@ -0,0 +1,3 @@
+/* [placeholder] */
+/* [placeholder] */
+/* [placeholder] */

data/public/stylesheets/bundles/css-bundle-3.min.css

@@ -0,0 +1,3 @@
+/* [placeholder] */
+/* [placeholder] */
+/* [placeholder] */

data/public/stylesheets/css-file-1-1.css

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/stylesheets/css-file-1-2.css

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/stylesheets/css-file-1-3.css

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/stylesheets/css-file-2-1.css

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/stylesheets/css-file-2-2.css

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/stylesheets/css-file-2-3.css

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/stylesheets/css-file-3-1.css

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/stylesheets/css-file-3-2.css

@@ -0,0 +1 @@
+/* [placeholder] */

data/public/stylesheets/css-file-3-3.css

@@ -0,0 +1 @@
+/* [placeholder] */

data/rails/init.rb

@@ -0,0 +1,17 @@
+::ActionView::Base.send(:include, AssetHatHelper)
+
+# Precalculate (and memoize) asset commit IDs
+AssetHat::TYPES.each do |type|
+  next if AssetHat.config[type.to_s].blank? ||
+          AssetHat.config[type.to_s]['bundles'].blank?
+
+  AssetHat.config[type.to_s]['bundles'].keys.each do |bundle|
+    # Memoize commit ID for this bundle
+    AssetHat.last_bundle_commit_id(bundle, type) if AssetHat.cache?
+
+    # Memoize commit IDs for each file in this bundle
+    AssetHat.bundle_filepaths(bundle, type).each do |filepath|
+      AssetHat.last_commit_id(filepath)
+    end
+  end
+end

data/tasks/asset_hat.rake

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), %w[.. lib asset_hat tasks])

data/test/asset_hat_helper_test.rb

@@ -0,0 +1,237 @@
+require 'test_helper'
+
+class AssetHatHelperTest < ActionView::TestCase
+  RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+  context 'include_css' do
+    context 'with caching enabled' do
+      context 'with minified versions' do
+        setup do
+          @commit_id = '111'
+          flexmock(AssetHat).should_receive(:last_commit_id => @commit_id)
+        end
+
+        should 'include one file by name, and automatically use minified version' do
+          flexmock(AssetHat).should_receive(:asset_exists?).and_return(true)
+          output = include_css('foo', :cache => true)
+          assert_equal css_tag("foo.min.css?#{@commit_id}"), output
+        end
+
+        should 'include one unminified file by name and extension' do
+          output = include_css('foo.css', :cache => true)
+          assert_equal css_tag("foo.css?#{@commit_id}"), output
+        end
+
+        should 'include one minified file by name and extension' do
+          output = include_css('foo.min.css', :cache => true)
+          assert_equal css_tag("foo.min.css?#{@commit_id}"), output
+        end
+
+        should 'include multiple files by name' do
+          flexmock(AssetHat).should_receive(:asset_exists?).and_return(true)
+          expected = %w[foo bar].map do |source|
+            css_tag("#{source}.min.css?#{@commit_id}")
+          end.join("\n")
+          output = include_css('foo', 'bar', :cache => true)
+          assert_equal expected, output
+        end
+
+        should 'include multiple files as a bundle' do
+          bundle = 'css-bundle-1'
+          output = include_css(:bundle => bundle, :cache => true)
+          assert_equal css_tag("bundles/#{bundle}.min.css?#{@commit_id}"), output
+        end
+      end # context 'with minified versions'
+
+      context 'without minified versions' do
+        should 'include one file by name, and automatically use original version' do
+          output = include_css('foo')
+          assert_equal css_tag('foo.css'), output
+        end
+      end # context 'without minified versions'
+    end # context 'with caching enabled'
+
+    context 'with caching disabled' do
+      should 'include one file by name, and automatically use original version' do
+        output = include_css('foo', :cache => false)
+        assert_equal css_tag('foo.css'), output
+      end
+
+      should 'include one unminified file by name and extension' do
+        output = include_css('foo.css', :cache => false)
+        assert_equal css_tag('foo.css'), output
+      end
+
+      should 'include multiple files by name' do
+        expected = %w[foo bar.min].map { |src| css_tag("#{src}.css") }.join("\n")
+        output = include_css('foo', 'bar.min', :cache => false)
+        assert_equal expected, output
+      end
+
+      context 'with real bundle files' do
+        setup do
+          @asset_id = ENV['RAILS_ASSET_ID'] = '222'
+          @config = AssetHat.config
+        end
+        teardown { ENV['RAILS_ASSET_ID'] = nil }
+
+        should 'include a bundle as separate files' do
+          bundle = 'css-bundle-1'
+          expected = @config['css']['bundles'][bundle].map do |source|
+            css_tag("#{source}.css?#{@asset_id}")
+          end.join("\n")
+          output = include_css(:bundle => bundle, :cache => false)
+          assert_equal expected, output
+        end
+
+        should 'include multiple bundles as separate files' do
+          bundles = [1,2,3].map { |i| "css-bundle-#{i}" }
+          expected = bundles.map do |bundle|
+            sources = @config['css']['bundles'][bundle]
+            sources.map { |src| css_tag("#{src}.css?#{@asset_id}") }
+          end.flatten.uniq.join("\n")
+          output = include_css(:bundles => bundles, :cache => false)
+          assert_equal expected, output
+        end
+      end # context 'with real bundle files'
+    end # context 'with caching disabled'
+  end # context 'include_css'
+
+  context 'include_js' do
+    context 'with caching enabled' do
+      context 'with minified versions' do
+        setup do
+          @commit_id = '111'
+          flexmock(AssetHat).should_receive(
+            :last_commit_id => @commit_id,
+            :last_bundle_commit_id => @commit_id
+          )
+        end
+
+        should 'include one file by name, and automatically use minified version' do
+          flexmock(AssetHat).should_receive(:asset_exists?).and_return(true)
+          output = include_js('jquery.some-plugin', :cache => true)
+          assert_equal js_tag("jquery.some-plugin.min.js?#{@commit_id}"), output
+        end
+
+        should 'include one unminified file by name and extension' do
+          output = include_js('jquery.some-plugin.js', :cache => true)
+          assert_equal js_tag("jquery.some-plugin.js?#{@commit_id}"), output
+        end
+
+        should 'include one minified file by name and extension' do
+          output = include_js('jquery.some-plugin.min.js', :cache => true)
+          assert_equal js_tag("jquery.some-plugin.min.js?#{@commit_id}"), output
+        end
+
+        should 'include jQuery' do
+          version = AssetHat::JS::Vendors::JQUERY_DEFAULT_VERSION
+          output = include_js(:jquery, :cache => true)
+          assert_equal(
+            js_tag("jquery-#{version}.min.js?#{@commit_id}"), output)
+        end
+
+        should 'include jQuery by version' do
+          version = '1.3.2'
+          output = include_js(:jquery, :version => version, :cache => true)
+          assert_equal(
+            js_tag("jquery-#{version}.min.js?#{@commit_id}"), output)
+        end
+
+        should 'include multiple files by name' do
+          flexmock(AssetHat).should_receive(:asset_exists?).and_return(true)
+          expected = %w[foo jquery.bar].map do |source|
+            js_tag("#{source}.min.js?#{@commit_id}")
+          end.join("\n")
+          output = include_js('foo', 'jquery.bar', :cache => true)
+          assert_equal expected, output
+        end
+
+        should 'include multiple files as a bundle' do
+          bundle = 'js-bundle-1'
+          output = include_js(:bundle => bundle, :cache => true)
+          assert_equal js_tag("bundles/#{bundle}.min.js?#{@commit_id}"), output
+        end
+
+        should 'include multiple bundles' do
+          flexmock(AssetHat).should_receive(:asset_exists?).and_return(true)
+          expected = %w[foo bar].map do |bundle|
+            js_tag("bundles/#{bundle}.min.js?#{@commit_id}")
+          end.join("\n")
+          output = include_js(:bundles => %w[foo bar], :cache => true)
+          assert_equal expected, output
+        end
+      end # context 'with minified versions'
+
+      context 'without minified versions' do
+        should 'include one file by name, and automatically use original version' do
+          output = include_js('jquery.some-plugin', :cache => true)
+          assert_equal js_tag('jquery.some-plugin.js'), output
+        end
+      end # context 'without minified versions'
+    end # context 'with caching enabled'
+
+    context 'with caching disabled' do
+      should 'include one file by name, and automatically use original version' do
+        output = include_js('foo', :cache => false)
+        assert_equal js_tag('foo.js'), output
+      end
+
+      should 'include one unminified file by name and extension' do
+        output = include_js('foo.js', :cache => false)
+        assert_equal js_tag('foo.js'), output
+      end
+
+      should 'include one minified file by name and extension' do
+        output = include_js('foo.min.js', :cache => false)
+        assert_equal js_tag('foo.min.js'), output
+      end
+
+      should 'include multiple files by name' do
+        expected = %w[foo bar.min].map { |src| js_tag("#{src}.js") }.join("\n")
+        output = include_js('foo', 'bar.min', :cache => false)
+        assert_equal expected, output
+      end
+
+      context 'with real bundle files' do
+        setup do
+          @asset_id = ENV['RAILS_ASSET_ID'] = '222'
+          @config = AssetHat.config
+        end
+        teardown { ENV['RAILS_ASSET_ID'] = nil }
+
+        should 'include a bundle as separate files' do
+          bundle = 'js-bundle-1'
+          sources = @config['js']['bundles'][bundle]
+          expected = sources.map { |src| js_tag("#{src}.js?#{@asset_id}") }.join("\n")
+          output = include_js(:bundle => bundle, :cache => false)
+          assert_equal expected, output
+        end
+
+        should 'include multiple bundles as separate files' do
+          bundles = [1,2,3].map { |i| "js-bundle-#{i}" }
+          expected = bundles.map do |bundle|
+            sources = @config['js']['bundles'][bundle]
+            sources.map { |src| js_tag("#{src}.js?#{@asset_id}") }
+          end.flatten.uniq.join("\n")
+          output = include_js(:bundles => bundles, :cache => false)
+          assert_equal expected, output
+        end
+      end # context 'with real bundle files'
+    end # context 'with caching disabled'
+
+  end # context 'include_js'
+
+
+
+  private
+
+  def css_tag(filename)
+    %Q{<link href="/stylesheets/#{filename}" media="screen,projection" rel="stylesheet" type="text/css" />}
+  end
+
+  def js_tag(filename)
+    %Q{<script src="/javascripts/#{filename}" type="text/javascript"></script>}
+  end
+
+end

data/test/asset_hat_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+class AssetHatTest < ActiveSupport::TestCase
+  context 'AssetHat::CSS' do
+    should 'return path to minified file' do
+      assert_equal  'foo/bar/baz.min.css',
+                    AssetHat::CSS.min_filepath('foo/bar/baz.css')
+    end
+
+    should 'add asset commit IDs' do
+      commit_id = 111
+      flexmock(AssetHat).should_receive(:last_commit_id => commit_id)
+      flexmock(Rails).should_receive(:public_path => '')
+
+      assert_equal  "p{background:url(/images/foo.png?#{commit_id})}",
+                    AssetHat::CSS.add_asset_commit_ids(
+                      'p{background:url(/images/foo.png)}')
+    end
+
+    should 'add asset hosts' do
+      asset_host = 'http://media%d.example.com'
+      assert_match(
+        /^p\{background:url\(http:\/\/media[\d]\.example\.com\/images\/foo.png\)\}$/,
+        AssetHat::CSS.add_asset_hosts(
+          'p{background:url(/images/foo.png)}', asset_host)
+      )
+    end
+  end # context 'AssetHat::CSS'
+
+  context 'AssetHat::JS' do
+    should 'return path to minified file' do
+      assert_equal  'foo/bar/baz.min.js',
+                    AssetHat::JS.min_filepath('foo/bar/baz.js')
+    end
+  end # context 'AssetHat::JS'
+
+  should "return a bundle's filenames" do
+    assert_equal  %w[css-file-1-1 css-file-1-2 css-file-1-3],
+                  AssetHat.bundle_filenames('css-bundle-1', :css)
+  end
+
+  should "return a bundle's filepaths" do
+    expected = [1,2,3].map { |i| "public/stylesheets/css-file-1-#{i}.css" }
+    assert_equal expected, AssetHat.bundle_filepaths('css-bundle-1', :css)
+  end
+end