middleman-webp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b5539b4deb99703757270b7eb31b09a2df36dc3
+  data.tar.gz: 543c15a9fa93979d4735f3a6a624fee39b2835d0
+SHA512:
+  metadata.gz: b418a6a0a9d5a2940eceb16ebbb3e8676efee855b0003aebbaf77e4acaee57b52b12d3422608f4e92baeda527b22eb0bb33d6f26b668ae6dbe7e5a3d25e40c45
+  data.tar.gz: 2f647b1338f867fc5d3b0b1251013db33c7003e2bff2d7665c7dbe3d2c8c6aa9317e2eccf8effc30296bd76d470af28b422d8920925c89e8ed0f8eac759af9cb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-webp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Juhamatti Niemelä
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Middleman::Webp
+
+This is [Middleman][middleman] extension that generates WebP versions
+of each image used in site during build.
+
+WebP is image format developed by Google and it usually generates
+smaller files than regular jpeg or png formats.
+
+Browser's supporting WebP will include Accepts header to the image
+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.
+
+[middleman]: http://middlemanapp.com
+
+## Installation
+
+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
+
+Add this line to your Middleman site's Gemfile:
+
+    gem 'middleman-webp'
+
+And then execute:
+
+    $ bundle
+
+And activate :webp extension in your config.rb:
+
+``` ruby
+activate :webp
+```
+
+## Configuring your site to provide WebP alternatives
+
+TODO: Write about .htaccess aproach
+
+TODO: Write about Modernizr
+
+
+## Contributing
+
+1. Fork it ( http://github.com/iiska/middleman-webp/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList["spec/spec_helper.rb", "spec/**/*_spec.rb"]
+end

data/lib/middleman-webp.rb

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

data/lib/middleman-webp/converter.rb

@@ -0,0 +1,72 @@
+module Middleman
+  module WebP
+
+    class Converter
+
+      def initialize(app, builder)
+        @app = app
+        @builder = builder
+      end
+
+      def convert
+        @total = 0
+        convert_images(image_files) do |src, dst|
+          next reject_file(dst) if dst.size >= src.size
+
+          @total += (src.size - dst.size)
+          @builder.say_status :webp, "#{dst.path} (#{change_percentage(src,dst)} smaller)"
+        end
+        @builder.say_status(:webp, "Total conversion savings: #{number_to_human_size(@total)}", :blue)
+      end
+
+      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
+          yield File.new(p), File.new(dst)
+        end
+      end
+
+      def run_cwebp(src, dst)
+        system("cwebp -quiet #{src} -o #{dst}")
+      end
+
+      def run_gif2webp(src, dst)
+        system("gif2webp -quiet #{src} -o #{dst}")
+      end
+
+      def reject_file(file)
+        @builder.say_status :webp, "#{file.path} skipped", :yellow
+        File.unlink(file)
+      end
+
+      # Calculate change percentage of converted file size
+      #
+      # 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]
+      end
+
+      def destination_path(src_path)
+        dst_name = src_path.basename.to_s.gsub(/(jpe?g|png|tiff?|gif)$/, "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 }
+      end
+
+      def number_to_human_size(n)
+        units = %w{B KiB MiB GiB TiB PiB}
+        exponent = (Math.log(n) / Math.log(1024)).to_i
+        "%g #{units[exponent]}" % ("%.2f" % (n.to_f / 1024**exponent))
+      end
+    end
+  end
+end

data/lib/middleman-webp/extension.rb

@@ -0,0 +1,14 @@
+require "middleman-core"
+require "middleman-webp/converter"
+
+module Middleman
+  class WebPExtension < Extension
+    def initialize(app, options, &block)
+      super
+
+      app.after_build do |builder|
+        Middleman::WebP::Converter.new(app, builder).convert
+      end
+    end
+  end
+end

data/lib/middleman-webp/version.rb

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

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-webp"

data/middleman-webp.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-webp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-webp"
+  spec.version       = Middleman::Webp::VERSION
+  spec.authors       = ["Juhamatti Niemelä"]
+  spec.email         = ["iiska@iki.fi"]
+  spec.summary       = %q{WebP image conversion for Middleman}
+  spec.description   = %q{Generate WebP versions of each image used in Middleman site during build.}
+  spec.homepage      = "http://github.com/iiska/middleman-webp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "middleman-core", "~> 3.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+
+require 'simplecov'
+SimpleCov.start

data/spec/unit/converter_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+require_relative "../../lib/middleman-webp/converter"
+
+describe Middleman::WebP::Converter do
+  before do
+    @converter = Middleman::WebP::Converter.new(nil, nil)
+  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"
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: middleman-webp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juhamatti Niemelä
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-15 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'
+description: Generate WebP versions of each image used in Middleman site during build.
+email:
+- iiska@iki.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/middleman-webp.rb
+- lib/middleman-webp/converter.rb
+- lib/middleman-webp/extension.rb
+- lib/middleman-webp/version.rb
+- lib/middleman_extension.rb
+- middleman-webp.gemspec
+- spec/spec_helper.rb
+- spec/unit/converter_spec.rb
+homepage: http://github.com/iiska/middleman-webp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: WebP image conversion for Middleman
+test_files:
+- spec/spec_helper.rb
+- spec/unit/converter_spec.rb