jekyll-minibundle 2.2.0 → 3.0.0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'rake/clean'
 require 'shellwords'
@@ -20,7 +22,11 @@ def run_jekyll_in_fixture_site(command)
   sh env, jekyll_cmd
 end
 
-desc 'Run benchmarks; BM=<benchmark_suite_path>'
+desc <<~TEXT
+  Run benchmarks. Supported options from environment variables:
+
+  BM=<benchmark_suite_path>
+TEXT
 task :benchmark do
   run_single_bm = ENV.key?('BM')
 
@@ -57,33 +63,40 @@ namespace :gem do
   end
 end
 
-desc 'Run tests; TEST=<test_suite_path>, NAME=<test_name_pattern>, DEBUG=1 to require Pry, PP, enable warnings'
-task :test do
-  run_single_test = ENV.key?('TEST')
+desc <<~TEXT
+  Run tests. Supported options from environment variables:
 
+  TEST=<test_suite_path>
+  NAME=<test_name_pattern>
+  DEBUG=1                     Require Pry, PP, enable warnings
+  SEED=n                      Set the random seed
+  TEST_OPTS='-v'              Enable other minitest options
+TEXT
+task :test do
   run_selected_or_all =
-    if run_single_test
-      rb_file = ENV['TEST']
-      name_opt = ENV.key?('NAME') ? " -n #{ENV['NAME']}" : ''
-      "#{rb_file}#{name_opt}"
+    if ENV.key?('TEST')
+      test_file = ENV['TEST']
+      minitest_opts = "#{ENV.key?('NAME') ? "-n #{ENV['NAME']} " : ''}#{ENV.fetch('TEST_OPTS', '')}"
+      "#{test_file} #{minitest_opts}"
     else
+      eval = "-e 'ARGV.each { |f| require \"#{Dir.pwd}/test/\#{f}\" }'"
       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 ' : ''
+  ruby_opts = "-I lib#{ENV['DEBUG'] ? ' -w -rpp -rpry' : ''}"
 
-  sh "ruby -I lib:test #{extra_opts}#{run_selected_or_all}"
+  puts "Jekyll version: #{Gem::Specification.find_by_name('jekyll').version}"
+  sh "ruby #{ruby_opts} #{run_selected_or_all}"
 end
 
 namespace :fixture do
-  CLEAN.include 'test/fixture/site/_site'
+  CLOBBER.include 'test/fixture/site/_site', 'test/fixture/site/.jekyll-cache'
 
-  desc 'Generate fixture site'
+  desc 'Generate fixture site (tests use it, this task allows manual inspection)'
   task :build do
     run_jekyll_in_fixture_site('build')
   end
@@ -96,4 +109,4 @@ end
 
 RuboCop::RakeTask.new
 
-task default: [:test, :rubocop]
+task default: %i[rubocop test]

data/jekyll-minibundle.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/jekyll/minibundle/version'
 
 Gem::Specification.new do |s|
@@ -9,33 +11,33 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/tkareine/jekyll-minibundle'
   s.license  = 'MIT'
 
-  s.description = <<-END
-A straightforward asset bundling plugin for Jekyll, utilizing external
-minification tool of your choice. It provides asset concatenation for
-bundling and asset fingerprinting with MD5 digest for cache busting.
-There are no other runtime dependencies besides the minification tool
-(not even other gems).
-  END
+  s.description = <<~TEXT
+    A straightforward asset bundling plugin for Jekyll, utilizing external
+    minification tool of your choice. It provides asset concatenation for
+    bundling and asset fingerprinting with MD5 digest for cache busting.
+    There are no other runtime dependencies besides the minification tool
+    (not even other gems).
+  TEXT
 
-  s.files = %w{
+  s.files = %w[
     CHANGELOG.md
     LICENSE.txt
     README.md
     Rakefile
     jekyll-minibundle.gemspec
-  } + `git ls-files -- lib`.split("\n")
+  ] + `git ls-files -- lib`.split("\n")
 
   s.test_files = `git ls-files -- test`.split("\n")
 
   s.add_development_dependency 'benchmark-ips', '~> 2.7'
-  s.add_development_dependency 'jekyll',        '~> 3.0'
+  s.add_development_dependency 'jekyll',        '>= 3.0'
   s.add_development_dependency 'minitest',      '~> 5.8'
   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.47.0'
+  s.add_development_dependency 'rake',          '~> 13.0'
+  s.add_development_dependency 'rubocop',       '~> 0.90.0'
 
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.4.0'
 
   s.rdoc_options << '--line-numbers' << '--title' << s.name << '--exclude' << 'test'
 end

data/lib/jekyll/minibundle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(Jekyll::VERSION) &&
    defined?(Gem::Version) &&
    (Gem::Version.create(Jekyll::VERSION) < Gem::Version.create('3.0.0'))

data/lib/jekyll/minibundle/asset_bundle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tempfile'
 require 'jekyll/minibundle/exceptions'
 require 'jekyll/minibundle/files'
@@ -5,7 +7,7 @@ require 'jekyll/minibundle/log'
 
 module Jekyll::Minibundle
   class AssetBundle
-    TEMPFILE_PREFIX = 'jekyll-minibundle-'.freeze
+    TEMPFILE_PREFIX = 'jekyll-minibundle-'
 
     def initialize(config)
       @type = config.fetch(:type)
@@ -15,12 +17,12 @@ module Jekyll::Minibundle
       @minifier_cmd = config.fetch(:minifier_cmd)
 
       unless @minifier_cmd
-        raise <<-END
-Missing minification command for bundling #{bundle_destination_path.inspect}. 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.
-        END
+        raise <<~MESSAGE
+          Missing minification command for bundling #{bundle_destination_path.inspect}. 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.
+        MESSAGE
       end
 
       @tempfile = Tempfile.new([TEMPFILE_PREFIX, ".#{@type}"])
@@ -33,25 +35,29 @@ Missing minification command for bundling #{bundle_destination_path.inspect}. Sp
 
     def 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
         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 #{bundle_destination_path.inspect} failed with exit status #{exit_status}, command: #{@minifier_cmd.inspect}"
         log_minifier_error(msg)
         raise msg
       end
+
       self
     end
 
@@ -72,7 +78,7 @@ Missing minification command for bundling #{bundle_destination_path.inspect}. Sp
       wr.close
       _, status = Process.waitpid2(pid)
       status.exitstatus
-    rescue => e
+    rescue StandardError => e
       raise "Bundling #{bundle_destination_path.inspect} failed: #{e}"
     ensure
       [rd, wr].each { |io| io.close unless io.closed? }
@@ -86,7 +92,7 @@ Missing minification command for bundling #{bundle_destination_path.inspect}. Sp
       Log.error("#{message}, last #{last_bytes.size} bytes of minifier output:")
 
       last_bytes
-        .gsub(/[^[:print:]\t\n]/) { |ch| '\x' + ch.unpack('H2').first }
+        .gsub(/[^[:print:]\t\n]/) { |ch| "\\x#{ch.unpack1('H2')}" }
         .split("\n")
         .each { |line| Log.error(line) }
     end

data/lib/jekyll/minibundle/asset_file_drop.rb

@@ -1,19 +1,22 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Jekyll::Minibundle
   class AssetFileDrop < ::Liquid::Drop
     extend Forwardable
 
-    KEYS = %w{
+    KEYS = %w[
       name
       extname
       basename
       modified_time
       path
       collection
-    }.freeze
+    ].freeze
 
     def initialize(file)
+      super()
       @file = file
     end
 

data/lib/jekyll/minibundle/asset_file_properties.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jekyll/minibundle/asset_file_drop'
 
 module Jekyll::Minibundle

data/lib/jekyll/minibundle/asset_file_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jekyll/minibundle/bundle_file'
 require 'jekyll/minibundle/development_file'
 require 'jekyll/minibundle/development_file_collection'
@@ -13,7 +15,7 @@ module Jekyll::Minibundle
 
       def clear_unused
         @_files
-          .select { |_, cached| !cached.fetch(:is_used) }
+          .reject { |_, cached| cached.fetch(:is_used) }
           .each do |asset_destination_path, cached|
             cached.fetch(:file).cleanup
             @_files.delete(asset_destination_path)
@@ -66,9 +68,9 @@ module Jekyll::Minibundle
           end
 
           if cached_is_used
-            raise <<-END
-Two or more minibundle blocks with the same destination path #{asset_destination_path.inspect}, but having different asset configuration: #{bundle_config.inspect} vs. #{cached_config.inspect}
-            END
+            raise <<~MESSAGE
+              Two or more minibundle blocks with the same destination path #{asset_destination_path.inspect}, but having different asset configuration: #{bundle_config.inspect} vs. #{cached_config.inspect}
+            MESSAGE
           end
 
           cached_file.cleanup
@@ -107,9 +109,9 @@ Two or more minibundle blocks with the same destination path #{asset_destination
           end
 
           if cached_is_used
-            raise <<-END
-Two or more ministamp tags with the same destination path #{asset_destination_path.inspect}, but different asset source paths: #{asset_source_path.inspect} vs. #{cached_config.inspect}
-            END
+            raise <<~MESSAGE
+              Two or more ministamp tags with the same destination path #{asset_destination_path.inspect}, but different asset source paths: #{asset_source_path.inspect} vs. #{cached_config.inspect}
+            MESSAGE
           end
 
           cached_file.cleanup

data/lib/jekyll/minibundle/asset_stamp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest/md5'
 
 module Jekyll::Minibundle

data/lib/jekyll/minibundle/asset_tag_markup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi/util'
 
 module Jekyll::Minibundle
@@ -8,9 +10,9 @@ module Jekyll::Minibundle
 
       case type
       when :js
-        %{<script type="text/javascript" src="#{url_str}"#{attributes_str}></script>}
+        %(<script type="text/javascript" src="#{url_str}"#{attributes_str}></script>)
       when :css
-        %{<link rel="stylesheet" href="#{url_str}"#{attributes_str}>}
+        %(<link rel="stylesheet" href="#{url_str}"#{attributes_str}>)
       else
         raise ArgumentError, "Unknown type for generating bundle markup: #{type}, #{url}"
       end
@@ -22,9 +24,9 @@ module Jekyll::Minibundle
 
     def self.make_attribute(name, value)
       if value.nil?
-        %{ #{name}}
+        %( #{name})
       else
-        %{ #{name}="#{CGI.escape_html(value.to_s)}"}
+        %( #{name}="#{CGI.escape_html(value.to_s)}")
       end
     end
   end

data/lib/jekyll/minibundle/bundle_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jekyll/minibundle/files'
 require 'jekyll/minibundle/asset_bundle'
 require 'jekyll/minibundle/asset_file_properties'
@@ -14,12 +16,17 @@ module Jekyll::Minibundle
       @site = site
       @type = config.fetch('type')
       asset_source_dir = File.join(@site.source, config.fetch('source_dir'))
+
       raise ArgumentError, "Bundle source directory does not exist: #{asset_source_dir}" unless File.directory?(asset_source_dir)
+
       @asset_paths = config.fetch('assets').map do |asset_path|
         path = File.join(asset_source_dir, "#{asset_path}.#{@type}")
+
         raise ArgumentError, "Bundle asset source file does not exist: #{path}" unless File.file?(path)
+
         path
       end
+
       @destination_path = config.fetch('destination_path')
       @asset_destination_dir = File.dirname(@destination_path)
       @asset_destination_filename_prefix = File.basename(@destination_path)
@@ -31,6 +38,7 @@ module Jekyll::Minibundle
 
     def cleanup
       return unless @_asset_bundle
+
       @_asset_bundle.close
       @_asset_bundle = nil
     end

data/lib/jekyll/minibundle/development_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jekyll/minibundle/files'
 require 'jekyll/minibundle/asset_file_properties'
 
@@ -13,7 +15,9 @@ module Jekyll::Minibundle
     def initialize(site, asset_source_path, asset_destination_path)
       @site = site
       @asset_source_path = File.join(@site.source, asset_source_path)
+
       raise ArgumentError, "Development source file does not exist: #{@asset_source_path}" unless File.file?(@asset_source_path)
+
       @asset_destination_dir = File.dirname(asset_destination_path)
       @asset_destination_filename = File.basename(asset_destination_path)
       @stamped_at = nil

data/lib/jekyll/minibundle/development_file_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jekyll/minibundle/development_file'
 
 module Jekyll::Minibundle

data/lib/jekyll/minibundle/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jekyll/minibundle/hashes'
 
 module Jekyll::Minibundle
@@ -8,15 +10,17 @@ module Jekyll::Minibundle
     end
 
     def self.development?(site)
-      mode = ENV['JEKYLL_MINIBUNDLE_MODE'] || Environment.find_site_config(site, %w{minibundle mode}, String)
+      mode = ENV['JEKYLL_MINIBUNDLE_MODE'] || Environment.find_site_config(site, %w[minibundle mode], String)
       mode == 'development'
     end
 
     def self.find_site_config(site, keys, type)
       value = Hashes.dig(site.config, *keys)
+
       if value && !value.is_a?(type)
         raise "Invalid site configuration for key #{keys.join('.')}; expecting type #{type}"
       end
+
       value
     end
   end

data/lib/jekyll/minibundle/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll::Minibundle
   class IllegalStateError < RuntimeError; end
 end

data/lib/jekyll/minibundle/files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 
 module Jekyll::Minibundle

data/lib/jekyll/minibundle/hashes.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Jekyll::Minibundle
   module Hashes
     def self.dig(obj, *keys)
       value = obj
       keys.each do |key|
         return nil unless value
+
         value = value[key]
       end
       value

data/lib/jekyll/minibundle/log.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Jekyll::Minibundle
   module Log
-    TOPIC = 'Minibundle:'.freeze
+    TOPIC = 'Minibundle:'
 
     def self.error(msg)
       ::Jekyll.logger.error(TOPIC, msg)

data/lib/jekyll/minibundle/mini_bundle_block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'jekyll/minibundle/hashes'
 require 'jekyll/minibundle/files'
@@ -9,7 +11,9 @@ module Jekyll::Minibundle
   class MiniBundleBlock < Liquid::Block
     def initialize(tag_name, type, _tokens)
       super
+
       @type = type.strip.downcase.to_sym
+
       raise ArgumentError, "Missing asset type for minibundle block; pass value such as 'css' or 'js' as the argument" if @type.empty?
     end
 
@@ -56,14 +60,17 @@ module Jekyll::Minibundle
 
     def parse_contents(contents)
       raise ArgumentError, 'Missing configuration for minibundle block; pass configuration in YAML syntax' if contents =~ /\A\s+\z/
+
       structure = parse_structure(contents)
+
       raise ArgumentError, "Unsupported minibundle block contents type (#{structure.class}), only Hash is supported: #{contents}" unless structure.is_a?(Hash)
+
       structure
     end
 
     def parse_structure(contents)
       ::SafeYAML.load(contents)
-    rescue => e
+    rescue StandardError => e
       raise ArgumentError, "Failed parsing minibundle block contents syntax as YAML: #{contents.strip.inspect}. Cause: #{e}"
     end