middleman-webp 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0b0affadf5badd85debeee5e4c945f5e18dadb9
-  data.tar.gz: 161c2a8925c82eeda8f84699bade12bb8532b0b7
+  metadata.gz: 15324f77a8223f217cce27a1a8b4a568053550d9
+  data.tar.gz: 76e7287091230e06db8f9bbcf1bc426893223741
 SHA512:
-  metadata.gz: 674cd611524a0617647a575c9e5646f04754774ed4f2df54cab27333e87588b511f2747b8087a158f036f3bcac675c1ab4edff8cd3b4387df3176bbf9eba61b5
-  data.tar.gz: 6ec3ddc1d381977d35de9dd352c7ef4c5709f26925ecd925b1150e11d91e5aa861954c8b8fe93a9ddefd75ad03f8dbe5ec7bd4307ba98f64a92e56b8f701beb0
+  metadata.gz: e1ba54d576791994a6994935ec93cd593351f530cc302c660e871e44eb4e41a13f41202bbc77f968b6277630b947ddce078ff6ba20c22ebf0e60177ad1b3be15
+  data.tar.gz: 9813913a33e7073ab880fa64cfb64f801dfbcb871f7a0c856eb4b984a68b3ea2427f0e952b116639ae922c882df97d6f708a6d54f378fb3f686dff01b5dd8e18

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.2.4
+
+- Add ```ignore``` option similar to the one in the [asset_hash extension](http://middlemanapp.com/advanced/improving-cacheability/#uniquely-named-assets) 26fb7972c9f7808a222fb03d0a4e11e60f9148d8
+- Allow using Regexp to match files for custom conversion options 985ea2fa62a2eb4c7b37062cd72f300bada62d11

data/README.md

@@ -41,20 +41,39 @@ And activate :webp extension in your config.rb:
 activate :webp
 ```
 
+### Custom conversion options
+
 Options for conversion are defined using
 [Ruby's glob syntax](http://www.ruby-doc.org/core-2.1.1/Dir.html#method-c-glob)
-for matching image files and hashes containing args supported by
-cwebp:
+or [Regexp](http://www.ruby-doc.org/core-2.1.1/Regexp.html) for
+matching image files and hashes containing args supported by cwebp:
 
 ``` ruby
 activate :webp do |webp|
   webp.conversion_options = {
     "icons/*.png" => {lossless: true},
-    "photos/**/*.jpg" => {q: 100}
+    "photos/**/*.jpg" => {q: 100},
+    /[0-9]/.+gif$/ => {lossy: true}
   }
 end
 ```
 
+### Ignoring some of the image files at you site
+
+If there are some image files that you don't want to convert to the
+webp alternatives, you could ignore them using ```ignore``` option
+matching those paths.
+
+``` ruby
+activate :webp do |webp|
+  webp.ignore = '**/*.gif'
+end
+```
+
+Ignore option accepts one or an array of String globs, Regexps or
+Procs.
+
+
 ## Configuring your site to provide WebP alternatives
 
 Configure web server to serve WebP images if they are available and

data/lib/middleman-webp.rb

@@ -1,7 +1,7 @@
-require "middleman-core"
-require "middleman-webp/version"
+require 'middleman-core'
+require 'middleman-webp/version'
 
 ::Middleman::Extensions.register(:webp) do
-  require "middleman-webp/extension"
+  require 'middleman-webp/extension'
   ::Middleman::WebPExtension
 end

data/lib/middleman-webp/converter.rb

@@ -1,11 +1,11 @@
-require "middleman-webp/options"
+require 'middleman-webp/options'
 
 module Middleman
   module WebP
-
     class Converter
+      SUFFIX_RE = /(jpe?g|png|tiff?|gif)$/i
 
-      def initialize(app, options={}, builder)
+      def initialize(app, options = {}, builder)
         @app = app
         @options = Middleman::WebP::Options.new(options)
         @builder = builder
@@ -19,10 +19,10 @@ module Middleman
 
           @original_size += src.size
           @converted_size += dst.size
-          @builder.say_status :webp, "#{dst.path} (#{change_percentage(src.size,dst.size)} smaller)"
+          @builder.say_status :webp, "#{dst.path} "\
+          "(#{change_percentage(src.size, dst.size)} smaller)"
         end
-        savings = @original_size - @converted_size
-        @builder.say_status(:webp, "Total conversion savings: #{number_to_human_size(savings)} (#{change_percentage(@original_size, @converted_size)})", :blue)
+        print_summary
       end
 
       def convert_images(paths, &after_conversion)
@@ -45,7 +45,7 @@ module Middleman
       #
       # file - Filename
       def tool_for(file)
-        file.to_s =~ /gif$/i ? "gif2webp" : "cwebp"
+        file.to_s =~ /gif$/i ? 'gif2webp' : 'cwebp'
       end
 
       def reject_file(file)
@@ -53,10 +53,24 @@ module Middleman
         File.unlink(file)
       end
 
+      def print_summary
+        savings = @original_size - @converted_size
+        @builder.say_status :webp, 'Total conversion savings: '\
+        "#{number_to_human_size(savings)} "\
+        "(#{change_percentage(@original_size, @converted_size)})", :blue
+      end
+
       # Calculate change percentage of converted file size
       #
       # src - File instance of the source
       # dst - File instance of the destination
+      #
+      # Examples
+      #
+      #   change_percentage(100, 75)
+      #   # => '25 %'
+      #
+      # Returns percentage as string.
       def change_percentage(src_size, dst_size)
         return '0 %' if src_size == 0
 
@@ -64,19 +78,35 @@ module Middleman
       end
 
       def destination_path(src_path)
-        dst_name = src_path.basename.to_s.gsub(/(jpe?g|png|tiff?|gif)$/, "webp")
+        dst_name = src_path.basename.to_s.gsub(SUFFIX_RE, 'webp')
         src_path.parent.join(dst_name)
       end
 
       def image_files
         all = ::Middleman::Util.all_files_under(@app.inst.build_dir)
-        all.select {|p| p.to_s =~ /(jpe?g|png|tiff?|gif)$/i }
+        images = all.select { |p| p.to_s =~ SUFFIX_RE }
+
+        # Reject files matching possible ignore patterns
+        @options.ignore.reduce(images) do |arr, matcher|
+          arr.select { |path| !matcher.matches? path }
+        end
       end
 
+      # Output file size using most human friendly multiple of byte
+      # eg. MiB.
+      #
+      # n - size in bytes
+      #
+      # Examples
+      #
+      #   number_to_human_size(12345)
+      #   # => '12.06 KiB'
+      #
+      # Returns string containing size and unit.
       def number_to_human_size(n)
         return '0 B' if n == 0
 
-        units = %w{B KiB MiB GiB TiB PiB}
+        units = %w(B KiB MiB GiB TiB PiB)
         exponent = (Math.log(n) / Math.log(1024)).to_i
         format("%g #{units[exponent]}",
                format('%.2f', n.to_f / 1024**exponent))

data/lib/middleman-webp/extension.rb

@@ -1,16 +1,16 @@
-require "middleman-core"
-require "middleman-webp/converter"
+require 'middleman-core'
+require 'middleman-webp/converter'
 
 module Middleman
   class WebPExtension < Extension
-    option :conversion_options, {}, "Custom conversion options for cwebp/gif2webp"
-
-    def initialize(app, options_hash={}, &block)
+    option(:conversion_options, {},
+           'Custom conversion options for cwebp/gif2webp')
+    option(:ignore, [], 'Ignores files with matching paths')
+    def initialize(app, options_hash = {}, &block)
       super
 
-      args = options.conversion_options
       app.after_build do |builder|
-        Middleman::WebP::Converter.new(app, args, builder).convert
+        Middleman::WebP::Converter.new(app, options_hash, builder).convert
       end
     end
   end

data/lib/middleman-webp/options.rb

@@ -1,11 +1,20 @@
+require 'middleman-webp/pathname_matcher'
+
 module Middleman
   module WebP
-
     class Options
+      attr_reader :ignore
+
+      def initialize(options = {})
+        @ignore = options[:ignore] || []
+        @ignore = [*@ignore].map do |pattern|
+          Middleman::WebP::PathnameMatcher.new(pattern)
+        end
 
-      def initialize(options={})
-        @options = options.inject(Hash.new("")) do |h,(k,v)|
-          h[k] = to_args(v); h
+        @conversion = options[:conversion_options] || {}
+        @conversion = @conversion.reduce(Hash.new('')) do |h, (k, v)|
+          h[Middleman::WebP::PathnameMatcher.new(k)] = to_args(v)
+          h
         end
       end
 
@@ -15,26 +24,24 @@ module Middleman
       # glob pattern matches file path and uses the one with longest
       # glob, because it's assumed to be the most precise one.
       def for(file)
-        matching = @options.select {|g,o| file.fnmatch?(g)}
+        matching = @conversion.select { |m, o| m.matches? file }
 
-        return "" if matching.empty?
+        return '' if matching.empty?
 
-        matching.sort {|(ga,oa),(gb,ob)| gb.size <=> ga.size}[0][1]
+        matching.sort { |(ga, oa), (gb, ob)| gb.size <=> ga.size }[0][1]
       end
 
       private
 
       def to_args(options)
-        options.map do |k,v|
+        options.map do |k, v|
           if v == true
             "-#{k}"
           elsif v != false
             "-#{k} #{v}"
           end
-        end.join(" ").gsub(/ +/, " ")
+        end.join(' ').gsub(/ +/, ' ')
       end
-
     end
-
   end
 end

data/lib/middleman-webp/pathname_matcher.rb

@@ -0,0 +1,47 @@
+module Middleman
+  module WebP
+    class PathnameMatcher
+      # Initializes matcher with given pattern.
+      #
+      # pattern - Pattern to match pathnames against to. May be
+      #           string, glob, prog or regex.
+      def initialize(pattern = '**/*')
+        @pattern = pattern
+      end
+
+      # Checks given file against pattern.
+      #
+      # file - File, Pathname or String
+      def matches?(path)
+        return false if path.nil?
+
+        send match_method, path
+      end
+
+      private
+
+      def match_method
+        @match_method ||=
+          if @pattern.respond_to? :call
+            :matches_proc?
+          elsif @pattern.class == Regexp
+            :matches_re?
+          else
+            :matches_glob?
+          end
+      end
+
+      def matches_glob?(path)
+        Pathname.new(path).fnmatch?(@pattern)
+      end
+
+      def matches_re?(path)
+        !@pattern.match(Pathname.new(path).to_s).nil?
+      end
+
+      def matches_proc?(path)
+        @pattern.call(Pathname.new(path).to_s)
+      end
+    end
+  end
+end

data/lib/middleman-webp/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Webp
-    VERSION = "0.2.3"
+    VERSION = '0.2.4'
   end
 end

data/lib/middleman_extension.rb

@@ -1 +1 @@
-require "middleman-webp"
+require 'middleman-webp'

data/spec/unit/converter_spec.rb

@@ -1,31 +1,40 @@
-require "spec_helper"
-require "pathname"
-require_relative "../../lib/middleman-webp/converter"
+require 'spec_helper'
+require 'pathname'
+require 'middleman-core'
+require_relative '../../lib/middleman-webp/converter'
 
 describe Middleman::WebP::Converter do
   before do
-    @converter = Middleman::WebP::Converter.new(nil, {}, nil)
+    @app_mock = stub(inst: stub(build_dir: 'spec/fixtures'))
+    @converter = Middleman::WebP::Converter.new(@app_mock, {}, nil)
   end
 
-  describe "#change_percentage" do
-    it "returns how many percents smaller destination file is" do
-      @converter.change_percentage(10000, 8746).must_equal "12.54 %"
+  describe '#destination_path' do
+    it 'returns file name with same basename and webp suffix' do
+      d = @converter.destination_path(Pathname.new('build/images/sample.jpg'))
+      d.to_s.must_equal 'build/images/sample.webp'
+    end
+  end
+
+  describe '#change_percentage' do
+    it 'returns how many percents smaller destination file is' do
+      @converter.change_percentage(10_000, 8746).must_equal '12.54 %'
     end
 
-    it "omits zeroes in the end of decimal part" do
-      @converter.change_percentage(100, 76).must_equal "24 %"
+    it 'omits zeroes in the end of decimal part' do
+      @converter.change_percentage(100, 76).must_equal '24 %'
     end
 
-    it "returns 0% when original and new size are both 0" do
-      @converter.change_percentage(0, 0).must_equal "0 %"
+    it 'returns 0% when original and new size are both 0' do
+      @converter.change_percentage(0, 0).must_equal '0 %'
     end
   end
 
-  describe "#number_to_human_size" do
-    it "uses human readable unit" do
-      @converter.number_to_human_size(100).must_equal "100 B"
-      @converter.number_to_human_size(1234).must_equal "1.21 KiB"
-      @converter.number_to_human_size(2_634_234).must_equal "2.51 MiB"
+  describe '#number_to_human_size' do
+    it 'uses human readable unit' do
+      @converter.number_to_human_size(100).must_equal '100 B'
+      @converter.number_to_human_size(1234).must_equal '1.21 KiB'
+      @converter.number_to_human_size(2_634_234).must_equal '2.51 MiB'
     end
 
     it 'handles zero size properly' do
@@ -33,19 +42,43 @@ describe Middleman::WebP::Converter do
     end
   end
 
-  describe "#tool_for" do
-    it "uses gif2webp for gif files" do
-      path = Pathname.new("/some/path/image.gif")
-      @converter.tool_for(path).must_equal "gif2webp"
+  describe '#tool_for' do
+    it 'uses gif2webp for gif files' do
+      path = Pathname.new('/some/path/image.gif')
+      @converter.tool_for(path).must_equal 'gif2webp'
+    end
+
+    it 'uses cwebp for jpeg, png and tiff files' do
+      path = Pathname.new('/some/path/image.jpg')
+      @converter.tool_for(path).must_equal 'cwebp'
+      path = Pathname.new('/some/path/image.png')
+      @converter.tool_for(path).must_equal 'cwebp'
+      path = Pathname.new('/some/path/image.tiff')
+      @converter.tool_for(path).must_equal 'cwebp'
+    end
+  end
+
+  describe '#image_files' do
+    it 'includes all image files in Middleman build dir' do
+      @converter.image_files.size.must_equal 3
+    end
+
+    it 'won\'t include ignored files' do
+      @converter = Middleman::WebP::Converter.new(@app_mock, {
+                                                    ignore: [/jpg$/, '**/*.gif']
+                                                  }, nil)
+
+      files_to_include = [Pathname.new('spec/fixtures/empty.png')]
+      @converter.image_files.must_equal files_to_include
     end
 
-    it "uses cwebp for jpeg, png and tiff files" do
-      path = Pathname.new("/some/path/image.jpg")
-      @converter.tool_for(path).must_equal "cwebp"
-      path = Pathname.new("/some/path/image.png")
-      @converter.tool_for(path).must_equal "cwebp"
-      path = Pathname.new("/some/path/image.tiff")
-      @converter.tool_for(path).must_equal "cwebp"
+    it 'won\'t include files rejected by given proc' do
+      options = {
+        ignore: ->(path) { path.end_with? 'jpg' }
+      }
+      @converter = Middleman::WebP::Converter.new(@app_mock, options, nil)
+
+      @converter.image_files.size.must_equal 2
     end
   end
 end

data/spec/unit/options_spec.rb

@@ -1,23 +1,46 @@
-require "spec_helper"
-require "pathname"
-require_relative "../../lib/middleman-webp/options"
+require 'spec_helper'
+require 'pathname'
+require_relative '../../lib/middleman-webp/options'
 
 describe Middleman::WebP::Options do
-  describe "#for" do
-    it "returns cwebp args when given file matches option file pattern" do
-      path = Pathname.new("test_image.jpg")
-      options = Middleman::WebP::Options.new("*.jpg" => {lossless: true, q: 85})
+  describe '#for' do
+    it 'returns cwebp args when given file matches option file pattern glob' do
+      path = Pathname.new('test_image.jpg')
+      options_hash = {
+        conversion_options: {
+          '*.jpg' => {
+            lossless: true,
+            q: 85
+          }
+        }
+      }
+      options = Middleman::WebP::Options.new options_hash
 
       args = options.for(path)
       args.must_match(/^(-q 85|-lossless) (-q 85|-lossless)$/)
     end
 
-    it "returns empty string when no options are defined" do
-      path = Pathname.new("test_image.jpg")
+    it 'returns empty string when no options are defined' do
+      path = Pathname.new('test_image.jpg')
       options = Middleman::WebP::Options.new
 
       args = options.for(path)
       args.must_be_empty
     end
+
+    it 'returns cwebp args when given file matches option pattern regexp' do
+      path = Pathname.new('test_image.jpg')
+      options_hash = {
+        conversion_options: {
+          /jpg$/ => {
+            q: 85
+          }
+        }
+      }
+      options = Middleman::WebP::Options.new options_hash
+
+      args = options.for(path)
+      args.must_match(/^-q 85$/)
+    end
   end
 end

data/spec/unit/pathname_matcher_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require_relative '../../lib/middleman-webp/pathname_matcher'
+
+describe Middleman::WebP::PathnameMatcher do
+
+  describe '#matches?' do
+    it 'returns true when given file matches pattern' do
+      patterns = ['**/*.jpg', /jpg$/, ->(path) { path.end_with?('jpg') }]
+      files = [
+        'images/sample.jpg',
+        Pathname.new('images/another.jpg'),
+        File.new('spec/fixtures/empty.jpg')
+      ]
+
+      patterns.each do |p|
+        matcher = Middleman::WebP::PathnameMatcher.new(p)
+        files.each do |f|
+          matcher.matches?(f).must_equal true, "Pattern: #{p.inspect}, "\
+          "file: #{f.inspect}"
+        end
+      end
+    end
+
+    it 'returns false when given file won\'t match pattern' do
+      patterns = ['**/*.jpg', /jpg$/, ->(path) { path.end_with?('jpg') }]
+      files = [
+        'images/sample.png',
+        Pathname.new('images/another.png'),
+        File.new('spec/fixtures/empty.png')
+      ]
+
+      patterns.each do |p|
+        matcher = Middleman::WebP::PathnameMatcher.new(p)
+        files.each do |f|
+          matcher.matches?(f).must_equal false, "Pattern: #{p.inspect}, "\
+          "file: #{f.inspect}"
+        end
+      end
+    end
+
+    it 'defaults to pattern \'**/*\' and matches all when pattern is nil' do
+      paths = [
+        'something/anything.foo',
+        Pathname.new('images/another.png'),
+        'a/b/c/d/e/f/g'
+      ]
+
+      matcher = Middleman::WebP::PathnameMatcher.new
+      paths.each do |p|
+        matcher.matches?(p).must_equal true
+      end
+    end
+
+    it 'handles nil path gracefully and returns false' do
+      Middleman::WebP::PathnameMatcher.new('*.jpg').matches? nil
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-webp
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Juhamatti Niemelä
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -96,12 +97,18 @@ files:
 - lib/middleman-webp/converter.rb
 - lib/middleman-webp/extension.rb
 - lib/middleman-webp/options.rb
+- lib/middleman-webp/pathname_matcher.rb
 - lib/middleman-webp/version.rb
 - lib/middleman_extension.rb
 - middleman-webp.gemspec
+- spec/fixtures/directory/dummy.html
+- spec/fixtures/directory/empty.gif
+- spec/fixtures/empty.jpg
+- spec/fixtures/empty.png
 - spec/spec_helper.rb
 - spec/unit/converter_spec.rb
 - spec/unit/options_spec.rb
+- spec/unit/pathname_matcher_spec.rb
 homepage: http://github.com/iiska/middleman-webp
 licenses:
 - MIT
@@ -127,7 +134,12 @@ signing_key:
 specification_version: 4
 summary: WebP image conversion for Middleman
 test_files:
+- spec/fixtures/directory/dummy.html
+- spec/fixtures/directory/empty.gif
+- spec/fixtures/empty.jpg
+- spec/fixtures/empty.png
 - spec/spec_helper.rb
 - spec/unit/converter_spec.rb
 - spec/unit/options_spec.rb
+- spec/unit/pathname_matcher_spec.rb
 has_rdoc: