middleman-webp 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a85d2700cf9364e534f055579f87d593237b34a
-  data.tar.gz: 320a9b9b2b14031104370981d41445e8a879c336
+  metadata.gz: c6c244ea287e06cf4f880eedb451099a9c6d0a3b
+  data.tar.gz: 27292bb40349197fd0ba463e59338ded84a4d6c7
 SHA512:
-  metadata.gz: adccb7efe24726cbf0eec77d8c59ffec2304758ef36b3a79b0dede10312a6f28a81a20af58b7ee2161809c1193cc2e88e7015b3c8a15ff9a41c12ac39546b1ca
-  data.tar.gz: 46470f901990a55d8e69f9b6403c9ee9158c7c23de98660f626c25a7b01fb48529c6fa229c4d095fe096fa398224380c3b1d6f0814760db1681d97f776089aa6
+  metadata.gz: 5eb6489c649a50da9bb0eba4aafc7d64a347358d6e6014d21e6977526e4011e2c254927fbe4b54de40121f8d4465b69a3492d3c70e90af1adecbe416232a25f0
+  data.tar.gz: 3246a4a8f3f6e82d4d965a6f0f1d1ae910d9d61f7e365ea00dc3809e662073b69e7cc555eecdb944f215d84a5aba1a2cf48afb3d3d4b7aa28181ce1241291fc0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.0
+
+- Add new option: run_before_build with default value false (ie. default
+  behaviour will stay unchanged)
+
 ## 0.2.5
 
 - Fixes regression bug with extension config options

data/README.md

@@ -30,7 +30,7 @@ install those first for your system.
 
 - Fedora: ```yum install libwebp-tools```
 - Ubuntu: ```apt-get install webp```
-- OS X: ```brew install webp```
+- OS X: ```brew install webp --with-giflib```
 - Or install from the Google's WebP site:
   https://developers.google.com/speed/webp/download
 
@@ -48,6 +48,8 @@ And activate :webp extension in your config.rb:
 activate :webp
 ```
 
+## Options
+
 ### Custom conversion options
 
 Options for conversion are defined using
@@ -105,6 +107,30 @@ activate :webp do |webp|
 end
 ```
 
+### Working with asset_hash core extension
+
+When you use [asset_hash extension](https://middlemanapp.com/advanced/improving_cacheability/)
+you may want to change whether WebP image are converted before or after
+Middleman build, dependin on how you plan to serve/download them.
+
+Default behaviour is to generate WebP images after build, which will create
+identical filenames with different extension, preserving the original
+asset_cache hash. This works well if you are going to replace request content
+based on Accepts header while serving image files by [configuring .htaccess or something similar](#configuring-your-site-to-provide-webp-alternatives).
+
+However if you are going to determine used file type on client side and want to
+use [asset helpers](https://middlemanapp.com/basics/helper_methods/), it would
+be good idea to generate WebP versions before build allowing them to have their
+own asset hashes. In this case you probably want to generate WebP versions
+always even if they end up to be same size or larger than originals.
+
+``` ruby
+activate :webp do |webp|
+  webp.run_before_build = true
+  webp.allow_skip = false
+end
+```
+
 ## Configuring your site to provide WebP alternatives
 
 Configure web server to serve WebP images if they are available and
@@ -126,3 +152,4 @@ Look for [this example how to do it in .htaccess][htaccess].
 
 - [Johannes Schleifenbaum](https://github.com/jojosch)
 - [Ryan Townsend](https://github.com/ryantownsend)
+- [François VANTOMME](https://github.com/akarzim)

data/lib/middleman-webp/converter.rb

@@ -90,7 +90,8 @@ module Middleman
       end
 
       def image_files
-        all = ::Middleman::Util.all_files_under(@app.inst.build_dir)
+        app_dir = @app.inst.send(@options.run_before_build ? :source_dir : :build_dir)
+        all = ::Middleman::Util.all_files_under(app_dir)
         images = all.select { |p| p.to_s =~ SUFFIX_RE }
 
         # Reject files matching possible ignore patterns

data/lib/middleman-webp/extension.rb

@@ -13,13 +13,21 @@ module Middleman
     option(:verbose, false, 'Display all external command which are executed '\
            'to help debugging.')
     option(:allow_skip, true, 'Skip saving .webp files which are larger than their source')
+    option(:run_before_build, false, 'Run before build and save .webp files in source dir')
 
     def initialize(app, options_hash = {}, &block)
       super
       @app = app
     end
 
+    def before_build(builder)
+      return unless options[:run_before_build]
+      return unless dependencies_installed?(builder)
+      Middleman::WebP::Converter.new(@app, options, builder).convert
+    end
+
     def after_build(builder)
+      return if options[:run_before_build]
       return unless dependencies_installed?(builder)
       Middleman::WebP::Converter.new(@app, options, builder).convert
     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, :verbose, :append_extension, :allow_skip
+      attr_reader :ignore, :verbose, :append_extension, :allow_skip, :run_before_build
 
       def initialize(options = {})
         @ignore = options[:ignore] || []
@@ -21,6 +21,7 @@ module Middleman
 
         @append_extension = options[:append_extension] || false
         @allow_skip = !(false == options[:allow_skip])
+        @run_before_build = options[:run_before_build] || false
       end
 
       # Internal: Generate command line args for cwebp or gif2webp command
@@ -33,7 +34,7 @@ module Middleman
 
         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

data/lib/middleman-webp/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Webp
-    VERSION = '0.2.7'
+    VERSION = '0.3.0'
   end
 end

data/spec/integration/extension_spec.rb

@@ -5,9 +5,6 @@ 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
@@ -18,14 +15,84 @@ describe Middleman::WebPExtension do
     Dir.glob('spec/fixtures/ok-build/**/*.webp').each do |file|
       File.unlink(file)
     end
+    Dir.glob('spec/fixtures/ok-source/**/*.webp').each do |file|
+      File.unlink(file)
+    end
+  end
+
+  describe '#before_build' do
+    it 'does not generate WebP versions using external tools' do
+      app_mock = stub({
+                        initialized: '',
+                        instance_available: true,
+                        after_configuration: nil,
+                        before_build: nil,
+                        after_build: nil,
+                        inst: stub(source_dir: 'spec/fixtures/ok-source')
+                      })
+
+      @builder.expects(:say_status).never.with do |action, msg, opts|
+        action == :webp and msg =~ /Total conversion savings/
+      end
+
+      @builder.expects(:say_status).never.with do |action, msg, opts|
+        action == :run and msg =~ /cwebp/
+      end
+
+      @builder.expects(:say_status).never.with do |action, msg, opts|
+        action == :webp and msg =~ /\.webp \([0-9.]+ % smaller\)/
+      end
+
+      @extension = Middleman::WebPExtension.new(app_mock)
+      @extension.before_build(@builder)
+
+      Dir.glob('spec/fixtures/ok-source/**/*.webp').size.must_equal 0
+    end
+
+    it 'generates WebP versions using external tools when option is set' do
+      app_mock = stub({
+                        initialized: '',
+                        instance_available: true,
+                        after_configuration: nil,
+                        before_build: nil,
+                        after_build: nil,
+                        inst: stub(source_dir: 'spec/fixtures/ok-source')
+                      })
+
+      @builder.expects(:say_status).once.with do |action, msg, opts|
+        action == :webp and msg =~ /Total conversion savings/
+      end
+
+      @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) do |webp|
+        webp.run_before_build = true
+      end
+      @extension.before_build(@builder)
+
+      Dir.glob('spec/fixtures/ok-source/**/*.webp').size.must_equal 2
+    end
   end
 
   describe '#after_build' do
+    before do
+      @builder.expects(:say_status).once.with do |action, msg, opts|
+          action == :webp and msg =~ /Total conversion savings/
+        end
+    end
+
     it 'generates WebP versions using external tools' do
       app_mock = stub({
                         initialized: '',
                         instance_available: true,
                         after_configuration: nil,
+                        before_build: nil,
                         after_build: nil,
                         inst: stub(build_dir: 'spec/fixtures/ok-build')
                       })
@@ -49,6 +116,7 @@ describe Middleman::WebPExtension do
                         initialized: '',
                         instance_available: true,
                         after_configuration: nil,
+                        before_build: nil,
                         after_build: nil,
                         inst: stub(build_dir: 'spec/fixtures/dummy-build')
                       })
@@ -69,6 +137,7 @@ describe Middleman::WebPExtension do
                         initialized: '',
                         instance_available: true,
                         after_configuration: nil,
+                        before_build: nil,
                         after_build: nil,
                         inst: stub(build_dir: 'spec/fixtures/dummy-build')
                       })

data/spec/unit/extension_spec.rb

@@ -11,6 +11,7 @@ describe Middleman::WebPExtension do
                       initialized: '',
                       instance_available: true,
                       after_configuration: nil,
+                      before_build: nil,
                       after_build: nil
                     })
     @extension = Middleman::WebPExtension.new(app_mock)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-webp
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Juhamatti Niemelä
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -94,6 +94,8 @@ files:
 - spec/fixtures/dummy-build/empty.png
 - spec/fixtures/ok-build/lizard.jpg
 - spec/fixtures/ok-build/tux.png
+- spec/fixtures/ok-source/lizard.jpg
+- spec/fixtures/ok-source/tux.png
 - spec/integration/extension_spec.rb
 - spec/spec_helper.rb
 - spec/unit/converter_spec.rb
@@ -131,6 +133,8 @@ test_files:
 - spec/fixtures/dummy-build/empty.png
 - spec/fixtures/ok-build/lizard.jpg
 - spec/fixtures/ok-build/tux.png
+- spec/fixtures/ok-source/lizard.jpg
+- spec/fixtures/ok-source/tux.png
 - spec/integration/extension_spec.rb
 - spec/spec_helper.rb
 - spec/unit/converter_spec.rb