hulk 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use hulk

data/Gemfile

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

data/README.md

@@ -0,0 +1,122 @@
+Hulk: simple asset compression
+==============================
+
+Hulk makes it easy to compress CSS and JavaScript strings into groups called _bundles._ It works with raw strings, not file systems. Compression is done with [YUI Compressor][YUI].
+
+Why another asset compiler?
+---------------------------
+
+Hulk processes raw strings. This means you can load your assets from wherever you want: a database, filesystem, remote URL, unicorn colony, etc.
+
+Why use raw strings instead of a file system? Flexibility. For example, a hosted CMS might allows users to edit CSS & JS through a web-interface and save it to a database.
+
+Hulk is _extremely simple_ -- it's basically just a light layer of sugar on top of [YUI Compressor][YUI].If you want support for all kinds of other fandangled preprocessors or are simply reading files from a filesystem, you'll probably want to use one of these instead:
+
+* [Sprockets][SPROCKETS]
+* [Jammit][JAMMIT]
+* [Crush][CRUSH]
+
+Overview
+--------
+
+_Bundles_ are the basic compilation unit of Hulk. A bundle is a collection of strings that compile into a single, named unit. Usually you'll just have two bundles: one for you CSS, and one for your JavaScripts.
+
+Although you can work with bundles directly, it's much easier to do so indirectly through an instance of `Hulk::Assets`. This lets you build up your source strings and compile them all in one go.
+
+Example Usage
+-------------
+
+First, create an instance of `Hulk::Assets` to hold your bundles:
+
+    assets = Hulk::Assets.new
+    
+Now add your CSS & JavaScript to the appropriate bundle:
+
+    assets.css[:all] << File.read('reset.css')
+    assets.css[:all] << File.read('screen.css')
+    assets.css[:all] << File.read('mobile.css')
+    assets.css[:all] << "body { background: #fff; }"
+    
+    assets.js[:all] << File.read('jquery.js')
+    assets.js[:all] << File.read('backbone.js')
+    assets.js[:all] << File.read('application.js')
+
+If you want to use something like [Sass](http://sass-lang.com/) or [CoffeeScript](http://jashkenas.github.com/coffee-script/) you can compile the sources yourself before adding to the bundle:
+
+    assets.css[:all] << Sass.compile(File.read('helpers.scss'))
+    assets.js[:all] << CoffeeScript.compile(File.read('app.coffee'))
+
+And finally, compile everything:
+
+    assets.compile!
+    
+_Assets are compiled in the same order they're appended._
+
+Use either `to_css` or `to_js` to get the contents of the bundle:
+
+    assets.css[:all].to_css   # The compiled CSS
+    assets.js[:all].to_js     # The compiled JS
+    
+_These methods will compile the bundle if it's not already compiled._
+
+From here you can do whatever you want, like write the bundle to a file:
+
+    file = File.open("all.css", 'w')
+    file.write(assets.css[:base].to_css)
+    file.close()
+
+Bundles have a `digest` based on the compiled contents:
+
+    assets.css[:all].digest # => "d41d8cd98f00b204e9800998ecf8427e"
+
+They also have a `filename` helper method:
+
+    assets.css[:all].filename # => "d41d8cd98f00b204e9800998ecf8427e-all.css"
+
+Once compiled, bundles are immutable:
+
+    assets.compile!
+    assets.css[:base] << "p { border: none; }" # Raises `Hulk::FrozenBundleError`
+
+Bug Reports & Contributing
+----------------------------
+
+You can report bugs using the [issue tracker][ISSUES] right here on GitHub! You get extra mojo if you include a fix.
+
+License
+--------
+
+Hulk is distributed under a Simplified BSD License:
+
+Copyright 2011 Carbonmade LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ''AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of Carbonmade LLC.
+
+
+[YUI]: https://github.com/sstephenson/ruby-yui-compressor
+[SPROCKETS]: https://github.com/sstephenson/sprockets
+[JAMMIT]: https://github.com/documentcloud/jammit
+[CRUSH]: https://github.com/petebrowne/crush
+[ISSUES]: https://github.com/Carbonmade/hulk/issues

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+end

data/hulk.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hulk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hulk"
+  s.version     = Hulk::VERSION
+  s.authors     = ["Kyle Fox"]
+  s.email       = ["kyle@carbonmade.com"]
+  s.homepage    = ""
+  s.summary     = %q{An easy way to compress static assets.}
+  s.description = %q{Hulk allows you to group JavaScript & CSS into compressed bundles.}
+
+  s.rubyforge_project = "hulk"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "yui-compressor", "0.9.6"
+  s.add_runtime_dependency "uglifier", "1.1.0"
+end

data/lib/hulk.rb

@@ -0,0 +1,8 @@
+require "hulk/version"
+require "hulk/css_bundle"
+require "hulk/js_bundle"
+require "hulk/assets"
+
+module Hulk
+  class FrozenBundleError < StandardError; end  
+end

data/lib/hulk/assets.rb

@@ -0,0 +1,17 @@
+require "hulk/bundle_collection"
+
+module Hulk
+  class Assets
+    attr_accessor :css, :js
+
+    def initialize
+      @css = Hulk::BundleCollection.new(:css)
+      @js = Hulk::BundleCollection.new(:js)
+    end
+    
+    def compile!
+      @css.compile!
+      @js.compile!
+    end
+  end
+end

data/lib/hulk/bundle.rb

@@ -0,0 +1,37 @@
+require 'digest/md5'
+
+module Hulk
+  class Bundle
+
+    attr_accessor :name
+    
+    def initialize(name)
+      @name = name.to_s
+      @raw = []
+      @compiled = nil
+    end
+    
+    def <<(val)
+      (@raw << val) and return unless compiled?
+      raise Hulk::FrozenBundleError.new("This bundle has already been compiled.")
+    end
+    
+    def compiled?
+      !@compiled.nil?
+    end
+    
+    def digest
+      return nil unless compiled?
+      @digest ||= Digest::MD5.hexdigest(compile!)
+    end
+    
+    def compile!
+      @compiled ||= generate_compiled(@raw.join)
+    end
+    
+    def filename
+      "#{digest}-#{name}.#{ext}"
+    end
+    
+  end
+end

data/lib/hulk/bundle_collection.rb

@@ -0,0 +1,24 @@
+require 'hulk/css_bundle'
+require 'hulk/js_bundle'
+
+module Hulk
+  class BundleCollection
+    def initialize(type)
+      @bundle_class = {
+        :css => Hulk::CssBundle,
+        :js => Hulk::JsBundle,
+      }[type]
+      @bundles = Hash.new {|h, k| h[k] = @bundle_class.new(k)}
+    end
+    
+    def [](name)
+      @bundles[name]
+    end
+    
+    def compile!
+      @bundles.each do |_, bundle|
+        bundle.compile!
+      end
+    end
+  end
+end

data/lib/hulk/css_bundle.rb

@@ -0,0 +1,25 @@
+require 'yui/compressor'
+require 'digest/md5'
+require 'hulk/bundle'
+
+module Hulk
+  class CssBundle < Hulk::Bundle
+    
+    alias_method :to_css, :compile!
+    
+    def ext
+      :css
+    end
+    
+    def generate_compiled(source)
+      self.class.compressor.compress(source)
+    end
+    
+    private
+    
+    def self.compressor
+      @@compressor ||= YUI::CssCompressor.new
+    end
+
+  end
+end

data/lib/hulk/js_bundle.rb

@@ -0,0 +1,24 @@
+require 'uglifier'
+require 'hulk/bundle'
+
+module Hulk
+  class JsBundle < Hulk::Bundle
+    
+    alias_method :to_js, :compile!
+    
+    def ext
+      :js
+    end
+    
+    def generate_compiled(source)
+      self.class.compressor.compile(source)
+    end
+    
+    private
+    
+    def self.compressor
+      @@compressor ||= Uglifier.new
+    end
+
+  end
+end

data/lib/hulk/version.rb

@@ -0,0 +1,3 @@
+module Hulk
+  VERSION = "0.0.3"
+end

data/test/test_css_bundle.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+require 'hulk'
+
+class TestCssBundle < MiniTest::Unit::TestCase
+
+  def test_compile_css
+    bundle = Hulk::CssBundle.new(:awesome)
+    bundle << <<-EOF
+    body {
+      /* This makes the background red. */
+      background: red;
+    }
+    EOF
+    bundle << "table { width: 100%; border: 1px solid red; }"
+    expected = "body{background:red}table{width:100%;border:1px solid red}"
+    assert_equal expected, bundle.compile!
+    assert_equal bundle.compile!, bundle.to_css
+  end
+  
+  def test_bundle_digest
+    bundle = Hulk::CssBundle.new(:awesome)
+    bundle << "body { background: red; }"
+    assert_equal nil, bundle.digest
+    bundle.compile!
+    assert_equal "a9e1e9ad1b183e6166efd88af91e8761", bundle.digest
+  end
+  
+  def test_bundle_filename
+    bundle = Hulk::CssBundle.new(:awesome)
+    bundle << "body { background: red; }"
+    bundle.compile!
+    assert_equal "a9e1e9ad1b183e6166efd88af91e8761-awesome.css", bundle.filename
+  end
+  
+  def test_frozen_bundle
+    bundle = Hulk::CssBundle.new(:awesome)
+    bundle << "body { background: red; }"
+    bundle.compile!
+    assert bundle.compiled?
+    assert_raises Hulk::FrozenBundleError do
+      bundle << "p { font-size: 14px; }"
+    end
+  end
+
+end

data/test/test_hulk.rb

@@ -0,0 +1,44 @@
+require 'test/unit'
+require 'hulk'
+
+class TestHulk < MiniTest::Unit::TestCase
+  
+  def test_css_bundles
+    assets = Hulk::Assets.new
+    assets.css[:base] << "body { background: red; }"
+    assets.css[:base] << "a { text-decoration: none; }"
+    assets.compile!
+    assert_equal "body{background:red}a{text-decoration:none}", assets.css[:base].to_css
+  end
+  
+  def test_multiple_css_bundles
+    assets = Hulk::Assets.new
+    assets.css[:base] << "body{background:#c00}"
+    assets.css[:base] << "a { text-decoration: none; }"
+    assets.css[:type] << "body { line-height: 1.5em; }"
+    assets.css[:type] << "p { margin-bottom: 1.5em; }"
+    assets.compile!
+    assert_equal "body{background:#c00}a{text-decoration:none}", assets.css[:base].to_css
+    assert_equal "body{line-height:1.5em}p{margin-bottom:1.5em}", assets.css[:type].to_css
+  end
+  
+  def test_js_bundle
+    assets = Hulk::Assets.new
+    assets.js[:base] << 'function test() { return "Hello, world!"; };'
+    assets.js[:base] << 'var person = {name: "Bob"};'
+    assets.compile!
+    assert_equal "function test(){return\"Hello, world!\"}var person={name:\"Bob\"}", assets.js[:base].to_js
+  end
+  
+  def test_multiple_js_bundle
+    assets = Hulk::Assets.new
+    assets.js[:base] << 'function test() { return "Hello, world!"; };'
+    assets.js[:base] << 'var person = {name: "Bob"};'
+    assets.js[:app] << 'function App(name) { this.name = name; };'
+    assets.js[:app] << 'var app = new App("test");'
+    assets.compile!
+    assert_equal "function test(){return\"Hello, world!\"}var person={name:\"Bob\"}", assets.js[:base].to_js
+    assert_equal "function App(a){this.name=a}var app=new App(\"test\")", assets.js[:app].to_js
+  end
+  
+end

data/test/test_js_bundle.rb

@@ -0,0 +1,33 @@
+require 'test/unit'
+require 'hulk'
+
+class TestJsBundle < MiniTest::Unit::TestCase
+
+  def test_compile_js
+    bundle = Hulk::JsBundle.new(:awesome)
+    bundle << "var foo = 10, person = {'name': 'Joe', age: 42};"
+    bundle << <<-EOF
+      function thing() {
+        alert('whoa!');
+      }
+    EOF
+    expected = "function thing(){alert(\"whoa!\")}var foo=10,person={name:\"Joe\",age:42}"
+    assert_equal expected, bundle.compile!
+    assert_equal bundle.compile!, bundle.to_js
+  end
+  
+  def test_bundle_digest
+    bundle = Hulk::JsBundle.new(:awesome)
+    bundle << "var foo = 10, person = {'name': 'Joe', age: 42};"
+    bundle << <<-EOF
+      function thing() {
+        alert('whoa!');
+                alert('whoa!');
+                        alert('whoa!');
+      }
+    EOF
+    bundle.compile!
+    assert_equal "baafd2a470f3514fe17e93d380d997af", bundle.digest
+  end
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: hulk
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Fox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yui-compressor
+  requirement: &70123693257600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70123693257600
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: &70123693257100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70123693257100
+description: Hulk allows you to group JavaScript & CSS into compressed bundles.
+email:
+- kyle@carbonmade.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- hulk.gemspec
+- lib/hulk.rb
+- lib/hulk/assets.rb
+- lib/hulk/bundle.rb
+- lib/hulk/bundle_collection.rb
+- lib/hulk/css_bundle.rb
+- lib/hulk/js_bundle.rb
+- lib/hulk/version.rb
+- test/test_css_bundle.rb
+- test/test_hulk.rb
+- test/test_js_bundle.rb
+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: hulk
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: An easy way to compress static assets.
+test_files:
+- test/test_css_bundle.rb
+- test/test_hulk.rb
+- test/test_js_bundle.rb