jekyll-minibundle 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 356988a5df27a7a0f043977db61538733db30af1
-  data.tar.gz: 910c98db3db8895ec27d4ffecf6aceb0ebae79d3
+  metadata.gz: 7676c0eba42d8141ef77c3fe778c401945f6bb74
+  data.tar.gz: a22db95aa1900aa83c1ef4f1b785bf10efde371a
 SHA512:
-  metadata.gz: bc17940f1f3c8b1c52bd65d5fe6718bf11e7147b0442b2d6212248b8daa34fd220dbf16c7f753668a904f1937cb3358cadc8158b5702a845873445a024b9033c
-  data.tar.gz: 4229020fbfb1ad6c35db2d35d813d82ce3648597c9c015505c02ee9070b853232c3b11ac3685550075e7e6777376790ba2132282c010dbd05d4dbb3effc36920
+  metadata.gz: 596712cfd61a61dd4f0524c809bfb3cf967fb5cbe451f59746f76e44efd3af907b8770db6928dda57c6c0c6e086f5ab2d1c20c4acd51ab3a392faa81b363b327
+  data.tar.gz: 5deded83c36f011098f81208fc548fbc3e8616581a208a0df4fe31695a5ca76eb0944efed20ed348ab57daccb29827f82a635c5e702684ef5ae19aa1e6977a90

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 1.3.0 / 2013-12-25
+
+* Disallow handling asset source files that are already static files
+  in Jekyll (would potentially lead to inconsistencies in watch mode,
+  see "Jekyll static file restriction" in README.md)
+* Upgrade development dependencies
+
 # 1.2.0 / 2013-09-29
 
 * If Jekyll's logger is available, use it for nice output when bundling

data/README.md

@@ -1,14 +1,15 @@
 # Jekyll Minibundle plugin
 
 A straightforward asset bundling plugin for
-[Jekyll](https://github.com/mojombo/jekyll), utilizing external
-minification tool of your choice. Provides asset concatenation for
-bundling and asset fingerprinting with MD5 digest for cache busting.
-No other runtime dependencies besides the minification tool (not even
-other gems).
+[Jekyll](http://jekyllrb.com/), utilizing external minification tool
+of your choice. Provides asset concatenation for bundling and asset
+fingerprinting with MD5 digest for cache busting.  No other runtime
+dependencies besides the minification tool (not even other gems).
 
 Tested with Ruby MRI 1.9.3 and 2.0.0. Ruby 1.8 is *not* supported.
 
+The plugin works with Jekyll's watch (auto-regeneration) mode.
+
 [![Build Status](https://secure.travis-ci.org/tkareine/jekyll-minibundle.png)](http://travis-ci.org/tkareine/jekyll-minibundle)
 
 # Features
@@ -18,9 +19,9 @@ contents of the asset, and asset bundling combined with the first
 feature.
 
 Asset bundling consists of concatenation and minification. The plugin
-implements concatenation and leaves up to you to choose the
-minification tool. [UglifyJS2](https://github.com/mishoo/UglifyJS2) is
-a good and fast minifier. The plugin connects to the minifier with
+implements concatenation and leaves choosing the minification tool up
+to you. [UglifyJS2](https://github.com/mishoo/UglifyJS2) is a good and
+fast minifier, for example. The plugin connects to the minifier with
 standard unix pipe, feeding asset file contents to it in desired order
 via standard input, and reads the result from standard output.
 
@@ -55,8 +56,8 @@ require 'jekyll/minibundle'
 ## Asset fingerprinting
 
 Asset fingerprinting is intended to be used together with
-[Compass](http://compass-style.org/) and other similar asset
-generation tools that have their own configuration for input sources.
+[Compass](http://compass-style.org/) and similar asset generation
+tools that have their own configuration for input sources.
 
 Configure Compass to take inputs from `_assets/styles/*.scss` and to
 put output to `_tmp/site.css`. Use `ministamp` tag to copy the
@@ -134,6 +135,37 @@ attributes:
 And then specify the command for launching bundling in
 `$JEKYLL_MINIBUNDLE_CMD_CSS` environment variable.
 
+## Jekyll static file restriction
+
+The plugin disallows using asset source files already known to Jekyll
+as static files. This is because the plugin operates by adding asset
+files as special static files to Jekyll, allowing the plugin work
+nicely with Jekyll's watch (auto-regeneration) mode.
+
+For example, the following snippet causes the plugin to throw an
+exception if `assets/src.css` is not excluded from Jekyll:
+
+``` html
+<link href="{% ministamp assets/src.css assets/dest.css %}" rel="stylesheet" media="screen, projection">
+```
+
+If the restriction would not exist, there would be both `src.css` and
+`dest-<md5-hash>.css` files in `_site/assets/` output directory, which
+you probably wouldn't want to happen.
+
+By default, Jekyll excludes directories beginning with underscore
+character (`_`), so you might use the following directory layout for
+assets:
+
+* `_assets/` for JS and CSS assets handled by the plugin that are in
+  version control
+* `_tmp/` for temporary JS and CSS assets handled by the plugin that
+  are not in version control (for example, Compass output files)
+* `assets/` for images and other assets handled by Jekyll directly
+
+See [Jekyll configuration](http://jekyllrb.com/docs/configuration/)
+for more about excluding files and directories.
+
 ## Development mode
 
 The plugin has one more trick in its sleeves. If you set environment
@@ -144,7 +176,7 @@ fingerprinting. This is useful in development workflow, where you need
 the filenames and line numbers of the original asset sources.
 
 ``` bash
-$ JEKYLL_MINIBUNDLE_MODE=development jekyll --auto --server
+$ JEKYLL_MINIBUNDLE_MODE=development jekyll serve --watch
 ```
 
 # Example site

data/Rakefile

@@ -39,9 +39,11 @@ task :test do
   files = Dir[glob].
     map { |file| %r{^test/(.+)\.rb$}.match(file)[1] }.
     shelljoin
-  opts = '-rpp -rpry' if ENV['debug']
-  cmd = %{ruby #{opts} -e 'ARGV.each { |f| require f }' #{files}}
-  sh(get_minibundle_env('RUBYLIB' => 'lib:test'), cmd)
+  opts = ENV['debug'] ? '-rpp -rpry' : ''
+  eval = %{-e 'ARGV.each { |f| require f }'}
+  cmd = "ruby #{opts} #{eval} #{files}"
+  env = get_minibundle_env 'RUBYLIB' => 'lib:test'
+  sh env, cmd
 end
 
 desc 'Generate fixture site for debugging'

data/jekyll-minibundle.gemspec

@@ -61,10 +61,10 @@ other gems).
     test/unit/stamp_file_test.rb
   }
 
-  s.add_development_dependency 'jekyll',   '~> 1.2.1'
-  s.add_development_dependency 'minitest', '~> 5.0.8'
-  s.add_development_dependency 'nokogiri', '~> 1.6.0'
-  s.add_development_dependency 'rake',     '~> 10.1.0'
+  s.add_development_dependency 'jekyll',   '~> 1.4.2'
+  s.add_development_dependency 'minitest', '~> 5.2.0'
+  s.add_development_dependency 'nokogiri', '~> 1.6.1'
+  s.add_development_dependency 'rake',     '~> 10.1.1'
 
   s.required_ruby_version = '>= 1.9.3'
 

data/lib/jekyll/minibundle/asset_file_operations.rb

@@ -3,8 +3,13 @@ require 'fileutils'
 module Jekyll::Minibundle
   module AssetFileOperations
     def static_file!(site)
-      static_file_exists = site.static_files.find { |f| f.path == path }
-      site.static_files << self unless static_file_exists
+      check_no_existing_static_file site.static_files
+      site.static_files << self
+    end
+
+    def check_no_existing_static_file(static_files)
+      found = static_files.find { |f| f.path == path }
+      raise "Minibundle cannot handle static file already handled by Jekyll: #{path}" if found
     end
 
     def write_destination(site_destination_dir)

data/lib/jekyll/minibundle/bundle_file.rb

@@ -35,6 +35,11 @@ module Jekyll::Minibundle
       asset_bundle.path
     end
 
+    def check_no_existing_static_file(static_files)
+      existing = @assets & static_files.map(&:path)
+      raise "Minibundle cannot handle static file already handled by Jekyll: #{existing.first}" unless existing.empty?
+    end
+
     def asset_destination_path
       "#{@destination_path}-#{asset_stamp}.#{@type}"
     end

data/lib/jekyll/minibundle/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Minibundle
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-minibundle
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Tuomas Kareinen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
+date: 2013-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 5.0.8
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 5.0.8
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 10.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 10.1.1
 description: |
   A straightforward asset bundling plugin for Jekyll, utilizing external
   minification tool of your choice. Provides asset concatenation for
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: A minimalistic asset bundling plugin for Jekyll