asset-trip 0.1.0

data/spec/integration/bundle_spec.rb

@@ -0,0 +1,243 @@
+require "spec_helper"
+require "action_controller"
+
+describe "rake asset_trip:bundle" do
+  setup_sandbox_app!(:each)
+
+  context "(disabling the YUI Compressor for speed)" do
+    before do
+      AssetTrip::Compressor.stub!(:new => DummyCompressor.new)
+    end
+
+    it "stores each Asset into the public directory" do
+      install_config <<-CONFIG
+        js_asset "signup" do
+        end
+      CONFIG
+      AssetTrip.bundle!
+      fixture_app.should have_asset("signup.js")
+    end
+
+    it "supports loading additional config files" do
+      install_config(<<-CONFIG, "assets.rb")
+        load "config/asset_trip/more_assets"
+      CONFIG
+      install_config(<<-CONFIG, "more_assets.rb")
+        js_asset "signup" do
+        end
+      CONFIG
+      AssetTrip.bundle!
+      fixture_app.should have_asset("signup.js")
+    end
+
+    it "concatenates the files into an Asset" do
+      install_config <<-CONFIG
+        js_asset "signup" do
+          include "main"
+          include "signup"
+        end
+      CONFIG
+      AssetTrip.bundle!
+      asset("signup.js").should have_contents('alert("main")')
+      asset("signup.js").should have_contents('alert("signup")')
+    end
+
+    it "uses the same path if the Asset content is the same" do
+      install_config <<-CONFIG
+        js_asset "signup" do
+          include "main.js"
+        end
+      CONFIG
+      AssetTrip.bundle!
+      AssetTrip.bundle!
+      assets("signup.js").should have(1).item
+    end
+
+    it "uses a different path if the Asset content is different" do
+      install_config <<-CONFIG
+        js_asset "signup" do
+          include "main.js"
+        end
+      CONFIG
+      AssetTrip.bundle!
+      AssetTrip.instance_variable_set(:@config, nil)
+      write_javascript("main.js", 'alert("new.main");')
+      AssetTrip.bundle!
+      assets("signup.js").should have(2).items
+    end
+
+    it "generates paths in the form of assets/XX/YYYYYYYY/filename.js" do
+      install_config <<-CONFIG
+        js_asset "signup" do
+          include "main.js"
+        end
+      CONFIG
+      AssetTrip.bundle!
+
+      directory = assets_path.glob("*").map { |f| File.basename(f) }.first
+      directory.size.should == 2
+    end
+
+    it "generates a manifest for use at runtime" do
+      install_config <<-CONFIG
+        js_asset "signup" do
+          include "main.js"
+        end
+      CONFIG
+      AssetTrip.bundle!
+
+      File.read(fixture_app.join("config", "asset_trip", "manifest.rb")).should be_like(<<-RUBY)
+        module AssetTrip
+          @manifest = Manifest.new
+          @manifest["signup.js"] = "7d6db1efb9e"
+        end
+      RUBY
+    end
+
+    it "rewrites URLs in CSS files to include the asset host" do
+      ActionController::Base.stub!(:asset_host => "http://cdn%d.example.com")
+
+      install_config <<-CONFIG
+        css_asset "signup" do
+          include "new"
+        end
+      CONFIG
+
+      write_stylesheet("new.css", <<-STYLESHEET)
+        .foo { background: url(/foo.jpg) }
+      STYLESHEET
+      AssetTrip.bundle!
+
+      asset("signup.css").should have_contents('url(http://cdn1.example.com/foo.jpg)')
+    end
+
+    it "rewrites URLs in CSS files to include HTTPs asset hosts" do
+      ActionController::Base.stub!(:asset_host => "http://cdn%d.example.com")
+
+      install_config <<-CONFIG
+        css_asset "signup" do
+          include "new"
+        end
+      CONFIG
+
+      write_stylesheet("new.css", <<-STYLESHEET)
+        .foo { background: url(/foo.jpg) }
+      STYLESHEET
+      AssetTrip.bundle!
+
+      asset("signup.ssl.css").should have_contents('url(https://cdn1.example.com/foo.jpg)')
+    end
+
+    it "respects ssl? method of request in asset proc" do
+      asset_proc = Proc.new { |source, request|
+        if request.ssl?
+          "https://assets.example.com"
+        else
+          "https://cdn.example.com"
+        end
+      }
+      ActionController::Base.stub!(:asset_host => asset_proc)
+      install_config <<-CONFIG
+        css_asset "signup" do
+          include "new"
+        end
+      CONFIG
+
+      write_stylesheet("new.css", <<-STYLESHEET)
+        .foo { background: url(/foo.jpg) }
+      STYLESHEET
+      AssetTrip.bundle!
+
+      asset("signup.ssl.css").should have_contents('url(https://assets.example.com/foo.jpg)')
+    end
+
+    it "does not write a new bundle if the package has not expired" do
+      install_config <<-CONFIG
+        js_asset "signup" do
+          include "main.js"
+        end
+      CONFIG
+      AssetTrip.bundle!
+
+      asset_mtime = 5.minutes.ago
+      source_mtime = 10.minutes.ago
+      asset("signup.js").utime(asset_mtime, asset_mtime)
+      app_javascript("main.js").utime(source_mtime, source_mtime)
+
+      AssetTrip.bundle!
+      asset("signup.js").mtime.to_i.should == asset_mtime.to_i
+    end
+
+    it "should use the most recent package to detect mtimes for expiry" do
+      install_config <<-CONFIG
+        js_asset "signup" do
+          include "main.js"
+        end
+      CONFIG
+      AssetTrip.bundle!
+
+      asset_mtime = 5.minutes.ago
+      source_mtime = 10.minutes.ago
+      oldest_asset_mtime = 15.minutes.ago
+
+      asset("signup.js").utime(asset_mtime, asset_mtime)
+      app_javascript("main.js").utime(source_mtime, source_mtime)
+      create_asset("46/123431bdc/signup.js", :mtime => oldest_asset_mtime)
+
+      AssetTrip.bundle!
+      assets("signup.js").map { |asset| asset.mtime.to_i }.sort.should == [oldest_asset_mtime.to_i, asset_mtime.to_i]
+    end
+  end
+
+  it "minifies JavaScript using the YUI Compressor" do
+    install_config <<-CONFIG
+      js_asset "signup" do
+        include "main"
+      end
+    CONFIG
+
+    write_javascript("main.js", <<-JAVASCRIPT)
+      // Comment
+      function foo() {
+        var long_var_name = 1;
+        return long_var_name + 1;
+      }
+    JAVASCRIPT
+    AssetTrip.bundle!
+
+    asset("signup.js").should_not have_contents('Comment')
+    asset("signup.js").should have_contents('return a+1')
+  end
+
+  it "minifies CSS using the YUI Compressor" do
+    install_config <<-CONFIG
+      css_asset "signup" do
+        include "new"
+      end
+    CONFIG
+
+    write_stylesheet("new.css", <<-STYLESHEET)
+      /* Comment */
+      .foo {
+        font-weight: bold;
+      }
+    STYLESHEET
+    AssetTrip.bundle!
+
+    asset("signup.css").should_not have_contents('Comment')
+    asset("signup.css").should have_contents('.foo{font-weight:bold;}')
+  end
+
+  it "raises a CompressorError if compression fails" do
+    install_config <<-CONFIG
+      js_asset "signup" do
+        include "main"
+      end
+    CONFIG
+    write_javascript("main.js", "!@$%&*")
+
+    lambda {
+      AssetTrip.bundle!
+    }.should raise_error(AssetTrip::CompressorError)
+  end
+end

data/spec/integration/prune_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe "rake asset_trip:prune" do
+  setup_sandbox_app!(:each)
+
+  before do
+    AssetTrip::Compressor.stub!(:new => DummyCompressor.new)
+  end
+
+  it "removes assets not in the current Manifest" do
+    install_config <<-CONFIG
+      js_asset "signup" do
+        include "main.js"
+      end
+    CONFIG
+    AssetTrip.bundle!
+    AssetTrip.instance_variable_set(:@config, nil)
+    write_javascript("main.js", 'alert("new.main");')
+    AssetTrip.bundle!
+    load fixture_app.join("config", "asset_trip", "manifest.rb")
+    AssetTrip.prune!
+    assets("signup.js").should have(1).item
+  end
+
+  it "does not remove assets in the current Manifest" do
+    install_config <<-CONFIG
+      js_asset "signup" do
+        include "main.js"
+      end
+    CONFIG
+    AssetTrip.bundle!
+    load fixture_app.join("config", "asset_trip", "manifest.rb")
+    AssetTrip.prune!
+    assets("signup.js").should have(1).item
+  end
+
+  it "removes unknown files" do
+    install_config <<-CONFIG
+      js_asset "signup" do
+        include "main.js"
+      end
+    CONFIG
+    AssetTrip.bundle!
+
+    File.open(assets_path.join("blah.jpg"), "w") do |f|
+      f << "blah!"
+    end
+
+    load fixture_app.join("config", "asset_trip", "manifest.rb")
+    AssetTrip.prune!
+    assets("blah.jpg").should have(0).items
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+-fs
+--debugger

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require "asset_trip"
+
+Dir[File.join(File.dirname(__FILE__), 'support', '*.rb')].each do |file|
+  require file
+end
+
+class DummyCompressor
+  def compress(contents)
+    return contents
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include AssetTrip::Spec::Helpers
+  config.include AssetTrip::Spec::Matchers
+  config.include AssetTrip::Spec::PathUtils
+  config.extend  AssetTrip::Spec::SandboxHelper
+
+  config.before do
+    # TODO: Is there a better way to accomodate this concern?
+    AssetTrip.instance_variable_set(:@config, nil)
+    AssetTrip.instance_variable_set(:@manifest, nil)
+  end
+end

data/spec/support/core_extensions.rb

@@ -0,0 +1,13 @@
+require "pathname"
+
+module AssetTrip
+  module Spec
+    module PathnameExtensions
+      def glob(*args)
+        self.class.glob(self.join(*args))
+      end
+    end
+
+    Pathname.send(:include, PathnameExtensions)
+  end
+end

data/spec/support/helpers.rb

@@ -0,0 +1,33 @@
+module AssetTrip
+  module Spec
+    module Helpers
+
+      def install_config(config_source, filename = "assets.rb")
+        FileUtils.mkdir_p(fixture_app)
+        File.open(fixture_app("config", "asset_trip", filename), 'w') do |f|
+          f.puts config_source
+        end
+      end
+
+      def write_javascript(name, contents)
+        File.open(app_javascript(name), "w") do |f|
+          f.puts contents
+        end
+      end
+
+      def write_stylesheet(name, contents)
+        File.open(app_stylesheet(name), "w") do |f|
+          f.puts contents
+        end
+      end
+
+      def create_asset(path, opts = {})
+        fake_asset = assets_path.join(path)
+        FileUtils.mkdir_p(fake_asset.dirname)
+        FileUtils.touch(fake_asset)
+        fake_asset.utime(opts[:mtime], opts[:mtime]) if opts[:mtime]
+      end
+
+    end
+  end
+end

data/spec/support/matchers.rb

@@ -0,0 +1,67 @@
+module AssetTrip
+  module Spec
+    module Matchers
+
+      class BeLike
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          @actual = actual
+          @expected.gsub(/\s+/, ' ').strip == @actual.gsub(/\s+/, ' ').strip
+        end
+
+        def failure_message
+          "expected\n#{@actual}\nto be like\n#{@expected}"
+        end
+
+        def negative_failure_message
+          "expected\n#{@actual}\nto be unlike\n#{@expected}"
+        end
+      end
+
+      def be_like(expected)
+        BeLike.new(expected)
+      end
+
+      def have_asset(name)
+        simple_matcher("have asset") do |path|
+          File.exist?(assets_path.glob("**", name).first)
+        end
+      end
+
+      def have_directory(name)
+        simple_matcher("have directory") do |path|
+          matches = path.glob("**", name)
+          matches.any? { |path| File.directory?(path) }
+        end
+      end
+
+      class HaveContents
+        def initialize(text)
+          @text = text
+        end
+
+        def matches?(path)
+          @path = path
+          @actual = File.read(path)
+          @actual.include?(@text)
+        end
+
+        def failure_message
+          "expected #{@path}\n#{@actual}\nto include\n#{@text}"
+        end
+
+        def negative_failure_message
+          "expected #{@path}\n#{@actual}\nto not include\n#{@text}"
+        end
+      end
+
+      def have_contents(text)
+        HaveContents.new(text)
+      end
+
+    end
+  end
+end

data/spec/support/path_utils.rb

@@ -0,0 +1,45 @@
+module AssetTrip
+  module Spec
+    module PathUtils
+
+      def reset_filesystem!
+        tmp_path.rmtree if tmp_path.exist?
+        tmp_path.mkdir
+        FileUtils.cp_r(root.join("spec", "fixtures"), fixture_app)
+      end
+
+      def root
+        Pathname.new(__FILE__).dirname.join('..', '..').expand_path
+      end
+
+      def tmp_path
+        root.join("tmp")
+      end
+
+      def fixture_app(*args)
+        tmp_path.join("fixture_app", *args)
+      end
+
+      def app_javascript(*args)
+        fixture_app.join("app", "javascripts", *args)
+      end
+
+      def app_stylesheet(*args)
+        fixture_app.join("app", "stylesheets", *args)
+      end
+
+      def asset(name)
+        assets(name).first
+      end
+
+      def assets(name)
+        assets_path.glob("**", name)
+      end
+
+      def assets_path
+        fixture_app.join("public", "assets")
+      end
+
+    end
+  end
+end

data/spec/support/sandbox_helper.rb

@@ -0,0 +1,19 @@
+module AssetTrip
+  module Spec
+    module SandboxHelper
+
+      def setup_sandbox_app!(around = :all)
+        before(around) do
+          reset_filesystem!
+          @old_pwd = Dir.pwd
+          Dir.chdir(fixture_app)
+        end
+
+        after(around) do
+          Dir.chdir(@old_pwd)
+        end
+      end
+
+    end
+  end
+end

data/tasks/asset_trip.rake

@@ -0,0 +1,11 @@
+namespace :assets do
+  desc "Bundle assets"
+  task :bundle => :environment do
+    AssetTrip.bundle!
+  end
+
+  desc "Prune assets"
+  task :prune => :environment do
+    AssetTrip.prune!
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: asset-trip
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bryan Helmkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-05 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: |-
+  Asset Trip bundles JavaScript and CSS files at deploy time. The assets are
+  then served from a Git-esque object store in the application's public
+  directory.
+email: bryan@brynary.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.rdoc
+- MIT-LICENSE.txt
+files: 
+- .gitignore
+- History.txt
+- MIT-LICENSE.txt
+- README.rdoc
+- Rakefile
+- Thorfile
+- asset-trip.gemspec
+- init.rb
+- lib/asset_trip.rb
+- lib/asset_trip/asset.rb
+- lib/asset_trip/compressor.rb
+- lib/asset_trip/config.rb
+- lib/asset_trip/file_writer.rb
+- lib/asset_trip/helper.rb
+- lib/asset_trip/javascript.rb
+- lib/asset_trip/load_path.rb
+- lib/asset_trip/manifest.rb
+- lib/asset_trip/manifest_writer.rb
+- lib/asset_trip/memoizable.rb
+- lib/asset_trip/middleware.rb
+- lib/asset_trip/ssl_stylesheet.rb
+- lib/asset_trip/stylesheet.rb
+- lib/asset_trip/url_rewriter.rb
+- spec/asset_trip/asset_spec.rb
+- spec/asset_trip/compressor_spec.rb
+- spec/asset_trip/config_spec.rb
+- spec/asset_trip/helper_spec.rb
+- spec/asset_trip/javascript_spec.rb
+- spec/asset_trip/load_path_spec.rb
+- spec/asset_trip/manifest_writer_spec.rb
+- spec/asset_trip/middleware_spec.rb
+- spec/asset_trip/stylesheet_spec.rb
+- spec/asset_trip/url_rewriter_spec.rb
+- spec/asset_trip_spec.rb
+- spec/fixtures/app/javascripts/main.js
+- spec/fixtures/app/javascripts/main/new.js
+- spec/fixtures/app/javascripts/signup.js
+- spec/fixtures/app/stylesheets/new.css
+- spec/fixtures/config/asset_trip/assets.rb
+- spec/integration/bundle_spec.rb
+- spec/integration/prune_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/core_extensions.rb
+- spec/support/helpers.rb
+- spec/support/matchers.rb
+- spec/support/path_utils.rb
+- spec/support/sandbox_helper.rb
+- tasks/asset_trip.rake
+- vendor/yuicompressor-2.4.2.jar
+has_rdoc: true
+homepage: http://github.com/brynary/asset-trip
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails asset bundling plugin that will expand your mind
+test_files: 
+- spec/asset_trip/asset_spec.rb
+- spec/asset_trip/compressor_spec.rb
+- spec/asset_trip/config_spec.rb
+- spec/asset_trip/helper_spec.rb
+- spec/asset_trip/javascript_spec.rb
+- spec/asset_trip/load_path_spec.rb
+- spec/asset_trip/manifest_writer_spec.rb
+- spec/asset_trip/middleware_spec.rb
+- spec/asset_trip/stylesheet_spec.rb
+- spec/asset_trip/url_rewriter_spec.rb
+- spec/asset_trip_spec.rb
+- spec/fixtures/config/asset_trip/assets.rb
+- spec/integration/bundle_spec.rb
+- spec/integration/prune_spec.rb
+- spec/spec_helper.rb
+- spec/support/core_extensions.rb
+- spec/support/helpers.rb
+- spec/support/matchers.rb
+- spec/support/path_utils.rb
+- spec/support/sandbox_helper.rb