bagger 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*
+*.rbc

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 1.8.7
+  - ree
+  - rbx-head

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in bagger.gemspec
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+# bagger
+
+A framework agnostic packaging solution to speed up client side
+rendering by using the following techniques:
+
+* Generating versioned assets to maximize cache efficiency
+* Combine, minify and lint javascript and css files to reduce bandwidth
+* Zip assets to further reduce bandwidth consumption
+* Generating a file manifest to lookup an asset's location
+* Rewrite urls in css files with the versioned file name
+* Bundle up the assets as a zip file
+
+## Similar projects
+
+* [jammit](https://github.com/documentcloud/jammit)
+* [Rails 3 asset pipeline](http://blog.nodeta.com/2011/06/14/rails-3-1-asset-pipeline-in-the-real-world/)
+* [assets.io](http://www.assets.io/)
+
+## Roadmap
+
+### Version 0.0.1 (Minimal Viable Product)
+
+* Versioned assets
+* Manifest files
+* Combine javascript
+* Combine css
+* Rewrite css urls
+* CLI binary
+* Solid test suite
+* Support for the following Ruby versions (MRI 1.8.7, 1.9.2, REE 1.8.7)
+* Pass all tests on travisci.org
+* Examples on how to integrate it into the development workflow using
+  tools like watch or supervisor
+
+## Tests
+
+check the build status on [travis.ci](http://travis-ci.org/wooga/bagger)

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+task :default => ['test:units']
+
+def rubies
+  require 'yaml'
+  rubies = YAML.load_file('.travis.yml')['rvm']
+end
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/*_test.rb']
+
+    t.verbose = true
+  end
+
+  desc 'run test suite with all ruby versions'
+  task :multi_ruby do
+    rubies.each do |ruby_version|
+      puts `rvm use #{ruby_version} && rake`
+    end
+  end
+end
+
+desc 'run bundle install for all rubies'
+task :prepare_rubies do
+  rubies.each do |ruby_version|
+    puts `rvm use #{ruby_version} && gem install bundler && bundle`
+  end
+end

data/bagger.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bagger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bagger"
+  s.version     = Bagger::VERSION
+  s.authors     = ["Patrick Huesler"]
+  s.email       = ["patrick.huesler@gmail.com"]
+  s.homepage    = ""
+  s.summary     = "Asset packaging for the rest of us"
+  s.description = "A framework agnostic packaging solution for your assets: version files, combine them, minify them and create a manifest"
+
+  s.rubyforge_project = "bagger"
+
+  s.add_dependency "json"
+  s.add_dependency "addressable"
+  s.add_dependency "uglifier"
+  s.add_dependency "rainpress"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "shoulda-context"
+  s.add_development_dependency "mocha"
+
+  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"]
+end

data/lib/bagger/packager.rb

@@ -0,0 +1,148 @@
+# encoding: UTF-8
+require 'json'
+require 'digest/md5'
+require 'addressable/uri'
+require 'uglifier'
+require 'rainpress'
+
+module Bagger
+  class Packager
+
+    def initialize(options)
+      @options = options
+      @manifest_name = 'manifest.json'
+      @stylesheets = (@options[:combine] || {})[:stylesheets] || []
+      @javascripts = (@options[:combine] || {})[:javascripts] || []
+      @source_dir = @options[:source_dir]
+      @target_dir = @options[:target_dir]
+      @stylesheet_path = (@options[:combine] || {})[:stylesheet_path] || 'combined.css'
+      @javascript_path = (@options[:combine] || {})[:javascript_path] || 'combined.js'
+      @path_prefix = @options[:path_prefix] || ''
+      @manifest = {}
+    end
+
+    def to_manifest(path, keep_original = true)
+      content = File.open(File.join(@target_dir, path)) { |f| f.read }
+      extension = File.extname(path)
+      basename = File.basename(path, extension)
+      dirname = File.dirname(path)
+      FileUtils.mkdir_p(File.join(@target_dir, dirname))
+      md5 = Digest::MD5.hexdigest(content)
+      new_file_name = "#{basename}.#{md5}#{extension}"
+      new_file_path = File.join(@target_dir, dirname, new_file_name)
+      File.open(new_file_path, 'w') { |f| f.write content }
+      FileUtils.rm(File.join(@target_dir, path)) unless keep_original
+      manifest_key_path = File.expand_path("/#{dirname}/#{basename}#{extension}")
+      effective_path = File.expand_path(@path_prefix + "/" + File.join(dirname, new_file_name))
+      @manifest[manifest_key_path] = effective_path
+    end
+
+    def manifest_path
+      File.join(@options[:source_dir], @manifest_name)
+    end
+
+    def run
+      combine_css
+      combine_js
+      version_files
+      rewrite_urls_in_css
+      compress_css
+      to_manifest(@stylesheet_path, false)
+      compress_js
+      to_manifest(@javascript_path, false)
+      generate_and_version_cache_manifest
+      write_manifest
+    end
+
+    def write_manifest
+      File.open(manifest_path, 'w') do |f|
+        f.write JSON.pretty_generate(@manifest)
+      end
+    end
+
+    def version_files
+      FileUtils.cd(@source_dir) do
+        Dir["**/*"].reject{ |f| f =~ /\.(css|js)$/ }.each do |path|
+          if File.directory? path
+            FileUtils.mkdir_p(File.join(@target_dir, path))
+            next
+          end
+          FileUtils.cp(path, File.join(@target_dir, path))
+          to_manifest(path, false)
+        end
+      end
+    end
+
+    def combine_css
+      combine_files(@stylesheets, @stylesheet_path)
+    end
+
+    def rewrite_urls_in_css
+      url_regex = /(^|[{;])(.*?url\(\s*['"]?)(.*?)(['"]?\s*\).*?)([;}]|$)/ui
+      behavior_regex = /behavior:\s*url/ui
+      data_regex = /^\s*data:/ui
+      input = File.open(File.join(@target_dir, @stylesheet_path)){|f| f.read}
+      output = input.gsub(url_regex) do |full_match|
+        pre, url_match, post = ($1 + $2), $3, ($4 + $5)
+        if behavior_regex.match(pre) || data_regex.match(url_match)
+          full_match
+        else
+          path = Addressable::URI.parse("/") + url_match
+          target_url = @manifest[path.to_s]
+          if target_url
+            pre + target_url + post
+          else
+            full_match
+          end
+        end
+      end
+      File.open(File.join(@target_dir, @stylesheet_path), 'w') do |f|
+        f.write output
+      end
+    end
+
+    def compress_css
+      css = File.open(File.join(@target_dir, @stylesheet_path)){|f| f.read}
+      compressed = Rainpress.compress(css)
+      File.open(File.join(@target_dir, @stylesheet_path), 'w') do |f|
+        f.write compressed
+      end
+    end
+
+    def combine_js
+      combine_files(@javascripts, @javascript_path)
+    end
+
+    def compress_js
+      javascript = File.open(File.join(@target_dir, @javascript_path)){|f| f.read}
+      compressed = Uglifier.compile(javascript)
+      File.open(File.join(@target_dir, @javascript_path), 'w'){|f| f.write compressed}
+    end
+
+    def generate_and_version_cache_manifest
+      File.open(File.join(@target_dir, 'cache.manifest'), 'w') do |f|
+        f.puts 'CACHE MANIFEST'
+        f.puts ''
+        f.puts '# Explicitely cached entries'
+        f.puts @manifest.values.join("\n")
+        f.puts ''
+        f.puts 'NETWORK:'
+        f.puts '*'
+      end
+      to_manifest('cache.manifest')
+    end
+
+    private
+
+    def combine_files(files, path)
+      output = ''
+      FileUtils.mkdir_p(File.join(@target_dir, File.dirname(path)))
+      target_path = File.join(@target_dir, path)
+      files.each do |file|
+        output << File.open(File.join(@source_dir, file)) { |f| f.read }
+        output << "\n"
+      end
+      File.open(target_path, "w") { |f| f.write(output) }
+    end
+  end
+end

data/lib/bagger/version.rb

@@ -0,0 +1,3 @@
+module Bagger
+  VERSION = "0.0.1"
+end

data/lib/bagger.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require 'json'
+require "bagger/packager"
+
+module Bagger
+  def self.bagit!(options)
+    Bagger::Packager.new(options).run
+  end
+end

data/test/bagger_test.rb

@@ -0,0 +1,265 @@
+# encoding: UTF-8
+require 'test_helper'
+
+class BaggerTest < Test::Unit::TestCase
+
+  def setup
+    @source_dir = Dir.mktmpdir
+    @target_dir = Dir.mktmpdir
+    Uglifier.stubs(:compile).returns('//minfied js');
+  end
+
+  def teardown
+    FileUtils.remove_entry_secure @source_dir
+    FileUtils.remove_entry_secure @target_dir
+  end
+
+  def write_file(path, content)
+    File.open(path, 'w') do |f|
+      f.write content
+    end
+  end
+
+  def default_options
+    {
+      :source_dir => @source_dir,
+      :target_dir => @target_dir,
+    }
+  end
+
+  def manifest
+    path = File.join(@source_dir, 'manifest.json')
+    json = File.open(path){|f| f.read}
+    JSON.parse(json) 
+  end
+
+  context 'manifest' do
+    should 'generate one' do
+      Bagger.bagit!(default_options)
+      assert File.exists?(File.join(@source_dir, 'manifest.json')), 'manifest was not created'
+    end
+
+    should 'version files with md5' do
+      test_content = 'testcontent'
+      write_file(File.join(@source_dir, 'test.txt'), test_content)
+      Bagger.bagit!(default_options)
+      md5 = Digest::MD5.hexdigest(test_content)
+      assert_equal md5, manifest['/test.txt'].split('.')[1]
+    end
+
+    should 'copy over the versioned files' do
+      test_content = 'testcontent'
+      write_file(File.join(@source_dir, 'test.txt'), test_content)
+      Bagger.bagit!(default_options)
+      assert File.exists?(File.join(@target_dir, manifest['/test.txt']))
+    end
+
+    should 'support a path prefix' do
+      test_content = 'testcontent'
+      write_file(File.join(@source_dir, 'test.txt'), test_content)
+      Bagger.bagit!(default_options.merge(:path_prefix => '/path_prefix'))
+      assert_match /\/path_prefix\/test\..*\.txt/, manifest['/test.txt']
+    end
+  end
+
+  context 'html 5 cache manifest' do
+    should 'generate one' do
+      Bagger.bagit!(default_options)
+      expected_path = File.join(@target_dir, 'cache.manifest')
+      assert File.exists?(expected_path), 'cache manifest not found'
+    end
+
+    should 'add the cache manifest to the manifest' do
+      Bagger.bagit!(default_options)
+      assert_match /\/cache\..*\.manifest/, manifest['/cache.manifest']
+    end
+
+    should 'create a versioned cache manifest' do
+      Bagger.bagit!(default_options)
+      expected_path = File.join(@target_dir, manifest['/cache.manifest'])
+      assert File.exists?(expected_path), 'versioned cache manifest not found'
+    end
+  end
+
+  context 'css files' do
+    setup do
+      @config = {
+        :stylesheets => [],
+        :stylesheet_path => 'css/combined.css'
+      }
+      @css_dir = File.join(@source_dir, 'css')
+      FileUtils.mkdir_p(@css_dir)
+      %w(one two).each do |file|
+        write_file(
+                    File.join(@css_dir, "#{file}.css"),
+                    ".#{file}{}"
+                  )
+        @config[:stylesheets] << "css/#{file}.css"
+      end
+    end
+
+    should 'add it to the manifest' do
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+
+      assert manifest['/css/combined.css']
+    end
+
+    should 'combine it' do
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+      expected_file_path = File.join(@target_dir, manifest['/css/combined.css'])
+      assert File.exists?(expected_file_path), 'combined css not found'
+    end
+
+    should 'only copy over the generate files' do
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+      assert !File.exists?(File.join(@target_dir, 'css', 'one.css'))
+    end
+
+    should 'compress it' do
+      Rainpress.stubs(:compress).returns('//super minified css');
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+      expected_file_path = File.join(@target_dir, manifest['/css/combined.css'])
+      compressed_content = File.open(expected_file_path){|f| f.read}
+      assert_equal '//super minified css', compressed_content , 'combined css not found'
+    end
+
+    context 'url rewriting' do
+      setup do
+        css = <<-EOF
+        #documentRootBasedUrl {
+            background: url("/images/root.png") top center;
+        }
+        #relativeUrl {
+            background: url("../images/relative.png") top center;
+        }
+        #absoluteUrl {
+            background: url('http://localhost/absolute.png') top center;
+        }
+        EOF
+        write_file(File.join(@css_dir, "urled.css"), css)
+        @config[:stylesheets] << 'css/urled.css'
+        FileUtils.mkdir_p(File.join(@source_dir, 'images'))
+        %w(root relative absolute).each do |type|
+          FileUtils.touch(File.join(@source_dir, 'images', "#{type}.png"))
+        end
+      end
+
+      should 'rewrite document root based urls' do
+        Bagger.bagit!(
+          :source_dir => @source_dir,
+          :target_dir => @target_dir,
+          :combine => @config
+        )
+        combined_css = File.open(File.join(@target_dir, manifest['/css/combined.css'])){|f| f.read}
+        assert combined_css.include?(manifest['/images/root.png'])
+      end
+
+      should 'rewrite relative (anchored by the css file) urls to absolute paths' do
+        Bagger.bagit!(
+          :source_dir => @source_dir,
+          :target_dir => @target_dir,
+          :combine => @config
+        )
+        combined_css = File.open(File.join(@target_dir, manifest['/css/combined.css'])){|f| f.read}
+        assert combined_css.include?(manifest['/images/relative.png'])
+      end
+
+      should 'not rewrite absolute urls' do
+        Bagger.bagit!(
+          :source_dir => @source_dir,
+          :target_dir => @target_dir,
+          :combine => @config
+        )
+        combined_css = File.open(File.join(@target_dir, manifest['/css/combined.css'])){|f| f.read}
+        assert combined_css.include?('http://localhost/absolute.png')
+      end
+
+      should 'support a path prefix' do
+        Bagger.bagit!(
+          :source_dir => @source_dir,
+          :target_dir => @target_dir,
+          :path_prefix => '/path_prefix',
+          :combine => @config
+        )
+        combined_css_path = manifest['/css/combined.css'].gsub(/path_prefix/,'')
+        combined_css = File.open(File.join(@target_dir, combined_css_path)){|f| f.read}
+        assert_match /\/path_prefix\/images\/relative\..*\.png/, combined_css
+      end
+    end
+  end
+
+  context 'combine javascript' do
+    setup do
+      @config = {
+        :javascripts => [],
+        :javascript_path => 'js/combined.js'
+      }
+      @js_dir = File.join(@source_dir, 'js')
+      FileUtils.mkdir_p(@js_dir)
+      %w(one two).each do |file|
+        write_file(
+                    File.join(@js_dir, "#{file}.js"),
+                    "var #{file} = 1;"
+                  )
+        @config[:javascripts] << "js/#{file}.js"
+      end
+    end
+
+    should 'add it to the manifest' do
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+      assert manifest['/js/combined.js']
+    end
+
+    should 'combine it' do
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+      expected_file_path = File.join(@target_dir, manifest['/js/combined.js'])
+      assert File.exists?(expected_file_path), 'combined js not found'
+    end
+
+    should 'only copy over the generate files' do
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+      assert !File.exists?(File.join(@target_dir, 'js', 'one.js'))
+    end
+
+    should 'compress the javascript' do
+      expected_path = File.join(@target_dir, 'js', 'combined.js')
+      Uglifier.expects(:compile).returns('//minified javascript')
+
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+      expected_file_path = File.join(@target_dir, manifest['/js/combined.js'])
+      assert_equal '//minified javascript', File.open(expected_file_path){|f| f.read}
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift( File.join( File.dirname(__FILE__), "..", "lib") )
+
+require "rubygems"
+require 'test/unit'
+require 'mocha'
+require 'shoulda-context'
+require 'bagger'
+require 'fileutils'
+
+TEST_TEMP_DIR = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp'))
+

data/tests.watchr

@@ -0,0 +1,38 @@
+# Run me with:
+#   $ watchr specs.watchr
+
+# --------------------------------------------------
+# Rules
+# --------------------------------------------------
+watch( '^test.*/test_.*\.rb'                 )  { |m| ruby  m[0] }
+watch( '^lib/(.*)\.rb'                       )  { |m| ruby "test/#{m[1]}_test.rb" }
+watch( '^test/test_helper\.rb'               )  { ruby tests }
+watch( '^test/bagger_test\.rb'               )  { ruby tests }
+watch( '^lib/bagger\.rb'                     )  { ruby tests }
+
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { ruby tests  } # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+def ruby(*paths)
+  run "ruby #{gem_opt} -I.:lib:test -e'%w( #{paths.flatten.join(' ')} ).each {|p| require p }'"
+end
+
+def tests
+  Dir['test/**/test_*.rb'] - ['test/test_helper.rb']
+end
+
+def run( cmd )
+  puts   cmd
+  system cmd
+end
+
+def gem_opt
+  defined?(Gem) ? "-rubygems" : ""
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: bagger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Patrick Huesler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70307486940240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70307486940240
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70307486939720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70307486939720
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: &70307486939180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70307486939180
+- !ruby/object:Gem::Dependency
+  name: rainpress
+  requirement: &70307486938540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70307486938540
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70307486938000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70307486938000
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: &70307486937460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70307486937460
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70307486936940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70307486936940
+description: ! 'A framework agnostic packaging solution for your assets: version files,
+  combine them, minify them and create a manifest'
+email:
+- patrick.huesler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bagger.gemspec
+- lib/bagger.rb
+- lib/bagger/packager.rb
+- lib/bagger/version.rb
+- test/bagger_test.rb
+- test/test_helper.rb
+- tests.watchr
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: bagger
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Asset packaging for the rest of us
+test_files:
+- test/bagger_test.rb
+- test/test_helper.rb