asset_hat 0.2.1 → 0.3.0

data/HISTORY

@@ -1,40 +1,59 @@
 = HISTORY
 
+* FEATURE: Added ERb support in `config/assets.yml`.
+* FEATURE: Added support for auto-creating SSL versions of every stylesheet.
+* FEATURE: Added support for loading remote JS via SSL. Includes loading
+  popular JS from `https://ajax.googleapis.com` or your own CDN.
+* FEATURE: Added support for `FORMAT=long|short|dot` flags for
+  `rake asset_hat:minify`. Useful for shortening output from deployment
+  scripts.
+* FEATURE: Added support for absolute paths in `config/assets.yml`. Allows
+  pointing to assets directly inside `public/`.
+* FEATURE: Added `asset_hat:minify:css` and `asset_hat:minify:js` Rake task
+  aliases.
+* IMPROVEMENT: Updated default CSS minification engine to remove rules that
+  have empty declaration blocks.
+* IMPROVEMENT: Stopped pre-caching asset commit IDs when launching console.
+* IMPROVEMENT: Added support for single/double quotation marks in `url()` CSS
+  when adding asset hosts and cache busters
+* FIX: Fixed adding asset commit IDs to URLs containing "?" in stylesheets.
+
 == Version 0.2.1 (2010-07-21)
-* Added WebFont Loader to supported JS vendors.
-* Stopped adding asset hosts to `url(/htc/...)` URLs because IE 6, by default,
-  refuses to run .htc files from other domains, including CDN subdomains.
+* FEATURE: Added WebFont Loader to supported JS vendors.
+* FIX: Stopped adding asset hosts to `url(/htc/...)` URLs because IE 6, by
+  default, refuses to run .htc files from other domains, including CDN
+  subdomains.
 
 == Version 0.2.0 (2010-06-10)
-* Added support for loading many more JS vendors from Google's CDN, including
-  Prototype, MooTools, and SWFObject.
-* Cleaned up existing docs, and added complete RDoc documentation.
-* Added example integration script for Capistrano deployments.
+* FEATURE: Added support for loading many more JS vendors from Google's CDN,
+  including Prototype, MooTools, and SWFObject.
+* FEATURE: Cleaned up existing docs, and added complete RDoc documentation.
+* FEATURE: Added example integration script for Capistrano deployments.
 
 == Version 0.1.5 (2010-03-11)
-* Fixed fetching asset commit IDs in some environments. The bug was possibly
-  caused by older versions of Git, which fail to read logs properly when given
-  absolute paths, rather than relative paths.
-* Stopped app tests from running twice in some environments.
+* FIX: Fixed fetching asset commit IDs in some environments. The bug was
+  possibly caused by older versions of Git, which fail to read logs properly
+  when given absolute paths, rather than relative paths.
+* FIX: Stopped app tests from running twice in some environments.
 
 == Version 0.1.4 (2010-03-03)
-* Fixed config filepaths in `asset_hat:config` task.
+* FIX: Fixed config filepaths in `asset_hat:config` task.
 
 == Version 0.1.3 (2010-03-03)
-* Allowed adding commit IDs and asset hosts to `url(/htc/...)` URLs (e.g.,
-  `/htc/iepngfix.htc`) in CSS, not just images.
-* Changed `AssetHat.config` to memoize only if `cache?` is true. In
+* FIX: Allowed adding commit IDs and asset hosts to `url(/htc/...)` URLs
+  (e.g., `/htc/iepngfix.htc`) in CSS, not just images.
+* FIX: Changed `AssetHat.config` to memoize only if `cache?` is true. In
   development environments, this means the config file will be reread with
   every request.
 
 == Version 0.1.2 (2010-01-27)
-* Memoized HTML output from `include_css` and `include_js` when
+* IMPROVEMENT: Memoized HTML output from `include_css` and `include_js` when
   `AssetHat.cache?` is true.
 
 == 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.
+* FIX: Rewrote `AssetHat::VERSION` to be based on `VERSION.yml`.
+* FIX: 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/README.rdoc

@@ -8,56 +8,59 @@ AssetHat can automatically:
 
 * Easily *minify* and *bundle* CSS and JS on deploy to reduce file sizes and
   HTTP requests.
-* Load popular <strong>third-party JS</strong> (like jQuery and Prototype)
-  from {<strong>Google's CDN</strong>}[http://code.google.com/apis/ajaxlibs/]
+* Load popular <b>third-party JS</b> (like jQuery and Prototype)
+  from {<b>Google's CDN</b>}[http://code.google.com/apis/ajaxlibs/]
   when in production, or from localhost in development.
-* Force image URLs in your CSS to use <strong>CDN subdomains</strong>, not
-  just the current host.
+* Force image URLs in your CSS to use <b>CDN subdomains</b>
+  (including SSL support), not just the current host.
 * Add an image's last Git[http://git-scm.com/] commit ID to its CSS URLs to
-  <strong>bust browser caches</strong> (e.g.,
-  <code>/images/foo.png?ab12cd34e</code>).
+  <b>bust browser caches</b> (e.g.,
+  <code>/images/foo.png?ab12cd3</code>).
 
-After setup, you can use these in your layouts and views:
+After setup, you can use this 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  :jquery, :bundles => ['plugins', 'common'] %>
 
-    <%= 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>
+Which turns into:
+
+    <link href="/stylesheets/bundles/application.min.css"
+      media="screen,projection" rel="stylesheet" type="text/css" />
+    <script src="/javascripts/jquery-1.x.x.min.js"
+      type="text/javascript"></script>
+      <!-- In production, jQuery loads from Google's CDN instead. -->
+    <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
 
-Tested with Rails 2.3.x.
+Tested with Rails 2.3.x. For the gritty details, check the
+{complete docs}[http://mintdigital.github.com/asset_hat/doc/] and
+{change history}[http://mintdigital.github.com/asset_hat/doc/files/HISTORY.html].
 
 
 
 == Installation
 
-1.  Install the gem:
+1.  Configure the gem:
 
-      gem install asset_hat
-
-2.  Configure the gem:
-
-    * If you're using {Bundler 0.9+}[http://github.com/carlhuda/bundler]:
+    * If you're using Rails 3 and/or
+      {Bundler 0.9+}[http://github.com/carlhuda/bundler]:
 
       1.  Add to your app's Gemfile: <code>gem 'asset_hat', '0.x.x'</code>
       2.  Command-line: <code>bundle install</code>
 
-    * If you're using Rails' <code>config.gem</code>, add to your app's
-      <code>config/environment.rb</code>:
-
-        config.gem 'asset_hat', :version => '0.x.x'
+    * If you're using Rails 2.x's <code>config.gem</code>:
 
-3.  Add to your app's Rakefile:
+      1.  Add to your app's <code>config/environment.rb</code>:
+          <code>config.gem 'asset_hat', :version => '0.x.x'</code>
+      2.  Command-line: <code>gem install asset_hat</code>
 
-      require 'asset_hat/tasks'
+2.  Add to your app's Rakefile: <code>require 'asset_hat/tasks'</code>
 
 
 
@@ -82,17 +85,21 @@ Tested with Rails 2.3.x.
     Bundles are created as new files in
     <code>public/stylesheets/bundles/</code> and
     <code>public/javascripts/bundles/</code>. Your original CSS/JS files
-    remain intact.
+    remain untouched.
 
 4.  Set your deployment script to run <code>rake asset_hat:minify</code> after
     deploying your latest CSS/JS. This overwrites previously minified bundles,
-    and leaves your original CSS/JS files intact.
+    and leaves your original CSS/JS files untouched.
 
 === Advanced configuration
 
 If you manage deployments with Capistrano[http://www.capify.org/], see the
 gem's packaged example at <code>lib/asset_hat/capistrano.rb</code>.
 
+If you want shorter output during deployments, you can use
+`rake asset_hat:minify FORMAT=short` (one output line per bundle) or
+`FORMAT=dot` (one output line total) in your deploy script.
+
 Additional settings are supported in <code>config/assets.yml</code>:
 
 * <code>engine</code>: Indicates how CSS and JS are minified; omit this
@@ -102,26 +109,64 @@ Additional settings are supported in <code>config/assets.yml</code>:
   rgrove/jsmin[http://github.com/rgrove/jsmin] (a Ruby port of Crockford's
   JSMin).
 
-  If the default engines cause problems by minifying too
-  strongly, try switching each to <code>weak</code>. The <code>weak</code>
-  engines are much safer, but don't save as many bytes.
+  If you'd prefer to have slightly more readable code for debugging purposes,
+  you can switch both the CSS and JS engines to <code>weak</code>. However,
+  the <code>weak</code> engines don't save as many bytes.
 
-* <code>vendors</code>: Currently only allows for setting the jQuery version
-  number:
+* <code>vendors</code>: Configures third-party JS that's loaded from a CDN or
+  other external source. The following example configures jQuery and jQuery UI
+  for use throughout the app:
 
         js:
           vendors:
             jquery:
-              version: 1.4
+              version:        1.4.4
+            jquery_ui:
+              version:        1.8.5
+              remote_url:     http://cdn.example.com/js/jquery-ui-1.8.5.min.js
+              remote_ssl_url: https://cdn-ssl.example.com/js/jquery-ui-1.8.5.min.js
+
+  Configuration keys per vendor:
 
-  In the future, this will be used for configuring the retrieval of other
-  third-party code.
+  * <code>version</code>: Sets the default version across the app. In the
+    example above, <code><%= include_js :jquery %></code> uses version 1.4.4
+    by default. You can override this for special layouts/views with
+    <code><%= include_js :jquery, :version => '1.3.2' %></code>.
+  * <code>remote_url</code>, <code>remote_ssl_url</code>: By default, vendor
+    JS will load from {Google's CDN}[http://code.google.com/apis/ajaxlibs/]
+    in production (or any environment where
+    <code>config.action_controller.consider_all_requests_local</code> is set
+    to <code>true</code>). If the original request to your app used SSL, the
+    vendor JS will also load from Google's CDN via SSL. If you prefer to use a
+    different CDN, specify its SSL/non-SSL URLs, and the appropriate URL will
+    be used per request.
+
+  A full list of supported vendors is in the AssetHat::JS::Vendors module.
+
+=== SSL configuration
+
+When you request a page via SSL, some browsers (euphemism for "IE") show
+errors if any assets -- stylesheets, JS files, images -- are served _without_
+SSL.
+
+AssetHat plays well with SSL pages that load assets from a CDN. Put this in
+<code>config/environments/production.rb</code> or similar:
+
+    config.action_controller.asset_host = Proc.new do |source, request|
+      "#{request.protocol}cdn#{source.hash % 4}.example.com"
+        # => 'http://cdn0.example.com', 'https://cdn1.example.com', etc.
+    end
+
+This switches to a different CDN URL if the request used SSL. When you run
+<code>rake asset_hat:minify</code> at deploy time, AssetHat detects this
+configuration, and generates special SSL versions of each stylesheet that also
+load images from CDN via SSL. (Non-SSL pages still get non-SSL stylesheets.)
 
 
 
 == Usage
 
-In your layouts and views, instead of these:
+In your layouts and views, <b>instead of these</b>:
 
     <%= stylesheet_link_tag 'reset', 'application', 'clearfix',
                             :media => 'screen,projection',
@@ -129,7 +174,7 @@ In your layouts and views, instead of these:
     <%= javascript_include_tag 'plugin-1', 'plugin-2', 'plugin-3',
                                :cache => 'bundles/application' %>
 
-<strong>Use these:</strong>
+<b>Use these:</b>
 
     <%= include_css :bundle => 'application' %>
     <%= include_js  :bundle => 'application' %>
@@ -150,6 +195,11 @@ minified bundle files. Otherwise, the separate, unminified files will be
 included, based on the bundle contents you define in
 <code>config/assets.yml</code>.
 
+If your environment has <code>config.action_controller.asset_host</code>
+pointing to a CDN, your CSS/JS files will load from there. If your
+configuration supports using the CDN via SSL (see the section "SSL
+configuration"), SSL requests will also load CSS/JS files via SSL.
+
 === Advanced usage
 
 You can also include single files as expected:
@@ -167,5 +217,13 @@ When including multiple bundles at once, this yields one
 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.
+using multiple bundles based on update frequency, browsers cache the rarely
+updated code, and only re-download the frequently updated code.
+
+
+
+== {What is best in AssetHat?}[http://www.youtube.com/watch?v=V30tyaXv6EI]
+
+* To crush your assets;
+* See them bundled before you; and
+* Hear no more lamentation about slow page loads.

data/Rakefile

@@ -5,19 +5,26 @@ require 'hanna/rdoctask'
 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.name        = 'asset_hat'
+    gemspec.summary     = 'Your assets are covered.'
+    gemspec.description = %{
+      Minifies, bundles, and optimizes CSS/JS assets ahead of time (e.g., on
+      deploy), not at runtime. Loads popular JS frameworks (like jQuery and
+      Prototype) from localhost in development, and auto-switches to Google's
+      CDN in production. Can rewrite stylesheets to use CDN hosts (not just
+      your web server) and cache-busting hashes for updated images.
+    }.strip.gsub(/\s+/, ' ')
+    gemspec.homepage    = 'http://github.com/mintdigital/asset_hat'
 
     gemspec.authors     = ['Ron DeVera', 'Mint Digital']
-    gemspec.email       = %q{ronald.devera@gmail.com}
+    gemspec.email       = 'hello@rondevera.com'
 
-    gemspec.add_development_dependency  'flexmock', '>= 0.8.6'
-    gemspec.add_development_dependency  'hanna',    '>= 0.1.12'
-    gemspec.add_development_dependency  'shoulda',  '>= 2.10.2'
-    gemspec.add_runtime_dependency      'cssmin',   '>= 1.0.2'
-    gemspec.add_runtime_dependency      'jsmin',    '>= 1.0.1'
+    gemspec.add_development_dependency  'flexmock', '~> 0.8.6'
+    gemspec.add_development_dependency  'hanna',    '~> 0.1.12'
+    gemspec.add_development_dependency  'jeweler',  '~> 1.4.0'
+    gemspec.add_development_dependency  'shoulda',  '~> 2.10.2'
+    gemspec.add_runtime_dependency      'cssmin',   '~> 1.0.2'
+    gemspec.add_runtime_dependency      'jsmin',    '~> 1.0.1'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION.yml

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

data/app/helpers/asset_hat_helper.rb

@@ -19,10 +19,7 @@ module AssetHatHelper
       return
     end
 
-    options = args.extract_options!
-    options.symbolize_keys!
-    options.reverse_merge!(:media => 'screen,projection') if type == :css
-
+    options   = args.extract_options!.symbolize_keys
     filenames = []
     sources   = [] # The URLs that are ultimately included via HTML
     source_commit_ids = {} # Last commit ID for each source
@@ -36,7 +33,10 @@ module AssetHatHelper
       bundles = [options.delete(:bundle), options.delete(:bundles)].
                   flatten.reject(&:blank?)
       if use_caching
-        sources += bundles.map { |b| "bundles/#{b}.min.#{type}" }
+        sources += bundles.map do |bundle|
+          File.join(AssetHat.bundles_dir(options.slice(:ssl)),
+                    "#{bundle}.min.#{type}")
+        end
       else
         config = AssetHat.config
         filenames = bundles.map { |b| AssetHat.bundle_filenames(b, type) }.
@@ -46,6 +46,7 @@ module AssetHatHelper
       filenames = args
     end
 
+    # Add extensions if needed, using minified file if it already exists
     filenames.each do |filename|
       if filename.match(/\.#{type}$/)
         sources << filename
@@ -69,9 +70,11 @@ module AssetHatHelper
       sources.map! do |src|
         if src =~ %r{^http(s?)://} || src =~ %r{^//}
           # Absolute URL; do nothing
-        elsif src =~ /^bundles\//
+        elsif src =~ /^#{AssetHat.bundles_dir}\//
           # Get commit ID of bundle file with most recently committed update
-          bundle = src.match(/^bundles\/(.*)\.min\.#{type}$/)[1]
+          bundle = src.
+            match(/^#{AssetHat.bundles_dir}\/(ssl\/)?(.*)\.min\.#{type}$/).
+            to_a.last
           commit_id = AssetHat.last_bundle_commit_id(bundle, type)
         else
           # Get commit ID of file's most recently committed update
@@ -86,12 +89,11 @@ module AssetHatHelper
     end
 
     # Build output HTML
+    options.delete :ssl
     sources.map do |src|
       case type
-      when :css
-        stylesheet_link_tag(src, options)
-      when :js
-        javascript_include_tag(src, options)
+      when :css ; stylesheet_link_tag(src, options)
+      when :js  ; javascript_include_tag(src, options)
       else nil
       end
     end.join("\n")
@@ -119,16 +121,27 @@ module AssetHatHelper
   #   =>  <link href="/stylesheets/reset.min.css" ... />
   #       <link href="/stylesheets/application.min.css" ... />
   #       <link href="/stylesheets/clearfix.min.css" ... />
+  #
+  # Include a stylesheet with extra media types:
+  #   include_css 'mobile', :media => 'handheld,screen,projection'
+  #   =>  <link href="/stylesheets/mobile.min.css"
+  #             media="handheld,screen,projection" ... />
   def include_css(*args)
     return if args.blank?
 
     AssetHat.html_cache       ||= {}
     AssetHat.html_cache[:css] ||= {}
-    cache_key = args.inspect
+
+    options = args.extract_options!
+    options.symbolize_keys!.reverse_merge!(
+      :media => 'screen,projection', :ssl => controller.request.ssl?)
+    cache_key = (args + [options]).inspect
 
     if !AssetHat.cache? || AssetHat.html_cache[:css][cache_key].blank?
       # Generate HTML and write to cache
-      html = AssetHat.html_cache[:css][cache_key] = include_assets(:css, *args)
+      options[:ssl] &&= AssetHat.ssl_asset_host_differs?
+      html = AssetHat.html_cache[:css][cache_key] =
+        include_assets(:css, *(args + [options]))
     end
 
     html ||= AssetHat.html_cache[:css][cache_key]
@@ -148,15 +161,18 @@ module AssetHatHelper
   #   =>  <script src="/javascripts/application.js" type="text/javascript"></script>
   #
   # Include jQuery:
-  #   include_js :jquery  # Development/test environment
+  #   # Development/test environment:
+  #   include_js :jquery
   #   =>  <script src="/javascripts/jquery-VERSION.min.js" ...></script>
-  #   include_js :jquery  # Staging/production environment
+  #
+  #   # Staging/production environment:
+  #   include_js :jquery
   #   =>  <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):
+  # configure in <code>config/assets.yml</code>):
   #   include_js :bundle => 'application'
   #   =>  <script src="/javascripts/bundles/application.min.js" ...></script>
   #
@@ -175,21 +191,25 @@ module AssetHatHelper
 
     AssetHat.html_cache       ||= {}
     AssetHat.html_cache[:js]  ||= {}
-    cache_key = args.inspect
+
+    options = args.extract_options!
+    options.symbolize_keys!.reverse_merge!(:ssl => controller.request.ssl?)
+    cache_key = (args + [options]).inspect
 
     if !AssetHat.cache? || AssetHat.html_cache[:js][cache_key].blank?
       # Generate HTML and write to cache
 
       html = []
-      options = args.extract_options!
-
       included_vendors = (args & AssetHat::JS::VENDORS)
       included_vendors.each do |vendor|
         args.delete vendor
-        src = AssetHat::JS::Vendors.source_for(vendor, options.slice(:version))
+        src = AssetHat::JS::Vendors.source_for(
+                vendor, options.slice(:ssl, :version))
         html << include_assets(:js, src, :cache => true)
       end
 
+      options.except! :ssl, :version
+
       html << include_assets(:js, *(args + [options]))
       html = html.join("\n").strip
       AssetHat.html_cache[:js][cache_key] = html