jekyll-images 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b16d950e3f192f849e1577a16fc572c9bb698604de4bf31a64b1c62285ac00ef
-  data.tar.gz: 1072440b92d9e2351a799100d1aef666fe14441bc0d52c93ac40ed71eba14cfb
+  metadata.gz: ade8806597db4aad25430a39bb1c7a8db08e4e474015344e7afe2e8bbd717038
+  data.tar.gz: c97d3622656034a395f745aaeafe47fc994cb1c1a18ba9853251ef77f924ebcc
 SHA512:
-  metadata.gz: 6c87cae74ddaacce079c5a192af9c1e1315a198176730a8b6f0b82dbf5e1868c0cc179ef191519ee502c6c839928ea56339a2a212099c87a21f53cd69c6c14ae
-  data.tar.gz: a89803b7bc464ab3b1a27a135946406814016ca61374ad7c904c93144369d912249b06f6b1e32cbc3c988e1ecda7515cc0ecce0cea8f4524ee87a58a80479a66
+  metadata.gz: 3398cc500da4c3ee7ea3be463247422636e37d9a363ab5b2aa94a42acd755f90341995c35b51055fe6bb446b90526a383d3bffbb507cbde64750b98cb85ac94c
+  data.tar.gz: b76bdd36d899533d031990eb152bb93032e609877b32806b9a629c6c4590ddef5baae6e63e8f98a236574d3a21d0fb10538c64ac8d7fee7b64e92af55418c1a6

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
@@ -70,31 +69,13 @@ Options for this filter are in the following order:
 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
-```
-
 ## 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,8 +1,6 @@
 # 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

@@ -1,25 +1,40 @@
 # frozen_string_literal: true
 
+require 'pry'
 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)
         return unless input
+        return cached_image(input).dest if cached_image? 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 = cached_image input, width, height, crop, auto_rotate
+
         image.write && image.optimize
         image.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, width = nil, height = nil, crop = nil, auto_rotate = nil)
+        @@cached_images[input] ||= Jekyll::Images::Thumbnail.new(@context.registers[:site],
+                                                          input,
+                                                          width: width,
+                                                          height: height,
+                                                          crop: crop,
+                                                          auto_rotate: auto_rotate)
       end
     end
   end

data/lib/jekyll/images/thumbnail.rb

@@ -8,7 +8,7 @@ module Jekyll
     #
     # We're assuming every image is going to be thumbnailed
     class Thumbnail
-      attr_reader :site, :image, :thumbnail, :filename, :width, :height
+      attr_reader :site, :filename, :width, :height, :crop, :auto_rotate
 
       def initialize(site, filename, **args)
         unless File.exist? filename
@@ -20,28 +20,44 @@ module Jekyll
         @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
+        @crop = args[:crop].to_sym
+        @auto_rotate = args[:auto_rotate]
       end
 
-      # Finds a height that's proportional to the width
+      def image
+        @image ||= Vips::Image.new_from_file filename,
+                                             access: :sequential
+      end
+
+      def thumbnail
+        @thumbnail ||= image.thumbnail_image width,
+                                             height: height,
+                                             auto_rotate: auto_rotate,
+                                             crop: crop
+      end
+
+      def height
+        @height || proportional_height
+      end
+
+      # Finds a heigth that's proportional to the width
       def proportional_height
-        @height = (image.height * (width / image.width.to_f)).round
+        @proportional_height ||= (image.height * (width / image.width.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 +72,12 @@ 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
+          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 +97,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,98 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-images
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 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/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 +100,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.0'
-  end
-end