jekyll-images 0.3.0 → 0.4.0rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 940d7564e5f46ba24c22eec51f474252fc5f23445f37f2589a05788c2b107e55
-  data.tar.gz: 3fdb9012e009324edac12a65d2550dedb93cb4bf899d50ce011a0849c23fc44a
+  metadata.gz: 7b806091563d3dfe022d4e6558631c998aa1be7cec781363b15a957bfbf09bc2
+  data.tar.gz: f7732fba18d8ed4e84b8c6f944ef1bc857d67ea2ad704e7d0522c54ff708709a
 SHA512:
-  metadata.gz: f1b872ea8903b49b10efe560c0d568debcdfb937a8efbdb6059f238251ab71279d78056479d756cbc7c6bef34577e23c09e22c0ce97ff73d1e2ec0e853b31a49
-  data.tar.gz: 59136867e0841097770b5ae7f3a774f8a4d6934445dcc0bf8e47ab6df4104bd70d34061eb88ac0bcf0c7ef6c53a4b30c970f959164700a41cb4a501008593772
+  metadata.gz: bd1d4b6b7d5ece1782928ae15c9bf59dec33414ad5c2c50928a55768429400156ea6e404467ba2679a92b40c0fe7891a40bc427b93512c894699dc8ee1964c4b
+  data.tar.gz: 4273da19ba65f935b2f11cb1cfb06e0023fca26e4c384f9ae2a8708c5dbbdb15eb971cb90e2aa128df6565bd57b4300205e35b5a6232d45c9f3768fa70cbecf7

data/README.md

@@ -31,8 +31,41 @@ 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
+```
+
+[^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/height.rb

@@ -6,14 +6,14 @@ module Jekyll
     module Height
       def height(input)
         return unless input
-        input = @context.registers[:site].in_source_dir input
+        path = @context.registers[:site].in_source_dir input
 
-        unless ::File.exist? input
+        unless ::File.exist? path
           Jekyll.logger.warn "File doesn't exist #{input}"
           return input
         end
 
-        Jekyll::Images::Cache.cached_image(input).height
+        Jekyll::Images::Cache.cached_image(path).height
       rescue Vips::Error => e
         Jekyll.logger.warn "Failed to process #{input}: #{e.message}"
         nil

data/lib/jekyll/filters/thumbnail.rb

@@ -6,15 +6,17 @@ 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
-        input = @context.registers[:site].in_source_dir input
+        return input unless input
+        return input unless Jekyll.env == 'production'
 
-        unless ::File.exist? input
+        path = @context.registers[:site].in_source_dir input
+
+        unless ::File.exist? path
           Jekyll.logger.warn "File doesn't exist #{input}"
           return input
         end
 
-        image = Jekyll::Images::Cache.cached_image input
+        image = Jekyll::Images::Cache.cached_image path
         thumb = image.thumbnail(width: width,
                                 height: height,
                                 crop: crop,

data/lib/jekyll/filters/width.rb

@@ -6,14 +6,14 @@ module Jekyll
     module Width
       def width(input)
         return unless input
-        input = @context.registers[:site].in_source_dir input
+        path = @context.registers[:site].in_source_dir input
 
-        unless ::File.exist? input
+        unless ::File.exist? path
           Jekyll.logger.warn "File doesn't exist #{input}"
           return input
         end
 
-        Jekyll::Images::Cache.cached_image(input).width
+        Jekyll::Images::Cache.cached_image(path).width
       rescue Vips::Error => e
         Jekyll.logger.warn "Failed to process #{input}: #{e.message}"
         nil

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 ? '1' : '0'), file]
       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

data/lib/jekyll-images.rb

@@ -2,7 +2,9 @@
 
 require_relative 'jekyll/images/cache'
 
-Jekyll::Images::Cache.site = Jekyll.sites.first
+Jekyll::Hooks.register :site, :after_reset do |site|
+  Jekyll::Images::Cache.site = site
+end
 
 require_relative 'jekyll/images/image'
 require_relative 'jekyll/images/thumbnail'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-images
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0rc0
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -99,11 +99,11 @@ 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.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Optimizes images for Jekyll