jekyll-images 0.2.3 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 522e86cd58354de44d3f57ec228fccdb3a2b2872f409f0ba2c7c7602faebf885
-  data.tar.gz: 4839dba88514687693ecc6ca174764f9c9b3dceecb6899e00e3d40383f9ffcb9
+  metadata.gz: 9343975c53eefd5a9e88ed8ef249455a5fc82ca6ae5ba5b36ce46f369ee0d24b
+  data.tar.gz: 2ab5924b0216ff9354bb404316f43b09448431d04fcfe9ae5233ca4da347f8a8
 SHA512:
-  metadata.gz: 644c96a927fabe9d74aebcc67a936d26a45302413f1ce63b7e704124c5de6d30820fa951518ce6dc62de069393e62765df8be07b0f2c8d75b4ed06c9e885b4b2
-  data.tar.gz: 324147f91123e3217079b6b9856e9e855852e285a9c4c3e83893488c0ad54f6a42d3dbbb826968e58dd5d1b578b99c79424f93a1917c400984cbe7bb96fe3f5b
+  metadata.gz: 52d5e60cc1edfb8e5a72dcbdbfaf062d51846fe0a281103ece714fc5251ee75d9c3f9c19ee3ac7e137c147f8a9a56b3c79fde6df28488f353923cc0b623f96a1
+  data.tar.gz: fccc5454c030535ace052d299c4f34b419d6d698aa3ff24fd3447adc52414118bb144204bdccf7ce04dd89f00b13be1200f8d3e823e20b9579ac9b1cef8d93ef

data/README.md

@@ -53,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
@@ -67,7 +69,7 @@ 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 `''`.
+`height` to `nil`.
 
 ## TODO
 

data/lib/jekyll-images.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'jekyll/images/image'
 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,31 @@
+# frozen_string_literal: true
+
+require 'vips'
+
+module Jekyll
+  module Images
+    class Image
+      attr_reader :site, :filename, :height, :width
+
+      def initialize(site, filename)
+        unless File.exist? filename
+          raise ArgumentError, "File not found: #{filename}"
+        end
+
+        @cached_thumbnails = {}
+        @site = site
+        @filename = filename
+
+        # We only need the image to get height and width
+        image = Vips::Image.new_from_file filename, access: :sequential
+
+        @height = image.height
+        @width = image.width
+      end
+
+      def thumbnail(**args)
+        @cached_thumbnails[args.hash.to_s] ||= Thumbnail.new site: site, filename: filename, image: self, **args
+      end
+    end
+  end
+end

data/lib/jekyll/images/thumbnail.rb

@@ -4,57 +4,56 @@ 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, :filename, :width, :height, :crop, :auto_rotate
+      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]
-        @crop = args[:crop].to_sym
-        @auto_rotate = args[:auto_rotate]
-      end
-
-      def image
-        @image ||= Vips::Image.new_from_file filename,
-                                             access: :sequential
+        @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
 
+      # XXX: We don't memoize because we don't need the thumbnail in
+      # memory after it has been written.
       def thumbnail
-        @thumbnail ||= image.thumbnail_image width,
-                                             height: height,
-                                             auto_rotate: auto_rotate,
-                                             crop: crop
+        Vips::Image.thumbnail filename,
+                              width,
+                              height: height,
+                              auto_rotate: auto_rotate,
+                              crop: crop
       end
 
-      def height
-        @height || proportional_height
+      # Finds a height that's proportional to the width
+      def proportional_height(width)
+        @proportional_height ||= (image.height * (width / image.width.to_f)).round
       end
 
-      # Finds a heigth that's proportional to the width
-      def proportional_height
-        @proportional_height ||= (image.height * (width / image.width.to_f)).round
+      # 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
@@ -69,8 +68,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.
@@ -90,7 +94,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.3
+  version: 0.2.7
 platform: ruby
 authors:
 - f
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2020-03-21 00:00:00.000000000 Z
+date: 2020-07-28 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.3'
-  end
-end