jekyll-images 0.3.2 → 0.4.0rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 755e74791dbcb257c7185b5343b6252c17453a805019d679be3311f2d8e54f0d
-  data.tar.gz: 10fae9888bf119263b82e440f5919ad9cca6cca4bc4e677ca58d5ba359bfc14e
+  metadata.gz: c8fb884679503e21d7cec255f22cd496b338ee6783b763249b94df7c9f719ec2
+  data.tar.gz: d2103b9d5ac82b643c5099e5a7f2a9ddb813951c81f429a0dd41822a4450e865
 SHA512:
-  metadata.gz: d3a21bfbd3591495bf0498d0779b1343c41e4317ff539ea1221ac4202928de8b7fa03c988aa98565ca87199fd6e4fd22ddc648fb7d386b76acc0643c226ab2ae
-  data.tar.gz: c252876f3d1a4bd9e72769fab9a726776aae20a56b3b64cf45e2c599c930f857063dd575798ac44740e21ccb13565a1da4d6c74540dfaae3bbab6e76eb09a51b
+  metadata.gz: 106b016d8420dcd171cc7676715b3bf3ba6f272e0cd678f369b3b9f264697dd4734ba2d62b30ff532023553c0467abf37762c3f4945bb32b3c2f05a400ae8d81
+  data.tar.gz: e895b2a0c9f623050ab911dc829ce22696ee72a0477944c260cc1ff0a7396a2cbcb24b06c9c16ee0a737c5513c9fb6d577510c1c86d66b5dbe07809f13f41b1c

data/README.md

@@ -31,8 +31,43 @@ Or install it yourself as:
 
     $ gem install jekyll-images
 
+For image optimization, install packages containing `jpegoptim` and
+`oxipng`.
+
+## Configuration
+
+Everything is handled automatically.  If image optimizers are found,
+thumbnails are automatically optimized.
+
+### Interlaced / Progressive images
+
+Interlaced images makes them appear to load faster, because the image
+loads dimensions and gains quality as it downloads.   According to
+Cloudflare, at 50% download the image looks almost like the final
+image[^0], even though interlaced images tend to use more disk space.
+
+To enable interlacing, add to `_config.yml`:
+
+```yaml
+images:
+  interlaced: true
+```
+
+**Note:** Interlacing sometimes won't make the images smaller.
+
+[^0]:
+  <https://blog.cloudflare.com/parallel-streaming-of-progressive-images/>
+
 ## Usage
 
+### Only builds on production
+
+To perform actual thumbnailing, run `jekyll build` in production mode:
+
+```bash
+JEKYLL_ENV=production bundle exec jekyll build
+```
+
 ### Liquid templates
 
 In your templates, you can use the `thumbnail` filter:

data/lib/jekyll/filters/dzsave.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    # Liquid filter for use in templates
+    module Dzsave
+      # Generates an image pyramid
+      #
+      # @see {https://www.libvips.org/API/current/Making-image-pyramids.md.html}
+      def dzsave(input, layout = 'google', tile_size = 256)
+        return input unless input
+
+        path = @context.registers[:site].in_source_dir input
+
+        unless ::File.exist? path
+          Jekyll.logger.warn "File doesn't exist #{input}"
+          return input
+        end
+
+        dir = ::File.dirname(input)
+        image = Vips::Image.new_from_file path, access: :sequential
+        image.dzsave(dir, layout: layout, tile_size: tile_size)
+
+        "#{dir}/{z}/{y}/{x}.#{::File.extname input}"
+      rescue Vips::Error => e
+        Jekyll.logger.warn "Failed to process #{input}: #{e.message}"
+        input
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::Dzsave)

data/lib/jekyll/filters/thumbnail.rb

@@ -6,7 +6,9 @@ module Jekyll
     module Thumbnail
       # Generates a thumbnail and returns its alternate destination
       def thumbnail(input, width = nil, height = nil, crop = nil, auto_rotate = nil)
-        return unless input
+        return input unless input
+        return input unless Jekyll.env == 'production'
+
         path = @context.registers[:site].in_source_dir input
 
         unless ::File.exist? path

data/lib/jekyll/images/image.rb

@@ -26,6 +26,10 @@ module Jekyll
       def thumbnail(**args)
         @cached_thumbnails[args.hash.to_s] ||= Thumbnail.new site: site, filename: filename, image: self, **args
       end
+
+      def dzsave(**args)
+
+      end
     end
   end
 end

data/lib/jekyll/images/jpeg_optim.rb

@@ -9,7 +9,7 @@ module Jekyll
       BINARY = 'jpegoptim'.freeze
 
       def command
-        [binary, '--strip-all', '--quiet', file]
+        [binary, '--strip-all', '--quiet', ('--all-progressive' if interlaced), file].compact
       end
     end
   end

data/lib/jekyll/images/oxipng.rb

@@ -9,7 +9,7 @@ module Jekyll
       BINARY = 'oxipng'.freeze
 
       def command
-        [binary, '--strip', 'all', '--quiet', file]
+        [binary, '--strip', 'all', '--quiet', '--interlace', (interlaced ? %w[1 --force] : '0'), file].flatten
       end
     end
   end

data/lib/jekyll/images/runner.rb

@@ -7,7 +7,7 @@ module Jekyll
   module Images
     # Runner for optimizations
     class Runner
-      attr_reader :binary, :bytes_after, :bytes_before, :file
+      attr_reader :binary, :bytes_after, :bytes_before, :file, :interlaced
 
       class << self
         # XXX: This only allows one optimization per file type, we could
@@ -28,15 +28,16 @@ module Jekyll
           @@mime.file(file, true)
         end
 
-        def run(file)
+        def run(file, interlaced = false)
           type = mime(file)
-          runners[type].new(file).run if runners[type]
+          runners[type].new(file, interlaced).run if runners[type]
         end
       end
 
-      def initialize(file)
+      def initialize(file, interlaced = false)
         @file = file
         @bytes_before = bytes_after
+        @interlaced = interlaced
       end
 
       def bytes_after

data/lib/jekyll/images/thumbnail.rb

@@ -90,7 +90,7 @@ module Jekyll
 
       # Run optimizations
       def optimize
-        before, after = Runner.run(dest)
+        before, after = Runner.run(dest, interlaced?)
 
         return unless before
 
@@ -106,6 +106,10 @@ module Jekyll
       def static_file
         @static_file ||= Jekyll::StaticFile.new(site, site.source, File.dirname(relative_path), File.basename(relative_path))
       end
+
+      def interlaced?
+        site.config.dig('images', 'interlaced')
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-images
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0rc2
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -64,6 +64,7 @@ files:
 - LICENSE
 - README.md
 - lib/jekyll-images.rb
+- lib/jekyll/filters/dzsave.rb
 - lib/jekyll/filters/height.rb
 - lib/jekyll/filters/thumbnail.rb
 - lib/jekyll/filters/width.rb
@@ -99,9 +100,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key: