dynamic_assets 0.2.0 → 0.3.0

data/README.rdoc

@@ -41,14 +41,14 @@ dynamically is useful enough that multiple people have thought of implementing i
    <tt>app/assets/javascripts</tt>. Each filename's extension triggers an
    optional pre-processor:
 
-    .css          = raw
-    .js           = raw
+    .css          = raw CSS
+    .js           = raw JS
     .css.erb      = process with ERB
     .js.erb       = process with ERB
-    .css.sass     = process with Sass and assume sass syntax
-    .css.scss     = process with Sass and assume scss syntax
-    .css.sass.erb = process with ERB then Sass (sass)
-    .css.scss.erb = process with ERB then Sass (scss)
+    .sass         = process with Sass and assume sass syntax
+    .scss         = process with Sass and assume scss syntax
+    .sass.erb     = process with ERB then Sass (sass syntax)
+    .scss.erb     = process with ERB then Sass (scss syntax)
 
    (Note that each file can be processed differently. You could stick one toe
    into the Sass world by renaming one of your .css files to .scss.)

data/app/helpers/dynamic_assets_helpers.rb

@@ -3,14 +3,12 @@ module DynamicAssetsHelpers
 
     def stylesheet_asset_tag(group_key, http_attributes = {})
       DynamicAssets::Manager.asset_references_for_group_key(:stylesheets, group_key).map do |asset_ref|
-        path = stylesheet_asset_path asset_ref.name
-        path << "?#{asset_ref.mtime.to_i.to_s}" if asset_ref.mtime.present?
 
         tag :link, {
           :type   => "text/css",
           :rel    => "stylesheet",
           :media  => "screen",
-          :href   => asset_url_for_path(path)
+          :href   => asset_url(asset_ref)
         }.merge!(http_attributes)
 
       end.join.html_safe
@@ -18,12 +16,10 @@ module DynamicAssetsHelpers
 
     def javascript_asset_tag(group_key, http_attributes = {})
       DynamicAssets::Manager.asset_references_for_group_key(:javascripts, group_key).map do |asset_ref|
-        path = javascript_asset_path asset_ref.name
-        path << "?#{asset_ref.mtime.to_i.to_s}" if asset_ref.mtime.present?
 
         content_tag :script, "", {
           :type => "text/javascript",
-          :src  => asset_url_for_path(path)
+          :src  => asset_url(asset_ref)
         }.merge!(http_attributes)
 
       end.join.html_safe
@@ -32,16 +28,24 @@ module DynamicAssetsHelpers
 
   protected
 
-    def asset_url_for_path(path)
-      raise "expected a path, not a full URL: #{path}" unless path.relative_url?
+    def asset_path(asset_ref)
+      name = asset_ref.name
+
+      case asset_ref
+      when DynamicAssets::StylesheetReference then stylesheet_asset_path name
+      when DynamicAssets::JavascriptReference then javascript_asset_path name
+      else raise "Unknown asset type: #{asset_ref}"
+      end
+    end
+
+    def asset_url(asset_ref)
+      path = asset_path asset_ref
       path = "/" + path unless path[0,1] == "/"
+      path << "?#{asset_ref.mtime.to_i.to_s}" if asset_ref.mtime.present?
+
       host = compute_asset_host path
 
-      if host
-        "#{host}#{path}"
-      else
-        path
-      end
+      host ? "#{host}#{path}" : path
     end
 
     # Extracted from Rails' AssetTagHelper, where it's private

data/lib/dynamic_assets/cssmin.rb

@@ -0,0 +1,110 @@
+#--
+# Copyright (c) 2008 Ryan Grove <ryan@wonko.com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * 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.
+#   * Neither the name of this project nor the names of its contributors may be
+#     used to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER 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.
+#++
+
+# = CSSMin
+#
+# Minifies CSS using a fast, safe routine adapted from Julien Lecomte's YUI
+# Compressor, which was in turn adapted from Isaac Schlueter's cssmin PHP
+# script.
+#
+# Author::    Ryan Grove (mailto:ryan@wonko.com)
+# Version::   1.0.2 (2008-08-23)
+# Copyright:: Copyright (c) 2008 Ryan Grove. All rights reserved.
+# License::   New BSD License (http://opensource.org/licenses/bsd-license.php)
+# Website::   http://github.com/rgrove/cssmin/
+#
+# == Example
+#
+#   require 'rubygems'
+#   require 'cssmin'
+#
+#   File.open('example.css', 'r') {|file| puts CSSMin.minify(file) }
+#
+module CSSMin
+
+  # Reads CSS from +input+ (which can be a String or an IO object) and
+  # returns a String containing minified CSS.
+  def self.minify(input)
+    css = input.is_a?(IO) ? input.read : input.dup.to_s
+
+    # Remove comments.
+    css.gsub!(/\/\*[\s\S]*?\*\//, '')
+
+    # Compress all runs of whitespace to a single space to make things easier
+    # to work with.
+    css.gsub!(/\s+/, ' ')
+
+    # Replace box model hacks with placeholders.
+    css.gsub!(/"\\"\}\\""/, '___BMH___')
+
+    # Remove unnecessary spaces, but be careful not to turn "p :link {...}"
+    # into "p:link{...}".
+    css.gsub!(/(?:^|\})[^\{:]+\s+:+[^\{]*\{/) do |match|
+      match.gsub(':', '___PSEUDOCLASSCOLON___')
+    end
+    css.gsub!(/\s+([!\{\};:>+\(\)\],])/, '\1')
+    css.gsub!('___PSEUDOCLASSCOLON___', ':')
+    css.gsub!(/([!\{\}:;>+\(\[,])\s+/, '\1')
+
+    # Add missing semicolons.
+    css.gsub!(/([^;\}])\}/, '\1;}')
+
+    # Replace 0(%, em, ex, px, in, cm, mm, pt, pc) with just 0.
+    css.gsub!(/([\s:])([+-]?0)(?:%|em|ex|px|in|cm|mm|pt|pc)/i, '\1\2')
+
+    # Replace 0 0 0 0; with 0.
+    css.gsub!(/:(?:0 )+0;/, ':0;')
+
+    # Replace background-position:0; with background-position:0 0;
+    css.gsub!('background-position:0;', 'background-position:0 0;')
+
+    # Replace 0.6 with .6, but only when preceded by : or a space.
+    css.gsub!(/(:|\s)0+\.(\d+)/, '\1.\2')
+
+    # Convert rgb color values to hex values.
+    css.gsub!(/rgb\s*\(\s*([0-9,\s]+)\s*\)/) do |match|
+      '#' << $1.scan(/\d+/).map{|n| n.to_i.to_s(16).rjust(2, '0') }.join
+    end
+
+    # Compress color hex values, making sure not to touch values used in IE
+    # filters, since they would break.
+    css.gsub!(/([^"'=\s])(\s?)\s*#([0-9a-f])\3([0-9a-f])\4([0-9a-f])\5/i, '\1\2#\3\4\5')
+
+    # Remove empty rules.
+    css.gsub!(/[^\}]+\{;\}\n/, '')
+
+    # Re-insert box model hacks.
+    css.gsub!('___BMH___', '"\"}\""')
+
+    # Prevent redundant semicolons.
+    css.gsub!(/;;+/, ';')
+
+    css.strip
+  end
+
+end

data/lib/dynamic_assets/reference/stylesheet_reference.rb

@@ -14,6 +14,7 @@ module DynamicAssets
 
     RELATIVE_URL_ROOT  = "/stylesheets"
 
+    delegate :minify, :to => CSSMin
 
     def formats
       %w(sass scss css)
@@ -23,16 +24,6 @@ module DynamicAssets
       :stylesheets
     end
 
-    def minify(content_string)
-      # From asset_packager. PENDING: replace with github.com/rgrove/cssmin ?
-      content_string.gsub(/\s+/, " ").# collapse space
-        gsub(/\/\*(.*?)\*\//, "").    # remove comments
-        gsub(/\} /, "}\n").           # add line breaks
-        gsub(/\n$/, "").              # remove last break
-        gsub(/ \{ /, " {").           # trim inside brackets
-        gsub(/; \}/, "}")             # trim inside brackets
-    end
-
 
   protected
 

data/lib/dynamic_assets.rb

@@ -3,6 +3,7 @@ module DynamicAssets
   require 'dynamic_assets/engine' if defined? Rails
 end
 
+require 'dynamic_assets/cssmin'
 require 'dynamic_assets/core_extensions'
 require 'dynamic_assets/config'
 require 'dynamic_assets/controller'

data/spec/helpers/dynamic_assets_helpers_spec.rb

@@ -3,67 +3,162 @@ require 'spec_helper'
 describe DynamicAssetsHelpers do
 
   describe "#stylesheet_asset_tag" do
-    subject { helper.stylesheet_asset_tag group_key }
+    subject { helper.stylesheet_asset_tag *args }
 
-    context "when the DynamicAssets::Manager says the given group key is associated with 3 stylesheets" do
-      let(:group_key) { :base }
+    context "when called with no arguments" do
+      let(:args) { [] }
 
-      before do
-        DynamicAssets::Manager.stub(:asset_references_for_group_key).with(:stylesheets, group_key).
-          and_return [
-            double(DynamicAssets::Reference, :name => "a", :mtime => 123),
-            double(DynamicAssets::Reference, :name => "b", :mtime => 456),
-            double(DynamicAssets::Reference, :name => "c", :mtime => 789)
-          ]
+      it "fails with an ArgumentError" do
+        expect { subject }.to raise_error ArgumentError
       end
+    end
 
-      it "is three link tags" do
-        subject.scan('<link ').length.should == 3
-      end
+    context "when called with a group_key" do
+      let(:args)      { [group_key] }
+      let(:group_key) { :base }
 
-      it 'is three tags with type="text/css"' do
-        subject.scan('type="text/css"').length.should == 3
-      end
+      context "when the DynamicAssets::Manager says the given group key is associated with 3 stylesheets" do
+
+        before do
+          DynamicAssets::Manager.stub(:asset_references_for_group_key).with(:stylesheets, group_key).
+            and_return [
+              DynamicAssets::StylesheetReference.new.tap { |r| r.stub(:name => "a", :mtime => 123) },
+              DynamicAssets::StylesheetReference.new.tap { |r| r.stub(:name => "b", :mtime => 456) },
+              DynamicAssets::StylesheetReference.new.tap { |r| r.stub(:name => "c", :mtime => 789) }
+            ]
+        end
+
+        it "is three link tags" do
+          subject.scan('<link ').length.should == 3
+        end
+
+        it 'is three tags with type="text/css"' do
+          subject.scan('type="text/css"').length.should == 3
+        end
+
+        it 'is three tags with rel"stylesheet"' do
+          subject.scan('rel="stylesheet"').length.should == 3
+        end
+
+        it 'is three tags with media="screen"' do
+          subject.scan('media="screen"').length.should == 3
+        end
+
+        context "when the arguments also include HTML attributes" do
+          before { args << { :media => "print", :id => "foo" } }
+
+          it "is three links, each of which has the given attributes" do
+            subject.scan('media="print"').length.should == 3
+            subject.scan('id="foo"').length.should == 3
+          end
+        end
+
+        context "when config.asset_host is nil" do
+          before { helper.config.asset_host.should be_nil }
+
+          it "is three tags with hrefs derived from the asset name and mtime" do
+            should contain_string 'href="/assets/stylesheets/a.css?123"'
+            should contain_string 'href="/assets/stylesheets/b.css?456"'
+            should contain_string 'href="/assets/stylesheets/c.css?789"'
+          end
+        end
+
+        context "when config.asset_host is set to a.example.com" do
+          before { helper.config.stub(:asset_host).and_return "http://a.example.com" }
+
+          it "is three tags with hrefs whose host is a.example.com" do
+            should contain_string 'href="http://a.example.com/assets/stylesheets/a.css?123"'
+            should contain_string 'href="http://a.example.com/assets/stylesheets/b.css?456"'
+            should contain_string 'href="http://a.example.com/assets/stylesheets/c.css?789"'
+          end
+        end
+
+        context "when config.asset_host is set to a%d.example.com" do
+          before { helper.config.stub(:asset_host).and_return "http://a%d.example.com" }
 
-      it 'is three tags with rel"stylesheet"' do
-        subject.scan('rel="stylesheet"').length.should == 3
+          it "is three tags with hrefs whose host is a[0-3].example.com" do
+            should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/a.css\?123"/
+            should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/b.css\?456"/
+            should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/c.css\?789"/
+          end
+        end
       end
+    end
+  end
+
+  describe "#javascript_asset_tag" do
+    subject { helper.javascript_asset_tag *args }
 
-      it 'is three tags with media="screen"' do
-        subject.scan('media="screen"').length.should == 3
+    context "when called with no arguments" do
+      let(:args) { [] }
+
+      it "fails with an ArgumentError" do
+        expect { subject }.to raise_error ArgumentError
       end
+    end
+
+    context "when called with a group_key" do
+      let(:args)      { [group_key] }
+      let(:group_key) { :base }
 
-      context "when config.asset_host is nil" do
-        before { helper.config.asset_host.should be_nil }
+      context "when the DynamicAssets::Manager says the given group key is associated with 3 scripts" do
 
-        it "is three tags with hrefs derived from the asset name and mtime" do
-          should contain_string 'href="/assets/stylesheets/a.css?123"'
-          should contain_string 'href="/assets/stylesheets/b.css?456"'
-          should contain_string 'href="/assets/stylesheets/c.css?789"'
+        before do
+          DynamicAssets::Manager.stub(:asset_references_for_group_key).with(:javascripts, group_key).
+            and_return [
+              DynamicAssets::JavascriptReference.new.tap { |r| r.stub(:name => "a", :mtime => 123) },
+              DynamicAssets::JavascriptReference.new.tap { |r| r.stub(:name => "b", :mtime => 456) },
+              DynamicAssets::JavascriptReference.new.tap { |r| r.stub(:name => "c", :mtime => 789) }
+            ]
         end
-      end
 
-      context "when config.asset_host is set to a.example.com" do
-        before { helper.config.stub(:asset_host).and_return "http://a.example.com" }
+        it "is three script tags" do
+          subject.scan('<script ').length.should == 3
+        end
 
-        it "is three tags with hrefs whose host is a.example.com" do
-          should contain_string 'href="http://a.example.com/assets/stylesheets/a.css?123"'
-          should contain_string 'href="http://a.example.com/assets/stylesheets/b.css?456"'
-          should contain_string 'href="http://a.example.com/assets/stylesheets/c.css?789"'
+        it 'is three tags with type="text/javascript"' do
+          subject.scan('type="text/javascript"').length.should == 3
+        end
+
+        context "when the arguments also include HTML attributes" do
+          before { args << { :id => "foo" } }
+
+          it "is three links, each of which has the given attributes" do
+            subject.scan('id="foo"').length.should == 3
+          end
         end
-      end
 
-      context "when config.asset_host is set to a%d.example.com" do
-        before { helper.config.stub(:asset_host).and_return "http://a%d.example.com" }
+        context "when config.asset_host is nil" do
+          before { helper.config.asset_host.should be_nil }
 
-        it "is three tags with hrefs whose host is a[0-3].example.com" do
-          should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/a.css\?123"/
-          should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/b.css\?456"/
-          should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/c.css\?789"/
+          it "is three tags with srcs derived from the asset name and mtime" do
+            should contain_string 'src="/assets/javascripts/a.js?123"'
+            should contain_string 'src="/assets/javascripts/b.js?456"'
+            should contain_string 'src="/assets/javascripts/c.js?789"'
+          end
+        end
+
+        context "when config.asset_host is set to a.example.com" do
+          before { helper.config.stub(:asset_host).and_return "http://a.example.com" }
+
+          it "is three tags with srcs whose host is a.example.com" do
+            should contain_string 'src="http://a.example.com/assets/javascripts/a.js?123"'
+            should contain_string 'src="http://a.example.com/assets/javascripts/b.js?456"'
+            should contain_string 'src="http://a.example.com/assets/javascripts/c.js?789"'
+          end
+        end
+
+        context "when config.asset_host is set to a%d.example.com" do
+          before { helper.config.stub(:asset_host).and_return "http://a%d.example.com" }
+
+          it "is three tags with srcs whose host is a[0-3].example.com" do
+            should =~ /src="http:\/\/a[0-3].example.com\/assets\/javascripts\/a.js\?123"/
+            should =~ /src="http:\/\/a[0-3].example.com\/assets\/javascripts\/b.js\?456"/
+            should =~ /src="http:\/\/a[0-3].example.com\/assets\/javascripts\/c.js\?789"/
+          end
         end
       end
     end
-
   end
 
 end

data/spec/lib/dynamic_assets/stylesheet_reference_spec.rb

@@ -10,18 +10,44 @@ module DynamicAssets
       context "when a css file with the given reference name exists" do
         before do
           reference.stub(:path_for_member_name).with("thing").and_return "/foo/thing.css"
-          reference.stub(:raw_content_exists?).and_return false
           reference.stub(:raw_content_exists?).with("/foo/thing.css").and_return true
-          reference.stub(:get_raw_content).with("/foo/thing.css").and_return content
+          reference.stub(:get_raw_content).with("/foo/thing.css").and_return raw_content
         end
 
         context "and the file is blank" do
-          let(:content) { "" }
+          let(:raw_content) { "" }
           it { should be_blank }
         end
 
+        context "and the file contains styles" do
+          let(:raw_content) { "div.foo { color: #FFF }" }
+
+          context "and the Manager is not configured to minify" do
+            before { Manager.stub :minify? => false }
+
+            it "is the raw content" do
+              subject.should == raw_content
+            end
+
+            it "does not call its own #minify method" do
+              reference.should_not_receive :minify
+              subject
+            end
+          end
+
+          context "and the Manager is configured to minify" do
+            before { Manager.stub :minify? => true }
+
+            it "is the result of calling its own #minify method" do
+              reference.should_receive(:minify).and_return "tiny output"
+              subject.should == "tiny output"
+            end
+
+          end
+        end
+
         context "and the file contains URLs relative to the stylesheet" do
-          let(:content) { "body { background: url(background.gif); }" }
+          let(:raw_content) { "body { background: url(background.gif); }" }
 
           it "makes the URLs relative to RELATIVE_URL_ROOT and the member name" do
             should contain_string "url(#{StylesheetReference::RELATIVE_URL_ROOT}/thing/background.gif)"
@@ -29,7 +55,7 @@ module DynamicAssets
         end
 
         context "and the file contains URLs within directories relative to the stylesheet" do
-          let(:content) { "body { background: url(a/b/background.gif); }" }
+          let(:raw_content) { "body { background: url(a/b/background.gif); }" }
 
           it "makes the URLs relative to RELATIVE_URL_ROOT and the member name" do
             should contain_string "url(#{StylesheetReference::RELATIVE_URL_ROOT}/thing/a/b/background.gif)"
@@ -37,7 +63,7 @@ module DynamicAssets
         end
 
         context "and the file contains URLs with dots, relative to the stylesheet" do
-          let(:content) { "body { background: url(../a/b/background.gif); }" }
+          let(:raw_content) { "body { background: url(../a/b/background.gif); }" }
 
           it "makes the URLs relative to RELATIVE_URL_ROOT and the member name, ignoring leading dots" do
             should contain_string "url(#{StylesheetReference::RELATIVE_URL_ROOT}/thing/a/b/background.gif)"
@@ -45,7 +71,7 @@ module DynamicAssets
         end
 
         context "and the file contains full URLs with hosts" do
-          let(:content) { "body { background: url(http://www.example.com/background.gif); }" }
+          let(:raw_content) { "body { background: url(http://www.example.com/background.gif); }" }
 
           it "leaves the URLs unchanged" do
             should contain_string "url(http://www.example.com/background.gif)"
@@ -54,5 +80,60 @@ module DynamicAssets
       end
     end
 
+    describe "#minify" do
+      subject         { reference.minify content }
+      let(:reference) { StylesheetReference.new :name => "thing" }
+
+      context "when given content that has whitespace and comments" do
+        let(:content) do %Q!
+          /*
+           * Some sample styles
+           */
+          div.foo   { color: #FFF; } /* foo style */
+          div.bar,   span.baz   {   font-size:  12px;   }
+          !
+        end
+
+        it "is the result of calling CSSMin.minify" do
+          CSSMin.should_receive(:minify).with(content).and_return "tiny content"
+          subject.should == "tiny content"
+        end
+
+        # We assume CSSMin is fully tested, but as a sanity check we
+        # observe the StylesheetReference's behavior with a few examples:
+
+        it "contains no double spaces" do
+          should_not =~ /  /
+        end
+
+        it "contains no newlines" do
+          should_not =~ /\n/
+        end
+
+        it "removes space between selectors" do
+          should contain_string "div.bar,span.baz"
+        end
+
+        it "removes space around opening brackets" do
+          should contain_string "span.baz{font-size"
+        end
+
+        it "removes space around closing brackets" do
+          should contain_string "}div.bar"
+        end
+
+        it "removes space around values" do
+          should contain_string "font-size:12px;}"
+        end
+
+        it "removes comments that are on their own lines" do
+          should_not contain_string "Some sample styles"
+        end
+
+        it "removes comments that are on the same line as a style" do
+          should_not contain_string "Some sample styles"
+        end
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -6,10 +6,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'rspec/rails'
-
-require "capybara/rails"
-Capybara.default_driver   = :rack_test
-Capybara.default_selector = :css
+require 'capybara/rspec'
 
 require 'dynamic_assets'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dynamic_assets
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Robert Davis
@@ -128,6 +128,7 @@ files:
 - lib/dynamic_assets/config.rb
 - lib/dynamic_assets/controller.rb
 - lib/dynamic_assets/core_extensions.rb
+- lib/dynamic_assets/cssmin.rb
 - lib/dynamic_assets/engine.rb
 - lib/dynamic_assets/manager.rb
 - lib/dynamic_assets/reference.rb