jekyll-images 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07b509e1549cea19f69feb3dfc28a428ea64b28c671e4676293189948dbf898c
-  data.tar.gz: c53c72a3b38da604f56c483e3f7ab196053b87f7fe2bf1ee4e7ff21ce08aaf0a
+  metadata.gz: b16d950e3f192f849e1577a16fc572c9bb698604de4bf31a64b1c62285ac00ef
+  data.tar.gz: 1072440b92d9e2351a799100d1aef666fe14441bc0d52c93ac40ed71eba14cfb
 SHA512:
-  metadata.gz: 4a4385f6cd05bb4a0cfdd1f801a3a7271216b935f1a8c1442c6ddf5bd47918b06c9a7229acd1c84778168854eff87cba6c4bb5dc344b32747604a50b0afe26e9
-  data.tar.gz: c216720295925557a364e0a57ddd22cb85e298adb220f95981c67e291a617ed4fb62b177517755a11e52dc3bea5d69e7f4d2631f8a98620a97909af8606c10df
+  metadata.gz: 6c87cae74ddaacce079c5a192af9c1e1315a198176730a8b6f0b82dbf5e1868c0cc179ef191519ee502c6c839928ea56339a2a212099c87a21f53cd69c6c14ae
+  data.tar.gz: a89803b7bc464ab3b1a27a135946406814016ca61374ad7c904c93144369d912249b06f6b1e32cbc3c988e1ecda7515cc0ecce0cea8f4524ee87a58a80479a66

data/README.md

@@ -1,15 +1,27 @@
-# Jekyll::Image::Optimization
+# Image optimization for Jekyll
 
-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/jekyll/image/optimization`. To experiment with that code, run `bin/console` for an interactive prompt.
+This Jekyll plugin helps you optimize images by thumbnailing them to
+the sizes you specify in templates and in the configuration for images
+in posts and collections.
 
-TODO: Delete this and the text above, and describe your gem
+It uses [Libvips](https://libvips.github.io/libvips/) for performance
+and low resource usage.  It'll also cache the thumbnails so it only runs
+once, but it'll update the thumbnail if the source image changes (or is
+`touch`ed).
+
+The thumbnails are smartly cropped by default to point of attention, so
+they're more useful than just cropping at the center, but you can change
+this (see below).
+
+It will run `jpegoptim` and `oxipng` if it can find the binaries
+installed for extra optimization.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your site's Gemfile:
 
 ```ruby
-gem 'jekyll-image-optimization'
+gem 'jekyll-images'
 ```
 
 And then execute:
@@ -18,26 +30,86 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install jekyll-image-optimization
+    $ gem install jekyll-images
 
 ## Usage
 
-TODO: Write usage instructions here
+### Liquid templates
+
+In your templates, you can use the `thumbnail` filter:
+
+```html
+<img src="{{ page.image.path | thumbnail: 100 }}" />
+
+<!-- responsive images -->
+
+<picture>
+  {% for size in site.images.sizes %}
+  <source srcset="{{ page.image.path | thumbnail: size }}" media="(max-width: {{ size }}px)" />
+  {% endfor %}
+
+  <img src="{{ page.image.path | thumbnail: 750 }}" />
+</picture>
+```
+
+Options for this filter are in the following order:
 
-## Development
+* `width` (required), the desired width for the image
+
+* `height`, if provided, the thumbnail will crop to this size.  If not,
+  the image is scaled down proportionally to the width.
+
+* `crop` the smart cropping algorithm.  One of `none`, `centre`,
+  `entropy` or `attention` (default).  See
+  [Vips::Interesting](https://www.rubydoc.info/gems/ruby-vips/Vips/Interesting)
+  for documentation.
+
+* `auto_rotate`, a boolean (defaults to `true`).  If the image has
+  orientation metadata, this controls if it's automatically rotated.
+
+If you want to pass `crop` and `auto_rotate` but not `height`, just set
+`height` to `0` or `''`.
+
+### Configuration and posts
+
+Images in a post content need to be configured globally:
+
+```yaml
+# _config.yml
+images:
+  # These are bootstrap4 breakpoints in pixels
+  sizes:
+    - 576
+    - 768
+    - 992
+    - 1200
+  thumbnail:
+    width: 600
+    height: 0 # Leave this out for proportional thumbnailing
+    crop: attention # See Vips::Interesting
+    auto_rotate: true
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## TODO
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* Use `<picture>` and the `srcset` attribute automatically for posts
+  <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/picture>
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-image-optimization. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+<https://0xacab.org/sutty/jekyll/jekyll-images>. This project is
+intended to be a welcoming space for collaboration, and contributors are
+expected to adhere to the [Sutty code of
+conduct](https://sutty.nl/en/code-of-conduct/).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as free software under the terms of the GPL3
+License.
 
 ## Code of Conduct
 
-Everyone interacting in the Jekyll::Image::Optimization project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-image-optimization/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the jekyll-images project’s codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code
+of conduct](https://sutty.nl/en/code-of-conduct/).

data/jekyll-images.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'ruby-vips', '~> 2'
+  spec.add_dependency 'ruby-filemagic', '~> 0.7'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'

data/lib/jekyll-images.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
+require 'pry'
 require_relative 'jekyll/images/thumbnail'
 require_relative 'jekyll/filters/thumbnail'
+require_relative 'jekyll/hooks/thumbnail'
+require_relative 'jekyll/images/oxipng'
+require_relative 'jekyll/images/jpeg_optim'

data/lib/jekyll/filters/thumbnail.rb

@@ -4,15 +4,21 @@ module Jekyll
   module Filters
     # Liquid filter for use in templates
     module Thumbnail
-      # Generates a thumbnail and returns its destination
-      def thumbnail(input, width, height, crop = :attention, auto_rotate = true)
-        image = Jekyll::Images::Thumbnail.new(input,
+      # Generates a thumbnail and returns its alternate destination
+      def thumbnail(input, width, height = nil, crop = :attention, auto_rotate = true)
+        return unless input
+
+        height = height if height.to_i > 1
+        image = Jekyll::Images::Thumbnail.new(@context.registers[:site],
+                                              input,
                                               width: width,
                                               height: height,
                                               crop: crop,
                                               auto_rotate: auto_rotate)
-        image.write
 
+        # XXX: This won't run optimizations more than once but it won't
+        # also optimize source images.
+        image.write && image.optimize
         image.dest
       end
     end

data/lib/jekyll/images/jpeg_optim.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'runner'
+
+module Jekyll
+  module Images
+    # Runs jpegoptim on JPEG files
+    class JpegOptim < Runner
+      BINARY = 'jpegoptim'.freeze
+
+      def command
+        [binary, '--strip-all', '--quiet', file]
+      end
+    end
+  end
+end
+
+Jekyll::Images::Runner.register('jpeg', Jekyll::Images::JpegOptim)

data/lib/jekyll/images/oxipng.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'runner'
+
+module Jekyll
+  module Images
+    # Runs oxipng on PNG files
+    class Oxipng < Runner
+      BINARY = 'oxipng'.freeze
+
+      def command
+        [binary, '--strip', 'all', '--quiet', file]
+      end
+    end
+  end
+end
+
+Jekyll::Images::Runner.register('png', Jekyll::Images::Oxipng)

data/lib/jekyll/images/runner.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'filemagic'
+
+module Jekyll
+  module Images
+    # Runner for optimizations
+    class Runner
+      attr_reader :binary, :bytes_after, :bytes_before, :file
+
+      class << self
+        # XXX: This only allows one optimization per file type, we could
+        # make it an array but how do we garantee order?  Maybe adding a
+        # priority field?
+        def register(mime, class_name)
+          @@runners ||= {}
+          @@runners[mime] = class_name
+        end
+
+        def runners
+          @@runners
+        end
+
+        def mime(file)
+          @@mime ||= FileMagic.new
+
+          @@mime.file(file, true)
+        end
+
+        def run(file)
+          type = mime(file)
+          runners[type].new(file).run if runners[type]
+        end
+      end
+
+      def initialize(file)
+        @file = file
+        @bytes_before = bytes_after
+      end
+
+      def bytes_after
+        File.size file
+      end
+
+      def exist?
+        @binary, _, status = Open3.capture3("which #{self.class::BINARY}")
+        @binary.chomp!
+
+        status.success?
+      end
+
+      def run
+        return unless exist?
+
+        _, status = Open3.capture2e(*command)
+
+        [bytes_before, bytes_after] if status.success?
+      end
+    end
+  end
+end

data/lib/jekyll/images/thumbnail.rb

@@ -8,38 +8,76 @@ module Jekyll
     #
     # We're assuming every image is going to be thumbnailed
     class Thumbnail
-      attr_reader :image, :filename, :width, :height
+      attr_reader :site, :image, :thumbnail, :filename, :width, :height
 
-      def initialize(filename, **args)
+      def initialize(site, filename, **args)
         unless File.exist? filename
           raise ArgumentError, "File not found: #{filename}"
         end
-        raise ArgumentError, 'Missing width' unless width
-        raise ArgumentError, 'Missing height' unless height
+        raise ArgumentError, 'Missing width' unless args[:width]
 
-        @image = Image::Vips.thumbnail @filename, args[:width],
-                                       height: args[:height],
-                                       auto_rotate: args[:auto_rotate],
-                                       crop: args[:crop].to_sym
+        @site = site
+        @filename = filename
+        @width = args[:width]
+        @height = args[:height]
+        @image = Vips::Image.new_from_file filename, access: :sequential
+        @thumbnail = image.thumbnail_image width,
+                                           height: height || proportional_height,
+                                           auto_rotate: args[:auto_rotate],
+                                           crop: args[:crop].to_sym
       end
 
-      # Generates a destination from filename
+      # Finds a height that's proportional to the width
+      def proportional_height
+        @height = (image.height * (width / image.width.to_f)).round
+      end
+
+      # Generates a destination from filename only if we're downsizing
       def dest
-        filename.gsub(/#{extname}\z/, "_#{height}x#{width}#{extname}")
+        @dest ||= if image.width > width
+                    filename.gsub(/#{extname}\z/, "_#{width}x#{height}#{extname}")
+                  else
+                    Jekyll.logger.info "Not thumbnailing #{filename}"
+                    filename
+                  end
       end
 
       def extname
         @extname ||= File.extname filename
       end
 
-      # Only write when the origin is newer than destination
+      # Only write when the source is newer than the thumbnail
       def write?
-        File.mtime(filename) > File.mtime(dest)
+        !File.exist?(dest) || File.mtime(filename) > File.mtime(dest)
       end
 
-      # Save the file into destination if needed
+      # Save the file into destination if needed and add to files to
+      # copy
       def write
-        image.write_to_file(dest) if write?
+        return unless write?
+
+        Jekyll.logger.info "Thumbnailing #{filename} => #{dest}"
+        thumbnail.write_to_file(dest)
+
+        # Add it to the static files so Jekyll copies them.  Once they
+        # are written they're copied when the site is loaded.
+        site.static_files << Jekyll::StaticFile.new(site, site.source,
+                                                    File.dirname(dest),
+                                                    File.basename(dest))
+
+        # The file was updated, so it exists and is newer than source
+        !write?
+      end
+
+      # Run optimizations
+      def optimize
+        before, after = Runner.run(dest)
+
+        return unless before
+
+        pct = ((after.to_f / before) * -100 + 100).round(2)
+
+        Jekyll.logger.info "Reduced #{filename} from #{before} to #{after} bytes (%#{pct})"
       end
     end
   end

data/lib/jekyll/images/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Images
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-images
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - f
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-vips
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +112,9 @@ files:
 - jekyll-images.gemspec
 - lib/jekyll-images.rb
 - lib/jekyll/filters/thumbnail.rb
+- lib/jekyll/images/jpeg_optim.rb
+- lib/jekyll/images/oxipng.rb
+- lib/jekyll/images/runner.rb
 - lib/jekyll/images/thumbnail.rb
 - lib/jekyll/images/version.rb
 homepage: https://0xacab.org/sutty/jekyll/jekyll-images