middleman-webp 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32038f04df33f853d0ee464e25be360591fafc0b
-  data.tar.gz: 4c0d0e4778cd4d3590ffb533d951d07bed2e0d3c
+  metadata.gz: 8edf6cefbf5002fdad1decc34a8478c36b84046f
+  data.tar.gz: 34d574375a04fcda5e7aa035288a9039aa0c414b
 SHA512:
-  metadata.gz: 32b535871eb54586de7e7482a6e3fce5242f921406038ea31de62a91a3ab648442ce3a6f603a7430456acac6aa8c963cadbca99313137fb3d913fa142151cd69
-  data.tar.gz: a1383ba546688e462dca0b63d269996ab3077b21345866c72633a0e1327f805e606419370459b32ef8fa3b957d3912a0e3123a38230fef8950f1a5a0815290ee
+  metadata.gz: 9b78739e99e432f9d6fd2c01bf9d3db6bbe52534147d6511b109eba7eb4813386160c779d37e73eaa06d598c6a4add837916d7bde870720e1515ca580cdb3c88
+  data.tar.gz: 7a43165a4724e126b44b14e8937f1c2ac247d003e36d7040a1a4c1c5342f0fb8088db5015f1b61b77066b6b9e4afc498009e9f344744d40a4dc42585dd53a20e

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+script: bundle exec rake test
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install webp

data/CHANGELOG.md

@@ -4,5 +4,9 @@
 
 ## 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
+- Add ```ignore``` option similar to the one in the [asset_hash extension](http://middlemanapp.com/advanced/improving-cacheability/#uniquely-named-assets)
+- Allow using Regexp to match files for custom conversion options
+
+## 0.1.0
+
+- First release

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in middleman-webp.gemspec
 gemspec
+
+gem 'coveralls', require: false, group: :test
+gem 'simplecov', '~> 0.7.1', require: false, group: :test

data/README.md

@@ -1,5 +1,10 @@
 # Middleman::Webp
 
+[![Gem Version](https://badge.fury.io/rb/middleman-webp.svg)](http://badge.fury.io/rb/middleman-webp)
+[![Build Status](https://travis-ci.org/iiska/middleman-webp.svg?branch=master)](https://travis-ci.org/iiska/middleman-webp)
+[![Coverage Status](https://img.shields.io/coveralls/iiska/middleman-webp.svg)](https://coveralls.io/r/iiska/middleman-webp?branch=master)
+[![Dependency Status](https://gemnasium.com/iiska/middleman-webp.svg)](https://gemnasium.com/iiska/middleman-webp)
+
 This is [Middleman][middleman] extension that generates WebP versions
 of each image used in site during build.
 
@@ -23,9 +28,11 @@ details why I think using WebP matters.
 Middleman-webp depends on cwep and gif2webp commandline tools, so
 install those first for your system.
 
-- Fedora: yum install libwebp-tools
-- Ubuntu: apt-get install webp
-- OS X: brew install webp
+- Fedora: ```yum install libwebp-tools```
+- Ubuntu: ```apt-get install webp```
+- OS X: ```brew install webp```
+- Or install from the Google's WebP site:
+  https://developers.google.com/speed/webp/download
 
 Add this line to your Middleman site's Gemfile:
 
@@ -73,6 +80,17 @@ end
 Ignore option accepts one or an array of String globs, Regexps or
 Procs.
 
+### Append the .webp extension instead of replacing the original extension
+
+If you want the output images to be named **sample.png.webp**
+instead of **sample.webp**, set the option `append_extension` to true.
+
+``` ruby
+activate :webp do |webp|
+  webp.append_extension = true
+end
+```
+
 
 ## Configuring your site to provide WebP alternatives
 
@@ -90,3 +108,7 @@ Look for [this example how to do it in .htaccess][htaccess].
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Contributors
+
+- [Johannes Schleifenbaum](https://github.com/jojosch)

data/lib/middleman-webp/converter.rb

@@ -38,7 +38,8 @@ module Middleman
       end
 
       def exec_convert_tool(src, dst)
-        system("#{tool_for(src)} #{@options.for(src)} -quiet #{src} -o #{dst}")
+        cmd = "#{tool_for(src)} #{@options.for(src)} -quiet #{src} -o #{dst}"
+        @builder.run cmd, verbose: @options.verbose, capture: true
       end
 
       # Internal: Return proper tool command based on file type
@@ -78,7 +79,11 @@ module Middleman
       end
 
       def destination_path(src_path)
-        dst_name = src_path.basename.to_s.gsub(SUFFIX_RE, 'webp')
+        if @options.append_extension
+          dst_name = "#{src_path.basename.to_s}.webp"
+        else
+          dst_name = src_path.basename.to_s.gsub(SUFFIX_RE, 'webp')
+        end
         src_path.parent.join(dst_name)
       end
 

data/lib/middleman-webp/extension.rb

@@ -1,18 +1,45 @@
 require 'middleman-core'
 require 'middleman-webp/converter'
 
+require 'shell'
+
 module Middleman
   class WebPExtension < Extension
     option(:conversion_options, {},
            'Custom conversion options for cwebp/gif2webp')
+    option(:append_extension, false,
+           'keep the original filename and extension and append .webp (image.png => image.png.webp)')
     option(:ignore, [], 'Ignores files with matching paths')
+    option(:verbose, false, 'Display all external command which are executed '\
+           'to help debugging.')
+
     def initialize(app, options_hash = {}, &block)
       super
+      @app = app
+    end
 
-      configuration = options
+    def after_build(builder)
+      return unless dependencies_installed?(builder)
+      Middleman::WebP::Converter.new(@app, options, builder).convert
+    end
+
+    # Internal: Check that cwebp and gif2webp commandline tools are available.
+    #
+    # Returns true if all is OK.
+    def dependencies_installed?(builder)
+      sh = Shell.new
+
+      begin
+        sh.find_system_command('gif2webp')
+      rescue Shell::Error::CommandNotFound => e
+        builder.say_status :webp, "#{e.message} Please install latest version of webp library and tools to get gif2webp and be able to convert gif files also.", :red
+      end
 
-      app.after_build do |builder|
-        Middleman::WebP::Converter.new(app, configuration, builder).convert
+      begin
+        true if sh.find_system_command('cwebp')
+      rescue Shell::Error::CommandNotFound => e
+        builder.say_status :webp, "ERROR: #{e.message} Please install cwebp and gif2webp commandline tools first.", :red
+        false
       end
     end
   end

data/lib/middleman-webp/options.rb

@@ -3,7 +3,7 @@ require 'middleman-webp/pathname_matcher'
 module Middleman
   module WebP
     class Options
-      attr_reader :ignore
+      attr_reader :ignore, :verbose, :append_extension
 
       def initialize(options = {})
         @ignore = options[:ignore] || []
@@ -16,6 +16,10 @@ module Middleman
           h[Middleman::WebP::PathnameMatcher.new(k)] = to_args(v)
           h
         end
+
+        @verbose = options[:verbose] || false
+
+        @append_extension = options[:append_extension] || false
       end
 
       # Internal: Generate command line args for cwebp or gif2webp command

data/lib/middleman-webp/pathname_matcher.rb

@@ -15,7 +15,7 @@ module Middleman
       def matches?(path)
         return false if path.nil?
 
-        send match_method, path
+        send match_method, Pathname.new(path)
       end
 
       private
@@ -32,15 +32,15 @@ module Middleman
       end
 
       def matches_glob?(path)
-        Pathname.new(path).fnmatch?(@pattern)
+        path.fnmatch?(@pattern)
       end
 
       def matches_re?(path)
-        !@pattern.match(Pathname.new(path).to_s).nil?
+        !@pattern.match(path.to_s).nil?
       end
 
       def matches_proc?(path)
-        @pattern.call(Pathname.new(path).to_s)
+        @pattern.call(path.to_s)
       end
     end
   end

data/lib/middleman-webp/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Webp
-    VERSION = '0.2.5'
+    VERSION = '0.2.6'
   end
 end

data/middleman-webp.gemspec

@@ -22,6 +22,6 @@ 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 "simplecov"
   spec.add_development_dependency "mocha"
 end

data/spec/integration/extension_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'middleman-core/cli'
+require_relative '../../lib/middleman-webp/extension'
+
+describe Middleman::WebPExtension do
+  before do
+    @builder = Middleman::Cli::Build.new
+    @builder.expects(:say_status).once.with do |action, msg, opts|
+        action == :webp and msg =~ /Total conversion savings/
+      end
+    @builder.stubs(:say_status).with do |action, msg, opts|
+      action == :webp and msg =~ /Please install latest version of webp/
+    end
+  end
+
+  after do
+    # Remove temporarily created files
+    Dir.glob('spec/fixtures/ok-build/**/*.webp').each do |file|
+      File.unlink(file)
+    end
+  end
+
+  describe '#after_build' do
+    it 'generates WebP versions using external tools' do
+      app_mock = stub({
+                        initialized: '',
+                        instance_available: true,
+                        after_configuration: nil,
+                        after_build: nil,
+                        inst: stub(build_dir: 'spec/fixtures/ok-build')
+                      })
+
+      @builder.expects(:say_status).twice.with do |action, msg, opts|
+        action == :run and msg =~ /cwebp/
+      end
+
+      @builder.expects(:say_status).twice.with do |action, msg, opts|
+        action == :webp and msg =~ /\.webp \([0-9.]+ % smaller\)/
+      end
+
+      @extension = Middleman::WebPExtension.new(app_mock)
+      @extension.after_build(@builder)
+
+      Dir.glob('spec/fixtures/ok-build/**/*.webp').size.must_equal 2
+    end
+
+    it 'shows errors if files couldn\'t be converted' do
+      app_mock = stub({
+                        initialized: '',
+                        instance_available: true,
+                        after_configuration: nil,
+                        after_build: nil,
+                        inst: stub(build_dir: 'spec/fixtures/dummy-build')
+                      })
+
+      Middleman::WebP::Converter.any_instance.
+        expects(:exec_convert_tool).times(3)
+
+      @builder.expects(:say_status).times(3).with do |action, msg, opts|
+        msg =~ /Converting .*empty\.(jpg|gif|png) failed/
+      end
+
+      @extension = Middleman::WebPExtension.new(app_mock)
+      @extension.after_build(@builder)
+    end
+
+    it 'rejects file if it is larger than original' do
+      app_mock = stub({
+                        initialized: '',
+                        instance_available: true,
+                        after_configuration: nil,
+                        after_build: nil,
+                        inst: stub(build_dir: 'spec/fixtures/dummy-build')
+                      })
+
+      Middleman::WebP::Converter.any_instance.
+        expects(:exec_convert_tool).times(3).with do |src, dst|
+        if dst.to_s =~ /spec\/fixtures\/dummy-build\/.*webp$/
+          File.open(dst, 'w') do |f|
+            f << 'Making it larger than empty dummy original'
+          end
+          true
+        else
+          false
+        end
+      end
+
+      @builder.expects(:say_status).times(3).with do |action, msg, opts|
+        action == :webp and msg =~ /.*empty.webp skipped/
+      end
+
+      @extension = Middleman::WebPExtension.new(app_mock)
+      @extension.after_build(@builder)
+
+      Dir.glob('spec/fixtures/dummy-build/**/*.webp').size.must_equal 0
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,7 +1,13 @@
-require 'minitest/autorun'
-require 'mocha/mini_test'
-
 require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 SimpleCov.start do
   add_filter '/spec/'
 end
+
+require 'minitest/autorun'
+require 'mocha/mini_test'

data/spec/unit/converter_spec.rb

@@ -5,7 +5,7 @@ require_relative '../../lib/middleman-webp/converter'
 
 describe Middleman::WebP::Converter do
   before do
-    @app_mock = stub(inst: stub(build_dir: 'spec/fixtures'))
+    @app_mock = stub(inst: stub(build_dir: 'spec/fixtures/dummy-build'))
     @converter = Middleman::WebP::Converter.new(@app_mock, {}, nil)
   end
 
@@ -16,6 +16,17 @@ describe Middleman::WebP::Converter do
     end
   end
 
+  describe '#destination_path with append_extension = true' do
+    before do
+      @converter = Middleman::WebP::Converter.new(@app_mock, {append_extension: true}, nil)
+    end
+
+    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.jpg.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 %'
@@ -68,7 +79,7 @@ describe Middleman::WebP::Converter do
                                                     ignore: [/jpg$/, '**/*.gif']
                                                   }, nil)
 
-      files_to_include = [Pathname.new('spec/fixtures/empty.png')]
+      files_to_include = [Pathname.new('spec/fixtures/dummy-build/empty.png')]
       @converter.image_files.must_equal files_to_include
     end
 

data/spec/unit/extension_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+#require 'pathname'
+#require 'middleman-core'
+require_relative '../../lib/middleman-webp/extension'
+
+describe Middleman::WebPExtension do
+
+  before do
+    #Middleman::Extension.any_instance.expects(:initialize).returns(true)
+    app_mock = stub({
+                      initialized: '',
+                      instance_available: true,
+                      after_configuration: nil,
+                      after_build: nil
+                    })
+    @extension = Middleman::WebPExtension.new(app_mock)
+  end
+
+  describe '#dependencies_installed?' do
+    it 'returns true if required command line tools are found' do
+      Shell.any_instance.expects(:find_system_command).with('cwebp').returns('/usr/bin/cwebp')
+      Shell.any_instance.expects(:find_system_command).with('gif2webp').returns('/usr/bin/gif2webp')
+
+      @extension.dependencies_installed?(stub(say_status: '')).must_equal true
+    end
+
+    it 'returns false and displays error if cwebp is missing' do
+      Shell.any_instance.expects(:find_system_command).with('cwebp').raises(Shell::Error::CommandNotFound)
+      Shell.any_instance.stubs(:find_system_command).with('gif2webp').returns('/usr/bin/gif2webp')
+
+      builder_mock = stub(:say_status)
+      builder_mock.stubs(:say_status).once
+
+      @extension.dependencies_installed?(builder_mock).must_equal false
+    end
+
+    it 'displays error if only gif2webp is missing and returns still true' do
+      Shell.any_instance.expects(:find_system_command).with('gif2webp').raises(Shell::Error::CommandNotFound)
+      Shell.any_instance.stubs(:find_system_command).with('cwebp').returns('/usr/bin/cwebp')
+
+      builder_mock = stub(:say_status)
+      builder_mock.stubs(:say_status).once
+
+      @extension.dependencies_installed?(builder_mock).must_equal true
+    end
+  end
+
+end

data/spec/unit/pathname_matcher_spec.rb

@@ -9,7 +9,7 @@ describe Middleman::WebP::PathnameMatcher do
       files = [
         'images/sample.jpg',
         Pathname.new('images/another.jpg'),
-        File.new('spec/fixtures/empty.jpg')
+        File.new('spec/fixtures/dummy-build/empty.jpg')
       ]
 
       patterns.each do |p|
@@ -26,7 +26,7 @@ describe Middleman::WebP::PathnameMatcher do
       files = [
         'images/sample.png',
         Pathname.new('images/another.png'),
-        File.new('spec/fixtures/empty.png')
+        File.new('spec/fixtures/dummy-build/empty.png')
       ]
 
       patterns.each do |p|

metadata

@@ -1,83 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: middleman-webp
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Juhamatti Niemelä
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-09-07 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.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.2
 - !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.
@@ -87,7 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -101,12 +88,16 @@ files:
 - 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/fixtures/dummy-build/directory/dummy.html
+- spec/fixtures/dummy-build/directory/empty.gif
+- spec/fixtures/dummy-build/empty.jpg
+- spec/fixtures/dummy-build/empty.png
+- spec/fixtures/ok-build/lizard.jpg
+- spec/fixtures/ok-build/tux.png
+- spec/integration/extension_spec.rb
 - spec/spec_helper.rb
 - spec/unit/converter_spec.rb
+- spec/unit/extension_spec.rb
 - spec/unit/options_spec.rb
 - spec/unit/pathname_matcher_spec.rb
 homepage: http://github.com/iiska/middleman-webp
@@ -119,27 +110,31 @@ 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.0.14
+rubygems_version: 2.2.2
 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/fixtures/dummy-build/directory/dummy.html
+- spec/fixtures/dummy-build/directory/empty.gif
+- spec/fixtures/dummy-build/empty.jpg
+- spec/fixtures/dummy-build/empty.png
+- spec/fixtures/ok-build/lizard.jpg
+- spec/fixtures/ok-build/tux.png
+- spec/integration/extension_spec.rb
 - spec/spec_helper.rb
 - spec/unit/converter_spec.rb
+- spec/unit/extension_spec.rb
 - spec/unit/options_spec.rb
 - spec/unit/pathname_matcher_spec.rb
 has_rdoc: