asset_hat 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/HISTORY

@@ -0,0 +1,12 @@
+HISTORY
+=======
+
+Version 0.1.1 (2010-01-20)
+--------------------------
+* Rewrote `AssetHat::VERSION` to be based on `VERSION.yml`.
+* Prefixed `AssetHat::CONFIG_FILEPATH` with `RAILS_ROOT`, which fixes ability
+  to run an app's individual test files.
+
+Version 0.1.0 (2010-01-19)
+--------------------------
+* Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Ron DeVera, Mint Digital
+
+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.markdown

@@ -0,0 +1,153 @@
+AssetHat
+========
+Your assets are covered.
+
+* Minify CSS and JS with one command. (Can be done on deploy instead of
+  at runtime.)
+* Bundle CSS and JS to reduce HTTP requests.
+* Reuse CSS and JS bundles across layouts without repetition.
+* Bust image caches by changing CSS URLs whenever an image is modified.
+* Force image URLs in your CSS to use CDN subdomains, not just the current
+  host.
+
+After setup, you can use these in your layouts and views:
+
+    include_css :bundle => 'application'
+      # => <link href="/stylesheets/bundles/application.min.css"
+      #          media="screen,projection" rel="stylesheet" type="text/css" />
+
+    include_js :bundles => ['plugins', 'common']
+      # => <script src="/javascripts/bundles/plugins.min.js"
+      #            type="text/javascript"></script>
+      #    <script src="/javascripts/bundles/common.min.js"
+      #            type="text/javascript"></script>
+
+And this in your deploy script:
+
+    rake asset_hat:minify
+
+Works with Rails 2.3.4 and above.
+
+
+
+Installation
+------------
+
+1. Install the gem:
+
+        gem install asset_hat
+
+2. Configure the gem:
+
+    * Using [Bundler](http://github.com/wycats/bundler):
+
+        1.  Add to your app's Gemfile: `gem 'asset_hat', '0.x.x'`
+
+        2.  Command-line: `gem bundle`
+
+    * Using Rails' `config.gem`, add to your app's `config/environment.rb`:
+
+        `config.gem 'asset_hat', :version => '0.x.x'`
+
+3. In your app, create `lib/tasks/asset_hat.rake` with the following contents:
+
+        begin
+          require 'asset_hat/tasks'
+        rescue LoadError
+          puts %q{Could not load AssetHat tasks: 'asset_hat' not found.}
+        end
+
+
+
+Configuration
+-------------
+
+1.  Create the default config file:
+
+        rake asset_hat:config
+
+2.  In your app, open the new config file at `config/assets.yml`, and set up
+    your CSS/JS bundles according to that file's example.
+
+3.  Minify your bundles:
+
+        rake asset_hat:minify
+
+    This minifies all of the CSS/JS files listed in `config/assets.yml`,
+    concatenates the minified code into bundle files, and adds CDN asset hosts
+    and cache-busting commit IDs to image URLs in your CSS.
+
+    Bundles are created as new files in `public/stylesheets/bundles/` and
+    `public/javascripts/bundles/`. Your original CSS/JS files remain intact.
+
+4.  Set your deployment script to run `rake asset_hat:minify` after deploying
+    your latest CSS/JS. This overwrites previously minified bundles, and
+    leaves your original CSS/JS files intact.
+
+### Advanced configuration ###
+
+Additional settings are supported in `config/assets.yml`:
+
+* `engine`: Indicates how CSS and JS are minified; omit this setting to use
+  the defaults. If the default engines cause problems by minifying too
+  strongly, try switching each to `weak`. The `weak` engines are much safer,
+  but don't save as many bytes.
+
+* `vendors`: Currently only allows for setting the jQuery version number:
+
+        js:
+          vendors:
+            jquery:
+              version: 1.4
+
+  In the future, this will be used for configuring the retrieval of other
+  third-party code.
+
+
+
+Usage
+-----
+
+In your layouts and views, instead of these:
+
+    <%= stylesheet_link_tag 'reset', 'application', 'clearfix',
+                            :media => 'screen,projection',
+                            :cache => 'bundles/application' %>
+    <%= javascript_include_tag 'plugin-1', 'plugin-2', 'plugin-3',
+                               :cache => 'bundles/application' %>
+
+**Use these:**
+
+    <%= include_css :bundle => 'application' %>
+    <%= include_js  :bundle => 'application' %>
+
+These turn into:
+
+    <link href="/stylesheets/bundles/application.min.css"
+      media="screen,projection" rel="stylesheet" type="text/css" />
+    <script src="/javascripts/bundles/application.min.js"
+      type="text/javascript"></script>
+
+If your environment has `config.action_controller.perform_caching` set to
+`true` (e.g., in production), the layout/view will include minified bundle
+files. Otherwise, the separate, unminified files will be included.
+
+### Advanced usage ###
+
+You can also include single files as expected:
+
+    <%= include_css 'reset', 'application' %>
+    <%= include_js 'plugin.min', 'application' %>
+
+Or include multiple bundles at once:
+
+    <%= include_js :bundles => %w[plugins common] %>
+
+When including multiple bundles at once, this yields one `<link>` or
+`<script>` element per bundle.
+
+You may want to use multiple bundles to separate plugins (rarely changed) from
+application code (frequently changed). If all code is in one huge bundle, then
+whenever there's a change, browsers have to re-download the whole bundle. By
+using multiple bundles based on change frequency, browsers cache the rarely
+changed code, and only re-download the frequently changed code.

data/Rakefile

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), %w[lib asset_hat tasks])
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = %q{asset_hat}
+    gemspec.summary     = %q{Your assets are covered.}
+    gemspec.description = %q{Minify, bundle, and optimize CSS/JS assets.}
+    gemspec.homepage    = %q{http://github.com/mintdigital/asset_hat}
+
+    gemspec.authors     = ['Ron DeVera', 'Mint Digital']
+    gemspec.email       = %q{ronald.devera@gmail.com}
+
+    gemspec.add_development_dependency  'shoulda',  '>= 2.10.2'
+    gemspec.add_development_dependency  'flexmock', '>= 0.8.6'
+    gemspec.add_runtime_dependency      'cssmin',   '>= 1.0.2'
+    gemspec.add_runtime_dependency      'jsmin',    '>= 1.0.1'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler is not available. Install it with: `gem install jeweler`'
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+---
+:major: 0
+:minor: 1
+:patch: 0
+:build:

data/app/helpers/asset_hat_helper.rb

@@ -0,0 +1,171 @@
+module AssetHatHelper
+  unless defined?(RAILS_ROOT)
+    RAILS_ROOT = File.join(File.dirname(__FILE__), '..', '..')
+  end
+
+  def include_assets(type, *args)
+    # `include_css` and `include_js` are recommended instead.
+
+    type = type.to_sym
+    allowed_types = AssetHat::TYPES
+    unless allowed_types.include?(type)
+      expected_types = allowed_types.map { |x| ":#{x}" }.to_sentence(
+        :two_words_connector => ' or ',
+        :last_word_connector => ', or '
+      )
+      raise "Unknown type :#{type}; should be #{expected_types}"
+      return
+    end
+
+    options = args.extract_options!
+    options.symbolize_keys!
+    options.reverse_merge!(:media => 'screen,projection') if type == :css
+
+    filenames = []
+    sources   = [] # The URLs that are ultimately included via HTML
+    source_commit_ids = {} # Last commit ID for each source
+
+    # Set to `true` to use bundles and minified code:
+    use_caching = AssetHat.cache?
+    use_caching = options[:cache] unless options[:cache].nil?
+    options.delete :cache # Completely avoid Rails' built-in caching
+
+    if options[:bundle].present? || options[:bundles].present?
+      bundles = [options.delete(:bundle), options.delete(:bundles)].
+                  flatten.reject(&:blank?)
+      if use_caching
+        sources += bundles.map { |b| "bundles/#{b}.min.#{type}" }
+      else
+        config = AssetHat.config
+        filenames = bundles.map { |b| AssetHat.bundle_filenames(b, type) }.
+                      flatten.reject(&:blank?)
+      end
+    else
+      filenames = args
+    end
+
+    filenames.each do |filename|
+      if filename.match(/\.#{type}$/)
+        sources << filename
+      else
+        min_filename_with_ext = "#{filename}.min.#{type}"
+        if use_caching && AssetHat.asset_exists?(min_filename_with_ext, type)
+          sources << min_filename_with_ext  # Use minified version
+        else
+          sources << "#{filename}.#{type}"  # Use original version
+        end
+      end
+    end
+
+    sources.uniq!
+
+    if use_caching
+      # Add commit IDs to bust browser caches based on when each file was
+      # last updated in the repository. If `use_caching` is false (e.g., in
+      # development environments), skip this, and instead default to Rails'
+      # mtime-based cache busting.
+      sources.map! do |src|
+        if src =~ /^bundles\//
+          # Get commit ID of bundle file with most recently committed update
+          bundle = src.match(/^bundles\/(.*)\.min\.#{type}$/)[1]
+          commit_id = AssetHat.last_bundle_commit_id(bundle, type)
+        else
+          # Get commit ID of file's most recently committed update
+          commit_id = AssetHat.last_commit_id(
+            File.join(AssetHat.assets_dir(type), src))
+        end
+        if commit_id.present? # False if file isn't committed to repo
+          src += "#{src =~ /\?/ ? '&' : '?'}#{commit_id}"
+        end
+        src
+      end
+    end
+
+    # Build output HTML
+    sources.map do |src|
+      case type
+      when :css
+        stylesheet_link_tag(src, options)
+      when :js
+        javascript_include_tag(src, options)
+      end
+    end.join("\n")
+  end
+
+  def include_css(*args)
+    # Usage:
+    #
+    # Include a single stylesheet:
+    #   include_css 'diagnostics'
+    #   =>  <link href="/stylesheets/diagnostics.min.css" media="screen,projection" rel="stylesheet" type="text/css" />
+    #
+    # Include a single unminified stylesheet:
+    #   include_css 'diagnostics.css'
+    #   =>  <link href="/stylesheets/diagnostics.css" media="screen,projection" rel="stylesheet" type="text/css" />
+    #
+    # Include a bundle of stylesheets (i.e., a concatenated set of
+    # stylesheets; configure in config/assets.yml):
+    #   include_css :bundle => 'application'
+    #   =>  <link href="/stylesheets/bundles/application.min.css" ... />
+    #
+    # Include multiple stylesheets separately (not as cool):
+    #   include_css 'reset', 'application', 'clearfix'
+    #   =>  <link href="/stylesheets/reset.min.css" ... />
+    #       <link href="/stylesheets/application.min.css" ... />
+    #       <link href="/stylesheets/clearfix.min.css" ... />
+
+    return if args.blank?
+    include_assets :css, *args
+  end
+
+  def include_js(*args)
+    # Usage:
+    #
+    # Include a single JS file:
+    #   include_js 'application'
+    #   =>  <script src="/javascripts/application.min.js" type="text/javascript"></script>
+    #
+    # Include a single JS unminified file:
+    #   include_js 'application.js'
+    #   =>  <script src="/javascripts/application.js" type="text/javascript"></script>
+    #
+    # Include jQuery:
+    #   include_js :jquery  # Development/test environment
+    #   =>  <script src="/javascripts/jquery-VERSION.min.js" ...></script>
+    #   include_js :jquery  # Staging/production environment
+    #   =>  <script src="http://ajax.googleapis.com/.../jquery.min.js" ...></script>
+    #     # Set jQuery versions either in `config/assets.yml`, or by using
+    #     # `include_js :jquery, :version => '1.4'`.
+    #
+    # Include a bundle of JS files (i.e., a concatenated set of files;
+    # configure in config/assets.yml):
+    #   include_js :bundle => 'application'
+    #   =>  <script src="/javascripts/bundles/application.min.js" ...></script>
+    #
+    # Include multiple bundles of JS files:
+    #   include_js :bundles => %w[plugins common]
+    #   =>  <script src="/javascripts/bundles/plugins.min.js" ...></script>
+    #       <script src="/javascripts/bundles/common.min.js" ...></script>
+    #
+    # Include multiple JS files separately (not as cool):
+    #   include_js 'bloombox', 'jquery.cookie', 'jquery.json.min'
+    #   =>  <script src="/javascripts/bloombox.min.js" ...></script>
+    #       <script src="/javascripts/jquery.cookie.min.js" ...></script>
+    #       <script src="/javascripts/jquery.json.min.js" ...></script>
+
+    return if args.blank?
+    html = []
+    options = args.extract_options!
+
+    included_vendors = (args & AssetHat::JS::VENDORS)
+    included_vendors.each do |vendor|
+      args.delete vendor
+      source = AssetHat::JS::Vendors.source_for(vendor, options.slice(:version))
+      html << include_assets(:js, source, :cache => true)
+    end
+
+    html << include_assets(:js, *(args + [options]))
+    html.join("\n").strip
+  end
+
+end

data/asset_hat.gemspec

@@ -0,0 +1,98 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{asset_hat}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ron DeVera", "Mint Digital"]
+  s.date = %q{2010-01-20}
+  s.description = %q{Minify, bundle, and optimize CSS/JS assets.}
+  s.email = %q{ronald.devera@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "HISTORY",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION.yml",
+     "app/helpers/asset_hat_helper.rb",
+     "asset_hat.gemspec",
+     "config/assets.yml",
+     "lib/asset_hat.rb",
+     "lib/asset_hat/css.rb",
+     "lib/asset_hat/js.rb",
+     "lib/asset_hat/tasks.rb",
+     "lib/asset_hat/vcs.rb",
+     "lib/asset_hat/version.rb",
+     "public/javascripts/bundles/js-bundle-1.min.js",
+     "public/javascripts/bundles/js-bundle-2.min.js",
+     "public/javascripts/bundles/js-bundle-3.min.js",
+     "public/javascripts/js-file-1-1.js",
+     "public/javascripts/js-file-1-2.js",
+     "public/javascripts/js-file-1-3.js",
+     "public/javascripts/js-file-2-1.js",
+     "public/javascripts/js-file-2-2.js",
+     "public/javascripts/js-file-2-3.js",
+     "public/javascripts/js-file-3-1.js",
+     "public/javascripts/js-file-3-2.js",
+     "public/javascripts/js-file-3-3.js",
+     "public/stylesheets/bundles/css-bundle-1.min.css",
+     "public/stylesheets/bundles/css-bundle-2.min.css",
+     "public/stylesheets/bundles/css-bundle-3.min.css",
+     "public/stylesheets/css-file-1-1.css",
+     "public/stylesheets/css-file-1-2.css",
+     "public/stylesheets/css-file-1-3.css",
+     "public/stylesheets/css-file-2-1.css",
+     "public/stylesheets/css-file-2-2.css",
+     "public/stylesheets/css-file-2-3.css",
+     "public/stylesheets/css-file-3-1.css",
+     "public/stylesheets/css-file-3-2.css",
+     "public/stylesheets/css-file-3-3.css",
+     "rails/init.rb",
+     "tasks/asset_hat.rake",
+     "test/asset_hat_helper_test.rb",
+     "test/asset_hat_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mintdigital/asset_hat}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Your assets are covered.}
+  s.test_files = [
+    "test/asset_hat_helper_test.rb",
+     "test/asset_hat_test.rb",
+     "test/test_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
+      s.add_development_dependency(%q<shoulda>, [">= 2.10.2"])
+      s.add_development_dependency(%q<flexmock>, [">= 0.8.6"])
+      s.add_runtime_dependency(%q<cssmin>, [">= 1.0.2"])
+      s.add_runtime_dependency(%q<jsmin>, [">= 1.0.1"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+      s.add_dependency(%q<flexmock>, [">= 0.8.6"])
+      s.add_dependency(%q<cssmin>, [">= 1.0.2"])
+      s.add_dependency(%q<jsmin>, [">= 1.0.1"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+    s.add_dependency(%q<flexmock>, [">= 0.8.6"])
+    s.add_dependency(%q<cssmin>, [">= 1.0.2"])
+    s.add_dependency(%q<jsmin>, [">= 1.0.1"])
+  end
+end
+