jekyll-minibundle 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb4db2142f8fea9e137638a9f81fcf1673b0076c
-  data.tar.gz: 391293041abe19a1f143b28c6592fe2932bbac2e
+  metadata.gz: 477c2a1ad9364dfb5457b7b2b7894d74a0d5dcf8
+  data.tar.gz: 3212bf6bb364f63ad2e565c2eff35fed43c984b1
 SHA512:
-  metadata.gz: a23acbd135fc4100e284bb059a98c18dc981deb0dd83e0a7ee9aaba52bab6b8188f2fb2121ace3970086292db53053518e3633ff4b73d0f63406f7017dd07395
-  data.tar.gz: 56506b2a3bafebeef270f7630a69ff8c7ba08ed87ee33f13d595487b05e5804843a429d7f1382600c718006b4e03683d8824671395aeb04f108c3ede05868c2e
+  metadata.gz: c563707b1fa6b8cb468b96b22e3bc5ac99ec11d6cf0ef7eb4d520af3a1909744ef6c18d9beb646939d5f72efb83d3b28912fe44a3e66e402ea144183e64a8d43
+  data.tar.gz: bdf079e3b4af862ba04f19c17b1ec832cbfc4994af873ffefea3c7f500327a9ec2769d85eefc275810dd133417faaa99e95a2840b70cc32bacfb046b6b8a6216

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 1.4.3 / 2014-01-16
+
+* Do not leak read pipe file descriptor upon minifier command failure
+* Loosen version constraints for development gem dependencies
+* Clarify documentation
+* Fix some Ruby coding style issues
+* Minor internal state handling improvements
+* Clarify tests, increase test coverage
+
 # 1.4.2 / 2013-12-28
 
 * Ensure touching asset source triggers destination write. This was an

data/README.md

@@ -3,8 +3,10 @@
 A straightforward asset bundling plugin for [Jekyll][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).
+for cache busting.
+
+There are no runtime dependencies, except for the minification tool
+used for bundling (fingerprinting has no dependencies).
 
 Tested with Ruby MRI 1.9.3, 2.0, and 2.1. Ruby 1.8 is *not* supported.
 
@@ -46,7 +48,7 @@ The plugin is shipped as a
 $ gem install jekyll-minibundle
 ```
 
-Add file `_plugins/minibundle.rb` to your Jekyll site project with
+Add `_plugins/minibundle.rb` file to your Jekyll site project with
 this line:
 
 ``` ruby
@@ -58,16 +60,11 @@ You must allow Jekyll to use custom plugins. In
 
 ## Asset fingerprinting
 
-Asset fingerprinting is intended to be used together with
-[Compass](http://compass-style.org/) and similar asset generation
-tools that have their own configuration for input sources.
-
-Configure Compass to take inputs from `_assets/styles/*.scss` and to
-put output to `_tmp/site.css`. Use `ministamp` tag to copy the
-processed style asset to the generated site:
+If you just want to have a fingerprint in your asset's path, use
+`ministamp` tag:
 
 ``` html
-<link href="{% ministamp _tmp/site.css assets/site.css %}" rel="stylesheet" media="screen, projection">
+<link href="{% ministamp _assets/site.css assets/site.css %}" rel="stylesheet" media="screen, projection">
 ```
 
 Output, containing the MD5 digest of the file in the filename:
@@ -76,7 +73,18 @@ Output, containing the MD5 digest of the file in the filename:
 <link href="assets/site-390be921ee0eff063817bb5ef2954300.css" rel="stylesheet" media="screen, projection">
 ```
 
-This feature does not require any external tools.
+Jekyll's output directory will have the asset file at that path.
+
+This feature is useful when combined with asset generation tools
+external to Jekyll. For example, you can configure
+[Compass](http://compass-style.org/) to take inputs from
+`_assets/styles/*.scss` and to produce output to
+`_tmp/site.css`. Then, you use `ministamp` tag to copy the file with a
+fingerprint to Jekyll's output directory:
+
+``` html
+<link href="{% ministamp _tmp/site.css assets/site.css %}" rel="stylesheet">
+```
 
 ## Asset bundling
 
@@ -85,8 +93,8 @@ tool that supports reading input from STDIN and writing the output to
 STDOUT. You write the configuration for input sources directly into
 the content file where you want the markup tag for the bundle file to
 appear. The outcome will be a markup tag containing the path to the
-bundle file, and the generated site will have the bundle file in that
-path. The MD5 digest of the file will be included in the filename.
+bundle file, and the Jekyll's output directory will have the bundle
+file at that path. The path will contain a fingerprint.
 
 Place `minibundle` block with configuration into your content file
 where you want the generated markup to appear. For example, to bundle
@@ -157,12 +165,13 @@ result, there will be both `src.css` and `dest-<md5>.css` files in
 
 In order to avoid this, exclude the asset source file from
 Jekyll. Because Jekyll excludes directories beginning with underscore
-character (`_`), consider the following directory layout:
+character (`_`), consider using the following directory layout:
 
-* `_assets/` for JS and CSS assets handled by the plugin that are in
-  version control
-* `_tmp/` for temporary JS and CSS assets handled by the plugin that
-  are not in version control (for example, Compass output files)
+* `_assets/` for JavaScript and CSS assets handled by the plugin that
+  are in version control
+* `_tmp/` for temporary JavaScript and CSS assets handled by the
+  plugin that are not in version control (for example, Compass output
+  files)
 * `assets/` for images and other assets handled by Jekyll directly
 
 See [Jekyll configuration][JekyllConf] for more about excluding files
@@ -170,12 +179,13 @@ and directories.
 
 ## Development mode
 
-The plugin has one more trick in its sleeves. If you set environment
-variable `$JEKYLL_MINIBUNDLE_MODE` to `development`, then the plugin
-will copy asset files as is to the destination directory (using
-`destination_path` as directory for `minibundle` block), and omit
-fingerprinting. This is useful in development workflow, where you need
-the filenames and line numbers of the original asset sources.
+The plugin has one more trick in its sleeves. If you set
+`$JEKYLL_MINIBUNDLE_MODE` environment variable to `development`, then
+the plugin will copy asset files as is to Jekyll's output directory
+and omit fingerprinting. The `destination_path` setting in
+`minibundle` block sets the destination directory for bundled
+files. This is useful in development workflow, where you need the
+filenames and line numbers of the original asset sources.
 
 ``` bash
 $ JEKYLL_MINIBUNDLE_MODE=development jekyll serve --watch

data/Rakefile

@@ -14,8 +14,8 @@ def get_minibundle_env(overrides = {})
 end
 
 def run_jekyll_in_fixture_site(command)
-  Dir.chdir 'test/fixture/site'
-  FileUtils.rm_rf '_site'
+  Dir.chdir('test/fixture/site')
+  FileUtils.rm_rf('_site')
   sh get_minibundle_env, "jekyll #{command}"
 end
 
@@ -40,7 +40,7 @@ namespace :gem do
   end
 end
 
-desc 'Run tests'
+desc 'Run tests; envars: tests=<test_path> to select a particular suite, debug=1 to require Pry and PP'
 task :test do
   glob = ENV['tests'] || 'test/{unit,integration}/*_test.rb'
   files = Dir[glob].
@@ -49,7 +49,7 @@ task :test do
   opts = ENV['debug'] ? '-rpp -rpry' : ''
   eval = %{-e 'ARGV.each { |f| require f }'}
   cmd = "ruby #{opts} #{eval} #{files}"
-  env = get_minibundle_env 'RUBYLIB' => 'lib:test'
+  env = get_minibundle_env('RUBYLIB' => 'lib:test')
   sh env, cmd
 end
 
@@ -58,12 +58,12 @@ namespace :fixture do
 
   desc 'Generate fixture site'
   task :build do
-    run_jekyll_in_fixture_site 'build'
+    run_jekyll_in_fixture_site('build')
   end
 
   desc 'Generate fixture site in watch mode'
   task :watch do
-    run_jekyll_in_fixture_site 'build --watch'
+    run_jekyll_in_fixture_site('build --watch')
   end
 end
 

data/jekyll-minibundle.gemspec

@@ -1,13 +1,13 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'lib/jekyll/minibundle/version'))
 
 Gem::Specification.new do |s|
-  s.name        = 'jekyll-minibundle'
-  s.version     = Jekyll::Minibundle::VERSION
-  s.summary     = 'A minimalistic asset bundling plugin for Jekyll'
-  s.authors     = ['Tuomas Kareinen']
-  s.email       = 'tkareine@gmail.com'
-  s.homepage    = 'https://github.com/tkareine/jekyll-minibundle'
-  s.licenses    = %w{MIT}
+  s.name     = 'jekyll-minibundle'
+  s.version  = Jekyll::Minibundle::VERSION
+  s.summary  = 'A minimalistic asset bundling plugin for Jekyll'
+  s.authors  = ['Tuomas Kareinen']
+  s.email    = 'tkareine@gmail.com'
+  s.homepage = 'https://github.com/tkareine/jekyll-minibundle'
+  s.license  = 'MIT'
 
   s.description = <<-END
 A straightforward asset bundling plugin for Jekyll, utilizing external
@@ -27,10 +27,10 @@ minification tool (not even other gems).
 
   s.test_files = `git ls-files -- test`.split("\n")
 
-  s.add_development_dependency 'jekyll',   '~> 1.4.2'
-  s.add_development_dependency 'minitest', '~> 5.2.0'
-  s.add_development_dependency 'nokogiri', '~> 1.6.1'
-  s.add_development_dependency 'rake',     '~> 10.1.1'
+  s.add_development_dependency 'jekyll',   '~> 1.4'
+  s.add_development_dependency 'minitest', '~> 5.2'
+  s.add_development_dependency 'nokogiri', '~> 1.6'
+  s.add_development_dependency 'rake',     '~> 10.1'
 
   s.required_ruby_version = '>= 1.9.3'
 

data/lib/jekyll/minibundle/asset_bundle.rb

@@ -5,7 +5,7 @@ module Jekyll::Minibundle
   class AssetBundle
     def initialize(type, assets, site_dir)
       @type, @assets, @site_dir = type, assets, site_dir
-      @temp_file = Tempfile.new "jekyll-minibundle-#{@type}-"
+      @temp_file = Tempfile.new("jekyll-minibundle-#{@type}-")
       at_exit { @temp_file.close! }
     end
 
@@ -14,15 +14,17 @@ module Jekyll::Minibundle
     end
 
     def make_bundle
-      pipe_bundling_to_temp_file bundling_cmd do |wr|
+      cmd = get_minifier_cmd
+      exit_status = spawn_minifier(cmd) do |input|
         $stdout.puts  # place newline after "(Re)generating..." log messages
-        log "Bundling #{@type} assets:"
+        log("Bundling #{@type} assets:")
         @assets.each do |asset|
-          log asset
-          IO.foreach(asset) { |line| wr.write line }
-          wr.puts ';' if @type == :js
+          log(asset)
+          IO.foreach(asset) { |line| input.write(line) }
+          input.puts(';') if @type == :js
         end
       end
+      fail "Bundling #{@type} assets failed with exit status #{exit_status}, command: #{cmd}" if exit_status != 0
       self
     end
 
@@ -30,30 +32,31 @@ module Jekyll::Minibundle
 
     if defined? ::Jekyll.logger  # introduced in Jekyll 1.0.0
       def log(msg)
-        ::Jekyll.logger.info 'Minibundle:', msg
+        ::Jekyll.logger.info('Minibundle:', msg)
       end
     else
       def log(msg)
-        $stdout.puts msg
+        $stdout.puts(msg)
       end
     end
 
-    def bundling_cmd
-      Environment.command_for @type
+    def get_minifier_cmd
+      Environment.command_for(@type)
     end
 
-    def pipe_bundling_to_temp_file(cmd)
+    def spawn_minifier(cmd)
       pid = nil
       rd, wr = IO.pipe
-      Dir.chdir @site_dir do
-        pid = spawn cmd, out: [@temp_file.path, 'w'], in: rd
+      Dir.chdir(@site_dir) do
+        pid = spawn(cmd, out: [@temp_file.path, 'w'], in: rd)
       end
+      rd.close
       yield wr
       wr.close
-      _, status = Process.waitpid2 pid
-      raise "Bundling #{@type} assets failed with exit status #{status.exitstatus}, command: #{cmd}" if status.exitstatus != 0
+      _, status = Process.waitpid2(pid)
+      status.exitstatus
     ensure
-      wr.close unless wr.closed?
+      [rd, wr].each { |io| io.close unless io.closed? }
     end
   end
 end

data/lib/jekyll/minibundle/asset_file_operations.rb

@@ -9,9 +9,9 @@ module Jekyll::Minibundle
     end
 
     def write_destination(site_destination_dir)
-      destination_path = destination site_destination_dir
-      FileUtils.mkdir_p File.dirname(destination_path)
-      FileUtils.cp path, destination_path
+      destination_path = destination(site_destination_dir)
+      FileUtils.mkdir_p(File.dirname(destination_path))
+      FileUtils.cp(path, destination_path)
     end
   end
 end

data/lib/jekyll/minibundle/asset_file_paths.rb

@@ -5,15 +5,11 @@ module Jekyll::Minibundle
     end
 
     def asset_destination_path
-      File.join asset_destination_dir, asset_destination_basename
+      File.join(asset_destination_dir, asset_destination_basename)
     end
 
     def destination(site_destination_dir)
-      File.join site_destination_dir, asset_destination_path
-    end
-
-    def destination_exists?(site_destination_dir)
-      File.exists? destination(site_destination_dir)
+      File.join(site_destination_dir, asset_destination_path)
     end
 
     def mtime

data/lib/jekyll/minibundle/asset_file_registry.rb

@@ -5,45 +5,43 @@ require 'jekyll/minibundle/stamp_file'
 
 module Jekyll::Minibundle
   module AssetFileRegistry
-    def self.clear
-      @@_instances = {}
-    end
-
-    clear
-
-    def self.bundle_file(config)
-      asset_destination_path = "#{config['destination_path']}.#{config['type']}"
-      @@_instances[asset_destination_path] ||= register_bundle_file config
-    end
+    class << self
+      def clear
+        @_instances = {}
+      end
 
-    def self.stamp_file(asset_source_path, asset_destination_path)
-      @@_instances[asset_destination_path] ||= register_stamp_file asset_source_path, asset_destination_path
-    end
+      def bundle_file(config)
+        asset_destination_path = "#{config['destination_path']}.#{config['type']}"
+        @_instances[asset_destination_path] ||= register_bundle_file(config)
+      end
 
-    def self.register_bundle_file(config)
-      if Environment.development?
-        DevelopmentFileCollection.new config
-      else
-        BundleFile.new config
+      def stamp_file(asset_source_path, asset_destination_path)
+        @_instances[asset_destination_path] ||= register_stamp_file(asset_source_path, asset_destination_path)
       end
-    end
 
-    private_class_method :register_bundle_file
+      private
 
-    def self.register_stamp_file(asset_source_path, asset_destination_path)
-      StampFile.new(asset_source_path, asset_destination_path, &get_stamp_file_basenamer)
-    end
+      def register_bundle_file(config)
+        if Environment.development?
+          DevelopmentFileCollection.new(config)
+        else
+          BundleFile.new(config)
+        end
+      end
 
-    private_class_method :register_stamp_file
+      def register_stamp_file(asset_source_path, asset_destination_path)
+        StampFile.new(asset_source_path, asset_destination_path, &get_stamp_file_basenamer)
+      end
 
-    def self.get_stamp_file_basenamer
-      if Environment.development?
-        ->(base, ext, _) { base + ext }
-      else
-        ->(base, ext, stamper) { "#{base}-#{stamper.call}#{ext}" }
+      def get_stamp_file_basenamer
+        if Environment.development?
+          ->(base, ext, _) { base + ext }
+        else
+          ->(base, ext, stamper) { "#{base}-#{stamper.call}#{ext}" }
+        end
       end
     end
 
-    private_class_method :get_stamp_file_basenamer
+    clear
   end
 end

data/lib/jekyll/minibundle/asset_stamp.rb

@@ -3,7 +3,7 @@ require 'digest/md5'
 module Jekyll::Minibundle
   module AssetStamp
     def self.from_file(path)
-      Digest::MD5.hexdigest File.read(path)
+      Digest::MD5.hexdigest(File.read(path))
     end
   end
 end

data/lib/jekyll/minibundle/asset_tag_markup.rb

@@ -2,23 +2,25 @@ require 'cgi'
 
 module Jekyll::Minibundle
   module AssetTagMarkup
-    def self.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 "Unknown type for generating bundle markup: #{type}, #{path}"
+    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
+          fail "Unknown type for generating bundle markup: #{type}, #{path}"
+        end
       end
-    end
 
-    def self.make_attributes(attributes)
-      attributes.map { |name, value| make_attribute(name, value) }.join('')
-    end
+      def make_attributes(attributes)
+        attributes.map { |name, value| make_attribute(name, value) }.join('')
+      end
 
-    def self.make_attribute(name, value)
-      %{ #{name}="#{CGI.escape_html(value)}"}
+      def make_attribute(name, value)
+        %{ #{name}="#{CGI.escape_html(value)}"}
+      end
     end
   end
 end