jekyll-img-srcset 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf79fa5f1ff463976c7dbde6bc5e1b405ebb92ab44cc6cd8c60060507cefa0b7
-  data.tar.gz: 40674108c46079ffcf0cf211eda8a80f649e0b8e5baf0c3e7a1a842a90e5d170
+  metadata.gz: 92a18f3afa30c975e5595fb97644e09667ccb469c19fdb8ffb2641e6a6864b13
+  data.tar.gz: 2c87894a3a7f6f37a2f9757ebe6370818c6f2a1c7aa0514258557d5c8a4f21db
 SHA512:
-  metadata.gz: aa7ffe7b1cf84795ca502e50fba30517b25c2cc070e499271902ff18ffd8c188e14e9ec8e9a9ccbedb7eb9e1f552e6515349078cc58e67b0aaf0dd2fd898b2c2
-  data.tar.gz: 59256b325e7c5ba46307240c8c85ee94a0a134deaec5e44872bef72dc46b943f213ee561c4473c6823304ee5a3e8765ccbf6f8ef6f3ea35a2ffe589632c22970
+  metadata.gz: df94acc2e731136259369e950b9067ba4f2582b17a02e18709486346900c956206c24cb7b1c8cd7570367393358ae30aa78f77763e0bfedfbede2ff84345680c
+  data.tar.gz: 23acba98d8129f4f00c475b142fe5a769f565ced4362846cf21868db848218e831a24dc2b47caebffb837f6a3b2d08c8d6a74e142ad3303e8693f95a7c01ca91

data/lib/jekyll-img-srcset.rb

@@ -1,25 +1,48 @@
 require 'mini_magick'
 
-def resize_image(url, widths, dest, base_image_path)
-    image = MiniMagick::Image.open(File.join(base_image_path, url))
-    w = image.dimensions[0]
-    aspect = image.dimensions[1].to_f / w
-    new_widths = widths.select {|x| x <= w}
-    new_widths.map do |width| 
-        [width, File.join(dest, base_image_path, "#{width}", url)]
-    end.select do |width, target| 
-        not File.exists? target
-    end.each do |width, target|
-        image = MiniMagick::Image.open(File.join(base_image_path, url))
-        image.resize "#{width}x#{width*aspect}"
-        if not Dir.exists? File.dirname(target)
-            FileUtils.mkdir_p File.dirname(target)
+# Resizes an image to provide different versions for multiple
+# display resolutions
+#
+# @param url [String] the image's url
+# @param widths [Array<Numeric>] 
+#       target sizes to resize to; 
+#       only widths smaller than the original width are generated
+# @param base_image_path [String] the base image path. Usually assets/images
+# @param cache [Jekyll::Cache] 
+#       cache object to not resize if the computation was already done
+# @return [Array<Numeric>, Numeric] 
+#       the generated widths and the original iamge width
+def resize_image(url, widths, dest, base_image_path, cache)
+    src_path = File.join(base_image_path, url)
+    new_widths, w = cache.getset(src_path) do
+        image = MiniMagick::Image.open(src_path)
+        w = image.dimensions[0]
+        aspect = image.dimensions[1].to_f / w
+        [w, aspect] 
+        new_widths = widths.select {|x| x <= w}
+        new_widths.map do |width| 
+            [width, File.join(dest, base_image_path, "#{width}", url)]
+        end.select do |width, target| 
+            not File.exists? target
+        end.each do |width, target|
+            image = MiniMagick::Image.open(src_path)
+            image.resize "#{width}x#{width*aspect}"
+            if not Dir.exists? File.dirname(target)
+                FileUtils.mkdir_p File.dirname(target)
+            end
+            image.write target
         end
-        image.write target
+        [new_widths, w]
     end
     return new_widths, w
 end
 
+# Parses the argument list
+#
+# @param ident [String]
+#   the list to parse, e.g., '.someclass key="value"'
+# @return [Hash]
+#   a hash containing the sorted values
 def parse_identifier(ident)
     i = {
         classes: [],
@@ -83,6 +106,7 @@ def format_image(ident, sizes, original_width, url, caption, title, baseurl, bas
     return content
 end
 
+# Formats svg image data by providing the associated image tag
 def format_svg_image(url, ident, title, baseurl, base_image_path)
     content = "<img "
     if not ident[:style].nil?
@@ -99,6 +123,7 @@ end
 def process_page(document, payload)
     # see https://gist.github.com/mmistakes/77c68fbb07731a456805a7b473f47841
     doc_ext = document.extname.tr('.', '')
+    cache = Jekyll::Cache.new("jekyll-img-srcset")
     if payload['site']['markdown_ext'].include? doc_ext
         content = document.content
         base_image_path = document.site.config["base_image_path"] || "assets/images"
@@ -118,7 +143,7 @@ def process_page(document, payload)
                     widths, original_width = resize_image(img['url'], 
                         document.site.config["widths"],
                         document.site.config["destination"], 
-                        base_image_path)
+                        base_image_path, cache)
                     document.site.keep_files.concat(widths.map do |w|
                         File.join(base_image_path, "#{w}", img['url'])
                     end)
@@ -140,12 +165,6 @@ Jekyll::Hooks.register [:pages, :posts, :documents], :pre_render do |document, p
     process_page(document, payload)
 end
 
-# Jekyll::Hooks.register [:pages, :posts, :documents], :post_render do |document, payload|
-#     # puts "Post"
-#     # puts document
-#     process_page(document, payload)
-# end
-
 def check_in_context(context, path)
     parts = path.split(".")
     c = context.dup
@@ -161,6 +180,10 @@ end
 
 module Jekyll
     class ImgSrcsetTag < Liquid::Tag
+
+      def cache
+        @@cache ||= Jekyll::Cache.new("jekyll-img-srcset")
+      end
   
       def initialize(tag_name, text, tokens)
         super
@@ -193,13 +216,11 @@ module Jekyll
             end
         end
 
-        #puts "fs context: #{context.find_variable('first_image')}"
-        # puts "Prepare image: #{attrs[:src]}"
         if File.exists?(File.join base_image_path, attrs[:src])
             widths, original_width = resize_image(
                 attrs[:src], 
                 config["widths"],
-                config["destination"], base_image_path)
+                config["destination"], base_image_path, cache)
             context.registers[:site].keep_files.concat(widths.map do |w|
                 File.join(base_image_path, "#{w}", attrs[:src])
             end)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-img-srcset
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jan-Philipp Stauffert