sprockets-webp-exporter 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d2b364531e65037a1359bcef8d22316de697cb9ed6fe13b4f16880b809c7cf2
+  data.tar.gz: c0a61581b97f3a19c537a1b00ba69a8dc777da2373ab2ff7368f2a51820ad5c5
+SHA512:
+  metadata.gz: e2e680319385f4a3c0746eea3a802e59d01efa538968e767d2a7519e37e0b0cf00a4a222fb520671629fd85699a83bd6e4a1087de76264118dc1496b1d5d8216
+  data.tar.gz: aa06849b72d16cf26cf27c4d402d6623d6bf5ffdfaf5050a7cb7de93c19ad2c0c08f135c3e9ac533b8b89c9cc5bb18565d3cc463a30c11c3cdfbd5393fccecc4

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in sprockets-webp-exporter.gemspec
+gemspec
+
+gem 'sprockets', '>= 4.0.0.beta8', github: 'rails/sprockets'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Max Riveiro
+
+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,137 @@
+# Sprockets::WebP
+
+[![unstable](https://rawgithub.com/hughsk/stability-badges/master/dist/unstable.svg)](http://github.com/hughsk/stability-badges)
+
+[![Gem Version](https://badge.fury.io/rb/sprockets-webp.png)](http://badge.fury.io/rb/sprockets-webp)
+[![Code Climate](https://codeclimate.com/github/alsemyonov/sprockets-webp-exporter.png)](https://codeclimate.com/github/alsemyonov/sprockets-webp-exporter)
+[![Dependency Status](https://gemnasium.com/alsemyonov/sprockets-webp-exporter.png)](https://gemnasium.com/alsemyonov/sprockets-webp-exporter)
+[![Still Maintained](http://stillmaintained.com/alsemyonov/sprockets-webp-exporter.png)](http://stillmaintained.com/alsemyonov/sprockets-webp-exporter)
+
+[![Coderwall](https://api.coderwall.com/alsemyonov/endorsecount.png)](https://coderwall.com/alsemyonov)
+
+**Warning**: This gem depends on Sprockets 4 (that is in beta right now), because of using new `#register_exporter`.
+There is no guarantee for stable API until `sprockets-4.0.0` and `sprockets-webp-exporter-1.0.0` released.
+
+_Big thanks to [Max Riveiro](https://github.com/kavu) for his [sprockets-webp](https://github.com/kavu/sprockets-webp) 
+gem that worked with previous versions of Sprockets, but is not working now. I hope we could merge our gems in future._
+
+This gem provides a WebP Exporter for converting PNG and JPEG assets to the WebP format using Sprockets 4.
+
+## Requirements
+
+The main requirement is obviously [libwebp](https://developers.google.com/speed/webp/) itself. Please, consult the [webp-ffi](https://github.com/le0pard/webp-ffi) README for the installation instructions.
+
+## Installation
+
+### Rails 5
+
+If you're using Rails 5 you need to add gem to the ```:production``` group in to your application's Gemfile:
+
+```ruby
+group :production do
+  # ...
+  gem 'sprockets-webp-exporter'
+  # ...
+end
+```
+
+## Configuration
+
+You can configure encode options for webp by using `encode_options` (in example default options):
+
+```ruby
+Sprockets::WebP.encode_options = { quality: 100, lossless: 1, method: 6, alpha_filtering: 2, alpha_compression: 0, alpha_quality: 100 }
+```
+
+More options you can find in [web-ffi readme](https://github.com/le0pard/webp-ffi#encode-webp-image).
+
+## Testing
+
+Drop some PNGs and JPGs into ```app/assets/images``` and you can test converter locally with the Rake task:
+
+```bash
+bundle exec rake assets:precompile RAILS_ENV=production
+```
+
+## Web Server
+
+As not all browsers support ``webp`` images (see [Can I Use](http://caniuse.com/webp)), so they need to be served conditionally based on the HTTP ``Accept`` header sent by browsers capable to display this format.
+
+### Nginx
+
+Here is a simple [nginx](http://nginx.org) recipe, which contrary to popular beliefs, do not require ``if`` nor ``rewrite``, instead use lightweight ``map`` and ``try_files``
+
+```nginx
+http {
+  # IMPORTANT!!! Make sure that mime.types below lists WebP like that:
+  # image/webp webp;
+  include /etc/nginx/mime.types;
+
+  ##
+  # Is webp supported?
+  # (needs to be part of http section)
+  ##
+
+  map $http_accept $webp_suffix {
+    default   "";
+    "~*webp"  ".webp";
+  }
+
+  ##
+  # Server
+  ##
+
+  server {
+    location ~* ^/images/.+\.(png|jpg)$ {
+      if ($webp_suffix != "") {
+        add_header Vary Accept;
+      }
+
+      try_files $uri$webp_suffix $uri =404;
+    }
+  }
+}
+```
+
+Make sure that webp is defined in `mime.types` file:
+
+```nginx
+image/webp  webp;
+```
+
+## CDN
+
+If you serve your assets using CDN, you need to make sure that it forwards `Accept` header allowing to conditionally choose webp for browsers which support it.
+
+### Amazon AWS CloudFront
+
+Following solution would not work if your CloudFront distribution points to S3. Instead it should point to your webserver, which will host the webp serving logic.
+
+Take following steps to enable `Accept` header forwarding:
+
+* visit your CloudFront distributions page
+* select distribution
+* choose `Behaviors` tab
+* select behaviourrepresenting your assets end hit `Edit`
+* select `Whitelist` for the `Forward Headers` option
+* add `Accept` to the list on the right
+* approve your changes clicking `Yes, Edit`
+* wait until refreshed distribution will be deployed
+
+Test with:
+
+```
+curl -I -H "Accept: image/webp" http://yourdomain.com/yourimage.png
+curl -I http://yourdomain.com/yourimage.png
+```
+
+Returned `Content-Type` should be `image/webp` in the first case and `image/png` in the second.
+
+
+## Contributing
+
+1. Fork it
+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 @@
+require 'bundler/gem_tasks'

data/lib/sprockets/exporters/webp_exporter.rb

@@ -0,0 +1,27 @@
+require 'sprockets/exporters/base'
+require 'webp-ffi'
+
+module Sprockets
+  module Exporters
+    # Generates a `.webp` file using the webp-ffi
+    class WebpExporter < Exporters::Base
+      def setup
+        @webp_target = "#{ target }.webp"
+      end
+
+      def skip?(logger)
+        if ::File.exist?(@webp_target)
+          logger.debug "Skipping #{ @webp_target }, already exists"
+          true
+        else
+          logger.info "Writing #{ @webp_target }"
+          false
+        end
+      end
+
+      def call
+        ::WebP.encode(target, @webp_target, Sprockets::WebP.encode_options)
+      end
+    end
+  end
+end

data/lib/sprockets/webp/railtie.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'sprockets/exporters/webp_exporter'
+
+module Sprockets
+  module WebP
+    class Railtie < ::Rails::Railtie
+      initializer :webp, group: :all do |app|
+        app.config.assets.configure do |env|
+          env.register_exporter 'image/jpeg', Exporters::WebpExporter
+          env.register_exporter 'image/png', Exporters::WebpExporter
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/webp/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module Sprockets
+  module WebP
+    VERSION = '0.1.0.rc1'
+  end
+end

data/lib/sprockets-webp-exporter.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'sprockets/webp/version'
+require 'sprockets/webp/railtie' if defined?(Rails)
+
+module Sprockets
+  module WebP
+    # configure web encode options
+    #
+    # Sprockets::WebP.encode_options = { quality: 100, lossless: 1, method: 6, alpha_filtering: 2, alpha_compression: 0, alpha_quality: 100 }
+    #
+    class << self
+      attr_writer :encode_options
+
+      def encode_options
+        @encode_options ||= { quality: 100, lossless: 1, method: 6, alpha_filtering: 2, alpha_compression: 0, alpha_quality: 100 }
+      end
+    end
+  end
+end

data/sprockets-webp-exporter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sprockets/webp/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sprockets-webp-exporter'
+  spec.version = Sprockets::WebP::VERSION
+  spec.authors = ['Alex Semyonov']
+  spec.email = ['alex@semyonov.us']
+  spec.summary = %q{Sprockets 4 exporter of PNG and JPEG assets to WebP}
+  spec.description = spec.summary
+  spec.homepage = 'https://github.com/alsemyonov/sprockets-webp-exporter'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split($/)
+  spec.test_files = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'sprockets', '>= 4.0.0.beta8'
+  spec.add_dependency 'webp-ffi', '~> 0.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-webp-exporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc1
+platform: ruby
+authors:
+- Alex Semyonov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta8
+- !ruby/object:Gem::Dependency
+  name: webp-ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Sprockets 4 exporter of PNG and JPEG assets to WebP
+email:
+- alex@semyonov.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sprockets-webp-exporter.rb
+- lib/sprockets/exporters/webp_exporter.rb
+- lib/sprockets/webp/railtie.rb
+- lib/sprockets/webp/version.rb
+- sprockets-webp-exporter.gemspec
+homepage: https://github.com/alsemyonov/sprockets-webp-exporter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Sprockets 4 exporter of PNG and JPEG assets to WebP
+test_files: []