jekyll-assets 0.3.4 → 0.3.5

data/HISTORY.md

@@ -1,3 +1,10 @@
+### 0.3.5 (2013-03-03)
+
+* Add buil-tim neat support as `require "jekyll-assets/neat"`. See #18.
+  (Thanks @awmichel)
+* Automagically produce GZipped assets. See #17. (Thanks @beanieboi)
+
+
 ### 0.3.4 (2013-02-18)
 
 * Fix assets regeneration (with --auto) issue. See #13.

data/README.md

@@ -15,13 +15,17 @@ Jekyll plugin, that adds Rails-alike assets pipeline, that means that:
 - It supports JavaScript templates for client-side rendering of strings or
   markup. JavaScript templates have the special format extension `.jst` and are
   compiled to JavaScript functions.
-- Automaticaly adds MD5 fingerprint suffix for _cache busting_. That means
-  that your `app.css` will become `app-908e25f4bf641868d8683022a5b62f54.css`.
-- [Compass][compass] and [Bourbon][bourbon] built-in support.
+- Adds MD5 fingerprint suffix for _cache busting_. That means your `app.css`
+  will become `app-908e25f4bf641868d8683022a5b62f54.css`. See `cachebust`
+  configuration option for other variants.
+- Produce gzipped versions of assets. See `gzip` configuration option for
+  details.
+- [Compass][compass], [Bourbon][bourbon] and [Neat][neat] built-in support.
   See "Custom Vendors" below.
 
 [compass]: http://compass-style.org/
 [bourbon]: http://bourbon.io/
+[neat]:    http://neat.bourbon.io/
 
 Jekyll-Assets uses fabulous [Sprockets][sprockets] under the hood, so you may
 refer to Rails guide about [Asset Pipeline][rails-guide] for detailed
@@ -282,6 +286,18 @@ require "jekyll-assets/bourbon"
 Now you can add `@import "bourbon"` in your SASS assets to get Bourbon goodies.
 
 
+#### Neat Support
+
+Require `jekyll-assets/neat` to enable, e.g.:
+
+``` ruby
+require "jekyll-assets"
+require "jekyll-assets/neat"
+```
+
+Now you can add `@import "neat"` in your SASS assets to get Neat goodies.
+
+
 ## The Directive Processor
 
 *Note:* This section extracted from [Sprockets][sprockets] README.
@@ -435,18 +451,15 @@ assets:
   #     output URL:   /assets/javascripts/app-4f41243847da693a4f356c0486114bc6.css
   #
   cachebust: hard
+  #
+  # 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.
+  #
+  gzip: [ text/css, application/javascript ]
 ```
 
 
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-
 ## "Th-th-th-that's all folks!"
 
 Feel free to follow me on [twitter][twitter], chat via [jabber][jabber] or
@@ -457,6 +470,15 @@ write an [e-mail][e-mail]. :D
 [e-mail]:   mailto://ixti@member.fsf.org
 
 
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
 ## License
 
 Copyright (C) 2012 Aleksey V Zapparov (http://ixti.net/)

data/jekyll-assets.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |gem|
   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
   Jekyll plugin, that allows you to write javascript/css assets in
@@ -16,7 +17,7 @@ Gem::Specification.new do |gem|
   DESC
 
   gem.add_dependency "jekyll"
-  gem.add_dependency "sprockets", "~> 2.8"
+  gem.add_dependency "sprockets", "~> 2.9"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
@@ -24,6 +25,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rb-inotify"
   gem.add_development_dependency "compass"
   gem.add_development_dependency "bourbon"
+  gem.add_development_dependency "neat"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/jekyll-assets/neat.rb

@@ -0,0 +1,5 @@
+require "sprockets"
+
+
+neat_root = Gem::Specification.find_by_name("neat").gem_dir
+Sprockets.append_path File.join(neat_root, "app", "assets", "stylesheets")

data/lib/jekyll/assets_plugin/asset_file.rb

@@ -1,30 +1,39 @@
+# stdlib
+require "forwardable"
+
+
 module Jekyll
   module AssetsPlugin
     class AssetFile
 
+      extend Forwardable
+
+
       @@mtimes = Hash.new
 
 
       attr_reader :asset
 
 
+      def_delegator :@site, :assets_config, :config
+      def_delegator :@asset, :content_type
+
+
       def initialize site, asset
         @site, @asset = site, asset
       end
 
 
       def destination dest
-        File.join dest, @site.assets_config.dirname, filename
+        File.join dest, config.dirname, filename
       end
 
 
       def filename
-        cachebust = @site.assets_config.cachebust
-
-        case cachebust
+        case config.cachebust
         when :none, :soft then asset.logical_path
         when :hard        then asset.digest_path
-        else raise "Unknown cachebust strategy: #{cachebust.inspect}"
+        else raise "Unknown cachebust strategy: #{config.cachebust.inspect}"
         end
       end
 
@@ -51,6 +60,8 @@ module Jekyll
         @@mtimes[path] = mtime
 
         @asset.write_to dest_path
+        @asset.write_to "#{dest_path}.gz" if gzip?
+
         true
       end
 
@@ -64,6 +75,11 @@ module Jekyll
       end
 
 
+      def gzip?
+        config.gzip && config.gzip.include?(content_type)
+      end
+
+
       def to_s
         "#<Jekyll::AssetsPlugin::AssetFile:#{asset.logical_path}>"
       end

data/lib/jekyll/assets_plugin/configuration.rb

@@ -9,7 +9,8 @@ module Jekyll
         :dirname    => "assets",
         :sources    => %w{_assets/javascripts _assets/stylesheets _assets/images},
         :compress   => { :css => nil, :js => nil },
-        :cachebust  => :hard
+        :cachebust  => :hard,
+        :gzip       => %w{ text/css application/javascript }
       }.freeze
 
 
@@ -44,6 +45,11 @@ module Jekyll
         none?(@data.cachebust) ? :none : @data.cachebust.to_sym
       end
 
+      def gzip
+        return @data.gzip if @data.gzip.is_a? Array
+        @data.gzip ? DEFAULTS[:gzip] : false
+      end
+
 
       def method_missing name, *args, &block
         @data.send name, *args, &block

data/lib/jekyll/assets_plugin/version.rb

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

data/spec/fixtures/_assets/vendor/neat.css.sass

@@ -0,0 +1,5 @@
+@import "bourbon"
+@import "neat"
+
+.container
+  @include outer-container

data/spec/lib/jekyll-assets/neat_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+require "jekyll-assets/neat"
+
+
+module Jekyll::AssetsPlugin
+  describe "Neat integration" do
+    it "should globally append neat paths into Sprockets environment" do
+      @site.assets["vendor/neat.css"].to_s.should =~ /max-width/
+    end
+  end
+end

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

@@ -35,6 +35,12 @@ module Jekyll::AssetsPlugin
         subject { config.compress.css }
         it { should be_nil }
       end
+
+      context "gzip" do
+        subject { config.gzip }
+        it { should =~ %w{ text/css application/javascript } }
+      end
+
     end
 
     it "should override specified options and leave defaults for missing" do
@@ -91,5 +97,13 @@ module Jekyll::AssetsPlugin
         it { should be_false }
       end
     end
+
+    context "#gzip" do
+      context "when gzip is disabled" do
+        let(:config){ Configuration.new(:gzip => false) }
+        subject { config.gzip }
+        it { should be false }
+      end
+    end
   end
 end

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

@@ -107,6 +107,22 @@ module Jekyll::AssetsPlugin
       @dest.join("assets", "app.css").exist?.should be_true
     end
 
+    context "#gzip" do
+      subject { site.assets_config }
+
+      it "should generate a static assets if gzip is enabled" do
+        @site.assets_config.gzip = true
+        @site.process
+        @dest.join("assets", "app.css.gz").exist?.should be_true
+      end
+
+      it "should not generate a static assets if gzip is enabled" do
+        @site.assets_config.gzip = false
+        @site.process
+        @dest.join("assets", "app.css.gz").exist?.should be_false
+      end
+
+    end
 
     it "should be included into Jekyll::Site" do
       Jekyll::Site.included_modules.should include SitePatch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-assets
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +139,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: neat
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "  Jekyll plugin, that allows you to write javascript/css assets in\n
   \ other languages such as CoffeeScript, Sass, Less and ERB, concatenate\n  them,
   respecting dependencies, minify and many more.\n"
@@ -162,6 +178,7 @@ files:
 - lib/jekyll-assets.rb
 - lib/jekyll-assets/bourbon.rb
 - 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/configuration.rb
@@ -183,12 +200,14 @@ files:
 - spec/fixtures/_assets/vapor.js
 - spec/fixtures/_assets/vendor/bourbon.css.sass
 - spec/fixtures/_assets/vendor/compass.css.sass
+- spec/fixtures/_assets/vendor/neat.css.sass
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/default.html
 - spec/fixtures/_posts/2012-10-19-hello-world.md
 - spec/fixtures/index.html
 - 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/filters_spec.rb
@@ -197,7 +216,8 @@ files:
 - spec/spec_helper.rb
 - spec/support/fixtures_path.rb
 homepage: http://ixti.github.com/jekyll-assets
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -208,18 +228,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3616688251786802351
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3616688251786802351
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: jekyll-assets-0.3.4
+summary: jekyll-assets-0.3.5
 test_files:
 - spec/fixtures/.gitignore
 - spec/fixtures/_assets/app.css.erb
@@ -230,12 +256,14 @@ test_files:
 - spec/fixtures/_assets/vapor.js
 - spec/fixtures/_assets/vendor/bourbon.css.sass
 - spec/fixtures/_assets/vendor/compass.css.sass
+- spec/fixtures/_assets/vendor/neat.css.sass
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/default.html
 - spec/fixtures/_posts/2012-10-19-hello-world.md
 - spec/fixtures/index.html
 - 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/filters_spec.rb
@@ -243,4 +271,3 @@ test_files:
 - spec/lib/jekyll/assets_plugin/tag_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures_path.rb
-has_rdoc: