asset-trip 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+tmp
+pkg

data/History.txt

@@ -0,0 +1,6 @@
+== 0.1.0 / 2009-11-05
+
+* 1 major enhancement
+
+  * Birthday!
+

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2008-2009 Bryan Helmkamp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,27 @@
+= Asset Trip
+
+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.
+
+Development of Asset Trip was kindly sponsored by Weplay[http://www.weplay.com]
+
+== Features and Benefits
+
+* Reliable cache busting strategy, even during graceful deploys
+* Develop in app/, deploy to public/
+* Efficient compression of JavaScript and CSS from the YUI Compressor
+* Fast at runtime. No bundling or File mtime checking slowing down your
+  production requests
+* Simple, powerful all-Ruby configuration files
+
+== Hat tips
+
+* bundle_fu
+* asset_packager
+* bundler
+* sprockets
+* git
+* asset-hosting-with-minimum-ssl
+* http://carsonified.com/blog/features/webapps/serving-javascript-fast/
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "spec/rake/spectask"
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = true
+end
+
+task :default => :spec
+
+desc 'Removes trailing whitespace'
+task :whitespace do
+  sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
+end

data/Thorfile

@@ -0,0 +1,110 @@
+module GemHelpers
+
+  def generate_gemspec
+    $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "lib")))
+    require "asset_trip"
+
+    Gem::Specification.new do |s|
+      s.name      = "asset-trip"
+      s.version   = AssetTrip::VERSION
+      s.author    = "Bryan Helmkamp"
+      s.email     = "bryan@brynary.com"
+      s.homepage  = "http://github.com/brynary/asset-trip"
+      s.summary   = "Rails asset bundling plugin that will expand your mind"
+      s.description  = <<-EOS.strip
+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.
+      EOS
+
+      require "git"
+      repo = Git.open(".")
+
+      s.files      = normalize_files(repo.ls_files.keys - repo.lib.ignored_files)
+      s.test_files = normalize_files(Dir['spec/**/*.rb'] - repo.lib.ignored_files)
+
+      s.has_rdoc = true
+      s.extra_rdoc_files = %w[History.txt README.rdoc MIT-LICENSE.txt]
+    end
+  end
+
+  def normalize_files(array)
+    # only keep files, no directories, and sort
+    array.select do |path|
+      File.file?(path)
+    end.sort
+  end
+
+  # Adds extra space when outputting an array. This helps create better version
+  # control diffs, because otherwise it is all on the same line.
+  def prettyify_array(gemspec_ruby, array_name)
+    gemspec_ruby.gsub(/s\.#{array_name.to_s} = \[.+?\]/) do |match|
+      leadin, files = match[0..-2].split("[")
+      leadin + "[\n    #{files.split(",").join(",\n   ")}\n  ]"
+    end
+  end
+
+  def read_gemspec
+    @read_gemspec ||= eval(File.read("asset-trip.gemspec"))
+  end
+
+  def sh(command)
+    puts command
+    system command
+  end
+end
+
+class Default < Thor
+  include GemHelpers
+
+  desc "gemspec", "Regenerate asset-trip.gemspec"
+  def gemspec
+    File.open("asset-trip.gemspec", "w") do |file|
+      gemspec_ruby = generate_gemspec.to_ruby
+      gemspec_ruby = prettyify_array(gemspec_ruby, :files)
+      gemspec_ruby = prettyify_array(gemspec_ruby, :test_files)
+      gemspec_ruby = prettyify_array(gemspec_ruby, :extra_rdoc_files)
+
+      file.write gemspec_ruby
+    end
+
+    puts "Wrote gemspec to asset-trip.gemspec"
+    read_gemspec.validate
+  end
+
+  desc "build", "Build a asset-trip gem"
+  def build
+    sh "gem build asset-trip.gemspec"
+    FileUtils.mkdir_p "pkg"
+    FileUtils.mv read_gemspec.file_name, "pkg"
+  end
+
+  desc "install", "Install the latest built gem"
+  def install
+    sh "gem install --local pkg/#{read_gemspec.file_name}"
+  end
+
+  desc "release", "Release the current branch to GitHub and Gemcutter"
+  def release
+    gemspec
+    build
+    Release.new.tag
+    Release.new.gem
+  end
+end
+
+class Release < Thor
+  include GemHelpers
+
+  desc "tag", "Tag the gem on the origin server"
+  def tag
+    release_tag = "v#{read_gemspec.version}"
+    sh "git tag -a #{release_tag} -m 'Tagging #{release_tag}'"
+    sh "git push origin #{release_tag}"
+  end
+
+  desc "gem", "Push the gem to Gemcutter"
+  def gem
+    sh "gem push pkg/#{read_gemspec.file_name}"
+  end
+end

data/asset-trip.gemspec

@@ -0,0 +1,107 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{asset-trip}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bryan Helmkamp"]
+  s.date = %q{2009-11-05}
+  s.description = %q{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.}
+  s.email = %q{bryan@brynary.com}
+  s.extra_rdoc_files = [
+    "History.txt",
+    "README.rdoc",
+    "MIT-LICENSE.txt"
+  ]
+  s.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"
+  ]
+  s.homepage = %q{http://github.com/brynary/asset-trip}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rails asset bundling plugin that will expand your mind}
+  s.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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,3 @@
+if File.exist?(Rails.root.join("config", "asset_trip", "manifest.rb"))
+  require Rails.root.join("config", "asset_trip", "manifest")
+end

data/lib/asset_trip/asset.rb

@@ -0,0 +1,82 @@
+require "digest"
+
+module AssetTrip
+  class Asset
+    extend Memoizable
+
+    attr_reader :files
+
+    def initialize(config, name, files = [], &block)
+      @config = config
+      @name = name
+      @files = files
+
+      instance_eval(&block) if block_given?
+    end
+
+    def contents
+      compressor.compress(joined_contents)
+    end
+
+    def paths
+      files.map do |file|
+        @config.resolve_file(asset_type, file)
+      end
+    end
+
+    def bundle!
+      if expired?
+        FileWriter.new(path).write!(contents)
+      else
+        last_package = packaged_files.sort_by { |path| File.mtime(path) }.last
+        @md5sum = File.dirname(last_package).last(12).gsub(/\//, '')
+      end
+    end
+
+    def md5sum
+      @md5sum ||= Digest::MD5.hexdigest(contents)
+    end
+
+  private
+
+    def expired?
+      packaged_files.empty? || generated_at <= last_change_at
+    end
+
+    def generated_at
+      packaged_file_mtimes.last
+    end
+
+    def packaged_file_mtimes
+      @packaged_file_mtimes ||= packaged_files.map { |path| File.mtime(path) }.sort
+    end
+
+    def packaged_files
+      Dir[AssetTrip.assets_path.join("**", name)]
+    end
+
+    def last_change_at
+      mtimes.last
+    end
+
+    def mtimes
+      @mtimes ||= paths.map { |path| File.mtime(path) }.sort
+    end
+
+    def include(name)
+      name += extension unless name.ends_with?(extension)
+      files << name
+    end
+
+    def path
+      dir.join(name)
+    end
+
+    def dir
+      part1 = md5sum[0..1]
+      part2 = md5sum[2..10]
+      AssetTrip.assets_path.join(part1, part2)
+    end
+
+  end
+end

data/lib/asset_trip/compressor.rb

@@ -0,0 +1,36 @@
+require 'popen4'
+
+module AssetTrip
+  class Compressor
+
+    def initialize(type)
+      @type = type
+    end
+
+    def compress(contents)
+      out = nil
+      err = nil
+
+      status = POpen4.popen4(command) do |stdout, stderr, stdin, pid|
+        stdin.puts contents
+        stdin.close
+        out = stdout.read.strip
+        err = stderr.read.strip
+      end
+
+      raise CompressorError.new(err) unless status.success?
+      return out
+    end
+
+  private
+
+    def command
+      "java -jar #{jar_path} --type #{@type}"
+    end
+
+    def jar_path
+      AssetTrip.root.join("vendor", "yuicompressor-2.4.2.jar")
+    end
+
+  end
+end

data/lib/asset_trip/config.rb

@@ -0,0 +1,60 @@
+module AssetTrip
+  class Config
+
+    def self.from_file(dir)
+      source = File.read(dir.join("assets.rb"))
+      eval "self.new {( " + source + "\n )}"
+    end
+
+    attr_reader :assets_hash
+    attr_reader :load_paths
+
+    def initialize(&block)
+      @load_paths = Hash.new { LoadPath.new }
+      @load_paths[:javascripts] = LoadPath.new(["app/javascripts"])
+      @load_paths[:stylesheets] = LoadPath.new(["app/stylesheets"])
+
+      @assets_hash = {}
+      instance_eval(&block)
+    end
+
+    def bundle!
+      assets.each do |asset|
+        asset.bundle!
+      end
+
+      ManifestWriter.new(assets).write!
+    end
+
+    def resolve_file(asset_type, file)
+      @load_paths[asset_type].resolve(file)
+    end
+
+    def assets
+      @assets_hash.values
+    end
+
+  private
+
+    def js_asset(name, &block)
+      asset = Javascript.new(self, name, &block)
+      @assets_hash[asset.name] = asset
+    end
+
+    def css_asset(name, &block)
+      asset = Stylesheet.new(self, name, &block)
+      @assets_hash[asset.name] = asset
+
+      ssl_asset = asset.ssl_stylesheet
+      @assets_hash[ssl_asset.name] = ssl_asset
+    end
+
+    def load(filename)
+      dirname   = File.dirname(filename.to_s)
+      filename  = File.basename(filename.to_s, ".rb") + ".rb"
+      source    = File.read(AssetTrip.app_root.join(dirname, filename))
+      instance_eval(source)
+    end
+
+  end
+end

data/lib/asset_trip/file_writer.rb

@@ -0,0 +1,17 @@
+module AssetTrip
+  class FileWriter
+
+    def initialize(path)
+      @path = path
+    end
+
+    def write!(contents)
+      FileUtils.mkdir_p(File.dirname(@path))
+
+      File.open(@path, "w") do |file|
+        file << contents
+      end
+    end
+
+  end
+end

data/lib/asset_trip/helper.rb

@@ -0,0 +1,83 @@
+module AssetTrip
+  module Helper
+
+    def javascript_include_asset(*sources)
+      _javascripts_for_sources(sources).map do |javascript|
+        javascript_include_tag(javascript)
+      end.join("\n")
+    end
+
+    def stylesheet_link_asset(*sources)
+      options = sources.extract_options!
+
+      _stylesheets_for_sources(sources).map do |stylesheet|
+        stylesheet_link_tag(stylesheet, options)
+      end.join("\n")
+    end
+
+    def rewrite_asset_path(source)
+      if source =~ /assets/
+        source
+      else
+        super
+      end
+    end
+
+  private
+
+    def _stylesheets_for_sources(sources)
+      sources.map { |source| _stylesheets_for_source(source) }.flatten
+    end
+
+    def _javascripts_for_sources(sources)
+      sources.map { |source| _javascripts_for_source(source) }.flatten
+    end
+
+    def _stylesheets_for_source(source)
+      if AssetTrip.bundle
+        _stylesheet_manifest_url(source)
+      else
+        _unbundled_stylesheet_urls(source)
+      end
+    end
+
+    def _javascripts_for_source(source)
+      if AssetTrip.bundle
+        AssetTrip.manifest.path_for(_source_with_extension(source, ".js"))
+      else
+        _unbundled_javascript_urls(source)
+      end
+    end
+
+    def _unbundled_stylesheet_urls(source)
+      asset = AssetTrip.config.assets_hash[_source_with_extension(source, ".css")]
+
+      asset.files.map do |file|
+        _unbundled_asset_url(:stylesheets, file)
+      end
+    end
+
+    def _unbundled_javascript_urls(source)
+      asset = AssetTrip.config.assets_hash[_source_with_extension(source, ".js")]
+
+      asset.files.map do |file|
+        _unbundled_asset_url(:javascripts, file)
+      end
+    end
+
+    def _unbundled_asset_url(asset_type, file)
+      "#{request.protocol}#{request.host}:#{request.port}/__asset_trip__/#{asset_type}/#{file}"
+    end
+
+    def _stylesheet_manifest_url(source)
+      source_with_extension = _source_with_extension(source, ".css")
+      source_with_extension.gsub!(/.css$/, ".ssl.css") if request.ssl?
+      AssetTrip.manifest.path_for(source_with_extension)
+    end
+
+    def _source_with_extension(source, extension)
+      File.basename(source.to_s, extension) + extension
+    end
+
+  end
+end

data/lib/asset_trip/javascript.rb

@@ -0,0 +1,29 @@
+module AssetTrip
+  class Javascript < Asset
+
+    def name
+      "#{@name}.js"
+    end
+
+  private
+
+    def joined_contents
+      paths.map do |path|
+        File.read(path)
+      end.join("\n\n")
+    end
+
+    def compressor
+      Compressor.new("js")
+    end
+
+    def asset_type
+      :javascripts
+    end
+
+    def extension
+      ".js"
+    end
+
+  end
+end

data/lib/asset_trip/load_path.rb

@@ -0,0 +1,39 @@
+module AssetTrip
+  class LoadPath
+
+    attr_reader :paths
+
+    def initialize(paths = [])
+      @paths = paths.map { |path| Pathname.new(path) }
+    end
+
+    def ==(other)
+      self.class == other.class &&
+      @paths == other.paths
+    end
+
+    def <<(path)
+      @paths << Pathname.new(path)
+    end
+
+    # TODO: Refactor
+    def resolve(file)
+      raise UnknownAssetError.new("Could not find #{file} in paths: #{@paths.inspect}") if file.nil?
+
+      file_paths = @paths.map do |path|
+        path.join(file).expand_path
+      end
+
+      result = file_paths.detect do |file_path|
+        File.exist?(file_path)
+      end
+
+      if result
+        return result
+      else
+        raise UnknownAssetError.new("Could not find #{file} in paths: #{@paths.inspect}")
+      end
+    end
+
+  end
+end

data/lib/asset_trip/manifest.rb

@@ -0,0 +1,40 @@
+module AssetTrip
+  class Manifest
+
+    def initialize(md5sums = {})
+      @md5sums = md5sums
+    end
+
+    def path_for(key)
+      md5sum = self[key]
+      "/" + File.join("assets", md5sum[0..1], md5sum[2..10], key)
+    end
+
+    def []=(key, value)
+      @md5sums[key] = value
+    end
+
+    def [](key)
+      unless @md5sums.has_key?(key)
+        raise UnknownAssetError.new("Can't find #{key} in the manifest")
+      end
+
+      @md5sums[key]
+    end
+
+    def prune!
+      Pathname.glob(AssetTrip.assets_path.join("**", "*.*")).each do |file|
+        part2 = file.dirname.split.last.to_s
+        part1 = file.dirname.split.first.split.last.to_s
+
+        md5sum = part1 + part2
+
+        if !@md5sums.has_key?(file.basename.to_s) || @md5sums[file.basename.to_s][0..10] != md5sum
+          File.unlink(file)
+        end
+      end
+    end
+
+  end
+end
+