jekyll-assets 0.5.1 → 0.5.2

data/HISTORY.md

@@ -1,3 +1,10 @@
+### 0.5.2 (2013-05-25)
+
+* Use Sprocket assets cache for compilation speed improvement. See #32.
+  (Thanks @beanieboi).
+* Minor fix in gemspec.
+
+
 ### 0.5.1 (2013-05-13)
 
 * Re-use underlying asset file to avoid "recompilation" of fresh assets.

data/README.md

@@ -170,11 +170,6 @@ 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:
@@ -215,16 +210,17 @@ assets:
 [amazon-s3]: http://aws.amazon.com/s3
 
 
-## Liquid Assets Pre-processing
+### Compilation Cache
 
-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:
+To improve build time, we have Sprockets caching enabled. You might want to
+clean this cache time after time with `assets:cleanup` jekyll command:
 
-``` coffeescript
-# file: _assets/javascripts/app.js.coffee
-yepnope.load "{% asset_path app.css %}"
-```
+    $ jekyll assets:cleanup
+
+You can turn caching off with `cache_assests` configuration option.
+
+At the moment we use *FileStore* cache which keeps compiled data on file system.
+If you need MemCache or Redis based store, please raise a ticket.
 
 
 ## Custom Vendors
@@ -454,6 +450,12 @@ assets:
   #
   cachebust: hard
   #
+  # Whenever or not cache compiled assets (enabled by default).
+  # Caching significantly improves compilation performance, but you might need
+  # clean it up time after time with `jekyll assets:cleanup` command.
+  #
+  cache_assets: true
+  #
   # Specifies list of MIME types that needs to have gzipped versions.
   # You can set it to `false` to disable gzipping. Only javascripts and
   # stylesheets are gzipped by default.

data/jekyll-assets.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.name          = "jekyll-assets"
   gem.version       = Jekyll::AssetsPlugin::VERSION
   gem.homepage      = "http://ixti.github.com/jekyll-assets"
-  gem.authors       = "Aleksey V Zapparov"
+  gem.authors       = ["Aleksey V Zapparov"]
   gem.email         = %w{ixti@member.fsf.org}
   gem.license       = "MIT"
   gem.summary       = "jekyll-assets-#{Jekyll::AssetsPlugin::VERSION}"

data/lib/jekyll/assets_plugin.rb

@@ -2,3 +2,4 @@ require "jekyll/assets_plugin/patches"
 require "jekyll/assets_plugin/filters"
 require "jekyll/assets_plugin/tag"
 require "jekyll/assets_plugin/version"
+require "jekyll/assets_plugin/commands"

data/lib/jekyll/assets_plugin/commands.rb

@@ -0,0 +1,16 @@
+# 3rd-party
+require "commander"
+
+
+::Commander::Runner.instance.command "assets:cleanup" do |c|
+  c.syntax      = "jekyll assets:cleanup"
+  c.description = "Clenup jekyll-assets cache"
+
+  c.option "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array,
+    "Custom Jekyll configuration file"
+
+  c.action do |_, options|
+    assets = Jekyll::Site.new(Jekyll.configuration(options)).assets
+    assets.cache_path.rmtree if assets.cache_path.exist?
+  end
+end

data/lib/jekyll/assets_plugin/configuration.rb

@@ -6,11 +6,12 @@ module Jekyll
   module AssetsPlugin
     class Configuration
       DEFAULTS = {
-        :dirname    => "assets",
-        :sources    => %w{_assets/javascripts _assets/stylesheets _assets/images},
-        :compress   => { :css => nil, :js => nil },
-        :cachebust  => :hard,
-        :gzip       => %w{ text/css application/javascript }
+        :dirname      => "assets",
+        :sources      => %w{_assets/javascripts _assets/stylesheets _assets/images},
+        :compress     => { :css => nil, :js => nil },
+        :cachebust    => :hard,
+        :cache_assets => true,
+        :gzip         => %w{ text/css application/javascript }
       }.freeze
 
 
@@ -45,6 +46,12 @@ module Jekyll
         none?(@data.cachebust) ? :none : @data.cachebust.to_sym
       end
 
+
+      def cache_assets?
+        !!@data.cache_assets
+      end
+
+
       def gzip
         return @data.gzip if @data.gzip.is_a? Array
         @data.gzip ? DEFAULTS[:gzip] : []

data/lib/jekyll/assets_plugin/environment.rb

@@ -1,3 +1,7 @@
+# stdlib
+require "pathname"
+
+
 # 3rd-party
 require "sprockets"
 
@@ -27,6 +31,10 @@ module Jekyll
         self.js_compressor   = @site.assets_config.js_compressor
         self.css_compressor  = @site.assets_config.css_compressor
 
+        if @site.assets_config.cache_assets?
+          self.cache = Sprockets::Cache::FileStore.new cache_path
+        end
+
         # bind jekyll and Sprockets context together
         context_class.instance_variable_set :@site, @site
 
@@ -34,6 +42,11 @@ module Jekyll
       end
 
 
+      def cache_path
+        Pathname.new(@site.source).join ".jekyll-assets-cache"
+      end
+
+
       def find_asset path, *args
         super or raise AssetNotFound, path
       end

data/lib/jekyll/assets_plugin/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module AssetsPlugin
-    VERSION = "0.5.1"
+    VERSION = "0.5.2"
   end
 end

data/spec/fixtures/.gitignore

@@ -1 +1,2 @@
 _site/
+.jekyll-assets-cache

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

@@ -41,6 +41,11 @@ module Jekyll::AssetsPlugin
         it { should =~ %w{ text/css application/javascript } }
       end
 
+      context "cache_assets?" do
+        subject { config.cache_assets? }
+        it { should be_true }
+      end
+
     end
 
     it "should override specified options and leave defaults for missing" do

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

@@ -18,6 +18,13 @@ module Jekyll::AssetsPlugin
         subject { site.assets }
         it { should be_a_kind_of Sprockets::Environment }
 
+        context "#cache_path" do
+          let(:source_path) { Pathname.new site.source }
+          subject           { site.assets.cache_path }
+
+          it { should == source_path.join(".jekyll-assets-cache") }
+        end
+
         context "calling #asset_path within assets" do
           context "when requested file not found" do
             it "should raise a NotFound error" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-assets
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -181,6 +181,7 @@ files:
 - lib/jekyll-assets/neat.rb
 - lib/jekyll/assets_plugin.rb
 - lib/jekyll/assets_plugin/asset_file.rb
+- lib/jekyll/assets_plugin/commands.rb
 - lib/jekyll/assets_plugin/configuration.rb
 - lib/jekyll/assets_plugin/environment.rb
 - lib/jekyll/assets_plugin/filters.rb
@@ -242,7 +243,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: jekyll-assets-0.5.1
+summary: jekyll-assets-0.5.2
 test_files:
 - spec/fixtures/.gitignore
 - spec/fixtures/_assets/app.css.erb