jekyll-minibundle 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78d5b4816f385803fa9430a93c45b4400bdc412b
-  data.tar.gz: 840c54ba92488bf1f8116789267bd3a4890a0ce0
+  metadata.gz: b7dc5bf67a5d4a713810a998484b2bca9ecc1cc3
+  data.tar.gz: 4f2fc0b94c6e29a573666627609e50dccdc123ab
 SHA512:
-  metadata.gz: 768d946a42f110c20029d45bf50a6c5174d665adfac5dff7f56b6eef81538f2d7044f6222d2efc31bafdc1083c3f8fb0639959e8c9dc50be999f950b45832b35
-  data.tar.gz: 506cc7dd2bc7405b431ebb09815aab616bf786407d46d5b19b93aa510c999a552481d1ed6a6a1711817ae6e618e1252549ac8311c0b32cf751892347c65a45f0
+  metadata.gz: e7571e9ec0a7a0c7914afbaf93b3442747b50b36b5645ac67d6745ecb777a49d17c66c40f6d7af2fc87e265fcf888b53d17a9dd3f9c80c390e2b048b458d8dc3
+  data.tar.gz: 0bfeacb9e08ea16d1e4815af0b3dfa7c061ffd7138fa883a2619817b9588d30fefe3b72c0b843db84282e2c9c429714e138f65239e579326636c1a715c21ab35

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.6.0 / 2016-03-26
+
+* Log the last 2000 bytes of minifier's STDOUT output if the minifier
+  command fails. Pull Request #6 by Martin Nordholts (@Enselic).
+* Allow prepending base URL for the destination path of `minibundle`
+  block
+* Drop Ruby MRI 1.9 support because Jekyll 3 does not support it
+* Fix issues in asset reloading in Jekyll's watch (auto-regeneration)
+  mode, doing bundling and asset fingerprinting again
+
 # 1.5.1 / 2015-01-29
 
 * Improve future compatibility with Jekyll. Minibundle has classes
@@ -8,7 +18,7 @@
 # 1.5.0 / 2014-07-27
 
 * Support minifier command specification in `_config.yml` and inside
-  `minibundle` block (#4, @phillipadsmith)
+  `minibundle` block. Issue #4 by Phillip Smith (@phillipadsmith).
 * Support enabling development mode from `_config.yml`
 * Add argument validation to `minibundle` block and `ministamp` tag
 * Document how to load the gem with Jekyll's `gems` config setting
@@ -25,8 +35,8 @@
 * Clean log messages: show relative paths when bundling assets
 * Add missing implementations of `relative_path` and `to_liquid`
   methods from Jekyll's StaticFile API (introduced in Jekyll v1.5.0),
-  allowing Minibundle to behave better with other Jekyll plugins (#3,
-  @mmistakes)
+  allowing Minibundle to behave better with other Jekyll
+  plugins. Issue #3 by Michael Rose (@mmistakes).
 * Fix Ruby deprecation warnings (use `File.exist?` instead of
   `File.exists?`)
 
@@ -65,14 +75,15 @@
 * Fix bug causing exception to be thrown when `ministamp` or
   `minibundle` is called twice with same asset source argument. Allow
   handling asset source files that are already static files in Jekyll
-  (remove the restriction introduced in 1.3.0). (#2, @agrigg)
+  (remove the restriction introduced in 1.3.0). Issue #2 by Austin
+  Grigg (@agrigg).
 
 # 1.3.0 / 2013-12-25
 
 * Disallow handling asset source files that are already static files
   in Jekyll. Otherwise, we would potentially get to inconsistencies in
   Jekyll's watch mode. See "Jekyll static file restriction" in
-  README.md. (#2, @agrigg)
+  README.md. Issue #2 by Austin Grigg (@agrigg).
 * Upgrade development dependencies
 
 # 1.2.0 / 2013-09-29
@@ -85,7 +96,8 @@
 
 * `ministamp` tag omits fingerprint in development mode
 * Clarify documentation
-* Comply with (Gemnasium) conventions for changelogs (#1, @tmatilai)
+* Comply with (Gemnasium) conventions for changelogs. Pull Request #1
+  by Teemu Matilainen (@tmatilai).
 * Bug fix: do not bundle assets when nonrelated files change
 * Bug fix: do not bundle assets twice upon startup
 

data/README.md

@@ -8,12 +8,12 @@ for cache busting.
 There are no runtime dependencies, except for the minification tool
 used for bundling (fingerprinting has no dependencies).
 
-Tested with Ruby MRI 1.9.3 and 2.x. Ruby 1.8 is *not* supported.
+Tested with Ruby MRI 2.x. Ruby 1.9 and 1.8 are *not* supported.
 
 The plugin works with Jekyll's watch (auto-regeneration) mode.
 
-[![Gem Version](https://badge.fury.io/rb/jekyll-minibundle.svg)](http://badge.fury.io/rb/jekyll-minibundle)
-[![Build Status](https://secure.travis-ci.org/tkareine/jekyll-minibundle.svg)](http://travis-ci.org/tkareine/jekyll-minibundle)
+[![Gem version](https://badge.fury.io/rb/jekyll-minibundle.svg)][MinibundleGem]
+[![Build status](https://secure.travis-ci.org/tkareine/jekyll-minibundle.svg)][MinibundleBuild]
 
 # Features
 
@@ -29,11 +29,11 @@ feeding asset file contents to it in desired order via standard input,
 and reads the result from standard output.
 
 Why is this good? A fingerprint in asset's path is the
-[recommended way][GoogleCachingBestPractices] to handle caching of
-static resources, because you can allow caching the asset
-forever. Calculating MD5 digest over the contents of the asset is fast
-and the resulting digest is reasonably unique to be generated
-automatically.
+[recommended way][GoogleWebFundamentalsHttpCaching] to handle caching
+of static resources, because you can allow browsers and intermediate
+proxies to cache the asset for a very long time. Calculating MD5
+digest over the contents of the asset is fast and the resulting digest
+is reasonably unique to be generated automatically.
 
 Asset bundling is good for reducing the number of requests to the
 backend upon page load. The minification of stylesheets and JavaScript
@@ -42,8 +42,7 @@ network.
 
 # Usage
 
-The plugin ships as a
-[RubyGem](https://rubygems.org/gems/jekyll-minibundle). To install:
+The plugin ships as a [RubyGem][MinibundleGem]. To install:
 
 ``` bash
 $ gem install jekyll-minibundle
@@ -76,13 +75,14 @@ If you just want to have a fingerprint in your asset's path, use
 `ministamp` tag:
 
 ``` html
-<link href="{% ministamp _assets/site.css assets/site.css %}" rel="stylesheet" media="screen, projection">
+<link href="{{ site.baseurl }}{% ministamp _assets/site.css assets/site.css %}" rel="stylesheet" media="screen, projection">
 ```
 
-Output, containing the MD5 digest of the file in the filename:
+Output, when `site.baseurl` is `/`, containing the MD5 digest of the
+file in the filename:
 
 ``` html
-<link href="assets/site-390be921ee0eff063817bb5ef2954300.css" rel="stylesheet" media="screen, projection">
+<link href="/assets/site-390be921ee0eff063817bb5ef2954300.css" rel="stylesheet" media="screen, projection">
 ```
 
 Jekyll's output directory will have the asset file at that path.
@@ -94,7 +94,7 @@ to take inputs from `_assets/styles/*.scss` and to produce output to
 fingerprint to Jekyll's output directory:
 
 ``` html
-<link href="{% ministamp _tmp/site.css assets/site.css %}" rel="stylesheet">
+<link href="{{ site.baseurl }}{% ministamp _tmp/site.css assets/site.css %}" rel="stylesheet">
 ```
 
 ## Asset bundling
@@ -115,6 +115,7 @@ a set of JavaScript sources:
 {% minibundle js %}
 source_dir: _assets/scripts
 destination_path: assets/site
+baseurl: {{ site.baseurl }}
 assets:
   - dependency
   - app
@@ -126,15 +127,17 @@ attributes:
 Then, specify the command for launching your favorite minifier in `_config.yml`:
 
 ``` yaml
+baseurl: /
+
 minibundle:
   minifier_commands:
-    js: ./node_modules/.bin/uglifyjs -
+    js: node_modules/.bin/uglifyjs --
 ```
 
 Output in the content file:
 
 ``` html
-<script src="assets/site-8e764372a0dbd296033cb2a416f064b5.js" type="text/javascript" id="my-scripts"></script>
+<script src="/assets/site-8e764372a0dbd296033cb2a416f064b5.js" type="text/javascript" id="my-scripts"></script>
 ```
 
 You can pass custom attributes, like `id="my-scripts"` above, to the
@@ -147,6 +150,7 @@ For bundling CSS assets, you use `css` as the argument to the
 {% minibundle css %}
 source_dir: _assets/styles
 destination_path: assets/site
+baseurl: {{ site.baseurl }}
 assets:
   - reset
   - common
@@ -161,7 +165,7 @@ And then specify the minifier command in `_config.yml`:
 minibundle:
   minifier_commands:
     css: _bin/remove_whitespace
-    js: ./node_modules/.bin/uglifyjs -
+    js: node_modules/.bin/uglifyjs --
 ```
 
 ### Minifier command specification
@@ -174,14 +178,14 @@ You can specify minifier commands in three places:
    minibundle:
      minifier_commands:
        css: _bin/remove_whitespace
-       js: ./node_modules/.bin/uglifyjs -
+       js: node_modules/.bin/uglifyjs --
    ```
 
 2. as environment variables:
 
    ``` bash
    export JEKYLL_MINIBUNDLE_CMD_CSS=_bin/remove_whitespace
-   export JEKYLL_MINIBUNDLE_CMD_JS="./node_modules/.bin/uglifyjs -"
+   export JEKYLL_MINIBUNDLE_CMD_JS="node_modules/.bin/uglifyjs --"
    ```
 
 3. inside the minibundle block with `minifier_cmd` setting, allowing
@@ -191,7 +195,7 @@ You can specify minifier commands in three places:
    {% minibundle js %}
    source_dir: _assets/scripts
    destination_path: assets/site
-   minifier_cmd: ./node_modules/.bin/uglifyjs -
+   minifier_cmd: node_modules/.bin/uglifyjs --
    assets:
      - dependency
      - app
@@ -217,7 +221,7 @@ asset source to `ministamp` tag:
 
 ``` html
 <!-- BAD: unless assets dir is excluded, both src.css and dest.css will be copied to output directory -->
-<link href="{% ministamp assets/src.css assets/dest.css %}" rel="stylesheet" media="screen, projection">
+<link href="{{ site.baseurl }}{% ministamp assets/src.css assets/dest.css %}" rel="stylesheet" media="screen, projection">
 ```
 
 By default, Jekyll includes this file to the output directory. As a
@@ -266,13 +270,19 @@ wins.
 
 See the contents of `test/fixture/site` directory.
 
+# Known caveats
+
+See `test/integration/known_caveats_test.rb`.
+
 # License
 
 MIT. See `LICENSE.txt`.
 
 [Compass]: http://compass-style.org/
 [GemBundler]: http://bundler.io/
-[GoogleCachingBestPractices]: https://developers.google.com/speed/docs/best-practices/caching
-[Jekyll]: http://jekyllrb.com/
-[JekyllConf]: http://jekyllrb.com/docs/configuration/
+[GoogleWebFundamentalsHttpCaching]: https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching#invalidating-and-updating-cached-responses
+[MinibundleGem]: https://rubygems.org/gems/jekyll-minibundle
+[MinibundleBuild]: https://travis-ci.org/tkareine/jekyll-minibundle
+[Jekyll]: https://jekyllrb.com/
+[JekyllConf]: https://jekyllrb.com/docs/configuration/
 [UglifyJS2]: https://github.com/mishoo/UglifyJS2

data/Rakefile

@@ -1,6 +1,7 @@
 require 'fileutils'
 require 'rake/clean'
 require 'shellwords'
+require 'rubocop/rake_task'
 
 require_relative 'lib/jekyll/minibundle/version'
 
@@ -25,7 +26,7 @@ namespace :gem do
   CLEAN.include "#{gem_name}-*.gem"
 
   desc 'Package the software as a gem'
-  task :build => :test do
+  task build: :default do
     sh "gem build #{gem_name}.gemspec"
   end
 
@@ -35,7 +36,7 @@ namespace :gem do
   end
 
   desc 'Uninstall the gem'
-  task :uninstall => :clean do
+  task uninstall: :clean do
     sh "gem uninstall #{gem_name}"
   end
 end
@@ -44,17 +45,19 @@ desc 'Run tests; TEST=<test_suite_path>, NAME=<test_name_pattern>, DEBUG=1 to re
 task :test do
   run_single_test = ENV.key?('TEST')
 
-  run_selected_or_all = if run_single_test
-    rb_file = ENV['TEST']
-    name_opt = ENV.key?('NAME') ? " -n #{ENV['NAME']}" : ''
-    "#{rb_file}#{name_opt}"
-  else
-    requirable_files = Dir['test/{unit,integration}/*_test.rb'].
-      map { |file| %r{^test/(.+)\.rb$}.match(file)[1] }.
-      shelljoin
-    eval = "-e 'ARGV.each { |f| require f }'"
-    "#{eval} #{requirable_files}"
-  end
+  run_selected_or_all =
+    if run_single_test
+      rb_file = ENV['TEST']
+      name_opt = ENV.key?('NAME') ? " -n #{ENV['NAME']}" : ''
+      "#{rb_file}#{name_opt}"
+    else
+      requirable_files =
+        Dir['test/{unit,integration}/*_test.rb']
+        .map { |file| %r{^test/(.+)\.rb$}.match(file)[1] }
+        .shelljoin
+      eval = "-e 'ARGV.each { |f| require f }'"
+      "#{eval} #{requirable_files}"
+    end
 
   extra_opts = ENV['DEBUG'] ? '-w -rpp -rpry ' : ''
 
@@ -75,4 +78,6 @@ namespace :fixture do
   end
 end
 
-task :default => :test
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/jekyll-minibundle.gemspec

@@ -27,12 +27,13 @@ minification tool (not even other gems).
 
   s.test_files = `git ls-files -- test`.split("\n")
 
-  s.add_development_dependency 'jekyll',   '~> 2.1'
-  s.add_development_dependency 'minitest', '~> 5.3'
+  s.add_development_dependency 'jekyll',   '~> 3.1'
+  s.add_development_dependency 'minitest', '~> 5.8'
   s.add_development_dependency 'nokogiri', '~> 1.6'
-  s.add_development_dependency 'rake',     '~> 10.3'
+  s.add_development_dependency 'rake',     '~> 11.1'
+  s.add_development_dependency 'rubocop',  '~> 0.38.0'
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.0.0'
 
   s.rdoc_options << '--line-numbers' << '--title' << s.name << '--exclude' << 'test'
 end

data/lib/jekyll/minibundle/asset_bundle.rb

@@ -1,5 +1,6 @@
 require 'tempfile'
 require 'jekyll/minibundle/compatibility'
+require 'jekyll/minibundle/files'
 
 module Jekyll::Minibundle
   class AssetBundle
@@ -10,7 +11,7 @@ module Jekyll::Minibundle
       @minifier_cmd = config.fetch(:minifier_cmd)
 
       unless @minifier_cmd
-        fail <<-END
+        raise <<-END
 Missing minification command for bundling #{@type} assets. Specify it in
 1) minibundle.minifier_commands.#{@type} setting in _config.yml,
 2) $JEKYLL_MINIBUNDLE_CMD_#{@type.to_s.upcase} environment variable, or
@@ -18,7 +19,7 @@ Missing minification command for bundling #{@type} assets. Specify it in
         END
       end
 
-      @temp_file = Tempfile.new(["jekyll-minibundle-", ".#{@type}"])
+      @temp_file = Tempfile.new(['jekyll-minibundle-', ".#{@type}"])
       at_exit { @temp_file.close! }
     end
 
@@ -36,14 +37,18 @@ Missing minification command for bundling #{@type} assets. Specify it in
           input.puts(';') if @type == :js
         end
       end
-      fail "Bundling #{@type} assets failed with exit status #{exit_status}, command: #{@minifier_cmd}" if exit_status != 0
+      if exit_status != 0
+        msg = "Bundling #{@type} assets failed with exit status #{exit_status}, command: '#{@minifier_cmd}'"
+        log_minifier_error(msg)
+        raise msg
+      end
       self
     end
 
     private
 
     def relative_path_from(path, base)
-      path.sub(/\A#{base}\//, '')
+      path.sub(%r{\A#{base}/}, '')
     end
 
     def spawn_minifier(cmd)
@@ -57,8 +62,23 @@ Missing minification command for bundling #{@type} assets. Specify it in
       wr.close
       _, status = Process.waitpid2(pid)
       status.exitstatus
+    rescue => e
+      raise "Bundling #{@type} assets failed: #{e}"
     ensure
       [rd, wr].each { |io| io.close unless io.closed? }
     end
+
+    def log_minifier_error(message)
+      last_bytes = Files.read_last(@temp_file.path, 2000)
+
+      return if last_bytes.empty?
+
+      Compatibility.log_error("#{message}, last #{last_bytes.size} bytes of minifier output:")
+
+      last_bytes
+        .gsub(/[^[:print:]\t\n]/) { |ch| '\x' + ch.unpack('H2').first }
+        .split("\n")
+        .each { |line| Compatibility.log_error(line) }
+    end
   end
 end

data/lib/jekyll/minibundle/asset_file_operations.rb

@@ -2,14 +2,6 @@ require 'fileutils'
 
 module Jekyll::Minibundle
   module AssetFileOperations
-    def add_as_static_file_to(site)
-      # NOTE: Rely on explicit site parameter (not on self's @site) so
-      # that we can utilize asset registry clearing for tests.
-      unless site.static_files.include? self
-        site.static_files << self
-      end
-    end
-
     def write_destination(site_destination_dir)
       destination_path = destination(site_destination_dir)
       FileUtils.mkdir_p(File.dirname(destination_path))

data/lib/jekyll/minibundle/asset_file_properties.rb

@@ -1,5 +1,11 @@
 module Jekyll::Minibundle
   module AssetFileProperties
+    def asset_destination_path
+      File.join(asset_destination_dir, asset_destination_basename)
+    end
+
+    # Conformance to remaining Jekyll StaticFile public API methods
+
     def path
       asset_source_path
     end
@@ -8,20 +14,20 @@ module Jekyll::Minibundle
       path.sub(/\A#{@site.source}/, '')
     end
 
-    def asset_destination_path
-      File.join(asset_destination_dir, asset_destination_basename)
-    end
-
     def destination(site_destination_dir)
       File.join(site_destination_dir, asset_destination_path)
     end
 
-    def extname
-      File.extname(relative_path)
+    def url
+      asset_destination_path
+    end
+
+    def modified_time
+      File.stat(path).mtime
     end
 
     def mtime
-      File.stat(path).mtime.to_i
+      modified_time.to_i
     end
 
     def modified?
@@ -35,7 +41,7 @@ module Jekyll::Minibundle
     def to_liquid
       {
         'path'          => relative_path,
-        'modified_time' => mtime.to_s,
+        'modified_time' => modified_time,
         'extname'       => extname
       }
     end
@@ -43,5 +49,17 @@ module Jekyll::Minibundle
     def write?
       true
     end
+
+    def type
+      nil  # no collection present
+    end
+
+    def defaults
+      {}
+    end
+
+    def placeholders
+      {}
+    end
   end
 end