jekyll-minibundle 2.1.2 → 2.2.0

data/Rakefile

@@ -20,6 +20,22 @@ def run_jekyll_in_fixture_site(command)
   sh env, jekyll_cmd
 end
 
+desc 'Run benchmarks; BM=<benchmark_suite_path>'
+task :benchmark do
+  run_single_bm = ENV.key?('BM')
+
+  bm_sources =
+    if run_single_bm
+      [ENV['BM']]
+    else
+      Dir['benchmark/*_bm.rb']
+    end
+
+  bm_sources.each do |bm_source|
+    sh "ruby -I lib #{bm_source}"
+  end
+end
+
 namespace :gem do
   gem_name = 'jekyll-minibundle'
 

data/jekyll-minibundle.gemspec

@@ -27,12 +27,13 @@ There are no other runtime dependencies besides the minification tool
 
   s.test_files = `git ls-files -- test`.split("\n")
 
-  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 'benchmark-ips', '~> 2.7'
+  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.required_ruby_version = '>= 2.0.0'
 

data/lib/jekyll/minibundle/asset_bundle.rb

@@ -16,7 +16,7 @@ module Jekyll::Minibundle
 
       unless @minifier_cmd
         raise <<-END
-Missing minification command for bundling #{bundle_destination_path}. Specify it in
+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.
@@ -48,7 +48,7 @@ Missing minification command for bundling #{bundle_destination_path}. Specify it
         end
       end
       if exit_status != 0
-        msg = "Bundling #{bundle_destination_path} failed with exit status #{exit_status}, command: '#{@minifier_cmd}'"
+        msg = "Bundling #{bundle_destination_path.inspect} failed with exit status #{exit_status}, command: #{@minifier_cmd.inspect}"
         log_minifier_error(msg)
         raise msg
       end
@@ -73,7 +73,7 @@ Missing minification command for bundling #{bundle_destination_path}. Specify it
       _, status = Process.waitpid2(pid)
       status.exitstatus
     rescue => e
-      raise "Bundling #{bundle_destination_path} failed: #{e}"
+      raise "Bundling #{bundle_destination_path.inspect} failed: #{e}"
     ensure
       [rd, wr].each { |io| io.close unless io.closed? }
     end

data/lib/jekyll/minibundle/asset_file_drop.rb

@@ -0,0 +1,45 @@
+require 'forwardable'
+
+module Jekyll::Minibundle
+  class AssetFileDrop < ::Liquid::Drop
+    extend Forwardable
+
+    KEYS = %w{
+      name
+      extname
+      basename
+      modified_time
+      path
+      collection
+    }.freeze
+
+    def initialize(file)
+      @file = file
+    end
+
+    def key?(key)
+      respond_to?(key)
+    end
+
+    def keys
+      KEYS
+    end
+
+    def to_h
+      keys.each_with_object({}) do |key, acc|
+        acc[key] = self[key]
+      end
+    end
+
+    alias to_hash to_h
+
+    def inspect
+      require 'json'
+      JSON.pretty_generate(to_h)
+    end
+
+    def_delegators :@file, :name, :extname, :basename, :modified_time
+    def_delegator :@file, :relative_path, :path
+    def_delegator :@file, :type, :collection
+  end
+end

data/lib/jekyll/minibundle/asset_file_properties.rb

@@ -1,3 +1,5 @@
+require 'jekyll/minibundle/asset_file_drop'
+
 module Jekyll::Minibundle
   module AssetFileProperties
     def asset_destination_path
@@ -26,6 +28,10 @@ module Jekyll::Minibundle
       asset_destination_filename
     end
 
+    def basename
+      File.basename(name, extname)
+    end
+
     def modified_time
       File.stat(path).mtime
     end
@@ -35,17 +41,15 @@ module Jekyll::Minibundle
     end
 
     def destination_rel_dir
-      asset_destination_dir
+      "/#{asset_destination_dir}"
     end
 
     def to_liquid
-      {
-        'basename'      => File.basename(name, extname),
-        'name'          => name,
-        'extname'       => extname,
-        'modified_time' => modified_time,
-        'path'          => relative_path
-      }
+      AssetFileDrop.new(self)
+    end
+
+    def data
+      {}
     end
 
     def write?

data/lib/jekyll/minibundle/asset_file_registry.rb

@@ -49,7 +49,7 @@ module Jekyll::Minibundle
 
         if cached
           if cached.fetch(:type) != :bundle
-            raise "minibundle block has the same destination path as a ministamp tag: '#{asset_destination_path}'"
+            raise "minibundle block has the same destination path as a ministamp tag: #{asset_destination_path}"
           end
 
           cached_file = cached.fetch(:file)
@@ -67,7 +67,7 @@ module Jekyll::Minibundle
 
           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}
+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
           end
 
@@ -90,7 +90,7 @@ Two or more minibundle blocks with the same destination path '#{asset_destinatio
 
         if cached
           if cached.fetch(:type) != :stamp
-            raise "ministamp tag has the same destination path as a minibundle block: '#{asset_destination_path}'"
+            raise "ministamp tag has the same destination path as a minibundle block: #{asset_destination_path}"
           end
 
           cached_file = cached.fetch(:file)
@@ -108,7 +108,7 @@ Two or more minibundle blocks with the same destination path '#{asset_destinatio
 
           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}'
+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
           end
 

data/lib/jekyll/minibundle/asset_tag_markup.rb

@@ -1,29 +1,30 @@
-require 'cgi'
+require 'cgi/util'
 
 module Jekyll::Minibundle
   module AssetTagMarkup
-    class << self
-      def make_markup(type, path, attributes)
-        case type
-        when :js
-          %{<script type="text/javascript" src="#{path}"#{make_attributes(attributes)}></script>}
-        when :css
-          %{<link rel="stylesheet" href="#{path}"#{make_attributes(attributes)}>}
-        else
-          raise ArgumentError, "Unknown type for generating bundle markup: #{type}, #{path}"
-        end
-      end
+    def self.make_markup(type, url, attributes)
+      url_str = CGI.escape_html(url)
+      attributes_str = make_attributes(attributes)
 
-      def make_attributes(attributes)
-        attributes.map { |name, value| make_attribute(name, value) }.join('')
+      case type
+      when :js
+        %{<script type="text/javascript" src="#{url_str}"#{attributes_str}></script>}
+      when :css
+        %{<link rel="stylesheet" href="#{url_str}"#{attributes_str}>}
+      else
+        raise ArgumentError, "Unknown type for generating bundle markup: #{type}, #{url}"
       end
+    end
+
+    def self.make_attributes(attributes)
+      attributes.map { |name, value| make_attribute(name, value) }.join('')
+    end
 
-      def make_attribute(name, value)
-        if value.nil?
-          %{ #{name}}
-        else
-          %{ #{name}="#{CGI.escape_html(value.to_s)}"}
-        end
+    def self.make_attribute(name, value)
+      if value.nil?
+        %{ #{name}}
+      else
+        %{ #{name}="#{CGI.escape_html(value.to_s)}"}
       end
     end
   end

data/lib/jekyll/minibundle/bundle_file.rb

@@ -14,7 +14,12 @@ module Jekyll::Minibundle
       @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}") }
+      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)

data/lib/jekyll/minibundle/development_file.rb

@@ -12,7 +12,8 @@ module Jekyll::Minibundle
 
     def initialize(site, asset_source_path, asset_destination_path)
       @site = site
-      @asset_source_path = asset_source_path
+      @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

@@ -7,12 +7,12 @@ module Jekyll::Minibundle
     def initialize(site, config)
       @type = config.fetch('type')
 
-      asset_source_dir = File.join(site.source, config.fetch('source_dir'))
+      source_dir = config.fetch('source_dir')
       destination_path = config.fetch('destination_path')
 
       @files = config.fetch('assets').map do |asset_path|
         asset_basename = "#{asset_path}.#{@type}"
-        asset_source = File.join(asset_source_dir, asset_basename)
+        asset_source = File.join(source_dir, asset_basename)
         asset_destination = File.join(destination_path, asset_basename)
         DevelopmentFile.new(site, asset_source, asset_destination)
       end

data/lib/jekyll/minibundle/environment.rb

@@ -2,24 +2,22 @@ require 'jekyll/minibundle/hashes'
 
 module Jekyll::Minibundle
   module Environment
-    class << self
-      def minifier_command(site, type)
-        type = type.to_s
-        ENV["JEKYLL_MINIBUNDLE_CMD_#{type.upcase}"] || Environment.find_site_config(site, ['minibundle', 'minifier_commands', type], String)
-      end
+    def self.minifier_command(site, type)
+      type = type.to_s
+      ENV["JEKYLL_MINIBUNDLE_CMD_#{type.upcase}"] || Environment.find_site_config(site, ['minibundle', 'minifier_commands', type], String)
+    end
 
-      def development?(site)
-        mode = ENV['JEKYLL_MINIBUNDLE_MODE'] || Environment.find_site_config(site, %w{minibundle mode}, String)
-        mode == 'development'
-      end
+    def self.development?(site)
+      mode = ENV['JEKYLL_MINIBUNDLE_MODE'] || Environment.find_site_config(site, %w{minibundle mode}, String)
+      mode == 'development'
+    end
 
-      def 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
+    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
 end

data/lib/jekyll/minibundle/files.rb

@@ -2,30 +2,28 @@ require 'fileutils'
 
 module Jekyll::Minibundle
   module Files
-    class << self
-      def copy_p(src_path, dst_path)
-        FileUtils.mkdir_p(File.dirname(dst_path))
-        FileUtils.cp(src_path, dst_path)
-      end
+    def self.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
+    def self.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)
-          end
+        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
+    def self.strip_dot_slash_from_path_start(path)
+      path.sub(%r{\A\./+}, '')
     end
   end
 end

data/lib/jekyll/minibundle/hashes.rb

@@ -1,19 +1,17 @@
 module Jekyll::Minibundle
   module Hashes
-    class << self
-      def dig(obj, *keys)
-        value = obj
-        keys.each do |key|
-          return nil unless value
-          value = value[key]
-        end
-        value
+    def self.dig(obj, *keys)
+      value = obj
+      keys.each do |key|
+        return nil unless value
+        value = value[key]
       end
+      value
+    end
 
-      def pick(hash, *keys)
-        keys.each_with_object({}) do |key, acc|
-          acc[key] = hash.fetch(key)
-        end
+    def self.pick(hash, *keys)
+      keys.each_with_object({}) do |key, acc|
+        acc[key] = hash.fetch(key)
       end
     end
   end

data/lib/jekyll/minibundle/log.rb

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

data/lib/jekyll/minibundle/mini_bundle_block.rb

@@ -1,3 +1,4 @@
+require 'pathname'
 require 'jekyll/minibundle/hashes'
 require 'jekyll/minibundle/files'
 require 'jekyll/minibundle/environment'
@@ -9,41 +10,63 @@ module Jekyll::Minibundle
     def initialize(tag_name, type, _tokens)
       super
       @type = type.strip.downcase.to_sym
-      raise ArgumentError, "No asset type for minibundle block; pass value such as 'css' or 'js' as the argument" if @type.empty?
+      raise ArgumentError, "Missing asset type for minibundle block; pass value such as 'css' or 'js' as the argument" if @type.empty?
     end
 
     def render(context)
       site = context.registers.fetch(:site)
-      bundle_config = get_current_bundle_config(::SafeYAML.load(super), site)
+
+      bundle_config = get_current_bundle_config(parse_contents(super), site)
       baseurl = bundle_config.fetch('baseurl')
+      destination_baseurl = bundle_config.fetch('destination_baseurl')
       attributes = bundle_config.fetch('attributes')
 
+      do_form_destination_baseurl = !destination_baseurl.empty?
+      destination_dir_path = Pathname.new(File.dirname(bundle_config.fetch('destination_path'))) if do_form_destination_baseurl
+
       register_asset_files(site, bundle_config).map do |file|
         dst_path = Files.strip_dot_slash_from_path_start(file.destination_path_for_markup)
 
-        full_path =
-          if baseurl.empty?
-            dst_path
-          else
+        url =
+          if do_form_destination_baseurl
+            destination_baseurl + Pathname.new(dst_path).relative_path_from(destination_dir_path).to_s
+          elsif !baseurl.empty?
             File.join(baseurl, dst_path)
+          else
+            dst_path
           end
 
-        AssetTagMarkup.make_markup(@type, full_path, attributes)
+        AssetTagMarkup.make_markup(@type, url, attributes)
       end.join("\n")
     end
 
     def self.default_bundle_config
       {
-        'source_dir'       => '_assets',
-        'destination_path' => 'assets/site',
-        'baseurl'          => '',
-        'assets'           => [],
-        'attributes'       => {}
+        'source_dir'          => '_assets',
+        'destination_path'    => 'assets/site',
+        'baseurl'             => '',
+        'destination_baseurl' => '',
+        'assets'              => [],
+        'attributes'          => {},
+        'minifier_cmd'        => nil
       }
     end
 
     private
 
+    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
+      raise ArgumentError, "Failed parsing minibundle block contents syntax as YAML: #{contents.strip.inspect}. Cause: #{e}"
+    end
+
     def get_current_bundle_config(local_bundle_config, site)
       config =
         MiniBundleBlock