jekyll-assets 0.6.1 → 0.7.0

data/HISTORY.md

@@ -1,3 +1,9 @@
+### 0.7.0 (2013-08-11)
+
+* Adds `debug` mode that outputs multiple scripts/styles instead of bundling
+  them. See #40.
+
+
 ### 0.6.1 (2013-07-22)
 
 * Fix regression with `asset_path`. See #38.

data/README.md

@@ -42,7 +42,7 @@ information about amazing features it gives you.
 [extjs]:        https://github.com/sstephenson/execjs#readme
 
 For a quick start check out [jekyll-assets introduction][jekyll-assets-intro]
-that shows how to use it step by step. Also you might want to take a look on 
+that shows how to use it step by step. Also you might want to take a look on
 [my blog sources][ixti-blog-src] as a real-world example as well.
 
 [jekyll-assets-intro]:  http://ixti.net/software/2012/12/30/unleash-mr-hyde-introduction-of-jekyll-assets.html
@@ -147,7 +147,8 @@ difference is only in comments styles used with _directives_.
 See detailes information about these _directives_ below.
 
 You might also want your stylesheets and javascripts to be minified. In this
-case just install `uglifier` gem and add following lines into your `config.yml`:
+case just install the `uglifier` gem and any other gems you will be using, e.g.
+`sass`, `coffee-script`. Then add following lines into your `config.yml`:
 
 ``` yaml
 assets:
@@ -484,6 +485,12 @@ assets:
   # stylesheets are gzipped by default.
   #
   gzip: [ text/css, application/javascript ]
+  #
+  # Does not concatenates files requested by `javascript` and `stylesheet`
+  # helpers. Instead outputs multiple files in order they are required.
+  # Default: false
+  #
+  debug: false
 ```
 
 

data/lib/jekyll/assets_plugin/asset_path.rb

@@ -0,0 +1,50 @@
+module Jekyll
+  module AssetsPlugin
+    class AssetPath
+
+      attr_reader :asset
+
+
+      def initialize site, pathname, *args
+        pathname, _, @anchor = pathname.rpartition "#" if pathname["#"]
+        pathname, _, @query  = pathname.rpartition "?" if pathname["?"]
+
+        @asset  = site.assets[pathname, *args]
+        @site   = site
+
+        site.bundle_asset! asset
+      end
+
+
+      def cachebust
+        @cachebust ||= @site.assets_config.cachebust
+      end
+
+
+      def path
+        :hard == cachebust && asset.digest_path || asset.logical_path
+      end
+
+
+      def query
+        query = []
+
+        query << "cb=#{asset.digest}" if :soft == cachebust
+        query << @query               if @query
+
+        "?#{query.join '&'}" unless query.empty?
+      end
+
+
+      def anchor
+        "##{@anchor}" if @anchor
+      end
+
+
+      def to_s
+        "#{@site.assets_config.baseurl}/#{path}#{query}#{anchor}"
+      end
+
+    end
+  end
+end

data/lib/jekyll/assets_plugin/configuration.rb

@@ -12,7 +12,8 @@ module Jekyll
         :css_compressor => nil,
         :cachebust      => :hard,
         :cache          => false,
-        :gzip           => %w{ text/css application/javascript }
+        :gzip           => %w{ text/css application/javascript },
+        :debug          => false
       }.freeze
 
 
@@ -49,7 +50,9 @@ module Jekyll
 
 
       def cachebust
-        none?(@data.cachebust) ? :none : @data.cachebust.to_sym
+        return :none if none?(@data.cachebust)
+        return @data.cachebust.to_sym if @data.cachebust.to_s =~ /^(soft|hard)$/
+        raise "Unknown cachebust strategy: #{@data.cachebust}"
       end
 
 

data/lib/jekyll/assets_plugin/patches/asset_patch.rb

@@ -7,8 +7,67 @@ module Jekyll
     module Patches
       module AssetPatch
 
-        def jekyll_assets
-          []
+        def self.included base
+          base.send :extend, ClassMethods
+          base.send :include, InstanceMethods
+        end
+
+
+        module ClassMethods
+
+          def mtimes
+            @mtimes ||= Hash.new
+          end
+
+        end
+
+
+        module InstanceMethods
+
+          attr_reader :site
+
+
+          def jekyll_assets
+            []
+          end
+
+
+          def destination dest
+            File.join dest, site.assets_config.dirname, filename
+          end
+
+
+          def filename
+            case cachebust = site.assets_config.cachebust
+            when :none, :soft then logical_path
+            when :hard        then digest_path
+            else raise "Unknown cachebust strategy: #{cachebust.inspect}"
+            end
+          end
+
+
+          def modified?
+            self.class.mtimes[pathname.to_s] != mtime.to_i
+          end
+
+
+          def write dest
+            dest_path = destination dest
+
+            return false if File.exist?(dest_path) and !modified?
+            self.class.mtimes[pathname.to_s] = mtime.to_i
+
+            write_to dest_path
+            write_to "#{dest_path}.gz" if gzip?
+
+            true
+          end
+
+
+          def gzip?
+            site.assets_config.gzip.include? content_type
+          end
+
         end
 
       end

data/lib/jekyll/assets_plugin/patches/context_patch.rb

@@ -17,11 +17,11 @@ module Jekyll
         end
 
 
-        def asset_path path, *args
-          jekyll_assets << resolve(path.to_s[/^[^#?]+/]).to_s
-          site.asset_path path, *args
+        def asset_path pathname, *args
+          jekyll_assets << resolve(pathname.to_s[/^[^#?]+/]).to_s
+          site.asset_path pathname, *args
         rescue Sprockets::FileNotFound
-          raise Environment::AssetNotFound, path
+          raise Environment::AssetNotFound, pathname
         end
 
       end

data/lib/jekyll/assets_plugin/patches/index_patch.rb

@@ -17,7 +17,7 @@ module Jekyll
 
         def __wrap_find_asset path, options = {}
           __orig_find_asset(path, options).tap do |asset|
-            @environment.site.bundle_asset! asset if asset and options[:bundle]
+            asset.instance_variable_set :@site, @environment.site if asset
           end
         end
 

data/lib/jekyll/assets_plugin/patches/site_patch.rb

@@ -5,7 +5,7 @@ require "jekyll"
 # internal
 require "jekyll/assets_plugin/configuration"
 require "jekyll/assets_plugin/environment"
-require "jekyll/assets_plugin/asset_file"
+require "jekyll/assets_plugin/asset_path"
 
 
 module Jekyll
@@ -36,35 +36,15 @@ module Jekyll
         end
 
 
-        def asset_path pathname, *args
-          pathname, _, anchor = pathname.rpartition "#" if pathname["#"]
-          pathname, _, query  = pathname.rpartition "?" if pathname["?"]
-
-          asset     = assets[pathname, *args]
-          baseurl   = "#{assets_config.baseurl}/"
-
-          case cachebust = assets_config.cachebust
-          when :none then baseurl << asset.logical_path
-          when :soft then baseurl << asset.logical_path << "?cb=#{asset.digest}"
-          when :hard then baseurl << asset.digest_path
-          else raise "Unknown cachebust strategy: #{cachebust.inspect}"
-          end
-
-          baseurl << (:soft == cachebust ? "&" : "?") << query if query
-          baseurl << "#" << anchor if anchor
-
-          baseurl
+        def asset_path *args
+          AssetPath.new(self, *args).to_s
         end
 
 
         def bundle_asset! asset
           if not asset_files.include? asset
-            file = AssetFile.new self, asset
-
+            asset_files << asset
             asset.jekyll_assets.each{ |path| bundle_asset! assets[path] }
-
-            asset_files   << file
-            static_files  << file
           end
         end
 

data/lib/jekyll/assets_plugin/renderer.rb

@@ -25,6 +25,12 @@ module Jekyll
       def render_javascript
         @path << ".js" if File.extname(@path).empty?
 
+        if @site.assets_config.debug
+          return @site.assets[@path].to_a.map{ |a|
+            JAVASCRIPT % @site.asset_path(a.logical_path, :bundle => false)
+          }.join("\n")
+        end
+
         JAVASCRIPT % render_asset_path
       end
 
@@ -32,6 +38,12 @@ module Jekyll
       def render_stylesheet
         @path << ".css" if File.extname(@path).empty?
 
+        if @site.assets_config.debug
+          return @site.assets[@path].to_a.map{ |a|
+            STYLESHEET % @site.asset_path(a.logical_path, :bundle => false)
+          }.join("\n")
+        end
+
         STYLESHEET % render_asset_path
       end
 

data/lib/jekyll/assets_plugin/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module AssetsPlugin
-    VERSION = "0.6.1"
+    VERSION = "0.7.0"
   end
 end

data/spec/fixtures/_assets/vapor.css.scss

@@ -1,3 +1,4 @@
+//= require wowstyle
 /* vapor css framework */
 
 @font-face {

data/spec/fixtures/_assets/vapor.js

@@ -1 +1,2 @@
+//= require wowscript
 /* vapor js framework */

data/spec/lib/jekyll/assets_plugin/configuration_spec.rb

@@ -51,6 +51,11 @@ module Jekyll::AssetsPlugin
         it { should == ".jekyll-assets-cache" }
       end
 
+      context "debug" do
+        subject { config.debug }
+        it { should be_false }
+      end
+
     end
 
     it "should override specified options and leave defaults for missing" do

data/spec/lib/jekyll/assets_plugin/patches/site_patch_spec.rb

@@ -39,13 +39,6 @@ module Jekyll::AssetsPlugin
               noise_img_re = %r{url\(/assets/noise-[a-f0-9]{32}\.png\)}
               site.assets["app.css"].to_s.should match(noise_img_re)
             end
-
-            it "should be appended to the static_files list" do
-              asset = site.assets["app.css"] # make sure main asset was compiled
-              asset = site.assets["noise.png"]
-
-              site.static_files.include?(asset).should be_true
-            end
           end
         end
       end

data/spec/lib/jekyll/assets_plugin/renderer_spec.rb

@@ -0,0 +1,56 @@
+# stdlib
+require "ostruct"
+
+
+require "spec_helper"
+
+
+module Jekyll::AssetsPlugin
+  describe Renderer do
+
+    let(:site) do
+      Jekyll::Site.new Jekyll.configuration({
+        "source"      => fixtures_path.to_s,
+        "destination" => @dest.to_s,
+        "assets"      => assets_config
+      })
+    end
+
+
+    let(:renderer) do
+      context = OpenStruct.new(:registers => { :site => site })
+      Renderer.new context, "app"
+    end
+
+
+    describe "#render_javascript" do
+      subject { renderer.render_javascript }
+
+      context "when debug mode enabled" do
+        let(:assets_config){ Hash[:debug, true] }
+        it { should match %r{^(\s*<script src="[^"]+"></script>\s*){3}$} }
+      end
+
+      context "when debug mode disabled" do
+        let(:assets_config){ Hash[:debug, false] }
+        it { should match %r{^(\s*<script src="[^"]+"></script>\s*){1}$} }
+      end
+    end
+
+
+    describe "#render_stylesheet" do
+      subject { renderer.render_stylesheet }
+
+      context "when debug mode enabled" do
+        let(:assets_config){ Hash[:debug, true] }
+        it { should match %r{^(\s*<link rel="stylesheet" href="[^"]+">\s*){3}$} }
+      end
+
+      context "when debug mode disabled" do
+        let(:assets_config){ Hash[:debug, false] }
+        it { should match %r{^(\s*<link rel="stylesheet" href="[^"]+">\s*){1}$} }
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-assets
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-21 00:00:00.000000000 Z
+date: 2013-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -180,7 +180,7 @@ files:
 - lib/jekyll-assets/compass.rb
 - lib/jekyll-assets/neat.rb
 - lib/jekyll/assets_plugin.rb
-- lib/jekyll/assets_plugin/asset_file.rb
+- lib/jekyll/assets_plugin/asset_path.rb
 - lib/jekyll/assets_plugin/configuration.rb
 - lib/jekyll/assets_plugin/environment.rb
 - lib/jekyll/assets_plugin/filters.rb
@@ -208,6 +208,8 @@ files:
 - spec/fixtures/_assets/vendor/bourbon.css.sass
 - spec/fixtures/_assets/vendor/compass.css.sass
 - spec/fixtures/_assets/vendor/neat.css.sass
+- spec/fixtures/_assets/wowscript.js
+- spec/fixtures/_assets/wowstyle.css
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/default.html
 - spec/fixtures/_posts/2012-10-19-hello-world.md
@@ -215,11 +217,11 @@ files:
 - spec/lib/jekyll-assets/bourbon_spec.rb
 - spec/lib/jekyll-assets/compass_spec.rb
 - spec/lib/jekyll-assets/neat_spec.rb
-- spec/lib/jekyll/assets_plugin/asset_file_spec.rb
 - spec/lib/jekyll/assets_plugin/configuration_spec.rb
 - spec/lib/jekyll/assets_plugin/environment_spec.rb
 - spec/lib/jekyll/assets_plugin/filters_spec.rb
 - spec/lib/jekyll/assets_plugin/patches/site_patch_spec.rb
+- spec/lib/jekyll/assets_plugin/renderer_spec.rb
 - spec/lib/jekyll/assets_plugin/tag_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures_path.rb
@@ -247,7 +249,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: jekyll-assets-0.6.1
+summary: jekyll-assets-0.7.0
 test_files:
 - spec/fixtures/.gitignore
 - spec/fixtures/_assets/app.css.erb
@@ -263,6 +265,8 @@ test_files:
 - spec/fixtures/_assets/vendor/bourbon.css.sass
 - spec/fixtures/_assets/vendor/compass.css.sass
 - spec/fixtures/_assets/vendor/neat.css.sass
+- spec/fixtures/_assets/wowscript.js
+- spec/fixtures/_assets/wowstyle.css
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/default.html
 - spec/fixtures/_posts/2012-10-19-hello-world.md
@@ -270,11 +274,11 @@ test_files:
 - spec/lib/jekyll-assets/bourbon_spec.rb
 - spec/lib/jekyll-assets/compass_spec.rb
 - spec/lib/jekyll-assets/neat_spec.rb
-- spec/lib/jekyll/assets_plugin/asset_file_spec.rb
 - spec/lib/jekyll/assets_plugin/configuration_spec.rb
 - spec/lib/jekyll/assets_plugin/environment_spec.rb
 - spec/lib/jekyll/assets_plugin/filters_spec.rb
 - spec/lib/jekyll/assets_plugin/patches/site_patch_spec.rb
+- spec/lib/jekyll/assets_plugin/renderer_spec.rb
 - spec/lib/jekyll/assets_plugin/tag_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures_path.rb

data/lib/jekyll/assets_plugin/asset_file.rb

@@ -1,86 +0,0 @@
-module Jekyll
-  module AssetsPlugin
-    class AssetFile
-
-      @@mtimes = Hash.new
-
-
-      attr_reader :logical_path
-
-
-      def initialize site, asset
-        @site, @asset, @logical_path = site, asset, asset.logical_path
-      end
-
-
-      def destination dest
-        File.join dest, @site.assets_config.dirname, filename
-      end
-
-
-      def filename
-        case cachebust = @site.assets_config.cachebust
-        when :none, :soft then asset.logical_path
-        when :hard        then asset.digest_path
-        else raise "Unknown cachebust strategy: #{cachebust.inspect}"
-        end
-      end
-
-
-      def asset
-        @asset = @site.assets[logical_path] if @asset.stale? @site.assets
-        @asset
-      end
-
-
-      def content_type
-        asset.content_type
-      end
-
-
-      def path
-        asset.pathname.to_s
-      end
-
-
-      def mtime
-        asset.mtime.to_i
-      end
-
-
-      def modified?
-        @@mtimes[path] != mtime
-      end
-
-
-      def write dest
-        dest_path = destination dest
-
-        return false if File.exist?(dest_path) and !modified?
-        @@mtimes[path] = mtime
-
-        asset.write_to dest_path
-        asset.write_to "#{dest_path}.gz" if gzip?
-
-        true
-      end
-
-
-      def == other
-        return false unless other.respond_to? :logical_path
-        other.logical_path == logical_path
-      end
-
-
-      def gzip?
-        @site.assets_config.gzip.include? content_type
-      end
-
-
-      def to_s
-        "#<Jekyll::AssetsPlugin::AssetFile:#{logical_path}>"
-      end
-
-    end
-  end
-end

data/spec/lib/jekyll/assets_plugin/asset_file_spec.rb

@@ -1,34 +0,0 @@
-require "spec_helper"
-
-
-module Jekyll::AssetsPlugin
-  describe AssetFile do
-    context "#destination" do
-      subject do
-        AssetFile.new(@site, @site.assets["app.css"]).destination @dest.to_s
-      end
-
-      context "with none cachebust" do
-        before { @site.assets_config.cachebust = :none }
-        it { should match(%r{/app\.css$}) }
-      end
-
-      context "with soft cachebust" do
-        before { @site.assets_config.cachebust = :soft }
-        it { should match(%r{/app\.css$}) }
-      end
-
-      context "with hard cachebust" do
-        before { @site.assets_config.cachebust = :hard }
-        it { should match %r{/app-[0-9a-f]{32}\.css$} }
-      end
-
-      context "with unknown cachebust" do
-        before { @site.assets_config.cachebust = :wtf }
-        it "should raise error" do
-          expect { @site.asset_path "app.css" }.to raise_error
-        end
-      end
-    end
-  end
-end