middleman-webp 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b5539b4deb99703757270b7eb31b09a2df36dc3
-  data.tar.gz: 543c15a9fa93979d4735f3a6a624fee39b2835d0
+  metadata.gz: ee8dc469ed517f77130ab6e9e9bcce14553fe30b
+  data.tar.gz: 5e4b7f341b270b426ec5ff840a978b2de819919e
 SHA512:
-  metadata.gz: b418a6a0a9d5a2940eceb16ebbb3e8676efee855b0003aebbaf77e4acaee57b52b12d3422608f4e92baeda527b22eb0bb33d6f26b668ae6dbe7e5a3d25e40c45
-  data.tar.gz: 2f647b1338f867fc5d3b0b1251013db33c7003e2bff2d7665c7dbe3d2c8c6aa9317e2eccf8effc30296bd76d470af28b422d8920925c89e8ed0f8eac759af9cb
+  metadata.gz: 38398c88e7565d7c8c53ff9cd6f230d7565087ced45bf910cfd04841cdffc3cc0a07446eb867402f7d3a7ec712992bb1b9bf96671bac5c03cb54fe7fb86ebaa5
+  data.tar.gz: a19c29547c2c7b4dd8f0e86cc728f22f6f7ffd451b41ad9be017452144f15103efc3ef9e43005a6cbf41803f223b5ce45f8c06055f83027312426a97410ac536

data/README.md

@@ -11,7 +11,12 @@ file requests so you can refer to jpegs or pngs in your HTML and use
 for example .htaccess configuration to provide smaller alternatives
 for browser's supporting WebP.
 
+See my blog post
+["Introducing WebP extension for Middleman"][blog-post] for more
+details why I think using WebP matters.
+
 [middleman]: http://middlemanapp.com
+[blog-post]: http://byteplumbing.net/2014/03/introducing-webp-extension-for-middleman/
 
 ## Installation
 
@@ -36,12 +41,28 @@ And activate :webp extension in your config.rb:
 activate :webp
 ```
 
+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:
+
+``` ruby
+activate :webp do |webp|
+  webp.conversion_options = {
+    "icons/*.png" => {lossless: true},
+    "photos/**/*.jpg" => {q: 100}
+  }
+end
+```
+
 ## Configuring your site to provide WebP alternatives
 
-TODO: Write about .htaccess aproach
+Configure web server to serve WebP images if they are available and
+browser has set the HTTP Accept header.
 
-TODO: Write about Modernizr
+Look for [this example how to do it in .htaccess][htaccess].
 
+[htaccess]: https://github.com/vincentorback/WebP-images-with-htaccess
 
 ## Contributing
 

data/lib/middleman-webp/converter.rb

@@ -1,10 +1,13 @@
+require "middleman-webp/options"
+
 module Middleman
   module WebP
 
     class Converter
 
-      def initialize(app, builder)
+      def initialize(app, options={}, builder)
         @app = app
+        @options = Middleman::WebP::Options.new(options)
         @builder = builder
       end
 
@@ -22,21 +25,20 @@ module Middleman
       def convert_images(paths, &after_conversion)
         paths.each do |p|
           dst = destination_path(p)
-          if p.to_s =~ /gif$/i
-            run_gif2webp(p, dst)
-          else
-            run_cwebp(p, dst)
-          end
+          exec_convert_tool(p, dst)
           yield File.new(p), File.new(dst)
         end
       end
 
-      def run_cwebp(src, dst)
-        system("cwebp -quiet #{src} -o #{dst}")
+      def exec_convert_tool(src, dst)
+        system("#{tool_for(src)} #{@options.for(src)} -quiet #{src} -o #{dst}")
       end
 
-      def run_gif2webp(src, dst)
-        system("gif2webp -quiet #{src} -o #{dst}")
+      # Internal: Return proper tool command based on file type
+      #
+      # file - Filename
+      def tool_for(file)
+        file.to_s =~ /gif$/i ? "gif2webp" : "cwebp"
       end
 
       def reject_file(file)
@@ -49,7 +51,7 @@ module Middleman
       # src - File instance of the source
       # dst - File instance of the destination
       def change_percentage(src, dst)
-        "%.2f%%" % [100 - 100.0 * dst.size / src.size]
+        "%g %%" % ("%.2f" % [100 - 100.0 * dst.size / src.size])
       end
 
       def destination_path(src_path)

data/lib/middleman-webp/extension.rb

@@ -3,11 +3,14 @@ require "middleman-webp/converter"
 
 module Middleman
   class WebPExtension < Extension
-    def initialize(app, options, &block)
+    option :conversion_options, {}, "Custom conversion options for cwebp/gif2webp"
+
+    def initialize(app, options_hash={}, &block)
       super
 
+      args = options.conversion_options
       app.after_build do |builder|
-        Middleman::WebP::Converter.new(app, builder).convert
+        Middleman::WebP::Converter.new(app, args, builder).convert
       end
     end
   end

data/lib/middleman-webp/options.rb

@@ -0,0 +1,40 @@
+module Middleman
+  module WebP
+
+    class Options
+
+      def initialize(options={})
+        @options = options.inject(Hash.new("")) do |h,(k,v)|
+          h[k] = to_args(v); h
+        end
+      end
+
+      # Internal: Generate command line args for cwebp or gif2webp command
+      #
+      # Find options defined for given file. Selects all options whose
+      # 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)}
+
+        return "" if matching.empty?
+
+        matching.sort {|(ga,oa),(gb,ob)| gb.size <=> ga.size}[0][1]
+      end
+
+      private
+
+      def to_args(options)
+        options.map do |k,v|
+          if v == true
+            "-#{k}"
+          elsif v != false
+            "-#{k} #{v}"
+          end
+        end.join(" ").gsub(/ +/, " ")
+      end
+
+    end
+
+  end
+end

data/lib/middleman-webp/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Webp
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/middleman-webp.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "mocha"
 end

data/spec/spec_helper.rb

@@ -1,4 +1,7 @@
 require 'minitest/autorun'
+require 'mocha/mini_test'
 
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/spec/unit/converter_spec.rb

@@ -1,9 +1,24 @@
 require "spec_helper"
+require "pathname"
 require_relative "../../lib/middleman-webp/converter"
 
 describe Middleman::WebP::Converter do
   before do
-    @converter = Middleman::WebP::Converter.new(nil, nil)
+    @converter = Middleman::WebP::Converter.new(nil, {}, nil)
+  end
+
+  describe "#change_percentage" do
+    it "returns how many percents smaller destination file is" do
+      src = stub(:size => 10000)
+      dst = stub(:size => 8746)
+      @converter.change_percentage(src, dst).must_equal "12.54 %"
+    end
+
+    it "omits zeroes in the end of decimal part" do
+      src = stub(:size => 100)
+      dst = stub(:size => 76)
+      @converter.change_percentage(src, dst).must_equal "24 %"
+    end
   end
 
   describe "#number_to_human_size" do
@@ -13,4 +28,20 @@ describe Middleman::WebP::Converter do
       @converter.number_to_human_size(2_634_234).must_equal "2.51 MiB"
     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"
+    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
 end

data/spec/unit/options_spec.rb

@@ -0,0 +1,23 @@
+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})
+
+      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")
+      options = Middleman::WebP::Options.new
+
+      args = options.for(path)
+      args.must_be_empty
+    end
+  end
+end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: middleman-webp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Juhamatti Niemelä
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-15 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Generate WebP versions of each image used in Middleman site during build.
@@ -73,7 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -81,11 +95,13 @@ files:
 - lib/middleman-webp.rb
 - lib/middleman-webp/converter.rb
 - lib/middleman-webp/extension.rb
+- lib/middleman-webp/options.rb
 - lib/middleman-webp/version.rb
 - lib/middleman_extension.rb
 - middleman-webp.gemspec
 - spec/spec_helper.rb
 - spec/unit/converter_spec.rb
+- spec/unit/options_spec.rb
 homepage: http://github.com/iiska/middleman-webp
 licenses:
 - MIT
@@ -96,20 +112,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: WebP image conversion for Middleman
 test_files:
 - spec/spec_helper.rb
 - spec/unit/converter_spec.rb
+- spec/unit/options_spec.rb
+has_rdoc: