jekyll-minibundle 1.0.0 → 1.1.0

data/lib/jekyll/minibundle/development_file_collection.rb

@@ -6,12 +6,12 @@ module Jekyll::Minibundle
     def initialize(config)
       @type = config['type']
       asset_source_dir = File.join config['site_dir'], config['source_dir']
-      asset_destination_path = config['destination_path']
+      destination_path = config['destination_path']
 
       @files = config['assets'].map do |asset_path|
         asset_basename = "#{asset_path}.#{@type}"
         asset_source = File.join asset_source_dir, asset_basename
-        asset_destination = File.join asset_destination_path, asset_basename
+        asset_destination = File.join destination_path, asset_basename
         DevelopmentFile.new asset_source, asset_destination
       end
 
@@ -27,7 +27,7 @@ module Jekyll::Minibundle
 
     def markup
       @files.
-        map { |f| AssetTagMarkup.make_markup @type, f.asset_path, @attributes }.
+        map { |f| AssetTagMarkup.make_markup @type, f.asset_destination_path, @attributes }.
         join('')
     end
   end

data/lib/jekyll/minibundle/environment.rb

@@ -0,0 +1,14 @@
+module Jekyll::Minibundle
+  module Environment
+    def self.command_for(type)
+      key = "JEKYLL_MINIBUNDLE_CMD_#{type.upcase}"
+      cmd = ENV[key]
+      raise "You need to set command for minification in $#{key}" if !cmd
+      cmd
+    end
+
+    def self.development?
+      ENV['JEKYLL_MINIBUNDLE_MODE'] == 'development'
+    end
+  end
+end

data/lib/jekyll/minibundle/mini_bundle_block.rb

@@ -1,6 +1,7 @@
 require 'yaml'
 require 'jekyll/minibundle/bundle_file'
 require 'jekyll/minibundle/development_file_collection'
+require 'jekyll/minibundle/environment'
 
 module Jekyll::Minibundle
   class MiniBundleBlock < Liquid::Block
@@ -11,19 +12,12 @@ module Jekyll::Minibundle
 
     def render(context)
       site = context.registers[:site]
-      config = get_current_config YAML.load(super), site
-
-      file = if ENV['JEKYLL_MINIBUNDLE_MODE'] == 'development'
-        DevelopmentFileCollection.new config
-      else
-        BundleFile.new config
-      end
-
+      file = get_file get_current_config(YAML.load(super), site)
       file.static_file! site
       file.markup
     end
 
-    def default_config
+    def self.default_config
       {
         'source_dir'        => '_assets',
         'destination_path'  => 'assets/site',
@@ -35,10 +29,18 @@ module Jekyll::Minibundle
     private
 
     def get_current_config(user_config, site)
-      default_config.
+      MiniBundleBlock.default_config.
         merge(user_config).
         merge({ 'type' => @type, 'site_dir' => site.source })
     end
+
+    def get_file(config)
+      if Environment.development?
+        DevelopmentFileCollection.new config
+      else
+        BundleFile.new config
+      end
+    end
   end
 end
 

data/lib/jekyll/minibundle/mini_stamp_tag.rb

@@ -9,9 +9,19 @@ module Jekyll::Minibundle
 
     def render(context)
       site = context.registers[:site]
-      file = StampFile.new File.join(site.source, @asset_source), @asset_destination
+      file = StampFile.new(File.join(site.source, @asset_source), @asset_destination, &get_basenamer)
       file.static_file! site
-      file.asset_path
+      file.markup
+    end
+
+    private
+
+    def get_basenamer
+      if Environment.development?
+        ->(base, ext, _) { base + ext }
+      else
+        ->(base, ext, stamper) { "#{base}-#{stamper.call}#{ext}" }
+      end
     end
   end
 end

data/lib/jekyll/minibundle/stamp_file.rb

@@ -11,11 +11,28 @@ module Jekyll::Minibundle
 
     attr_reader :asset_source_path, :asset_destination_dir
 
-    def initialize(asset_source_path, asset_destination_path)
+    def initialize(asset_source_path, asset_destination_path, &basenamer)
+      @basenamer = basenamer
       @asset_source_path = asset_source_path
       @asset_destination_dir = File.dirname asset_destination_path
       @asset_destination_extension = File.extname asset_destination_path
       @asset_destination_base_prefix = File.basename(asset_destination_path)[0 .. -(@asset_destination_extension.size + 1)]
+      @was_modified = false
+    end
+
+    def markup
+      # we must regenerate the fingerprint here, if at all, in order
+      # to make sure the markup and generated file have the same
+      # fingerprint
+      if modified?
+        @asset_stamp = nil
+        @@mtimes[path] = mtime
+        @was_modified = true
+      else
+        @was_modified = false
+      end
+
+      asset_destination_path
     end
 
     def last_mtime_of(path)
@@ -23,14 +40,9 @@ module Jekyll::Minibundle
     end
 
     def write(site_destination_dir)
-      is_modified = modified?
-
-      clear_asset_stamp if is_modified
-
-      if destination_exists?(site_destination_dir) && !is_modified
+      if destination_exists?(site_destination_dir) && !@was_modified
         false
       else
-        update_mtime
         write_destination site_destination_dir
         true
       end
@@ -39,19 +51,11 @@ module Jekyll::Minibundle
     private
 
     def asset_destination_basename
-      "#{@asset_destination_base_prefix}-#{asset_stamp}#{@asset_destination_extension}"
+      @basenamer.call @asset_destination_base_prefix, @asset_destination_extension, -> { asset_stamp }
     end
 
     def asset_stamp
       @asset_stamp ||= AssetStamp.from_file(path)
     end
-
-    def clear_asset_stamp
-      @asset_stamp = nil
-    end
-
-    def update_mtime
-      @@mtimes[path] = mtime
-    end
   end
 end

data/lib/jekyll/minibundle/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Minibundle
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/test/fixture/site/_bin/with_count

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+filename = ARGV.first
+
+count = if File.exists? filename
+  File.read(filename).strip.to_i
+else
+  0
+end
+
+File.write filename, "#{count + 1}\n"
+
+exec(*ARGV[1..-1])

data/test/integration/minibundle_development_mode_test.rb

@@ -5,8 +5,8 @@ module Jekyll::Minibundle::Test
   class MiniBundleDevelopmentModeTest < TestCase
     include FixtureConfig
 
-    EXPECTED_CSS_ASSET_PATHS = %w{reset common}.map { |f| File.join(CSS_BUNDLE_DESTINATION_DIR, "#{f}.css") }
-    EXPECTED_JS_ASSET_PATHS = %w{dependency app}.map { |f| File.join(JS_BUNDLE_DESTINATION_DIR, "#{f}.js") }
+    EXPECTED_CSS_ASSET_PATHS = %w{reset common}.map { |f| File.join(CSS_BUNDLE_DESTINATION_PATH, "#{f}.css") }
+    EXPECTED_JS_ASSET_PATHS = %w{dependency app}.map { |f| File.join(JS_BUNDLE_DESTINATION_PATH, "#{f}.js") }
 
     def test_css_assets_have_tags_in_configured_order
       with_precompiled_site :development do
@@ -38,35 +38,38 @@ module Jekyll::Minibundle::Test
 
     def test_changing_css_asset_copies_it_to_destination_dir
       with_site do
-        destination = destination_path CSS_BUNDLE_DESTINATION_DIR, 'common.css'
+        generate_site :development
+        destination = destination_path CSS_BUNDLE_DESTINATION_PATH, 'common.css'
         source = source_path CSS_BUNDLE_SOURCE_DIR, 'common.css'
+        ensure_file_mtime_changes { File.write source, 'h1 {}' }
 
-        generate_site :development
-        ensure_file_mtime_change { File.write source, 'h1 {}' }
         refute_equal File.read(destination), File.read(source)
+
         generate_site :development
+
         assert_equal File.read(destination), File.read(source)
       end
     end
 
     def test_changing_js_asset_copies_it_to_destination_dir
       with_site do
-        destination = destination_path JS_BUNDLE_DESTINATION_DIR, 'app.js'
+        generate_site :development
+        destination = destination_path JS_BUNDLE_DESTINATION_PATH, 'app.js'
         source = source_path JS_BUNDLE_SOURCE_DIR, 'app.js'
+        ensure_file_mtime_changes { File.write source, '(function() {})()' }
 
-        generate_site :development
-        ensure_file_mtime_change { File.write source, '(function() {})()' }
         refute_equal File.read(destination), File.read(source)
+
         generate_site :development
+
         assert_equal File.read(destination), File.read(source)
       end
     end
 
     def test_supports_relative_and_absolute_destination_paths
       with_site do
-        expected_css_path = destination_path CSS_BUNDLE_DESTINATION_DIR, 'common.css'
-        expected_js_path = destination_path JS_BUNDLE_DESTINATION_DIR, 'app.js'
-
+        expected_css_path = destination_path CSS_BUNDLE_DESTINATION_PATH, 'common.css'
+        expected_js_path = destination_path JS_BUNDLE_DESTINATION_PATH, 'app.js'
         generate_site :development
 
         assert File.exists?(expected_css_path)
@@ -75,7 +78,6 @@ module Jekyll::Minibundle::Test
         assert_equal 'assets/site/app.js', find_js_paths_from_index.last
 
         find_and_gsub_in_file source_path('index.html'), 'destination_path: assets/site', 'destination_path: /assets/site'
-
         generate_site :development
 
         assert File.exists?(expected_css_path)
@@ -94,6 +96,23 @@ module Jekyll::Minibundle::Test
       end
     end
 
+    def test_do_not_copy_source_when_other_files_change
+      with_site do
+        generate_site :development
+        expected_js_path = destination_path JS_BUNDLE_DESTINATION_PATH, 'app.js'
+        org_mtime = mtime_of expected_js_path
+        ensure_file_mtime_changes { File.write source_path(JS_BUNDLE_SOURCE_DIR, 'dependency.js'), '(function() {})()' }
+        generate_site :development
+
+        assert_equal org_mtime, mtime_of(expected_js_path)
+
+        ensure_file_mtime_changes { FileUtils.touch 'index.html' }
+        generate_site :development
+
+        assert_equal org_mtime, mtime_of(expected_js_path)
+      end
+    end
+
     private
 
     def find_css_paths_from_index
@@ -112,10 +131,5 @@ module Jekyll::Minibundle::Test
       assert File.exists?(actual)
       assert_equal File.read(expected), File.read(actual)
     end
-
-    def ensure_file_mtime_change(&block)
-      sleep 1.5  # ensures file mtime gets changed
-      yield
-    end
   end
 end

data/test/integration/minibundle_production_mode_test.rb

@@ -5,12 +5,9 @@ module Jekyll::Minibundle::Test
   class MiniBundleProductionModeTest < TestCase
     include FixtureConfig
 
-    EXPECTED_CSS_ASSET_PATH = 'assets/site-b2e0ecc1c100effc2c7353caad20c327.css'
-    EXPECTED_JS_ASSET_PATH = 'assets/site-4782a1f67803038d4f8351051e67deb8.js'
-
     def test_css_asset_bundle_has_configured_attributes
       with_precompiled_site :production do
-        element = find_html_element_from_index %{head link[href="#{EXPECTED_CSS_ASSET_PATH}"]}
+        element = find_html_element_from_index %{head link[href="#{EXPECTED_CSS_BUNDLE_PATH}"]}
         assert_equal 'my-styles', element['id']
         assert_equal 'projection', element['media']
       end
@@ -18,52 +15,52 @@ module Jekyll::Minibundle::Test
 
     def test_js_asset_bundle_has_configured_attributes
       with_precompiled_site :production do
-        element = find_html_element_from_index %{body script[src="#{EXPECTED_JS_ASSET_PATH}"]}
+        element = find_html_element_from_index %{body script[src="#{EXPECTED_JS_BUNDLE_PATH}"]}
         assert_equal 'my-scripts', element['id']
       end
     end
 
     def test_css_asset_bundle_has_stamp
       with_precompiled_site :production do
-        assert_equal EXPECTED_CSS_ASSET_PATH, find_css_path_from_index
+        assert_equal EXPECTED_CSS_BUNDLE_PATH, find_css_path_from_index
       end
     end
 
     def test_js_asset_bundle_has_stamp
       with_precompiled_site :production do
-        assert_equal EXPECTED_JS_ASSET_PATH, find_js_path_from_index
+        assert_equal EXPECTED_JS_BUNDLE_PATH, find_js_path_from_index
       end
     end
 
     def test_css_asset_bundle_is_copied_to_destination_dir
       with_precompiled_site :production do
-        assert File.exists?(destination_path(EXPECTED_CSS_ASSET_PATH))
+        assert File.exists?(destination_path(EXPECTED_CSS_BUNDLE_PATH))
       end
     end
 
     def test_js_asset_bundle_is_copied_to_destination_dir
       with_precompiled_site :production do
-        assert File.exists?(destination_path(EXPECTED_JS_ASSET_PATH))
+        assert File.exists?(destination_path(EXPECTED_JS_BUNDLE_PATH))
       end
     end
 
     def test_css_asset_bundle_is_concatenated_in_configured_order
       with_precompiled_site :production do
-        bundle = File.read(destination_path(EXPECTED_CSS_ASSET_PATH))
+        bundle = File.read(destination_path(EXPECTED_CSS_BUNDLE_PATH))
         assert_operator bundle.index('html { margin: 0; }'), :<, bundle.index('p { margin: 0; }')
       end
     end
 
     def test_js_asset_bundle_is_concatenated_in_configured_order
       with_precompiled_site :production do
-        bundle = File.read(destination_path(EXPECTED_JS_ASSET_PATH))
+        bundle = File.read(destination_path(EXPECTED_JS_BUNDLE_PATH))
         assert_operator bundle.index('root.dependency = {};'), :<, bundle.index('root.app = {};')
       end
     end
 
     def test_js_asset_bundle_has_inserted_semicolons_between_assets
       with_precompiled_site :production do
-        bundle = File.read(destination_path(EXPECTED_JS_ASSET_PATH))
+        bundle = File.read(destination_path(EXPECTED_JS_BUNDLE_PATH))
         assert_match(%r|}\)\(window\)\n;\n\(function|, bundle)
       end
     end
@@ -71,7 +68,7 @@ module Jekyll::Minibundle::Test
     def test_css_asset_bundle_is_minified
       with_precompiled_site :production do
         source_contents_size = source_assets_size(CSS_BUNDLE_SOURCE_DIR, %w{reset common}, 'css')
-        destination_contents_size = File.read(destination_path(EXPECTED_CSS_ASSET_PATH)).size
+        destination_contents_size = File.read(destination_path(EXPECTED_CSS_BUNDLE_PATH)).size
         assert_operator destination_contents_size, :<, source_contents_size
       end
     end
@@ -79,7 +76,7 @@ module Jekyll::Minibundle::Test
     def test_js_asset_bundle_is_minified
       with_precompiled_site :production do
         source_contents_size = source_assets_size(JS_BUNDLE_SOURCE_DIR, %w{dependency app}, 'js')
-        destination_contents_size = File.read(destination_path(EXPECTED_JS_ASSET_PATH)).size
+        destination_contents_size = File.read(destination_path(EXPECTED_JS_BUNDLE_PATH)).size
         assert_operator destination_contents_size, :<, source_contents_size
       end
     end
@@ -87,11 +84,16 @@ module Jekyll::Minibundle::Test
     def test_changing_css_assets_changes_bundle
       with_site do
         generate_site :production
-        assert File.exists?(destination_path(EXPECTED_CSS_ASSET_PATH))
-        File.write source_path('_assets/styles/common.css'), 'h1 {}'
-        generate_site :production
-        refute File.exists?(destination_path(EXPECTED_CSS_ASSET_PATH))
+
+        assert File.exists?(destination_path(EXPECTED_CSS_BUNDLE_PATH))
+
+        ensure_file_mtime_changes { File.write source_path(CSS_BUNDLE_SOURCE_DIR, 'common.css'), 'h1 {}' }
+        generate_site :production, clear_cache: false
+
+        refute File.exists?(destination_path(EXPECTED_CSS_BUNDLE_PATH))
+
         expected_new_path = 'assets/site-9fd3995d6f0fce425db81c3691dfe93f.css'
+
         assert_equal expected_new_path, find_css_path_from_index
         assert File.exists?(destination_path(expected_new_path))
       end
@@ -100,11 +102,16 @@ module Jekyll::Minibundle::Test
     def test_changing_js_assets_changes_bundle
       with_site do
         generate_site :production
-        assert File.exists?(destination_path(EXPECTED_JS_ASSET_PATH))
-        File.write source_path('_assets/scripts/app.js'), '(function() {})()'
-        generate_site :production
-        refute File.exists?(destination_path(EXPECTED_JS_ASSET_PATH))
+
+        assert File.exists?(destination_path(EXPECTED_JS_BUNDLE_PATH))
+
+        ensure_file_mtime_changes { File.write source_path(JS_BUNDLE_SOURCE_DIR, 'app.js'), '(function() {})()' }
+        generate_site :production, clear_cache: false
+
+        refute File.exists?(destination_path(EXPECTED_JS_BUNDLE_PATH))
+
         expected_new_path = 'assets/site-375a0b430b0c5555d0edd2205d26c04d.js'
+
         assert_equal expected_new_path, find_js_path_from_index
         assert File.exists?(destination_path(expected_new_path))
       end
@@ -112,24 +119,55 @@ module Jekyll::Minibundle::Test
 
     def test_supports_relative_and_absolute_destination_paths
       with_site do
-        expected_css_path = destination_path EXPECTED_CSS_ASSET_PATH
-        expected_js_path = destination_path EXPECTED_JS_ASSET_PATH
-
         generate_site :production
+        expected_css_path = destination_path EXPECTED_CSS_BUNDLE_PATH
+        expected_js_path = destination_path EXPECTED_JS_BUNDLE_PATH
 
         assert File.exists?(expected_css_path)
         assert File.exists?(expected_js_path)
-        assert_equal EXPECTED_CSS_ASSET_PATH, find_css_path_from_index
-        assert_equal EXPECTED_JS_ASSET_PATH, find_js_path_from_index
+        assert_equal EXPECTED_CSS_BUNDLE_PATH, find_css_path_from_index
+        assert_equal EXPECTED_JS_BUNDLE_PATH, find_js_path_from_index
 
         find_and_gsub_in_file source_path('index.html'), 'destination_path: assets/site', 'destination_path: /assets/site'
-
         generate_site :production
 
         assert File.exists?(expected_css_path)
         assert File.exists?(expected_js_path)
-        assert_equal "/#{EXPECTED_CSS_ASSET_PATH}", find_css_path_from_index
-        assert_equal "/#{EXPECTED_JS_ASSET_PATH}", find_js_path_from_index
+        assert_equal "/#{EXPECTED_CSS_BUNDLE_PATH}", find_css_path_from_index
+        assert_equal "/#{EXPECTED_JS_BUNDLE_PATH}", find_js_path_from_index
+      end
+    end
+
+    def test_bundles_assets_only_once_upon_startup
+      with_site do
+        with_env 'JEKYLL_MINIBUNDLE_CMD_JS' => cmd_to_remove_comments_and_count do
+          generate_site :production
+        end
+        assert_equal 1, get_cmd_count
+      end
+    end
+
+    def test_do_not_bundle_assets_when_nonsource_files_change
+      with_site do
+        with_env 'JEKYLL_MINIBUNDLE_CMD_JS' => cmd_to_remove_comments_and_count do
+          generate_site :production
+          expected_js_path = destination_path EXPECTED_JS_BUNDLE_PATH
+          last_mtime = mtime_of expected_js_path
+
+          assert_equal 1, get_cmd_count
+
+          ensure_file_mtime_changes { File.write source_path(CSS_BUNDLE_SOURCE_DIR, 'common.css'), 'h1 {}' }
+          generate_site :production, clear_cache: false
+
+          assert_equal last_mtime, mtime_of(expected_js_path)
+          assert_equal 1, get_cmd_count
+
+          ensure_file_mtime_changes { FileUtils.touch 'index.html' }
+          generate_site :production, clear_cache: false
+
+          assert_equal last_mtime, mtime_of(expected_js_path)
+          assert_equal 1, get_cmd_count
+        end
       end
     end