jekyll-assets 0.5.3 → 0.5.4

data/Guardfile

@@ -1,3 +1,5 @@
+notification :off
+
 guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }

data/HISTORY.md

@@ -1,3 +1,12 @@
+### 0.5.4 (2103-07-07)
+
+* Rename configuration options `compress.js` and `compress.css` into
+  `js_compressor` and `css_compressor` respectively.
+* Rename configureation option `cache_assets` into `cache`.
+* Allow specify custom compilation cache path.
+* Invalidate cache upon config changes.
+
+
 ### 0.5.3 (2013-05-25)
 
 * Assets cache disable by default, in order to avoid "unpredictable" behavior.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Aleksey V Zapparov (http://ixti.net/)
+Copyright (c) 2012-2013 Aleksey V Zapparov (http://ixti.net/)
 
 MIT License
 

data/README.md

@@ -216,19 +216,13 @@ To improve build time, you can enabled compiled assets cache:
 
 ``` yaml
 assets:
-  cache_assets: true
+  cache: true
 ```
 
-In this case you might want to clean cache time after time:
-
-    $ jekyll assets:cleanup
-
-Also you will need to add `.jekyll-assets-cache` path under source of your
-jekyll site into exclusion list of your source control system (`.gitignore`
-for git).
-
-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.
+This will keep cache of compiled assets in `.jekyll-assets-cache` under source
+of your jekyl site. If you want to use different location specify it instead of
+`true`, in this case it should be an absolute path or path relative to source
+path of your jekyl site.
 
 
 ## Custom Vendors
@@ -421,17 +415,15 @@ assets:
     - _assets/stylesheets
     - _assets/images
   #
-  # Sets compressors for the specific types of file: `js`, or `css`.
-  # No compression by default.
+  # Sets JS compressor. No compression by default.
+  # Possible variants: 'yui', 'uglifier', nil
   #
-  # Possible variants:
+  js_compressor: ~
   #
-  #     css  => 'yui', 'sass', nil
-  #     js   => 'yui', 'uglifier', nil
+  # Sets CSS compressor. No compression by default.
+  # Possible variants: 'yui', 'sass', nil
   #
-  compress:
-    js:   ~
-    css:  ~
+  css_compressor: ~
   #
   # Sets cachebusting policy for generated assets.
   #
@@ -461,7 +453,7 @@ assets:
   # Whenever or not cache compiled assets (disabled by default).
   # See `Compilation Cache` section of README for details.
   #
-  cache_assets: false
+  cache: false
   #
   # Specifies list of MIME types that needs to have gzipped versions.
   # You can set it to `false` to disable gzipping. Only javascripts and
@@ -492,7 +484,7 @@ write an [e-mail][e-mail]. :D
 
 ## License
 
-Copyright (C) 2012 Aleksey V Zapparov (http://ixti.net/)
+Copyright (C) 2012-2013 Aleksey V Zapparov (http://ixti.net/)
 
 The MIT License
 

data/Rakefile

@@ -1,5 +1,3 @@
-#!/usr/bin/env rake
-
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/jekyll-assets.gemspec

@@ -1,35 +1,36 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/jekyll/assets_plugin/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/assets_plugin/version'
 
 
-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.email         = %w{ixti@member.fsf.org}
-  gem.license       = "MIT"
-  gem.summary       = "jekyll-assets-#{Jekyll::AssetsPlugin::VERSION}"
-  gem.description   = <<-DESC
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-assets"
+  spec.version       = Jekyll::AssetsPlugin::VERSION
+  spec.homepage      = "http://ixti.github.com/jekyll-assets"
+  spec.authors       = ["Aleksey V Zapparov"]
+  spec.email         = %w{ixti@member.fsf.org}
+  spec.license       = "MIT"
+  spec.summary       = "jekyll-assets-#{Jekyll::AssetsPlugin::VERSION}"
+  spec.description   = <<-DESC
   Jekyll plugin, that allows you to write javascript/css assets in
   other languages such as CoffeeScript, Sass, Less and ERB, concatenate
   them, respecting dependencies, minify and many more.
   DESC
 
-  gem.add_dependency "jekyll",    "~> 1.0"
-  gem.add_dependency "sprockets", "~> 2.9"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "guard-rspec"
-  gem.add_development_dependency "rb-inotify"
-  gem.add_development_dependency "compass"
-  gem.add_development_dependency "bourbon"
-  gem.add_development_dependency "neat"
+  spec.add_dependency "jekyll",    "~> 1.0"
+  spec.add_dependency "sprockets", "~> 2.10"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-
-  gem.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "compass"
+  spec.add_development_dependency "bourbon"
+  spec.add_development_dependency "neat"
 end

data/lib/jekyll/assets_plugin.rb

@@ -2,4 +2,3 @@ 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/configuration.rb

@@ -6,12 +6,13 @@ module Jekyll
   module AssetsPlugin
     class Configuration
       DEFAULTS = {
-        :dirname      => "assets",
-        :sources      => %w{_assets/javascripts _assets/stylesheets _assets/images},
-        :compress     => { :css => nil, :js => nil },
-        :cachebust    => :hard,
-        :cache_assets => false,
-        :gzip         => %w{ text/css application/javascript }
+        :dirname        => "assets",
+        :sources        => %w{_assets/javascripts _assets/stylesheets _assets/images},
+        :js_compressor  => nil,
+        :css_compressor => nil,
+        :cachebust      => :hard,
+        :cache          => false,
+        :gzip           => %w{ text/css application/javascript }
       }.freeze
 
 
@@ -19,9 +20,14 @@ module Jekyll
         @data = OpenStruct.new DEFAULTS.merge(config)
 
         @data.sources  = [ @data.sources ] if @data.sources.is_a? String
-        @data.compress = OpenStruct.new @data.compress
         @data.dirname  = @data.dirname.gsub(/^\/+|\/+$/, "")
 
+        compress = OpenStruct.new @data.compress
+
+        @data.js_compressor   ||= compress.js
+        @data.css_compressor  ||= compress.css
+        @data.cache           ||= @data.cache_assets
+
         # if baseurl not given - autoguess base on dirname
         @data.baseurl ||= "/#{@data.dirname}/".squeeze '/'
       end
@@ -33,12 +39,12 @@ module Jekyll
 
 
       def js_compressor
-        compressor @data.compress.js
+        compressor @data.js_compressor
       end
 
 
       def css_compressor
-        compressor @data.compress.css
+        compressor @data.css_compressor
       end
 
 
@@ -48,7 +54,12 @@ module Jekyll
 
 
       def cache_assets?
-        !!@data.cache_assets
+        !!@data.cache
+      end
+
+
+      def cache_path
+        @data.cache.is_a?(String) ? @data.cache : ".jekyll-assets-cache"
       end
 
 

data/lib/jekyll/assets_plugin/environment.rb

@@ -26,24 +26,26 @@ module Jekyll
         @site = site
 
         # append asset paths
-        @site.assets_config.sources.each { |p| append_path p }
+        site.assets_config.sources.each { |p| append_path p }
 
-        self.js_compressor   = @site.assets_config.js_compressor
-        self.css_compressor  = @site.assets_config.css_compressor
+        self.js_compressor   = site.assets_config.js_compressor
+        self.css_compressor  = site.assets_config.css_compressor
 
-        if @site.assets_config.cache_assets?
+        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
+        # reset cache if config changed
+        self.version = site.assets_config.marshal_dump
 
+        # bind jekyll and Sprockets context together
+        context_class.instance_variable_set :@site, site
         context_class.send :include, Patches::ContextPatch
       end
 
 
       def cache_path
-        Pathname.new(@site.source).join ".jekyll-assets-cache"
+        Pathname.new(@site.source).join @site.assets_config.cache_path
       end
 
 

data/lib/jekyll/assets_plugin/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module AssetsPlugin
-    VERSION = "0.5.3"
+    VERSION = "0.5.4"
   end
 end

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

@@ -27,12 +27,12 @@ module Jekyll::AssetsPlugin
       end
 
       context "js compressor" do
-        subject { config.compress.js }
+        subject { config.js_compressor }
         it { should be_nil }
       end
 
       context "css compressor" do
-        subject { config.compress.css }
+        subject { config.css_compressor }
         it { should be_nil }
       end
 
@@ -46,18 +46,32 @@ module Jekyll::AssetsPlugin
         it { should be_false }
       end
 
+      context "cache_path" do
+        subject { config.cache_path }
+        it { should == ".jekyll-assets-cache" }
+      end
+
     end
 
     it "should override specified options and leave defaults for missing" do
       config = Configuration.new({
-        :sources  => %w{abc},
-        :compress => { :css => "sass" }
+        :sources        => %w{abc},
+        :css_compressor => "sass"
       })
 
-      config.dirname.should       ==  "assets"
-      config.sources.should       =~  %w{abc}
-      config.compress.js.should       be_nil
-      config.compress.css.should  ==  "sass"
+      config.dirname.should         ==  "assets"
+      config.sources.should         =~  %w{abc}
+      config.js_compressor.should       be_nil
+      config.css_compressor.should  ==  :sass
+    end
+
+    context "#cache" do
+      context "when specified as String" do
+        it "should override default cache path" do
+          config = Configuration.new :cache => "/tmp/jekyll-assets"
+          config.cache_path.should == "/tmp/jekyll-assets"
+        end
+      end
     end
 
     context "#baseurl" do
@@ -77,7 +91,7 @@ module Jekyll::AssetsPlugin
 
     context "#js_compressor" do
       context "when js compressor is given as `uglify`" do
-        let(:config){ Configuration.new(:compress => {:js => "uglify"}) }
+        let(:config){ Configuration.new(:js_compressor => "uglify") }
         subject { config.js_compressor }
         it { should be :uglify }
       end
@@ -91,7 +105,7 @@ module Jekyll::AssetsPlugin
 
     context "#css_compressor" do
       context "when css compressor is given as `sass`" do
-        let(:config){ Configuration.new(:compress => {:css => "sass"}) }
+        let(:config){ Configuration.new(:css_compressor => "sass") }
         subject { config.css_compressor }
         it { should be :sass }
       end
@@ -110,5 +124,27 @@ module Jekyll::AssetsPlugin
         it { should == [] }
       end
     end
+
+
+    context "Deprecated options" do
+      context "compress" do
+        let(:options){ { :compress => {:js => "uglify", :css => "sass"} } }
+
+        it "should set corresponding *_compressor value" do
+          config = Configuration.new options
+          config.js_compressor.should   == :uglify
+          config.css_compressor.should  == :sass
+        end
+      end
+
+      context "cache_assets" do
+        let(:options){ { :cache_assets => true } }
+
+        it "should set `cache` value" do
+          config = Configuration.new options
+          config.cache_assets?.should be_true
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-assets
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-25 00:00:00.000000000 Z
+date: 2013-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,25 +42,25 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -76,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-inotify
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -181,7 +181,6 @@ 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
@@ -243,7 +242,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: jekyll-assets-0.5.3
+summary: jekyll-assets-0.5.4
 test_files:
 - spec/fixtures/.gitignore
 - spec/fixtures/_assets/app.css.erb

data/lib/jekyll/assets_plugin/commands.rb

@@ -1,16 +0,0 @@
-# 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