jekyll-images 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ade8806597db4aad25430a39bb1c7a8db08e4e474015344e7afe2e8bbd717038
-  data.tar.gz: c97d3622656034a395f745aaeafe47fc994cb1c1a18ba9853251ef77f924ebcc
+  metadata.gz: 85114fbf8d07e0b91732c4c2ced348e28d7462a01cf1bafcd049d8a940d0c6bc
+  data.tar.gz: c49b4ed4846e8ba47817c320da37eb95f6bbebfe3496658e1d0c6618c71863ef
 SHA512:
-  metadata.gz: 3398cc500da4c3ee7ea3be463247422636e37d9a363ab5b2aa94a42acd755f90341995c35b51055fe6bb446b90526a383d3bffbb507cbde64750b98cb85ac94c
-  data.tar.gz: b76bdd36d899533d031990eb152bb93032e609877b32806b9a629c6c4590ddef5baae6e63e8f98a236574d3a21d0fb10538c64ac8d7fee7b64e92af55418c1a6
+  metadata.gz: 3584ac278b582ffe5355cacd68d8a34b18fa928ba6275a90d457c77c0cbd0de87e824450b9987aa61328e146b9cbd8a210a77d3aba9ba285c438ba12d856454c
+  data.tar.gz: aa1b7a026a5dbafe44b4ba9b34c2f466b6c804ad62b00bcabbf9d3d1cdb666e0885e30271f9c38f54c73b5b7c1384fe89851ce055c671ef9a7b6a299a67985da

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/filters/thumbnail.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'pry'
 module Jekyll
   module Filters
     # Liquid filter for use in templates
@@ -8,15 +7,18 @@ module Jekyll
       @@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
-        return cached_image(input).dest if cached_image? input
 
-        height = height if height.to_i > 1
-        image = cached_image input, width, height, crop, auto_rotate
+        image = cached_image input
+        thumb = image.thumbnail(width: width,
+                                height: height,
+                                crop: crop,
+                                auto_rotate: auto_rotate)
 
-        image.write && image.optimize
-        image.dest
+        thumb.write && thumb.optimize
+
+        thumb.dest
       rescue Vips::Error => e
         Jekyll.logger.warn "Failed to process #{input}: #{e.message}"
         input
@@ -28,13 +30,8 @@ module Jekyll
         @@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)
+      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,45 +4,39 @@ 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
 
       def thumbnail
-        @thumbnail ||= image.thumbnail_image width,
+        @thumbnail ||= 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
@@ -76,6 +70,7 @@ module Jekyll
           Jekyll.logger.info "Thumbnailing #{filename} => #{dest}"
           thumbnail.write_to_file(dest)
         else
+          Jekyll.logger.info "Copying #{filename} => #{dest}"
           FileUtils.cp(filename, dest)
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-images
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - f
@@ -65,6 +65,7 @@ files:
 - README.md
 - 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