jekyll-picture-tag-ng 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cd5f67823462661b93520b765668c3da82794480e4e58a7fb6657b41920c893
-  data.tar.gz: f76fc204106a3dc79fa40dbbb371ac988dcf6f2043a3089d2ab79b24cc6d94c7
+  metadata.gz: 8c023d8fa0eeb80434e5a7b0765ef2f5ae23d4b9cb042dfd11fc378113bb4796
+  data.tar.gz: d533e604e583d1003db2f5a6837d5fe5dc0906812e426221239332577b141b13
 SHA512:
-  metadata.gz: 5ea82a06e9626494f78b35a962733ff979f4c9b9c956e56a120290cc9c24930c10b7db29d409c0ec73741100341e5fce63be1d92b86fa54907847975dc4b0f0a
-  data.tar.gz: d967db3c36973c4eb29cca8c45a39b16c8cb9ece0003663c3ac2c11dd24435421d3b87248c15eca243a6cd333b820c7c591ec077e1c3de365efed46e2dd427f5
+  metadata.gz: 794f56c96b166b376951c77b27a22dd9d285f03626dbcd3127a58f60b601a316c48d60f42bba1e6733e4517f82c1826fc40e611d467ccdbfd3261b35ec0571b2
+  data.tar.gz: 6b854e35c9ca6d7acba69b938f3c14d7622e7c3b39b1743541031a641f2b3ba9aaab7f52752d93f1bf86fc85d1ef47b6d85badeb9e72d1eb1bed9ae3ac3ce4ac

data/README.md

@@ -159,6 +159,25 @@ to the following HTML :
 </picture>
 ```
 
+#### Extra `convert` arguments
+
+The `extra_convert_args` and `pre_extra_convert_args` options allow you to add any [`convert` argument](https://imagemagick.org/script/convert.php) to the image conversion processes. The `pre_extra_convert_args` will be added before the resize operation, and the `extra_convert_args` after the resize operation. These options must be either arrays of strings or a string that will be split on spaces. This can be used to add a watermark to all your pictures (see example below).
+
+Additionally, you can set different values based on the version for both these options. In the example below, the `m` version of output pictures will be blurred :
+
+```yaml
+picture_tag_ng:
+  pre_extra_convert_args: ["-font", "DejaVu-Sans-Book", "-pointsize", "72",
+    "-fill", "black", "-annotate", "+25+75", "Watermark"] # Add watermark to all output pics
+  picture_versions:
+    m:
+      out_size: 700
+      extra_convert_args: ["-scale", "20%", "-blur", "0x2.5", "-resize", "500%"] # Blur `m` pics
+    s: 400
+```
+
+You can disable the default resize operation by setting `replace_convert_args: true` either at the plugin level or at the version level. If the, the version-specific value will override the plugin-global value.
+
 ## Development
 
 After cloning the repo, you can run the following commands in a local Jekyll website's folder to start hacking on the code of `jekyll-picture-tag-ng` (you'll need to replace the path in the second command) :

data/lib/jekyll-picture-tag-ng/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module PictureTag
-    VERSION = "0.4.0"
+    VERSION = "0.5.1"
   end
 end

data/lib/jekyll-picture-tag-ng.rb

@@ -16,7 +16,9 @@ module Jekyll
         "s" => "400",
         "m" => "700"
       },
-      "background_color" => "FFFFFF"
+      "background_color" => "FFFFFF",
+      "extra_convert_args" => [],
+      "replace_convert_args" => false
     }.freeze
 
     class Error < StandardError; end
@@ -39,33 +41,77 @@ module Jekyll
         @config ||= CONFIG.merge(@site.config["picture_tag_ng"] || {})
       end
 
+      def replace_args
+        result = config["replace_convert_args"]
+        if picture_versions[@version].is_a?(Hash) &&
+           !picture_versions[@version]["replace_convert_args"].nil?
+          result = picture_versions[@version]["replace_convert_args"]
+        end
+        result
+      end
+
       def picture_versions
         config["picture_versions"]
       end
 
+      def as_args(input)
+        if input.nil?
+          []
+        elsif input.is_a?(Array)
+          input.clone
+        elsif input.is_a?(String)
+          input.split(" ")
+        else
+          raise(
+            TypeError,
+            "[jekyll-picture-tag-ng] `extra_convert_args` must be an array or a string (#{input})"
+          )
+        end
+      end
+
+      def convert_args
+        @convert_args ||= as_args(config["extra_convert_args"]).concat(
+          picture_versions[@version].is_a?(Hash) &&
+          picture_versions[@version]["extra_convert_args"] || []
+        )
+      end
+
+      def pre_convert_args
+        @pre_convert_args ||= as_args(config["pre_extra_convert_args"]).concat(
+          picture_versions[@version].is_a?(Hash) &&
+          picture_versions[@version]["pre_extra_convert_args"] || []
+        )
+      end
+
       def picture?
         extname =~ /(\.jpg|\.jpeg|\.webp)$/i
       end
 
       def destination(dest)
         output_dir = File.join("img", @version, @dir)
-        output_basename = @site.in_dest_dir(@site.dest, File.join(output_dir, "#{basename}.#{@pictype}"))
+        output_basename = @site.in_dest_dir(
+          @site.dest,
+          File.join(output_dir, "#{basename}.#{@pictype}")
+        )
         FileUtils.mkdir_p(File.dirname(output_dir))
         @destination ||= {}
         @destination[dest] ||= output_basename
       end
 
       def popen_args(dest_path)
-        args = ["convert", @path, "-resize", "#{@picture_dim}x>"]
+        args = ["convert", @path]
+        args.concat pre_convert_args
+        args.concat ["-resize", "#{@picture_dim}x>"] unless replace_args
         if @pictype == "jpg"
           args.concat ["-background", "##{@config["background_color"]}",
                        "-flatten", "-alpha", "off"]
         end
+        args.concat convert_args
         args.push dest_path
       end
 
       def copy_file(dest_path)
-        Jekyll.logger.debug "copy_file : #{path} -> #{dest_path}"
+        Jekyll.logger.debug "copy_file : #{path} -> #{dest_path} (#{popen_args(dest_path)})"
         p = IO.popen(popen_args(dest_path))
         p.close
         File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path)
@@ -225,21 +271,17 @@ module Kramdown
       end
 
       def media_attribute(version)
-        if version == default_pic_version
-          ""
-        else
-          geometry = picture_versions[version]
-          if geometry.is_a?(Hash)
-            if geometry["media"].is_a?(String)
-              "media=\"#{geometry["media"]}\""
-            elsif geometry["media"].is_a?(Integer)
-              "media=\"(max-width: #{geometry["media"]}px)\""
-            else
-              "media=\"(max-width: #{geometry["out_size"]}px)\""
-            end
+        geometry = picture_versions[version]
+        if geometry.is_a?(Hash)
+          if geometry["media"].is_a?(String)
+            "media=\"#{geometry["media"]}\""
+          elsif geometry["media"].is_a?(Integer)
+            "media=\"(max-width: #{geometry["media"]}px)\""
           else
-            "media=\"(max-width: #{geometry}px)\""
+            "media=\"(max-width: #{geometry["out_size"]}px)\""
           end
+        else
+          "media=\"(max-width: #{geometry}px)\""
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-picture-tag-ng
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - pcouy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-28 00:00:00.000000000 Z
+date: 2023-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll