jekyll-images 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b61dff2c6710eddeb885f339f68eb3c5c8df598c9bb83cc1065d130c7d2f0bb5
-  data.tar.gz: 6626adea05ae4f94829c815d0f4a71427b949478e22732a8e387d9b654d099a5
+  metadata.gz: 85114fbf8d07e0b91732c4c2ced348e28d7462a01cf1bafcd049d8a940d0c6bc
+  data.tar.gz: c49b4ed4846e8ba47817c320da37eb95f6bbebfe3496658e1d0c6618c71863ef
 SHA512:
-  metadata.gz: d33086b2bfc1bad9a0d051ffdb2f5383aa616f2bbb989fc2b16520cb7cd9dfd159568ad531af67dcd94557efb3dffa3c0bcb4394ff2a0fbc2a5e677b0c9bb320
-  data.tar.gz: be91ff3b175356cf2f66f26ff0bfe8b9536001c89924a9106f8b191a47a289c8e2401ed12f37059a57dd827c4935c3345ea0a06e5457e33a0d4e2441758f09ea
+  metadata.gz: 3584ac278b582ffe5355cacd68d8a34b18fa928ba6275a90d457c77c0cbd0de87e824450b9987aa61328e146b9cbd8a210a77d3aba9ba285c438ba12d856454c
+  data.tar.gz: aa1b7a026a5dbafe44b4ba9b34c2f466b6c804ad62b00bcabbf9d3d1cdb666e0885e30271f9c38f54c73b5b7c1384fe89851ce055c671ef9a7b6a299a67985da

data/README.md

@@ -1,8 +1,7 @@
 # Image optimization for Jekyll
 
 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.
+the sizes you specify in templates.
 
 It uses [Libvips](https://libvips.github.io/libvips/) for performance
 and low resource usage.  It'll also cache the thumbnails so it only runs
@@ -54,10 +53,12 @@ In your templates, you can use the `thumbnail` filter:
 
 Options for this filter are in the following order:
 
-* `width` (required), the desired width for the image
+* `width`, the desired width for the image, if `nil`, `height` is
+  required.
 
 * `height`, if provided, the thumbnail will crop to this size.  If not,
-  the image is scaled down proportionally to the width.
+  the image is scaled down proportionally to the width.  It becomes
+  required if the width is `nil`.
 
 * `crop` the smart cropping algorithm.  One of `none`, `centre`,
   `entropy` or `attention` (default).  See
@@ -68,33 +69,15 @@ Options for this filter are in the following order:
   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
-```
+`height` to `nil`.
 
 ## TODO
 
 * Use `<picture>` and the `srcset` attribute automatically for posts
   <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/picture>
 
+* Download and thumbnail images in posts and other documents.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at

data/lib/jekyll-images.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'pry'
 require_relative 'jekyll/images/thumbnail'
 require_relative 'jekyll/filters/thumbnail'
 require_relative 'jekyll/images/oxipng'

data/lib/jekyll/filters/thumbnail.rb

@@ -4,22 +4,34 @@ module Jekyll
   module Filters
     # Liquid filter for use in templates
     module Thumbnail
+      @@cached_images = {}
+
       # Generates a thumbnail and returns its alternate destination
-      def thumbnail(input, width, height = nil, crop = :attention, auto_rotate = true)
+      def thumbnail(input, width = nil, height = nil, crop = nil, auto_rotate = nil)
         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)
-
-        # XXX: This won't run optimizations more than once but it won't
-        # also optimize source images.
-        image.write && image.optimize
-        image.dest
+        image = cached_image input
+        thumb = image.thumbnail(width: width,
+                                height: height,
+                                crop: crop,
+                                auto_rotate: auto_rotate)
+
+        thumb.write && thumb.optimize
+
+        thumb.dest
+      rescue Vips::Error => e
+        Jekyll.logger.warn "Failed to process #{input}: #{e.message}"
+        input
+      end
+
+      private
+
+      def cached_image?(input)
+        @@cached_images.key? input
+      end
+
+      def cached_image(input)
+        @@cached_images[input] ||= Jekyll::Images::Image.new(@context.registers[:site], input)
       end
     end
   end

data/lib/jekyll/images/image.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'vips'
+
+module Jekyll
+  module Images
+    class Image
+      attr_reader :site, :filename
+
+      def initialize(site, filename)
+        unless File.exist? filename
+          raise ArgumentError, "File not found: #{filename}"
+        end
+
+        @cached_thumbnails = {}
+        @site = site
+        @filename = filename
+      end
+
+      def image
+        @image ||= Vips::Image.new_from_file filename, access: :sequential
+      end
+
+      def thumbnail(**args)
+        @cached_thumbnails[args.hash.to_s] ||= Thumbnail.new site: site, filename: filename, image: image, **args
+      end
+    end
+  end
+end

data/lib/jekyll/images/thumbnail.rb

@@ -4,44 +4,54 @@ require 'vips'
 
 module Jekyll
   module Images
-    # Use LibVIPS to generate images in different sizes
-    #
-    # We're assuming every image is going to be thumbnailed
     class Thumbnail
-      attr_reader :site, :image, :thumbnail, :filename, :width, :height
+      attr_reader :site, :filename, :image, :width, :height, :crop, :auto_rotate
 
-      def initialize(site, filename, **args)
-        unless File.exist? filename
-          raise ArgumentError, "File not found: #{filename}"
+      def initialize(site:, filename:, image:, **args)
+        if args.slice(:width, :height).values.none?
+          raise ArgumentError, "#{filename} thumbnail needs width or height"
         end
-        raise ArgumentError, 'Missing width' unless args[:width]
 
         @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
+        @image = image
+        @width = args[:width] || proportional_width(args[:height])
+        @height = args[:height] || proportional_height(args[:width])
+        @crop = args[:crop]&.to_sym || :attention
+        @auto_rotate = args[:auto_rotate].nil? ? true : args[:auto_rotate]
+      end
+
+      def thumbnail
+        @thumbnail ||= Vips::Image.thumbnail filename,
+                                             width,
+                                             height: height,
+                                             auto_rotate: auto_rotate,
+                                             crop: crop
       end
 
       # Finds a height that's proportional to the width
-      def proportional_height
-        @height = (image.height * (width / image.width.to_f)).round
+      def proportional_height(width)
+        @proportional_height ||= (image.height * (width / image.width.to_f)).round
+      end
+
+      # Find a width that's proportional to height
+      def proportional_width(height)
+        @proportional_width ||= (image.width * (height / image.height.to_f)).round
       end
 
       # Generates a destination from filename only if we're downsizing
       def dest
-        @dest ||= if image.width > width
+        @dest ||= if thumbnail?
                     filename.gsub(/#{extname}\z/, "_#{width}x#{height}#{extname}")
                   else
-                    Jekyll.logger.info "Not thumbnailing #{filename}"
-                    filename
+                    filename.gsub(/#{extname}\z/, "_optimized#{extname}")
                   end
       end
 
+      def thumbnail?
+        image.width > width
+      end
+
       def extname
         @extname ||= File.extname filename
       end
@@ -56,8 +66,13 @@ module Jekyll
       def write
         return unless write?
 
-        Jekyll.logger.info "Thumbnailing #{filename} => #{dest}"
-        thumbnail.write_to_file(dest)
+        if thumbnail?
+          Jekyll.logger.info "Thumbnailing #{filename} => #{dest}"
+          thumbnail.write_to_file(dest)
+        else
+          Jekyll.logger.info "Copying #{filename} => #{dest}"
+          FileUtils.cp(filename, dest)
+        end
 
         # Add it to the static files so Jekyll copies them.  Once they
         # are written they're copied when the site is loaded.
@@ -77,7 +92,7 @@ module Jekyll
 
         pct = ((after.to_f / before) * -100 + 100).round(2)
 
-        Jekyll.logger.info "Reduced #{filename} from #{before} to #{after} bytes (%#{pct})"
+        Jekyll.logger.info "Reduced #{dest} from #{before} to #{after} bytes (%#{pct})"
       end
     end
   end

metadata

@@ -1,139 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-images
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 platform: ruby
 authors:
 - f
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby-vips
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: ruby-filemagic
+  name: ruby-vips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2'
   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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: ruby-filemagic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
-  type: :development
+        version: '0.7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '0.7'
 description: Optimizes images for Jekyll
 email:
 - f@sutty.nl
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- jekyll-images.gemspec
 - lib/jekyll-images.rb
 - lib/jekyll/filters/thumbnail.rb
+- lib/jekyll/images/image.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
 licenses:
 - GPL-3.0
 metadata:
-  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://0xacab.org/sutty/jekyll/jekyll-images/issues
   homepage_uri: https://0xacab.org/sutty/jekyll/jekyll-images
   source_code_uri: https://0xacab.org/sutty/jekyll/jekyll-images
-  changelog_uri: https://0xacab.org/sutty/jekyll/jekyll-images/blob/master/CHANGELOG.md
-post_install_message: 
-rdoc_options: []
+  documentation_uri: https://rubydoc.info/gems/jekyll-images
+post_install_message:
+rdoc_options:
+- "--title"
+- jekyll-images - Optimizes images for Jekyll
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -141,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Optimizes images for Jekyll
 test_files: []

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

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

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "jekyll/image/optimization"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/jekyll-images.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll/images/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'jekyll-images'
-  spec.version       = Jekyll::Images::VERSION
-  spec.authors       = ['f']
-  spec.email         = ['f@sutty.nl']
-
-  spec.summary       = 'Optimizes images for Jekyll'
-  spec.description   = 'Optimizes images for Jekyll'
-  spec.homepage      = 'https://0xacab.org/sutty/jekyll/jekyll-images'
-  spec.license       = 'GPL-3.0'
-
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  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'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '~> 0.74'
-end

data/lib/jekyll/images/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Images
-    VERSION = '0.2.1'
-  end
-end