jekyll-minibundle 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c07644674d4019624ae3cd17463a8dc961df66ba
-  data.tar.gz: f512236902087572a1d618620ac87184f8590b28
+  metadata.gz: 8c11f2890adfcdd3cc6902ddf8f1449f3e1b1721
+  data.tar.gz: 8676586c08adf47c8962dcee2214cfba11eeff55
 SHA512:
-  metadata.gz: 3886e4b0a47bfa8d9aa720c0b5630952fd876835f29b9cfe55b5df11bb726ff51f9ff91defd338e64e9b7e44687f692b069aeb246f21be126793b3f139963428
-  data.tar.gz: 320e44f066004bf6a701ea26a0bdc42a507211656d9f446ea20da84cb67b5f5c0468afe2d7b2e70ac4919a34cad2a41b773c3f6c8319faa03f7667a8abe1bb07
+  metadata.gz: 3915fc23411307ba14bf2e700fe40ab7197aa155397027b6bcd65a3cb31efaa631df9aea43545b5584bf55e0ed63f33376e5e0f6a3344db4a3d55fa627cd37e3
+  data.tar.gz: d159b2a770dd15d261bdf6b2a6661a866ea73f3a76188d2a85bb62e061f875809558f53d46e0726e494ca2a0cad68ce7a12c006a5d0488c3f9b673f81588db61

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+# 2.1.2 / 2017-02-28
+
+* Bug fix: remove unnecessary '.' path component from asset destination
+  path. This manifested when the asset destination had no subdirectory.
+  Affects `ministamp` tag and `minibundle` block.
+
+  Example situation:
+
+  ```
+  <link href="{{ site.baseurl }}/{% ministamp _assets/site.css site.css %}" rel="stylesheet">
+  ```
+
+  Generation result, before the fix:
+
+  ```
+  <link href="/./site-6a204bd89f3c8348afd5c77c717a097a.css" rel="stylesheet">
+  ```
+
+  Generation result, after the fix:
+
+  ```
+  <link href="/site-6a204bd89f3c8348afd5c77c717a097a.css" rel="stylesheet">
+  ```
+
+* Bug fix (related to above): don't let Jekyll's watch mode
+  (auto-regenration) remove asset from generated site directory when
+  asset destination path has no subdirectory.
+* Show bundle destination path in bundling log message
+
 # 2.1.1 / 2017-01-14
 
 * Fix the file permissions of `minibundle` block's output file to

data/README.md

@@ -303,8 +303,12 @@ See the sources of [an example site][JekyllMinibundleExampleSite].
 
 ## Known caveats
 
-The plugin does not work with Jekyll's incremental rebuild feature
-(Jekyll option `--incremental`).
+1. The plugin does not work with Jekyll's incremental rebuild feature
+   (Jekyll option `--incremental`).
+
+2. `ministamp` tag does not interpret Liquid variables, as the tag just
+   takes in string literals. Improving this would require new syntax for
+   tag arguments.
 
 ## License
 

data/jekyll-minibundle.gemspec

@@ -32,7 +32,7 @@ There are no other runtime dependencies besides the minification tool
   s.add_development_dependency 'nokogiri', '~> 1.6'
   s.add_development_dependency 'pry',      '~> 0.10'
   s.add_development_dependency 'rake',     '~> 12.0'
-  s.add_development_dependency 'rubocop',  '~> 0.46.0'
+  s.add_development_dependency 'rubocop',  '~> 0.47.0'
 
   s.required_ruby_version = '>= 2.0.0'
 

data/lib/jekyll/minibundle/asset_bundle.rb

@@ -10,12 +10,13 @@ module Jekyll::Minibundle
     def initialize(config)
       @type = config.fetch(:type)
       @asset_paths = config.fetch(:asset_paths)
+      @destination_path = config.fetch(:destination_path)
       @site_dir = config.fetch(:site_dir)
       @minifier_cmd = config.fetch(:minifier_cmd)
 
       unless @minifier_cmd
         raise <<-END
-Missing minification command for bundling #{@type} assets. Specify it in
+Missing minification command for bundling #{bundle_destination_path}. Specify it in
 1) minibundle.minifier_commands.#{@type} setting in _config.yml,
 2) $JEKYLL_MINIBUNDLE_CMD_#{@type.to_s.upcase} environment variable, or
 3) minifier_cmd setting inside minibundle block.
@@ -39,15 +40,15 @@ Missing minification command for bundling #{@type} assets. Specify it in
       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
-        Log.info("Bundling #{@type} assets:")
+        Log.info("Bundling #{bundle_destination_path}:")
         @asset_paths.each do |asset|
-          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
       end
       if exit_status != 0
-        msg = "Bundling #{@type} assets failed with exit status #{exit_status}, command: '#{@minifier_cmd}'"
+        msg = "Bundling #{bundle_destination_path} failed with exit status #{exit_status}, command: '#{@minifier_cmd}'"
         log_minifier_error(msg)
         raise msg
       end
@@ -72,7 +73,7 @@ Missing minification command for bundling #{@type} assets. Specify it in
       _, status = Process.waitpid2(pid)
       status.exitstatus
     rescue => e
-      raise "Bundling #{@type} assets failed: #{e}"
+      raise "Bundling #{bundle_destination_path} failed: #{e}"
     ensure
       [rd, wr].each { |io| io.close unless io.closed? }
     end
@@ -89,5 +90,9 @@ Missing minification command for bundling #{@type} assets. Specify it in
         .split("\n")
         .each { |line| Log.error(line) }
     end
+
+    def bundle_destination_path
+      "#{@destination_path}.#{@type}"
+    end
   end
 end

data/lib/jekyll/minibundle/asset_file_properties.rb

@@ -15,7 +15,7 @@ module Jekyll::Minibundle
     end
 
     def destination(site_destination_dir)
-      File.join(site_destination_dir, asset_destination_path)
+      File.expand_path(File.join(site_destination_dir, asset_destination_path), '/')
     end
 
     def url
@@ -34,10 +34,6 @@ module Jekyll::Minibundle
       modified_time.to_i
     end
 
-    def modified?
-      stamped_at != mtime
-    end
-
     def destination_rel_dir
       asset_destination_dir
     end

data/lib/jekyll/minibundle/asset_tag_markup.rb

@@ -3,13 +3,12 @@ require 'cgi'
 module Jekyll::Minibundle
   module AssetTagMarkup
     class << self
-      def make_markup(type, baseurl, path, attributes)
-        url = make_url(baseurl, path)
+      def make_markup(type, path, attributes)
         case type
         when :js
-          %{<script type="text/javascript" src="#{url}"#{make_attributes(attributes)}></script>}
+          %{<script type="text/javascript" src="#{path}"#{make_attributes(attributes)}></script>}
         when :css
-          %{<link rel="stylesheet" href="#{url}"#{make_attributes(attributes)}>}
+          %{<link rel="stylesheet" href="#{path}"#{make_attributes(attributes)}>}
         else
           raise ArgumentError, "Unknown type for generating bundle markup: #{type}, #{path}"
         end
@@ -26,14 +25,6 @@ module Jekyll::Minibundle
           %{ #{name}="#{CGI.escape_html(value.to_s)}"}
         end
       end
-
-      def make_url(baseurl, path)
-        if baseurl.empty?
-          path
-        else
-          File.join(baseurl, path)
-        end
-      end
     end
   end
 end

data/lib/jekyll/minibundle/bundle_file.rb

@@ -1,23 +1,23 @@
+require 'jekyll/minibundle/files'
 require 'jekyll/minibundle/asset_bundle'
-require 'jekyll/minibundle/asset_file_operations'
 require 'jekyll/minibundle/asset_file_properties'
 require 'jekyll/minibundle/asset_stamp'
 
 module Jekyll::Minibundle
   class BundleFile
-    include AssetFileOperations
     include AssetFileProperties
 
-    attr_reader :asset_destination_dir, :stamped_at
+    attr_reader :asset_destination_dir,
+                :stamped_at
 
     def initialize(site, config)
       @site = site
       @type = config.fetch('type')
       asset_source_dir = File.join(@site.source, config.fetch('source_dir'))
       @asset_paths = config.fetch('assets').map { |asset_path| File.join(asset_source_dir, "#{asset_path}.#{@type}") }
-      destination_path = config.fetch('destination_path')
-      @asset_destination_dir = File.dirname(destination_path)
-      @asset_destination_filename_prefix = File.basename(destination_path)
+      @destination_path = config.fetch('destination_path')
+      @asset_destination_dir = File.dirname(@destination_path)
+      @asset_destination_filename_prefix = File.basename(@destination_path)
       @minifier_cmd = config.fetch('minifier_cmd')
       @stamped_at = nil
       @is_modified = false
@@ -32,10 +32,13 @@ module Jekyll::Minibundle
 
     def destination_path_for_markup
       # we must rebundle here, if at all, in order to make sure the
-      # destination path in the markup and the generated file path
-      # have the same fingerprint
-      if modified?
-        @stamped_at = mtime
+      # destination path in the markup and the generated file path have
+      # the same fingerprint
+
+      source_mtime = mtime
+
+      if @stamped_at != source_mtime
+        @stamped_at = source_mtime
         @is_modified = true
         @_asset_stamp = nil
         asset_bundle.make_bundle
@@ -60,11 +63,16 @@ module Jekyll::Minibundle
       @asset_paths.map { |f| File.stat(f).mtime }.max
     end
 
+    def modified?
+      @is_modified
+    end
+
     # allows writing destination only after
     # `destination_path_for_markup` has been called
     def write(site_destination_dir)
-      if @is_modified
-        dst_path = write_destination(site_destination_dir)
+      if modified?
+        dst_path = destination(site_destination_dir)
+        Files.copy_p(path, dst_path)
 
         # respect user's umask; Ruby's tempfile has mode 0o600
         File.chmod(0o666 & ~File.umask, dst_path)
@@ -84,10 +92,11 @@ module Jekyll::Minibundle
 
     def asset_bundle
       @_asset_bundle ||= AssetBundle.new(
-        type: @type,
-        asset_paths: @asset_paths,
-        site_dir: @site.source,
-        minifier_cmd: @minifier_cmd
+        type:             @type,
+        asset_paths:      @asset_paths,
+        destination_path: @destination_path,
+        site_dir:         @site.source,
+        minifier_cmd:     @minifier_cmd
       )
     end
   end

data/lib/jekyll/minibundle/development_file.rb

@@ -1,12 +1,14 @@
-require 'jekyll/minibundle/asset_file_operations'
+require 'jekyll/minibundle/files'
 require 'jekyll/minibundle/asset_file_properties'
 
 module Jekyll::Minibundle
   class DevelopmentFile
-    include AssetFileOperations
     include AssetFileProperties
 
-    attr_reader :asset_source_path, :asset_destination_dir, :asset_destination_filename, :stamped_at
+    attr_reader :asset_source_path,
+                :asset_destination_dir,
+                :asset_destination_filename,
+                :stamped_at
 
     def initialize(site, asset_source_path, asset_destination_path)
       @site = site
@@ -16,16 +18,24 @@ module Jekyll::Minibundle
       @stamped_at = nil
     end
 
+    def cleanup
+      # no-op
+    end
+
     alias destination_path_for_markup asset_destination_path
 
     def extname
       File.extname(asset_destination_filename)
     end
 
+    def modified?
+      stamped_at != mtime
+    end
+
     def write(site_destination_dir)
       if modified?
         @stamped_at = mtime
-        write_destination(site_destination_dir)
+        Files.copy_p(path, destination(site_destination_dir))
         true
       else
         false

data/lib/jekyll/minibundle/files.rb

@@ -1,18 +1,31 @@
+require 'fileutils'
+
 module Jekyll::Minibundle
   module Files
-    def self.read_last(path, max_size)
-      File.open(path, 'rb') do |file|
-        return '' if max_size < 1
+    class << self
+      def copy_p(src_path, dst_path)
+        FileUtils.mkdir_p(File.dirname(dst_path))
+        FileUtils.cp(src_path, dst_path)
+      end
+
+      def read_last(path, max_size)
+        File.open(path, 'rb') do |file|
+          return '' if max_size < 1
 
-        file_size = file.stat.size
+          file_size = file.stat.size
 
-        if file_size < max_size
-          file.read(file_size)
-        else
-          file.seek(file_size - max_size, ::IO::SEEK_SET)
-          file.read(max_size)
+          if file_size < max_size
+            file.read(file_size)
+          else
+            file.seek(file_size - max_size, ::IO::SEEK_SET)
+            file.read(max_size)
+          end
         end
       end
+
+      def strip_dot_slash_from_path_start(path)
+        path.sub(%r{\A\./+}, '')
+      end
     end
   end
 end

data/lib/jekyll/minibundle/mini_bundle_block.rb

@@ -1,4 +1,5 @@
 require 'jekyll/minibundle/hashes'
+require 'jekyll/minibundle/files'
 require 'jekyll/minibundle/environment'
 require 'jekyll/minibundle/asset_file_registry'
 require 'jekyll/minibundle/asset_tag_markup'
@@ -18,7 +19,16 @@ module Jekyll::Minibundle
       attributes = bundle_config.fetch('attributes')
 
       register_asset_files(site, bundle_config).map do |file|
-        AssetTagMarkup.make_markup(@type, baseurl, file.destination_path_for_markup, attributes)
+        dst_path = Files.strip_dot_slash_from_path_start(file.destination_path_for_markup)
+
+        full_path =
+          if baseurl.empty?
+            dst_path
+          else
+            File.join(baseurl, dst_path)
+          end
+
+        AssetTagMarkup.make_markup(@type, full_path, attributes)
       end.join("\n")
     end
 
@@ -52,16 +62,10 @@ module Jekyll::Minibundle
     end
 
     def normalize_baseurl_and_destination_path(baseurl, destination_path)
-      baseurl = '' if baseurl.nil?
-
-      unless destination_path.start_with?('/')
-        return [baseurl, destination_path]
-      end
-
-      normalized_baseurl = baseurl.empty? ? '/' : baseurl
-      normalized_destination_path = destination_path.sub(%r{\A/+}, '')
+      baseurl = '' if baseurl.nil? || baseurl == '.'
+      baseurl = '/' if destination_path.start_with?('/') && baseurl.empty?
 
-      [normalized_baseurl, normalized_destination_path]
+      [Files.strip_dot_slash_from_path_start(baseurl), destination_path.sub(%r{\A/+}, '')]
     end
 
     def register_asset_files(site, bundle_config)

data/lib/jekyll/minibundle/mini_stamp_tag.rb

@@ -1,3 +1,4 @@
+require 'jekyll/minibundle/files'
 require 'jekyll/minibundle/asset_file_registry'
 
 module Jekyll::Minibundle
@@ -26,7 +27,7 @@ module Jekyll::Minibundle
         else
           AssetFileRegistry.register_stamp_file(site, @source_path, @destination_path)
         end
-      @baseurl + file.destination_path_for_markup
+      @baseurl + Files.strip_dot_slash_from_path_start(file.destination_path_for_markup)
     end
 
     private

data/lib/jekyll/minibundle/stamp_file.rb

@@ -1,13 +1,14 @@
-require 'jekyll/minibundle/asset_file_operations'
+require 'jekyll/minibundle/files'
 require 'jekyll/minibundle/asset_file_properties'
 require 'jekyll/minibundle/asset_stamp'
 
 module Jekyll::Minibundle
   class StampFile
-    include AssetFileOperations
     include AssetFileProperties
 
-    attr_reader :asset_source_path, :asset_destination_dir, :stamped_at
+    attr_reader :asset_source_path,
+                :asset_destination_dir,
+                :stamped_at
 
     def initialize(site, asset_source_path, asset_destination_path)
       @site = site
@@ -19,12 +20,19 @@ module Jekyll::Minibundle
       @is_modified = false
     end
 
+    def cleanup
+      # no-op
+    end
+
     def destination_path_for_markup
       # we must rebundle here, if at all, in order to make sure the
-      # destination path in the markup and the generated file path
-      # have the same fingerprint
-      if modified?
-        @stamped_at = mtime
+      # destination path in the markup and the generated file path have
+      # the same fingerprint
+
+      source_mtime = mtime
+
+      if @stamped_at != source_mtime
+        @stamped_at = source_mtime
         @is_modified = true
         @_asset_stamp = nil
       end
@@ -40,11 +48,15 @@ module Jekyll::Minibundle
       @asset_destination_extension
     end
 
+    def modified?
+      @is_modified
+    end
+
     # allows writing destination only after
     # `destination_path_for_markup` has been called
     def write(site_destination_dir)
-      if @is_modified
-        write_destination(site_destination_dir)
+      if modified?
+        Files.copy_p(path, destination(site_destination_dir))
         @is_modified = false
         true
       else