jekyll-minibundle 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7dc5bf67a5d4a713810a998484b2bca9ecc1cc3
-  data.tar.gz: 4f2fc0b94c6e29a573666627609e50dccdc123ab
+  metadata.gz: 7b98e5563a50d5892a424e3be6ba49fe3d899810
+  data.tar.gz: 38648384d0bce35475e6a8f0787c5d607fbfae80
 SHA512:
-  metadata.gz: e7571e9ec0a7a0c7914afbaf93b3442747b50b36b5645ac67d6745ecb777a49d17c66c40f6d7af2fc87e265fcf888b53d17a9dd3f9c80c390e2b048b458d8dc3
-  data.tar.gz: 0bfeacb9e08ea16d1e4815af0b3dfa7c061ffd7138fa883a2619817b9588d30fefe3b72c0b843db84282e2c9c429714e138f65239e579326636c1a715c21ab35
+  metadata.gz: 96700c73cdaada8a240ef9009f13e8433e149670bee218cea457ada7e17a21e8781dc4291766bab54144d3527d9b02d9870f2fc8a9abee7c13ab37abb03bc480
+  data.tar.gz: 8c0d2048c10c7e07c1d4d5a59abf0acd0517ca3545febf09451d98b9f957c2bed9e8d22b966cdf6ec8d0370723982955d6aea13d6435bd45cf15322b25733546

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2.0.0 / 2016-04-01
+
+* Drop support for Jekyll versions below 3
+* Remove unused asset cache entries and temporary files when Jekyll
+  rebuilds the site
+* Document a known caveat: the plugin doesn't work with Jekyll's
+  incremental rebuild feature.
+
 # 1.6.0 / 2016-03-26
 
 * Log the last 2000 bytes of minifier's STDOUT output if the minifier

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Tuomas Kareinen
+Copyright (c) 2012-2016 Tuomas Kareinen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -8,14 +8,17 @@ for cache busting.
 There are no runtime dependencies, except for the minification tool
 used for bundling (fingerprinting has no dependencies).
 
-Tested with Ruby MRI 2.x. Ruby 1.9 and 1.8 are *not* supported.
+The plugin requires Jekyll version 3.x. It is tested with Ruby MRI
+2.x. Ruby 1.8 and 1.9 are *not* supported.
 
-The plugin works with Jekyll's watch (auto-regeneration) mode.
+The plugin works with Jekyll's watch mode (auto-regeneration, Jekyll
+option `--watch`), but not with incremental feature enabled (Jekyll
+option `--incremental`).
 
 [![Gem version](https://badge.fury.io/rb/jekyll-minibundle.svg)][MinibundleGem]
 [![Build status](https://secure.travis-ci.org/tkareine/jekyll-minibundle.svg)][MinibundleBuild]
 
-# Features
+## Features
 
 There are two features: asset fingerprinting with MD5 digest over the
 contents of the asset, and asset bundling combined with the first
@@ -40,7 +43,7 @@ backend upon page load. The minification of stylesheets and JavaScript
 sources makes asset sizes smaller and thus faster to load over
 network.
 
-# Usage
+## Usage
 
 The plugin ships as a [RubyGem][MinibundleGem]. To install:
 
@@ -69,7 +72,7 @@ require 'jekyll/minibundle'
 You must allow Jekyll to use custom plugins. That is, do not enable
 Jekyll's `safe` setting.
 
-## Asset fingerprinting
+### Asset fingerprinting
 
 If you just want to have a fingerprint in your asset's path, use
 `ministamp` tag:
@@ -97,7 +100,7 @@ fingerprint to Jekyll's output directory:
 <link href="{{ site.baseurl }}{% ministamp _tmp/site.css assets/site.css %}" rel="stylesheet">
 ```
 
-## Asset bundling
+### Asset bundling
 
 This is a straightforward way to bundle assets with any minification
 tool that supports reading input from STDIN and writing the output to
@@ -210,7 +213,7 @@ specific one wins. For example, the `minifier_cmd` setting inside
 `minibundle js` block overrides the setting in
 `$JEKYLL_MINIBUNDLE_CMD_JS` environment variable.
 
-## Recommended directory layout
+### Recommended directory layout
 
 It's recommended that you exclude the files you use as asset sources
 from Jekyll itself. Otherwise, you end up with duplicate files in the
@@ -242,7 +245,7 @@ character (`_`), consider using the following directory layout:
 See [Jekyll configuration][JekyllConf] for more about excluding files
 and directories.
 
-## Development mode
+### Development mode
 
 The plugin has one more trick in its sleeves. If you set
 `$JEKYLL_MINIBUNDLE_MODE` environment variable to `development`, then
@@ -266,15 +269,16 @@ minibundle:
 Should both be defined, the setting from the environment variable
 wins.
 
-# Example site
+## Example site
 
 See the contents of `test/fixture/site` directory.
 
-# Known caveats
+## Known caveats
 
-See `test/integration/known_caveats_test.rb`.
+The plugin does not work with Jekyll's incremental rebuild feature (Jekyll
+option `--incremental`).
 
-# License
+## License
 
 MIT. See `LICENSE.txt`.
 

data/jekyll-minibundle.gemspec

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'lib/jekyll/minibundle/version'))
+require_relative 'lib/jekyll/minibundle/version'
 
 Gem::Specification.new do |s|
   s.name     = 'jekyll-minibundle'
@@ -27,7 +27,7 @@ minification tool (not even other gems).
 
   s.test_files = `git ls-files -- test`.split("\n")
 
-  s.add_development_dependency 'jekyll',   '~> 3.1'
+  s.add_development_dependency 'jekyll',   '~> 3.0.0'
   s.add_development_dependency 'minitest', '~> 5.8'
   s.add_development_dependency 'nokogiri', '~> 1.6'
   s.add_development_dependency 'rake',     '~> 11.1'

data/lib/jekyll/minibundle/asset_bundle.rb

@@ -1,9 +1,12 @@
 require 'tempfile'
-require 'jekyll/minibundle/compatibility'
+require 'jekyll/minibundle/exceptions'
 require 'jekyll/minibundle/files'
+require 'jekyll/minibundle/log'
 
 module Jekyll::Minibundle
   class AssetBundle
+    TEMPFILE_PREFIX = 'jekyll-minibundle-'.freeze
+
     def initialize(config)
       @type = config.fetch(:type)
       @asset_paths = config.fetch(:asset_paths)
@@ -19,20 +22,26 @@ Missing minification command for bundling #{@type} assets. Specify it in
         END
       end
 
-      @temp_file = Tempfile.new(['jekyll-minibundle-', ".#{@type}"])
-      at_exit { @temp_file.close! }
+      @tempfile = Tempfile.new([TEMPFILE_PREFIX, ".#{@type}"])
+    end
+
+    def close
+      @tempfile.close!
+      @tempfile = nil
     end
 
     def path
-      @temp_file.path
+      raise IllegalStateError, 'Cannot get path of closed AssetBundle' unless @tempfile
+      @tempfile.path
     end
 
     def make_bundle
+      raise IllegalStateError, 'Cannot make bundle with closed AssetBundle' unless @tempfile
       exit_status = spawn_minifier(@minifier_cmd) do |input|
         $stdout.puts  # place newline after "(Re)generating..." log messages
-        Compatibility.log_info("Bundling #{@type} assets:")
+        Log.info("Bundling #{@type} assets:")
         @asset_paths.each do |asset|
-          Compatibility.log_info(relative_path_from(asset, @site_dir))
+          Log.info(relative_path_from(asset, @site_dir))
           IO.foreach(asset) { |line| input.write(line) }
           input.puts(';') if @type == :js
         end
@@ -55,7 +64,7 @@ Missing minification command for bundling #{@type} assets. Specify it in
       pid = nil
       rd, wr = IO.pipe
       Dir.chdir(@site_dir) do
-        pid = spawn(cmd, out: [@temp_file.path, 'w'], in: rd)
+        pid = spawn(cmd, out: [@tempfile.path, 'w'], in: rd)
       end
       rd.close
       yield wr
@@ -69,16 +78,16 @@ Missing minification command for bundling #{@type} assets. Specify it in
     end
 
     def log_minifier_error(message)
-      last_bytes = Files.read_last(@temp_file.path, 2000)
+      last_bytes = Files.read_last(@tempfile.path, 2000)
 
       return if last_bytes.empty?
 
-      Compatibility.log_error("#{message}, last #{last_bytes.size} bytes of minifier output:")
+      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) }
+        .each { |line| Log.error(line) }
     end
   end
 end

data/lib/jekyll/minibundle/asset_file_operations.rb

@@ -2,6 +2,10 @@ require 'fileutils'
 
 module Jekyll::Minibundle
   module AssetFileOperations
+    def cleanup
+      # defaults to no-op
+    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_registry.rb

@@ -7,10 +7,23 @@ require 'jekyll/minibundle/stamp_file'
 module Jekyll::Minibundle
   module AssetFileRegistry
     class << self
-      def clear
+      def clear_all
         @_files = {}
       end
 
+      def clear_unused
+        @_files
+          .select { |_, cached| !cached.fetch(:is_used) }
+          .each do |asset_destination_path, cached|
+            cached.fetch(:file).cleanup
+            @_files.delete(asset_destination_path)
+          end
+
+        @_files.each_value do |cached|
+          cached[:is_used] = false
+        end
+      end
+
       def register_bundle_file(site, bundle_config)
         register_file_for_bundle_block(BundleFile, site, bundle_config) { |file| [file] }
       end
@@ -35,23 +48,40 @@ module Jekyll::Minibundle
         cached = @_files[asset_destination_path]
 
         if cached
-          raise "minibundle block has same destination path as a ministamp tag: #{asset_destination_path}" if cached.fetch(:type) != :bundle
+          if cached.fetch(:type) != :bundle
+            raise "minibundle block has the same destination path as a ministamp tag: '#{asset_destination_path}'"
+          end
 
           cached_file = cached.fetch(:file)
+          cached_config = cached.fetch(:config)
+          cached_is_used = cached.fetch(:is_used)
 
-          if bundle_config == cached.fetch(:config)
-            get_files.call(cached_file).each do |file|
-              site.static_files << file unless site.static_files.include?(file)
+          if bundle_config == cached_config
+            unless cached_is_used
+              cached[:is_used] = true
+              add_as_static_files_to_site(site, get_files.call(cached_file))
             end
+
             return cached_file
-          else
-            get_files.call(cached_file).each { |file| site.static_files.delete(file) }
           end
+
+          if cached_is_used
+            raise <<-END
+Two or more minibundle blocks with the same destination path '#{asset_destination_path}', but having different asset configuration: #{bundle_config.inspect} vs. #{cached_config.inspect}
+            END
+          end
+
+          cached_file.cleanup
         end
 
         new_file = file_class.new(site, bundle_config)
-        @_files[asset_destination_path] = {type: :bundle, file: new_file, config: bundle_config}
-        get_files.call(new_file).each { |file| site.static_files << file }
+        @_files[asset_destination_path] = {
+          type:    :bundle,
+          file:    new_file,
+          config:  bundle_config,
+          is_used: true
+        }
+        add_as_static_files_to_site(site, get_files.call(new_file))
         new_file
       end
 
@@ -59,25 +89,52 @@ module Jekyll::Minibundle
         cached = @_files[asset_destination_path]
 
         if cached
-          raise "ministamp tag has same destination path as a minibundle block: #{asset_destination_path}" if cached.fetch(:type) != :stamp
+          if cached.fetch(:type) != :stamp
+            raise "ministamp tag has the same destination path as a minibundle block: '#{asset_destination_path}'"
+          end
 
           cached_file = cached.fetch(:file)
+          cached_config = cached.fetch(:config)
+          cached_is_used = cached.fetch(:is_used)
+
+          if asset_source_path == cached_config
+            unless cached_is_used
+              cached[:is_used] = true
+              add_as_static_files_to_site(site, [cached_file])
+            end
 
-          if asset_source_path == cached.fetch(:config)
-            site.static_files << cached_file unless site.static_files.include?(cached_file)
             return cached_file
-          else
-            site.static_files.delete(cached_file)
           end
+
+          if cached_is_used
+            raise <<-END
+Two or more ministamp tags with the same destination path '#{asset_destination_path}', but different asset source paths: '#{asset_source_path}' vs. '#{cached_config}'
+            END
+          end
+
+          cached_file.cleanup
         end
 
         new_file = file_class.new(site, asset_source_path, asset_destination_path)
-        @_files[asset_destination_path] = {type: :stamp, file: new_file, config: asset_source_path}
-        site.static_files << new_file
+        @_files[asset_destination_path] = {
+          type:    :stamp,
+          file:    new_file,
+          config:  asset_source_path,
+          is_used: true
+        }
+        add_as_static_files_to_site(site, [new_file])
         new_file
       end
+
+      def add_as_static_files_to_site(site, files)
+        files.each { |file| site.static_files << file }
+      end
     end
 
-    clear
+    clear_all
   end
 end
+
+::Jekyll::Hooks.register(:site, :post_write) do
+  ::Jekyll::Minibundle::AssetFileRegistry.clear_unused
+end

data/lib/jekyll/minibundle/bundle_file.rb

@@ -19,6 +19,13 @@ module Jekyll::Minibundle
       @minifier_cmd = config.fetch('minifier_cmd')
       @stamped_at = nil
       @is_modified = false
+      @_asset_bundle = nil
+    end
+
+    def cleanup
+      return unless @_asset_bundle
+      @_asset_bundle.close
+      @_asset_bundle = nil
     end
 
     def destination_path_for_markup

data/lib/jekyll/minibundle/development_file_collection.rb

@@ -17,5 +17,9 @@ module Jekyll::Minibundle
         DevelopmentFile.new(site, asset_source, asset_destination)
       end
     end
+
+    def cleanup
+      # no-op
+    end
   end
 end

data/lib/jekyll/minibundle/exceptions.rb

@@ -0,0 +1,3 @@
+module Jekyll::Minibundle
+  class IllegalStateError < RuntimeError; end
+end

data/lib/jekyll/minibundle/log.rb

@@ -0,0 +1,15 @@
+module Jekyll::Minibundle
+  module Log
+    TOPIC = 'Minibundle:'.freeze
+
+    class << self
+      def error(msg)
+        ::Jekyll.logger.error(TOPIC, msg)
+      end
+
+      def info(msg)
+        ::Jekyll.logger.info(TOPIC, msg)
+      end
+    end
+  end
+end

data/lib/jekyll/minibundle/mini_bundle_block.rb

@@ -1,5 +1,4 @@
 require 'jekyll/minibundle/hashes'
-require 'jekyll/minibundle/compatibility'
 require 'jekyll/minibundle/environment'
 require 'jekyll/minibundle/asset_file_registry'
 require 'jekyll/minibundle/asset_tag_markup'
@@ -14,7 +13,7 @@ module Jekyll::Minibundle
 
     def render(context)
       site = context.registers.fetch(:site)
-      bundle_config = get_current_bundle_config(Compatibility.load_yaml(super), site)
+      bundle_config = get_current_bundle_config(::SafeYAML.load(super), site)
       baseurl = bundle_config.fetch('baseurl')
       attributes = bundle_config.fetch('attributes')
 

data/lib/jekyll/minibundle/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Minibundle
-    VERSION = '1.6.0'.freeze
+    VERSION = '2.0.0'.freeze
   end
 end

data/lib/jekyll/minibundle.rb

@@ -1,3 +1,7 @@
+if defined?(Jekyll::VERSION) && Jekyll::VERSION < '3'
+  raise 'Minibundle plugin requires Jekyll version 3 or above'
+end
+
 require 'jekyll/minibundle/version'
 require 'jekyll/minibundle/mini_bundle_block'
 require 'jekyll/minibundle/mini_stamp_tag'

data/test/integration/minibundle_development_mode_test.rb

@@ -2,7 +2,7 @@ require 'support/test_case'
 require 'support/fixture_config'
 
 module Jekyll::Minibundle::Test
-  class MiniBundleDevelopmentModeTest < TestCase
+  class MinibundleDevelopmentModeTest < TestCase
     include FixtureConfig
 
     CSS_ASSET_DESTINATION_PATHS = %w{reset common}.map { |f| File.join(CSS_BUNDLE_DESTINATION_PATH, "#{f}.css") }
@@ -136,25 +136,53 @@ module Jekyll::Minibundle::Test
         assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'dependency.js'))
         assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'app.js'))
 
-        match_snippet = <<-END
-    {% minibundle js %}
-    source_dir: _assets/scripts
-    destination_path: assets/site
-        END
+        ensure_file_mtime_changes do
+          change_destination_path_in_minibundle_block('assets/site', 'assets/site2')
+        end
 
-        replacement_snippet = <<-END
-    {% minibundle js %}
-    source_dir: _assets/scripts
-    destination_path: assets/site2
-        END
+        generate_site(:development, clear_cache: false)
+
+        refute File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'dependency.js'))
+        refute File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'app.js'))
+
+        assert_equal ['assets/site2/dependency.js', 'assets/site2/app.js'], find_js_paths_from_index
+        assert File.exist?(destination_path('assets/site2/dependency.js'))
+        assert File.exist?(destination_path('assets/site2/app.js'))
+      end
+    end
+
+    def test_changing_asset_destination_path_to_new_value_and_back_to_original_rewrites_destination
+      with_site_dir do
+        generate_site(:development)
+
+        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'dependency.js'))
+        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'app.js'))
 
-        find_and_gsub_in_file(source_path('_layouts/default.html'), match_snippet, replacement_snippet)
+        ensure_file_mtime_changes do
+          change_destination_path_in_minibundle_block('assets/site', 'assets/site2')
+        end
 
         generate_site(:development, clear_cache: false)
 
+        refute File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'dependency.js'))
+        refute File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'app.js'))
+
         assert_equal ['assets/site2/dependency.js', 'assets/site2/app.js'], find_js_paths_from_index
         assert File.exist?(destination_path('assets/site2/dependency.js'))
         assert File.exist?(destination_path('assets/site2/app.js'))
+
+        ensure_file_mtime_changes do
+          change_destination_path_in_minibundle_block('assets/site2', 'assets/site')
+        end
+
+        generate_site(:development, clear_cache: false)
+
+        refute File.exist?(destination_path('assets/site2/dependency.js'))
+        refute File.exist?(destination_path('assets/site2/app.js'))
+
+        assert_equal ['assets/site/dependency.js', 'assets/site/app.js'], find_js_paths_from_index
+        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'dependency.js'))
+        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_PATH, 'app.js'))
       end
     end
 
@@ -320,5 +348,21 @@ module Jekyll::Minibundle::Test
       assert File.exist?(actual)
       assert_equal File.read(expected), File.read(actual)
     end
+
+    def change_destination_path_in_minibundle_block(from, to)
+      match_snippet = <<-END
+    {% minibundle js %}
+    source_dir: _assets/scripts
+    destination_path: #{from}
+      END
+
+      replacement_snippet = <<-END
+    {% minibundle js %}
+    source_dir: _assets/scripts
+    destination_path: #{to}
+      END
+
+      find_and_gsub_in_file(source_path('_layouts/default.html'), match_snippet, replacement_snippet)
+    end
   end
 end

data/test/integration/minibundle_production_mode_test.rb

@@ -2,7 +2,7 @@ require 'support/test_case'
 require 'support/fixture_config'
 
 module Jekyll::Minibundle::Test
-  class MiniBundleProductionModeTest < TestCase
+  class MinibundleProductionModeTest < TestCase
     include FixtureConfig
 
     def test_css_asset_bundle_has_stamp
@@ -174,36 +174,106 @@ module Jekyll::Minibundle::Test
       end
     end
 
-    def test_changing_asset_destination_path_rewrites_destination
+    def test_changing_asset_source_list_removes_old_temporary_bundle_file
       with_site_dir do
         generate_site(:production)
 
         assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
 
         match_snippet = <<-END
-    {% minibundle js %}
-    source_dir: _assets/scripts
-    destination_path: assets/site
+    assets:
+      - dependency
+      - app
         END
 
         replacement_snippet = <<-END
-    {% minibundle js %}
-    source_dir: _assets/scripts
-    destination_path: assets/site2
+    assets:
+      - dependency
         END
 
+        org_tempfiles = find_tempfiles
+
         ensure_file_mtime_changes do
           find_and_gsub_in_file(source_path('_layouts/default.html'), match_snippet, replacement_snippet)
         end
 
         generate_site(:production, clear_cache: false)
 
+        refute File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
+        assert File.exist?(destination_path('assets/site-71042d0b7c86c04e015fde694dd9f409.js'))
+        assert_equal 1, (org_tempfiles - find_tempfiles).size
+      end
+    end
+
+    def test_changing_asset_destination_path_rewrites_destination
+      with_site_dir do
+        generate_site(:production)
+
+        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
+
+        ensure_file_mtime_changes do
+          change_destination_path_in_minibundle_block('assets/site', 'assets/site2')
+        end
+
+        generate_site(:production, clear_cache: false)
+
+        refute File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
+
+        new_destination = "assets/site2-#{JS_BUNDLE_FINGERPRINT}.js"
+
+        assert_equal new_destination, find_js_path_from_index
+        assert File.exist?(destination_path(new_destination))
+      end
+    end
+
+    def test_changing_asset_destination_path_removes_old_temporary_bundle_file
+      with_site_dir do
+        generate_site(:production)
+
+        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
+
+        org_tempfiles = find_tempfiles
+
+        ensure_file_mtime_changes do
+          change_destination_path_in_minibundle_block('assets/site', 'assets/site2')
+        end
+
+        generate_site(:production, clear_cache: false)
+
+        refute File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
+        assert File.exist?(destination_path("assets/site2-#{JS_BUNDLE_FINGERPRINT}.js"))
+        assert_equal 1, (org_tempfiles - find_tempfiles).size
+      end
+    end
+
+    def test_changing_asset_destination_path_to_new_value_and_back_to_original_rewrites_destination
+      with_site_dir do
+        generate_site(:production)
+
+        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
+
+        ensure_file_mtime_changes do
+          change_destination_path_in_minibundle_block('assets/site', 'assets/site2')
+        end
+
+        generate_site(:production, clear_cache: false)
+
         refute File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
 
         new_destination = "assets/site2-#{JS_BUNDLE_FINGERPRINT}.js"
 
         assert_equal new_destination, find_js_path_from_index
         assert File.exist?(destination_path(new_destination))
+
+        ensure_file_mtime_changes do
+          change_destination_path_in_minibundle_block('assets/site2', 'assets/site')
+        end
+
+        generate_site(:production, clear_cache: false)
+
+        refute File.exist?(destination_path(new_destination))
+        assert_equal JS_BUNDLE_DESTINATION_FINGERPRINT_PATH, find_js_path_from_index
+        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
       end
     end
 
@@ -472,5 +542,25 @@ title: Test
         .join('')
         .size
     end
+
+    def change_destination_path_in_minibundle_block(from, to)
+      match_snippet = <<-END
+    {% minibundle js %}
+    source_dir: _assets/scripts
+    destination_path: #{from}
+      END
+
+      replacement_snippet = <<-END
+    {% minibundle js %}
+    source_dir: _assets/scripts
+    destination_path: #{to}
+      END
+
+      find_and_gsub_in_file(source_path('_layouts/default.html'), match_snippet, replacement_snippet)
+    end
+
+    def find_tempfiles
+      Dir[File.join(Dir.tmpdir, AssetBundle::TEMPFILE_PREFIX + '*')]
+    end
   end
 end

data/test/integration/ministamp_development_mode_test.rb

@@ -2,7 +2,7 @@ require 'support/test_case'
 require 'support/fixture_config'
 
 module Jekyll::Minibundle::Test
-  class MiniStampProductionModeTest < TestCase
+  class MinistampDevelopmentModeTest < TestCase
     include FixtureConfig
 
     def test_asset_destination_path_has_no_stamp
@@ -97,6 +97,46 @@ module Jekyll::Minibundle::Test
       end
     end
 
+    def test_changing_asset_destination_path_to_new_value_and_back_to_original_rewrites_destination
+      with_site_dir do
+        generate_site(:development)
+
+        assert File.exist?(destination_path(STAMP_DESTINATION_PATH))
+
+        ensure_file_mtime_changes do
+          find_and_gsub_in_file(
+            source_path('_layouts/default.html'),
+            '{% ministamp _tmp/site.css assets/screen.css',
+            '{% ministamp _tmp/site.css assets/screen2.css'
+          )
+        end
+
+        generate_site(:development, clear_cache: false)
+
+        refute File.exist?(destination_path(STAMP_DESTINATION_PATH))
+
+        new_destination = 'assets/screen2.css'
+
+        assert_equal new_destination, find_css_path_from_index
+        assert File.exist?(destination_path(new_destination))
+
+        ensure_file_mtime_changes do
+          find_and_gsub_in_file(
+            source_path('_layouts/default.html'),
+            '{% ministamp _tmp/site.css assets/screen2.css',
+            '{% ministamp _tmp/site.css assets/screen.css'
+          )
+        end
+
+        generate_site(:development, clear_cache: false)
+
+        refute File.exist?(destination_path(new_destination))
+
+        assert_equal STAMP_DESTINATION_PATH, find_css_path_from_index
+        assert File.exist?(destination_path(STAMP_DESTINATION_PATH))
+      end
+    end
+
     def test_supports_relative_and_absolute_destination_paths
       with_site_dir do
         generate_site(:development)

data/test/integration/ministamp_production_mode_test.rb

@@ -2,7 +2,7 @@ require 'support/test_case'
 require 'support/fixture_config'
 
 module Jekyll::Minibundle::Test
-  class MiniStampProductionModeTest < TestCase
+  class MinistampProductionModeTest < TestCase
     include FixtureConfig
 
     def test_asset_destination_path_has_stamp
@@ -101,6 +101,46 @@ module Jekyll::Minibundle::Test
       end
     end
 
+    def test_changing_asset_destination_path_to_new_value_and_back_to_original_rewrites_destination
+      with_site_dir do
+        generate_site(:production)
+
+        assert File.exist?(destination_path(STAMP_DESTINATION_FINGERPRINT_PATH))
+
+        ensure_file_mtime_changes do
+          find_and_gsub_in_file(
+            source_path('_layouts/default.html'),
+            '{% ministamp _tmp/site.css assets/screen.css',
+            '{% ministamp _tmp/site.css assets/screen2.css'
+          )
+        end
+
+        generate_site(:production, clear_cache: false)
+
+        refute File.exist?(destination_path(STAMP_DESTINATION_FINGERPRINT_PATH))
+
+        new_destination = "assets/screen2-#{STAMP_FINGERPRINT}.css"
+
+        assert_equal new_destination, find_css_path_from_index
+        assert File.exist?(destination_path(new_destination))
+
+        ensure_file_mtime_changes do
+          find_and_gsub_in_file(
+            source_path('_layouts/default.html'),
+            '{% ministamp _tmp/site.css assets/screen2.css',
+            '{% ministamp _tmp/site.css assets/screen.css'
+          )
+        end
+
+        generate_site(:production, clear_cache: false)
+
+        refute File.exist?(destination_path(new_destination))
+
+        assert_equal STAMP_DESTINATION_FINGERPRINT_PATH, find_css_path_from_index
+        assert File.exist?(destination_path(STAMP_DESTINATION_FINGERPRINT_PATH))
+      end
+    end
+
     def test_supports_relative_and_absolute_destination_paths
       with_site_dir do
         generate_site(:production)

data/test/support/test_case.rb

@@ -146,7 +146,7 @@ module Jekyll::Minibundle::Test
     end
 
     def _generate_site(test_options)
-      AssetFileRegistry.clear if test_options.fetch(:clear_cache, true)
+      AssetFileRegistry.clear_all if test_options.fetch(:clear_cache, true)
       site = new_real_site
       capture_io { site.process }
     end

data/test/unit/asset_file_registry_test.rb

@@ -4,11 +4,11 @@ require 'jekyll/minibundle/asset_file_registry'
 module Jekyll::Minibundle::Test
   class AssetFileRegistryTest < TestCase
     def setup
-      AssetFileRegistry.clear
+      AssetFileRegistry.clear_all
       @site = new_site
     end
 
-    def test_register_returns_same_bundle_file_for_same_bundle_configs
+    def test_register_returns_same_bundle_file_for_same_bundle_config
       first = AssetFileRegistry.register_bundle_file(@site, bundle_config)
       second = AssetFileRegistry.register_bundle_file(@site, bundle_config)
       assert_same first, second
@@ -16,7 +16,7 @@ module Jekyll::Minibundle::Test
       assert_contains_only @site.static_files, [first]
     end
 
-    def test_register_returns_same_development_file_collection_for_same_bundle_configs
+    def test_register_returns_same_development_file_collection_for_same_bundle_config
       first = AssetFileRegistry.register_development_file_collection(@site, bundle_config)
       second = AssetFileRegistry.register_development_file_collection(@site, bundle_config)
       assert_same first, second
@@ -60,12 +60,18 @@ module Jekyll::Minibundle::Test
       {description: 'assets', config_diff: {'assets' => %w{b1 b2}}},
       {description: 'source_directory', config_diff: {'source_dir' => '_assets/src2'}}
     ].each do |spec|
-      define_method :"test_register_replaces_cached_bundle_file_with_bundle_config_with_different_#{spec.fetch(:description)}" do
-        first = AssetFileRegistry.register_bundle_file(@site, bundle_config)
-        second = AssetFileRegistry.register_bundle_file(@site, bundle_config.merge(spec[:config_diff]))
-        refute_same first, second
+      define_method :"test_raise_exception_if_registering_bundle_file_with_same_destination_path_but_with_different_#{spec.fetch(:description)}" do
+        first_config = bundle_config
+        first_file = AssetFileRegistry.register_bundle_file(@site, first_config)
+        second_config = bundle_config.merge(spec[:config_diff])
+        err = assert_raises(RuntimeError) do
+          AssetFileRegistry.register_bundle_file(@site, second_config)
+        end
+        assert_equal <<-END, err.to_s
+Two or more minibundle blocks with the same destination path 'assets/dest.css', but having different asset configuration: #{second_config.inspect} vs. #{first_config.inspect}
+        END
         assert_equal 1, asset_file_registry_size
-        assert_contains_only @site.static_files, [second]
+        assert_contains_only @site.static_files, [first_file]
       end
     end
 
@@ -73,12 +79,18 @@ module Jekyll::Minibundle::Test
       {description: 'assets', config_diff: {'assets' => %w{b1 b2}}},
       {description: 'source_directory', config_diff: {'source_dir' => '_assets/src2'}}
     ].each do |spec|
-      define_method :"test_register_replaces_cached_development_file_collection_with_bundle_config_with_different_#{spec.fetch(:description)}" do
-        first = AssetFileRegistry.register_development_file_collection(@site, bundle_config)
-        second = AssetFileRegistry.register_development_file_collection(@site, bundle_config.merge(spec[:config_diff]))
-        refute_same first, second
+      define_method :"test_raise_exception_if_registering_development_file_collection_with_same_destination_path_but_with_different_#{spec.fetch(:description)}" do
+        first_config = bundle_config
+        first_file = AssetFileRegistry.register_development_file_collection(@site, first_config)
+        second_config = bundle_config.merge(spec[:config_diff])
+        err = assert_raises(RuntimeError) do
+          AssetFileRegistry.register_development_file_collection(@site, second_config)
+        end
+        assert_equal <<-END, err.to_s
+Two or more minibundle blocks with the same destination path 'assets/dest.css', but having different asset configuration: #{second_config.inspect} vs. #{first_config.inspect}
+        END
         assert_equal 1, asset_file_registry_size
-        assert_contains_only @site.static_files, second.files
+        assert_contains_only @site.static_files, first_file.files
       end
     end
 
@@ -102,12 +114,16 @@ module Jekyll::Minibundle::Test
         assert_contains_only @site.static_files, [first, second]
       end
 
-      define_method :"test_register_replaces_cached_#{spec.fetch(:description)}_with_different_source_and_same_destination_paths" do
+      define_method :"test_raise_exception_if_registering_#{spec.fetch(:description)}s_with_different_source_and_same_destination_paths" do
         first = AssetFileRegistry.send(spec.fetch(:method), @site, '_assets/src1.css', 'assets/dest1.css')
-        second = AssetFileRegistry.send(spec.fetch(:method), @site, '_assets/src2.css', 'assets/dest1.css')
-        refute_same first, second
+        err = assert_raises(RuntimeError) do
+          AssetFileRegistry.send(spec.fetch(:method), @site, '_assets/src2.css', 'assets/dest1.css')
+        end
+        assert_equal <<-END, err.to_s
+Two or more ministamp tags with the same destination path 'assets/dest1.css', but different asset source paths: '_assets/src2.css' vs. '_assets/src1.css'
+        END
         assert_equal 1, asset_file_registry_size
-        assert_contains_only @site.static_files, [second]
+        assert_contains_only @site.static_files, [first]
       end
     end
 
@@ -116,7 +132,7 @@ module Jekyll::Minibundle::Test
       err = assert_raises(RuntimeError) do
         AssetFileRegistry.register_stamp_file(@site, '_assets/src1.css', 'assets/dest.css')
       end
-      assert_equal 'ministamp tag has same destination path as a minibundle block: assets/dest.css', err.to_s
+      assert_equal "ministamp tag has the same destination path as a minibundle block: 'assets/dest.css'", err.to_s
       assert_equal 1, asset_file_registry_size
       assert_contains_only @site.static_files, [file]
     end
@@ -126,11 +142,43 @@ module Jekyll::Minibundle::Test
       err = assert_raises(RuntimeError) do
         AssetFileRegistry.register_bundle_file(@site, bundle_config.merge('type' => :css, 'destination_path' => 'assets/dest'))
       end
-      assert_equal 'minibundle block has same destination path as a ministamp tag: assets/dest.css', err.to_s
+      assert_equal "minibundle block has the same destination path as a ministamp tag: 'assets/dest.css'", err.to_s
       assert_equal 1, asset_file_registry_size
       assert_contains_only @site.static_files, [file]
     end
 
+    [
+      {description: 'bundle_file', method: :register_bundle_file},
+      {description: 'development_file_collection', method: :register_development_file_collection}
+    ].each do |spec|
+      define_method :"test_remove_unused_#{spec.fetch(:description)}" do
+        AssetFileRegistry.send(spec.fetch(:method), @site, bundle_config)
+        AssetFileRegistry.clear_unused
+
+        assert_equal 1, asset_file_registry_size
+
+        AssetFileRegistry.clear_unused
+
+        assert_equal 0, asset_file_registry_size
+      end
+    end
+
+    [
+      {description: 'stamp_file', method: :register_stamp_file},
+      {description: 'development_file', method: :register_development_file}
+    ].each do |spec|
+      define_method :"test_remove_unused_#{spec.fetch(:description)}" do
+        AssetFileRegistry.send(spec.fetch(:method), @site, '_assets/src.css', 'assets/dest.css')
+        AssetFileRegistry.clear_unused
+
+        assert_equal 1, asset_file_registry_size
+
+        AssetFileRegistry.clear_unused
+
+        assert_equal 0, asset_file_registry_size
+      end
+    end
+
     private
 
     def bundle_config

data/test/unit/mini_bundle_block_test.rb

@@ -41,7 +41,7 @@ module Jekyll::Minibundle::Test
       }
     ].each do |spec|
       define_method :"test_normalizing_baseurl_with_#{spec.fetch(:description)}" do
-        AssetFileRegistry.clear
+        AssetFileRegistry.clear_all
 
         template = Liquid::Template.parse(<<-END)
 {% minibundle css %}

data/test/unit/mini_stamp_tag_test.rb

@@ -21,7 +21,7 @@ module Jekyll::Minibundle::Test
     end
 
     def test_ignore_rest_arguments
-      AssetFileRegistry.clear
+      AssetFileRegistry.clear_all
       output = Liquid::Template
                .parse("{% ministamp #{STAMP_SOURCE_PATH} #{STAMP_DESTINATION_PATH} rest %}")
                .render({}, registers: {site: new_fake_site(site_fixture_path)})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-minibundle
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tuomas Kareinen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -104,12 +104,13 @@ files:
 - lib/jekyll/minibundle/asset_stamp.rb
 - lib/jekyll/minibundle/asset_tag_markup.rb
 - lib/jekyll/minibundle/bundle_file.rb
-- lib/jekyll/minibundle/compatibility.rb
 - lib/jekyll/minibundle/development_file.rb
 - lib/jekyll/minibundle/development_file_collection.rb
 - lib/jekyll/minibundle/environment.rb
+- lib/jekyll/minibundle/exceptions.rb
 - lib/jekyll/minibundle/files.rb
 - lib/jekyll/minibundle/hashes.rb
+- lib/jekyll/minibundle/log.rb
 - lib/jekyll/minibundle/mini_bundle_block.rb
 - lib/jekyll/minibundle/mini_stamp_tag.rb
 - lib/jekyll/minibundle/stamp_file.rb
@@ -126,7 +127,6 @@ files:
 - test/fixture/site/about.html
 - test/fixture/site/assets/site.css
 - test/fixture/site/index.html
-- test/integration/known_caveats_test.rb
 - test/integration/minibundle_development_mode_test.rb
 - test/integration/minibundle_production_mode_test.rb
 - test/integration/ministamp_development_mode_test.rb
@@ -192,7 +192,6 @@ test_files:
 - test/fixture/site/about.html
 - test/fixture/site/assets/site.css
 - test/fixture/site/index.html
-- test/integration/known_caveats_test.rb
 - test/integration/minibundle_development_mode_test.rb
 - test/integration/minibundle_production_mode_test.rb
 - test/integration/ministamp_development_mode_test.rb

data/lib/jekyll/minibundle/compatibility.rb

@@ -1,37 +0,0 @@
-module Jekyll::Minibundle
-  module Compatibility
-    LOG_TOPIC = 'Minibundle:'.freeze
-
-    class << self
-      # SafeYAML.load is introduced in Jekyll 2.0.0
-      if defined?(::SafeYAML) && ::SafeYAML.respond_to?(:load)
-        def load_yaml(*args)
-          ::SafeYAML.load(*args)
-        end
-      else
-        def load_yaml(*args)
-          ::YAML.load(*args)
-        end
-      end
-
-      # Jekyll.logger is introduced in Jekyll 1.0.3
-      if ::Jekyll.respond_to?(:logger)
-        def log_error(msg)
-          ::Jekyll.logger.error(LOG_TOPIC, msg)
-        end
-
-        def log_info(msg)
-          ::Jekyll.logger.info(LOG_TOPIC, msg)
-        end
-      else
-        def log_error(msg)
-          $stderr.puts(msg)
-        end
-
-        def log_info(msg)
-          $stdout.puts(msg)
-        end
-      end
-    end
-  end
-end

data/test/integration/known_caveats_test.rb

@@ -1,89 +0,0 @@
-require 'support/test_case'
-require 'support/fixture_config'
-
-module Jekyll::Minibundle::Test
-  # Known software caveats that won't be fixed in the current design
-  # of the software.
-  class KnownCaveatsTest < TestCase
-    include FixtureConfig
-
-    # In Jekyll's watch (auto-regeneration) mode, changing asset
-    # destination path to a new value triggers the plugin to rebundle
-    # the assets and writing the bundle file to site output
-    # directory. After that, changing the destination path back to the
-    # original value should cause the plugin to write the original
-    # bundle file to site output directory again. This should happen
-    # without rebundling the assets, because the plugin stores the
-    # original bundle in a temporary file.
-    #
-    # The plugin cannot rewrite the original bundle file to site
-    # output directory, because it does not get a trigger for doing
-    # so. The plugin has a non-expiring cumulative cache for
-    # assets. This allows the plugin to avoid rebundling assets in
-    # site regeneration if the assets themselves are unchanged.  This
-    # same mechanism is the cause for this caveat.
-    #
-    # As a workaround, touching or changing one of the assets in the
-    # bundle triggers rebundling and rewriting the bundle file to site
-    # output directory.
-    #
-    # For now, we have decided that the caveat is a minor drawback
-    # compared to the benefit of avoiding unnecessary rebundling in
-    # site regeneration.
-    def test_changing_asset_destination_path_to_new_value_and_back_to_original_does_not_rewrite_destination
-      with_site_dir do
-        generate_site(:production)
-
-        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
-
-        ensure_file_mtime_changes do
-          change_destination_path('assets/site', 'assets/site2')
-        end
-
-        generate_site(:production, clear_cache: false)
-
-        refute File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
-
-        new_destination = "assets/site2-#{JS_BUNDLE_FINGERPRINT}.js"
-
-        assert_equal new_destination, find_js_path_from_index
-        assert File.exist?(destination_path(new_destination))
-
-        ensure_file_mtime_changes do
-          change_destination_path('assets/site2', 'assets/site')
-
-          # CAVEAT: This should not be needed.
-          FileUtils.touch(source_path('_assets/scripts/dependency.js'))
-        end
-
-        generate_site(:production, clear_cache: false)
-
-        assert_equal JS_BUNDLE_DESTINATION_FINGERPRINT_PATH, find_js_path_from_index
-        refute File.exist?(destination_path(new_destination))
-        assert File.exist?(destination_path(JS_BUNDLE_DESTINATION_FINGERPRINT_PATH))
-      end
-    end
-
-    private
-
-    def change_destination_path(from, to)
-      match_snippet = <<-END
-    {% minibundle js %}
-    source_dir: _assets/scripts
-    destination_path: #{from}
-      END
-
-      replacement_snippet = <<-END
-    {% minibundle js %}
-    source_dir: _assets/scripts
-    destination_path: #{to}
-      END
-
-      find_and_gsub_in_file(source_path('_layouts/default.html'), match_snippet, replacement_snippet)
-    end
-
-    def find_js_path_from_index
-      find_html_element(File.read(destination_path('index.html')), 'body script').first['src']
-    end
-  end
-end