jekyll-responsive-magick 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0baafa9560a330fee2b5f7cce5844e0c7c79752f806b10dbf7bb23f782c6cac
-  data.tar.gz: 475a8781a41e2ff224facab935e7f19aeb5c12b1fd66df9dcea951f4a07b3424
+  metadata.gz: e2905a164041aead23497b61c323bb1e5403b0399e480b093907f48dae526f97
+  data.tar.gz: 12533be2ad6de518f39e29790aa6caad27a6eebc3ee5b7e00201f13beffe8f04
 SHA512:
-  metadata.gz: bd8e381e61b7888dbaa9482b552834fbd85c0a3f182e11c0fb4028c367558cbbe0984402320266f25cb4a6decef5da2f28fbc54accbc363753e4bab01977f8fc
-  data.tar.gz: eb42d09a814fe7a22532c2b1b6a340e8dac979d52e939c9106c40d85f8f7e001f3d1a23c3ca66a4e4c26beb0dfc0457cb6645f1f3a3c3b69384ca50a7bd401c7
+  metadata.gz: bd3c1084b77af29adf4e42ee89936bc53338e680a55cd9300a0ca734f0aae97d964b59930b19d78c357bf8817a668cafe6f661f563e3875002a0094c09ce20a8
+  data.tar.gz: 3090d4acffb28baf78d824a6ddefe5f222b858b8a1d72e1c76d5c03c15992d167a8b28f35c6e6daf6a333dbdf4f0c8d3142caa0e6dba7bfef9ea4e1790b54596

data/lib/jekyll-responsive-magick.rb

@@ -42,129 +42,131 @@ module Jekyll
       @@sizes[input] = sizes.split(',', 2).map!(&:to_i)
     end
 
-    def srcset(input)
-      site = @context.registers[:site]
+    # Throw error if it is not an absolute path
+    def check_path(input, filter_name)
       if not input.is_a? String || input.length == 0 || input.chr != '/'
-        throw "srcset: input must be absolute path"
+        throw "#{filter_name}: path must be an absolute path"
       end
+    end
+
+    # Return true if the file exists and is an image mime type
+    def is_image?(src)
+      cmd = "identify -ping #{src.shellescape} 2>&1"
+      output = `#{cmd}`
+
+      if not $?.success?
+        if output.include?("identify: improper image header")
+          throw "file is not an image: '#{src}'"
+        else
+          throw "width/height: failed to execute 'identity', is ImageMagick installed?"
+        end
+      end
+
+      return true
+    end
+
+    # Convert an image from src to dst with the given width
+    def convert(src, src_extname, dst, width)
+      site = @context.registers[:site]      
+      quality = site.config['responsive']['quality'] || 80
+      verbose = site.config['responsive']['verbose'] || false
+
+      if File.exist?(dst) and File.mtime(src) < File.mtime(dst)
+        return
+      end
+
+      FileUtils.mkdir_p(File.dirname(dst))
+      cmd = "convert #{src_extname == '.apng' ? 'apng:' : ''}#{src.shellescape} -strip -quality #{quality} -resize #{width} #{dst.shellescape}"
+      
+      if verbose
+        print("#{cmd}\n")
+      end
+      
+      if not system(cmd)
+        throw "srcset: failed to execute 'convert', is ImageMagick installed?"
+      end
+    end
+
+    def srcset(input)
+      check_path(input, "srcset")
+      site = @context.registers[:site]
       dirname = File.dirname(input)
       basename = File.basename(input, '.*')
       extname = File.extname(input)
+      new_extname = site.config['responsive']['format'] ? ".#{site.config['responsive']['format']}" : extname
       src = ".#{dirname}/#{basename}#{extname}"
-      srcwidth = width(input)      
+      srcwidth = width(input, "srcset")      
       srcset = ["#{input} #{srcwidth}w"]
 
-      if File.exist?(src) and ['.jpg', '.jpeg', '.png', '.apng', '.gif'].include?(extname)
-        dest = site.dest
-        if site.config['responsive']['widths']
-          widths = site.config['responsive']['widths']
-        else
-          # as default, use breakpoints of Bootstrap 5
-          widths = [576,768,992,1200,1400]
-        end
-        if site.config['responsive']['quality']
-          quality = site.config['responsive']['quality']
-        else
-          quality = 80
-        end
-        if site.config['responsive']['verbose']
-          verbose = site.config['responsive']['verbose']
-        else
-          verbose = false
-        end
+      if not File.exist?(src) or not is_image?(src)
+        throw "srcset: file does not exist or is not an image: '#{src}'"
+      elsif File.extname(src) != '.svg'
+        # as default, use breakpoints of Bootstrap 5
+        widths = site.config['responsive']['widths'] || [576, 768, 992, 1200, 1400]
         
         widths.map do |width|
-          if srcwidth > width
-            file = "#{basename}-#{width}w#{extname}"
-            dst = "_responsive#{dirname}/#{file}"
-            if not site.static_files.find{|file| file.path == dst}
-              site.static_files << StaticFile.new(site, "_responsive", dirname, file)
-              if not File.exist?(dst) or File.mtime(src) > File.mtime(dst)
-                FileUtils.mkdir_p(File.dirname(dst))
-                if extname == '.apng'
-                  cmd = "convert apng:#{src.shellescape} -strip -quality #{quality} -resize #{width} #{dst.shellescape}"
-                else
-                  cmd = "convert #{src.shellescape} -strip -quality #{quality} -resize #{width} #{dst.shellescape}"
-                end
-                if verbose
-                  print("#{cmd}\n")
-                end
-                if not system(cmd)
-                  throw "srcset: failed to execute 'convert', is ImageMagick installed?"
-                end
-              end
-            end
-            srcset.push("#{dirname}/#{file} #{width}w")
+          if not srcwidth > width
+            next # image is not large enough to generate a smaller version
           end
+
+          file = "#{basename}-#{width}w#{new_extname}"
+          dst = "_responsive#{dirname}/#{file}"
+          srcset.push("#{dirname}/#{file} #{width}w")
+
+          if site.static_files.find{|file| file.path == dst}
+            next # image is already generated
+          end
+          
+          site.static_files << StaticFile.new(site, "_responsive", dirname, file)
+          convert(src, extname, dst, width)
         end
       end
+
       return srcset.join(', ')
     end
 
-    def width(input)
-      if not input.is_a? String || input.length == 0 || input.chr != '/'
-        throw "width: input must be absolute path"
-      end
-      if not @@sizes[input]
-        identify(input)
-      end
+    def width(input, from = "width")
+      check_size(input, from)
       return @@sizes[input][0]
     end
 
-    def height(input)
-      if not input.is_a? String || input.length == 0 || input.chr != '/'
-        throw "height: input must be absolute path"
-      end
+    def height(input, from = "width")
+      check_size(input, from)
+      return @@sizes[input][1]
+    end
+
+    def check_size(input, from)
+      check_path(input, from)
       if not @@sizes[input]
         identify(input)
       end
-      return @@sizes[input][1]
     end
 
     def size(input, width)
+      check_path(input, "size")
       site = @context.registers[:site]
-      if not input.is_a? String || input.length == 0 || input.chr != '/'
-        throw "size: input must be absolute path"
-      end
       dirname = File.dirname(input)
       basename = File.basename(input, '.*')
       extname = File.extname(input)
+      new_extname = site.config['responsive']['format'] ? ".#{site.config['responsive']['format']}" : extname
       src = ".#{dirname}/#{basename}#{extname}"
 
-      if site.config['responsive']['quality']
-        quality = site.config['responsive']['quality']
-      else
-        quality = 80
-      end
-      if site.config['responsive']['verbose']
-        verbose = site.config['responsive']['verbose']
-      else
-        verbose = false
+      if not File.exist?(src) or not is_image?(src)
+        throw "srcset: file does not exist or is not an image: '#{src}'"
       end
+      
+      file = "#{basename}-#{width}w#{new_extname}"
+      dst = "_responsive#{dirname}/#{file}"
+      full_path = "#{dirname}/#{file}"
 
-      if File.exist?(src) and ['.jpg', '.jpeg', '.png', '.apng', '.gif'].include?(extname)
-        file = "#{basename}-#{width}w#{extname}"
-        dst = "_responsive#{dirname}/#{file}"
-        if not site.static_files.find{|file| file.path == dst}
-          site.static_files << StaticFile.new(site, "_responsive", dirname, file)
-          if not File.exist?(dst) or File.mtime(src) > File.mtime(dst)
-            FileUtils.mkdir_p(File.dirname(dst))
-            if extname == '.apng'
-              cmd = "convert apng:#{src.shellescape} -strip -quality #{quality} -resize #{width} #{dst.shellescape}"
-            else
-              cmd = "convert #{src.shellescape} -strip -quality #{quality} -resize #{width} #{dst.shellescape}"
-            end
-            if verbose
-              print("#{cmd}\n")
-            end
-            if not system(cmd)
-              throw "size: failed to execute 'convert', is ImageMagick installed?"
-            end
-          end
-        end
+      if site.static_files.find{|file| file.path == dst}
+        return full_path # image is already generated
       end
 
-      return "#{dirname}/#{file}"
+      site.static_files << StaticFile.new(site, "_responsive", dirname, file)
+      convert(src, extname, dst, width)
+
+      return full_path
     end
   end
 end

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-responsive-magick
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Lawrence Murray
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-08 00:00:00.000000000 Z
+date: 2024-03-02 00:00:00.000000000 Z
 dependencies: []
 description: A Jekyll plugin for responsive images. Adds filters for setting the srcset,
   width and height attributes of HTML img elements, while automatically generating
   image variants of configured sizes using the ImageMagick command-line tools. Resized
   images are cached to minimize build times, regenerated only when the original source
-  image changes. Supported image file formats are JPEG, PNG, GIF (including animated),
-  and APNG.
+  image changes. Supported image file formats include JPEG, PNG, GIF (including animated),
+  APNG and WebP.
 email: lawrence@indii.org
 executables: []
 extensions: []
@@ -30,7 +30,7 @@ metadata:
   bug_tracker_uri: https://github.com/lawmurray/jekyll-responsive-magick/issues
   homepage_uri: https://indii.org/software/jekyll-responsive-magick
   source_code_uri: https://github.com/lawmurray/jekyll-responsive-magick
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,8 +45,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: A Jekyll plugin for responsive images using ImageMagick. Works with Jekyll
   4.