jekyll-images 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ade8806597db4aad25430a39bb1c7a8db08e4e474015344e7afe2e8bbd717038
-  data.tar.gz: c97d3622656034a395f745aaeafe47fc994cb1c1a18ba9853251ef77f924ebcc
+  metadata.gz: 940d7564e5f46ba24c22eec51f474252fc5f23445f37f2589a05788c2b107e55
+  data.tar.gz: 3fdb9012e009324edac12a65d2550dedb93cb4bf899d50ce011a0849c23fc44a
 SHA512:
-  metadata.gz: 3398cc500da4c3ee7ea3be463247422636e37d9a363ab5b2aa94a42acd755f90341995c35b51055fe6bb446b90526a383d3bffbb507cbde64750b98cb85ac94c
-  data.tar.gz: b76bdd36d899533d031990eb152bb93032e609877b32806b9a629c6c4590ddef5baae6e63e8f98a236574d3a21d0fb10538c64ac8d7fee7b64e92af55418c1a6
+  metadata.gz: f1b872ea8903b49b10efe560c0d568debcdfb937a8efbdb6059f238251ab71279d78056479d756cbc7c6bef34577e23c09e22c0ce97ff73d1e2ec0e853b31a49
+  data.tar.gz: 59136867e0841097770b5ae7f3a774f8a4d6934445dcc0bf8e47ab6df4104bd70d34061eb88ac0bcf0c7ef6c53a4b30c970f959164700a41cb4a501008593772

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/height.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    # Obtain image height
+    module Height
+      def height(input)
+        return unless input
+        input = @context.registers[:site].in_source_dir input
+
+        unless ::File.exist? input
+          Jekyll.logger.warn "File doesn't exist #{input}"
+          return input
+        end
+
+        Jekyll::Images::Cache.cached_image(input).height
+      rescue Vips::Error => e
+        Jekyll.logger.warn "Failed to process #{input}: #{e.message}"
+        nil
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::Height)

data/lib/jekyll/filters/thumbnail.rb

@@ -1,41 +1,32 @@
 # 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)
+      def thumbnail(input, width = nil, height = nil, crop = nil, auto_rotate = nil)
         return unless input
-        return cached_image(input).dest if cached_image? input
+        input = @context.registers[:site].in_source_dir input
+
+        unless ::File.exist? input
+          Jekyll.logger.warn "File doesn't exist #{input}"
+          return input
+        end
 
-        height = height if height.to_i > 1
-        image = cached_image input, width, height, crop, auto_rotate
+        image = Jekyll::Images::Cache.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.url
       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
 end

data/lib/jekyll/filters/width.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    # Obtain image width
+    module Width
+      def width(input)
+        return unless input
+        input = @context.registers[:site].in_source_dir input
+
+        unless ::File.exist? input
+          Jekyll.logger.warn "File doesn't exist #{input}"
+          return input
+        end
+
+        Jekyll::Images::Cache.cached_image(input).width
+      rescue Vips::Error => e
+        Jekyll.logger.warn "Failed to process #{input}: #{e.message}"
+        nil
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::Width)

data/lib/jekyll/images/cache.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Images
+    # Cache
+    class Cache
+      class << self
+        attr_accessor :site
+
+        def cached_images
+          @cached_images ||= {}
+        end
+
+        def cached_image?(input)
+          cached_images.key? input
+        end
+
+        def cached_image(input)
+          cached_images[input] ||= Jekyll::Images::Image.new(site, input)
+        end
+      end
+    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,45 +4,41 @@ 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
@@ -54,6 +50,10 @@ module Jekyll
                   end
       end
 
+      def url
+        static_file.url
+      end
+
       def thumbnail?
         image.width > width
       end
@@ -76,14 +76,13 @@ 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
 
         # 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))
+        site.static_files << static_file
 
         # The file was updated, so it exists and is newer than source
         !write?
@@ -99,6 +98,14 @@ module Jekyll
 
         Jekyll.logger.info "Reduced #{dest} from #{before} to #{after} bytes (%#{pct})"
       end
+
+      def relative_path
+        @relative_path ||= dest.sub(site.source, '').sub(%r{\A/}, '')
+      end
+
+      def static_file
+        @static_file ||= Jekyll::StaticFile.new(site, site.source, File.dirname(relative_path), File.basename(relative_path))
+      end
     end
   end
 end

data/lib/jekyll-images.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
+require_relative 'jekyll/images/cache'
+
+Jekyll::Images::Cache.site = Jekyll.sites.first
+
+require_relative 'jekyll/images/image'
 require_relative 'jekyll/images/thumbnail'
 require_relative 'jekyll/filters/thumbnail'
+require_relative 'jekyll/filters/width'
+require_relative 'jekyll/filters/height'
 require_relative 'jekyll/images/oxipng'
 require_relative 'jekyll/images/jpeg_optim'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-images
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -64,7 +64,11 @@ files:
 - LICENSE
 - README.md
 - lib/jekyll-images.rb
+- lib/jekyll/filters/height.rb
 - lib/jekyll/filters/thumbnail.rb
+- lib/jekyll/filters/width.rb
+- lib/jekyll/images/cache.rb
+- lib/jekyll/images/image.rb
 - lib/jekyll/images/jpeg_optim.rb
 - lib/jekyll/images/oxipng.rb
 - lib/jekyll/images/runner.rb
@@ -99,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Optimizes images for Jekyll