rails-webp 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ec97dc302098c80af96495f165ee8afd728db23dce34c88b3e580ff608a659b
-  data.tar.gz: 5edfe398846e8cb4d44e36d769a74fb9cc2e486c11b8eaf710d2c6daaac33b81
+  metadata.gz: 71dc74349b769d210dfac65270ca98c18370085679b7dc65571a4561cf502b3a
+  data.tar.gz: ade953a26071ceab38f52137acb6188d2805d9641629fc7831f778666dff270f
 SHA512:
-  metadata.gz: b817eb8374517d1d3312da730a2b492447dfff9f98b57274fd4d9fa773ed2201da75bc7914b40477bbe3f38839ca53de7d7e86004e539861780c80c5a301067f
-  data.tar.gz: 770838c077d9973a6bfc276303c0b1aa6ea8e285d9ffd8bcf39dd6a64620f6df88cc4a443fc6bf8c0733180210798aa4e55eb2d949792ca80d11cdb47968b275
+  metadata.gz: 6e141952f99a18c8063373a4fc0480620856d857873ce7eb6c7e19b6cdfa6c707344cee1bed6e2c40404e9515febf5f62634dbfdc05d3db9965d0b505bf013ba
+  data.tar.gz: 960db331883e44ca712d049faabfdceaf35863018e5252fa5fe47c1d053f5ee62c254fb3efdc27b15578adc8ab9f43aebcb506ba17b9a933ae4dfe28918c0adb

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    rails-webp (0.1)
+      mini_magick
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    diff-lcs (1.3)
+    mini_magick (4.9.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  rails-webp!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -1,11 +1,11 @@
 # Rails::Webp
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails/webp`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Create webp copies of your image assets the easy way using [minimagick](https://github.com/minimagick/minimagick)!
 
 ## Installation
 
+Before installing, make sure you have [ImageMagick](https://imagemagick.org/script/download.php) installed on your host.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -22,7 +22,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem is intended to be used as a post processor step in your asset pipeline:
+```
+bundle exec rake assets:precompile
+```
+
+You can configure options passed to ImageMagick in an initializer:
+
+`config/initializers/webp.rb`:
+
+```
+Rails::WebP.encode_options = { quality: 80, lossless: true, method: 6, alpha_filtering: 2, alpha_compression: 0, alpha_quality: 100 }
+```
+
+A comprehensive list of options can be found [here](https://imagemagick.org/script/webp.php).
+
+**Note:** a digest is included in the processed webp image's file name. This digest is compared for each time compilation occurs.
+By default, `rails-webp` will only process images that have a mismatched digest (AKA hash of source image contents).
+If you wish to force webp processing:
+
+```
+Rails::WebP.force = true # default: false
+```
+
+
+## Motivations for this gem
+
+In my experience, the existing gems for processing webp images in the Rails Asset Pipeline made questionable assumptions.
+More importantly, I could not use the native libraries used by those gems in my team's acceptance/production environment.
+ImageMagick was an easy choice for this reason because it's widely implemented, used, and understood (my opinion).
 
 ## Development
 

data/lib/rails/webp/converter.rb

@@ -0,0 +1,67 @@
+require 'fileutils'
+require 'logger'
+require 'mini_magick'
+
+module Rails
+  module WebP
+    class Converter
+      class << self
+        attr_reader :context
+
+        def process(input_path, data, context)
+          @context = context
+          app = Rails.application
+          prefix = app.config.assets.prefix
+          digest = data_digest(data)
+          webp_file = webp_file_name(data, digest)
+          output_path = Pathname.new(File.join(app.root, 'public', prefix, webp_file))
+          if WebP.force || !webp_file_exists?(digest, output_path)
+            FileUtils.mkdir_p(output_path.dirname) unless Dir.exists?(output_path.dirname)
+            convert_to_webp(input_path, output_path)
+            logger.info "Writing #{output_path}"
+          end
+          data
+        end
+
+        def convert_to_webp(input_path, output_path)
+          # Ex: convert wizard.png -quality 50 -define webp:lossless=true wizard.webp
+          MiniMagick::Tool::Convert.new do |convert|
+            convert << input_path
+            options = WebP.encode_options
+            convert << '-quality' << options[:quality]
+            options.except(:quality).each do |name, value|
+              convert << "-define" << "webp:#{name.to_s.dasherize}=#{value}"
+            end
+            convert << output_path
+          end
+        end
+
+        private
+
+        def data_digest(data)
+          "-#{context.environment.digest_class.new.update(data).to_s}"
+        end
+
+        def webp_file_name(data, digest)
+          file_name = context.logical_path # Original File name w/o extension
+          file_ext  = context.pathname.extname # Original File extension
+          "#{file_name}#{digest}.webp" # WebP File fullname
+        end
+
+        def webp_file_exists?(digest, output_path)
+          File.exists?(output_path) && digest == output_path.to_s.split('-').last.split('.').first
+        end
+
+        def logger
+          if context && context.environment
+            context.environment.logger
+          else
+            logger = Logger.new($stderr)
+            logger.level = Logger::FATAL
+            logger
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/webp/post_processor.rb

@@ -0,0 +1,27 @@
+module Rails
+  module WebP
+    class PostProcessor
+      def initialize(filename, &block)
+        @filename = filename
+        @source   = block.call
+      end
+
+      def render(context, empty_hash_wtf)
+        self.class.run(@filename, @source, context)
+      end
+
+      def self.run(filename, data, context)
+        Converter.process(filename, data, context)
+      end
+
+      def self.call(input)
+        filename = input[:filename]
+        source   = input[:data]
+        context  = input[:environment].context_class.new(input)
+
+        result = run(filename, source, context)
+        context.metadata.merge(data: result)
+      end
+    end
+  end
+end

data/lib/rails/webp/railtie.rb

@@ -0,0 +1,19 @@
+require 'sprockets/processing'
+
+module Rails
+  module WebP
+    class Railtie < ::Rails::Railtie
+      extend Sprockets::Processing
+
+      initializer :webp, group: :all do |app|
+        app.config.assets.configure do |env|
+          env.register_mime_type 'image/jpeg', '.jpeg'
+          env.register_postprocessor 'image/jpeg', PostProcessor
+
+          env.register_mime_type 'image/png', '.png'
+          env.register_postprocessor 'image/png', PostProcessor
+        end
+      end
+    end
+  end
+end

data/lib/rails/webp/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module WebP
-    VERSION = "0.1"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-webp
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Jake Peterson
@@ -90,16 +90,20 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/rails/webp.rb
+- lib/rails/webp/converter.rb
+- lib/rails/webp/post_processor.rb
+- lib/rails/webp/railtie.rb
 - lib/rails/webp/version.rb
+- rails-webp-0.1.gem
 - rails-webp.gemspec
 homepage: https://github.com/jakenberg
 licenses:

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-before_install: gem install bundler -v 2.0.1