jekyll-assets 0.3.3 → 0.3.4

data/HISTORY.md

@@ -1,3 +1,8 @@
+### 0.3.4 (2013-02-18)
+
+* Fix assets regeneration (with --auto) issue. See #13.
+
+
 ### 0.3.3 (2013-02-16)
 
 * Respect cachebust setting on assets output filenames. (Thanks @softcrumbs)

data/README.md

@@ -154,8 +154,8 @@ If you want to use YUI compressor for minification, install `yui-compressor`
 gem and put `yui` in place of `uglifier` and/or `sass` in the config file.
 
 Let's go crazy now! Assume you want your blog's `body` background color to be
-white all the time, but red in December. Just add `.erb` suffix extension and
-you can use ruby to "pre-process" asset, something like this:
+white all the time, but red if you compiled your web-site in December. Just add
+`.erb` suffix extension and you can use ruby in your asset like this:
 
 ```
 // file: _assets/stylesheets/app.css.sass.erb
@@ -164,6 +164,11 @@ body
   background-color: <%= (12 == Date.today.month) ? "red" : "white" %>
 ```
 
+*Note* that all assets are pre-processed with Liquid. So if you just need to
+  output asset URL within your javascript/coffeescript or pure css, you don't
+  need to use ERB, just use `asset_path` Liquid tag same as you do it in your
+  layouts/pages. See "Liquid Assets Pre-processing" for more details.
+
 Want more? Sure, here you are. You can use JavaScript templating with EJS or ECO
 for example. Create a file `_assets/javascripts/hello.jst.ejs` with following
 contents:
@@ -204,6 +209,18 @@ assets:
 [amazon-s3]: http://aws.amazon.com/s3
 
 
+## Liquid Assets Pre-processing
+
+All javascript and stylesheet assets are preprocessed with Liquid automagically.
+That means that you can use all liquid tags available to you in Jekyll, but most
+like;y you would want it for `asset_path` tag only:
+
+``` coffeescript
+# file: _assets/javascripts/app.js.coffee
+yepnope.load "{% asset_path app.css %}"
+```
+
+
 ## Custom Vendors
 
 Sometimes you would like to have some 3rd-party vendors. For this purposes,
@@ -249,8 +266,8 @@ require "jekyll-assets/compass"
 
 Now you can add `@import "compass"` in your SASS assets to get Compass goodies.
 
-*Notice* that if you want to use other than default Compass plugins/frameworks,
-you must require them BEFORE `jekyll-assets/compass`.
+*Note* that if you want to use other than default Compass plugins/frameworks,
+  you must require them BEFORE `jekyll-assets/compass`.
 
 
 #### Bourbon Support
@@ -360,38 +377,65 @@ back by any other `require`.
 
 You can fine-tune configuration by editing your `_config.yml`:
 
-    #
-    # Plugin: jekyll-assets
-    #
-    assets:
-      #
-      # Pathname of the destination of generated (bundled) assets relative
-      # to the destination of the root.
-      #
-      dirname: assets
-      #
-      # Base URL of assets paths.
-      #
-      baseurl: /assets/
-      #
-      # Pathnames where to find assets relative to the root of the site.
-      #
-      sources:
-        - _assets/javascripts
-        - _assets/stylesheets
-        - _assets/images
-      #
-      # Sets compressors for the specific types of file: `js`, or `css`.
-      # No compression by default.
-      #
-      # Possible variants:
-      #
-      #     css  => 'yui', 'sass', nil
-      #     js   => 'yui', 'uglifier', nil
-      #
-      compress:
-        js:   ~
-        css:  ~
+``` yaml
+#
+# Plugin: jekyll-assets
+#
+assets:
+  #
+  # Pathname of the destination of generated (bundled) assets relative
+  # to the destination of the root.
+  #
+  dirname: assets
+  #
+  # Base URL of assets paths.
+  #
+  baseurl: /assets/
+  #
+  # Pathnames where to find assets relative to the root of the site.
+  #
+  sources:
+    - _assets/javascripts
+    - _assets/stylesheets
+    - _assets/images
+  #
+  # Sets compressors for the specific types of file: `js`, or `css`.
+  # No compression by default.
+  #
+  # Possible variants:
+  #
+  #     css  => 'yui', 'sass', nil
+  #     js   => 'yui', 'uglifier', nil
+  #
+  compress:
+    js:   ~
+    css:  ~
+  #
+  # Sets cachebusting policy for generated assets.
+  #
+  # Possible variants:
+  #
+  #   none - disables cachebusting
+  #
+  #     source file:  _assets/javascripts/app.css
+  #     output file:  _site/assets/javascriptis/app.css
+  #     output URL:   /assets/javascripts/app.css
+  #
+  #   soft - leave filenames as-is, but `?cb=<md5>` suffix for URLs generated
+  #          with `asset_path`, `javascript` and `stylesheet`:
+  #
+  #     source file:  _assets/javascripts/app.css
+  #     output file:  _site/assets/javascriptis/app.css
+  #     output URL:   /assets/javascripts/app.css?cb=4f41243847da693a4f356c0486114bc6
+  #
+  #   hard - (default) injects cachebusting checksum into processed filename:
+  #
+  #     source file:  _assets/javascripts/app.css
+  #     output file:  _site/assets/javascriptis/app-4f41243847da693a4f356c0486114bc6.css
+  #     output URL:   /assets/javascripts/app-4f41243847da693a4f356c0486114bc6.css
+  #
+  cachebust: hard
+```
 
 
 ## Contributing

data/lib/jekyll/assets_plugin/asset_file.rb

@@ -57,8 +57,8 @@ module Jekyll
 
       def == other
         case other
-        when AssetFile        then same_asset? other.asset
-        when Sprockets::Asset then same_asset? other
+        when AssetFile        then @asset == other.asset
+        when Sprockets::Asset then @asset == other
         else false
         end
       end
@@ -68,14 +68,6 @@ module Jekyll
         "#<Jekyll::AssetsPlugin::AssetFile:#{asset.logical_path}>"
       end
 
-
-      protected
-
-
-      def same_asset? other
-        other.pathname.cleanpath == asset.pathname.cleanpath
-      end
-
     end
   end
 end

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

@@ -4,14 +4,8 @@ module Jekyll
       module IndexPatch
 
         def find_asset path, options = {}
-          site    = @environment.site
-          asset   = super
-          bundle  = options[:bundle]
-
-          if asset and bundle and not site.static_files.include? asset
-            site.static_files << AssetFile.new(site, asset)
-          end
-
+          asset = super
+          @environment.site.bundle_asset! asset if asset and options[:bundle]
           asset
         end
 

data/lib/jekyll/assets_plugin/site_patch.rb

@@ -11,6 +11,14 @@ module Jekyll
   module AssetsPlugin
     module SitePatch
 
+      def self.included base
+        base.class_eval do
+          alias_method :write_without_assets, :write
+          alias_method :write, :write_with_assets
+        end
+      end
+
+
       def assets_config
         @assets_config ||= Configuration.new(self.config["assets"] || {})
       end
@@ -21,6 +29,11 @@ module Jekyll
       end
 
 
+      def asset_files
+        @asset_files ||= []
+      end
+
+
       def asset_path *args
         asset     = assets[*args]
         baseurl   = "#{assets_config.baseurl}/"
@@ -34,6 +47,22 @@ module Jekyll
         end
       end
 
+
+      def bundle_asset! asset
+        if not asset_files.include? asset
+          file = AssetFile.new self, asset
+
+          asset_files   << file
+          static_files  << file
+        end
+      end
+
+
+      def write_with_assets
+        static_files.push(*asset_files).uniq!
+        write_without_assets
+      end
+
     end
   end
 end

data/lib/jekyll/assets_plugin/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module AssetsPlugin
-    VERSION = "0.3.3"
+    VERSION = "0.3.4"
   end
 end

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

@@ -45,7 +45,7 @@ module Jekyll::AssetsPlugin
             site.assets["app.css"].to_s.should match(noise_img_re)
           end
 
-          it "should be appended to the static files list" do
+          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"]
 
@@ -88,6 +88,7 @@ module Jekyll::AssetsPlugin
       end
     end
 
+
     context "#assets_config" do
       subject { site.assets_config }
       it { should be_an_instance_of Configuration }
@@ -98,6 +99,15 @@ module Jekyll::AssetsPlugin
       end
     end
 
+
+    it "should regenerate assets upon multiple #process" do
+      @site.assets_config.cachebust = :none
+      2.times { @site.process }
+
+      @dest.join("assets", "app.css").exist?.should be_true
+    end
+
+
     it "should be included into Jekyll::Site" do
       Jekyll::Site.included_modules.should include SitePatch
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-assets
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -219,7 +219,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: jekyll-assets-0.3.3
+summary: jekyll-assets-0.3.4
 test_files:
 - spec/fixtures/.gitignore
 - spec/fixtures/_assets/app.css.erb