jekyll_picture_tag 1.10.1 → 1.14.0

data/lib/jekyll_picture_tag/cache/base.rb

@@ -0,0 +1,61 @@
+require 'json'
+
+module PictureTag
+  module Cache
+    # Basic image information cache functionality
+    module Base
+      def initialize(base_name)
+        @base_name = base_name
+      end
+
+      def [](key)
+        data[key]
+      end
+
+      def []=(key, value)
+        raise ArgumentError unless template.keys.include? key
+
+        data[key] = value
+      end
+
+      # Call after updating data.
+      def write
+        return if PictureTag.site.config['disable_disk_cache']
+
+        FileUtils.mkdir_p(File.join(base_directory, sub_directory))
+
+        File.open(filename, 'w+') do |f|
+          f.write JSON.generate(data)
+        end
+      end
+
+      private
+
+      def data
+        @data ||= if File.exist?(filename)
+                    JSON.parse(File.read(filename)).transform_keys(&:to_sym)
+                  else
+                    template
+                  end
+      end
+
+      # /home/dave/my_blog/.jekyll-cache/jpt/(cache_dir)/assets/myimage.jpg.json
+      # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+      def base_directory
+        File.join(PictureTag.site.cache_dir, 'jpt', cache_dir)
+      end
+
+      # /home/dave/my_blog/.jekyll-cache/jpt/(cache_dir)/assets/myimage.jpg.json
+      #                                                 ^^^^^^^^
+      def sub_directory
+        File.dirname(@base_name)
+      end
+
+      # /home/dave/my_blog/.jekyll-cache/jpt/somefolder/myimage.jpg.json
+      # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+      def filename
+        File.join(base_directory, @base_name + '.json')
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/cache/generated.rb

@@ -0,0 +1,20 @@
+module PictureTag
+  module Cache
+    # Caches generated image details, so we can skip expensive operations whenever
+    # possible.
+    # Stored width and height are values for the source image, after cropping.
+    class Generated
+      include Base
+
+      private
+
+      def cache_dir
+        'generated'
+      end
+
+      def template
+        { width: nil, height: nil }
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/cache/source.rb

@@ -0,0 +1,19 @@
+module PictureTag
+  module Cache
+    # Caches source image details, so we can skip expensive operations whenever
+    # possible.
+    class Source
+      include Base
+
+      private
+
+      def template
+        { digest: nil, width: nil, height: nil }
+      end
+
+      def cache_dir
+        'source'
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/defaults/global.yml

@@ -9,3 +9,5 @@ picture:
   ignore_missing_images: false
   disabled: false
   fast_build: false
+  ignore_baseurl: false
+  baseurl_key: 'baseurl'

data/lib/jekyll_picture_tag/defaults/presets.yml

@@ -8,3 +8,5 @@ link_source: false
 quality: 75
 data_sizes: true
 gravity: center
+dimension_attributes: false
+strip_metadata: true

data/lib/jekyll_picture_tag/images.rb

@@ -0,0 +1,3 @@
+require_relative 'images/generated_image'
+require_relative 'images/img_uri'
+require_relative 'images/source_image'

data/lib/jekyll_picture_tag/images/generated_image.rb

@@ -0,0 +1,130 @@
+require 'mini_magick'
+
+module PictureTag
+  # Represents a generated image file.
+  class GeneratedImage
+    attr_reader :width, :format
+
+    include MiniMagick
+
+    def initialize(source_file:, width:, format:, crop: nil, gravity: '')
+      @source = source_file
+      @width  = width
+      @format = process_format format
+      @crop = crop
+      @gravity = gravity
+    end
+
+    def exists?
+      File.exist?(absolute_filename)
+    end
+
+    def generate
+      generate_image unless @source.missing || exists?
+    end
+
+    # /home/dave/my_blog/_site/generated/somefolder/myimage-100-123abc.jpg
+    # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    def absolute_filename
+      @absolute_filename ||= File.join(PictureTag.dest_dir, name)
+    end
+
+    # /home/dave/my_blog/_site/generated/somefolder/myimage-100-123abc.jpg
+    #                                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    def name
+      @name ||= "#{@source.base_name}-#{@width}-#{id}.#{@format}"
+    end
+
+    # https://example.com/assets/somefolder/myimage-100-123abc.jpg
+    #                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    def uri
+      ImgURI.new(name).to_s
+    end
+
+    # Post crop
+    def source_width
+      update_cache unless cache[:width]
+
+      cache[:width]
+    end
+
+    # Post crop
+    def source_height
+      update_cache unless cache[:height]
+
+      cache[:height]
+    end
+
+    private
+
+    # We exclude width and format from the cache name, since it isn't specific to them.
+    def cache
+      @cache ||= Cache::Generated.new("#{@source.base_name}-#{id}")
+    end
+
+    def update_cache
+      return if @source.missing
+
+      # Ensure it's generated:
+      image
+
+      cache[:width] = @source_dimensions[:width]
+      cache[:height] = @source_dimensions[:height]
+
+      cache.write
+    end
+
+    # Hash all inputs and truncate, so we know when they change without getting too long.
+    # /home/dave/my_blog/_site/generated/somefolder/myimage-100-1234abcde.jpg
+    #                                                           ^^^^^^^^^
+    def id
+      @id ||= Digest::MD5.hexdigest([@source.digest, @crop, @gravity, quality].join)[0..8]
+    end
+
+    def image
+      return @image if defined? @image
+
+      # Post crop, before resizing and reformatting
+      @source_dimensions = { width: image_base.width, height: image_base.height }
+
+      @image = image_base
+    end
+
+    def image_base
+      @image_base ||= Image.open(@source.name).combine_options do |i|
+        if PictureTag.preset['strip_metadata']
+          i.auto_orient
+          i.strip
+        end
+
+        if @crop
+          i.gravity @gravity
+          i.crop @crop
+        end
+      end
+    end
+
+    def generate_image
+      puts 'Generating new image file: ' + name
+
+      image.format(@format, 0, { resize: "#{@width}x", quality: quality })
+      FileUtils.mkdir_p(File.dirname(absolute_filename))
+
+      image.write absolute_filename
+
+      FileUtils.chmod(0o644, absolute_filename)
+    end
+
+    def quality
+      PictureTag.quality(@format, @width)
+    end
+
+    def process_format(format)
+      if format.casecmp('original').zero?
+        @source.ext
+      else
+        format.downcase
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/{img_uri.rb → images/img_uri.rb}

@@ -8,6 +8,7 @@ module PictureTag
   # image. Call to_s on it to get the link.
   class ImgURI
     attr_reader :filename, :source_image
+
     def initialize(filename, source_image: false)
       @source_image = source_image
       @filename = filename
@@ -40,7 +41,9 @@ module PictureTag
     #                     ^^^^^^^^^^^^^
     # |     domain       |  baseurl   |       directory       | filename
     def baseurl
-      PictureTag.config['baseurl'] || ''
+      return '' if PictureTag.pconfig['ignore_baseurl']
+
+      PictureTag.config[PictureTag.pconfig['baseurl_key']] || ''
     end
 
     # https://example.com/my-base-path/assets/generated-images/image.jpg

data/lib/jekyll_picture_tag/images/source_image.rb

@@ -0,0 +1,103 @@
+module PictureTag
+  # Handles a given source image file and its properties. Provides a speed
+  # advantage by storing expensive file reads and writes in instance variables,
+  # to be reused by many different generated images.
+  class SourceImage
+    attr_reader :shortname, :missing, :media_preset
+
+    include MiniMagick
+
+    def initialize(relative_filename, media_preset = nil)
+      # /home/dave/my_blog/assets/images/somefolder/myimage.jpg
+      #                                  ^^^^^^^^^^^^^^^^^^^^^^
+      @shortname = relative_filename
+      @media_preset = media_preset
+
+      @missing = missing?
+      check_cache
+    end
+
+    def digest
+      @digest ||= cache[:digest] || ''
+    end
+
+    def width
+      @width ||= cache[:width] || 999_999
+    end
+
+    def height
+      @height ||= cache[:height] || 999_999
+    end
+
+    # /home/dave/my_blog/assets/images/somefolder/myimage.jpg
+    # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    def name
+      @name ||= File.join(PictureTag.source_dir, @shortname)
+    end
+
+    # /home/dave/my_blog/assets/images/somefolder/myimage.jpg
+    #                                  ^^^^^^^^^^^^^^^^^^
+    def base_name
+      @shortname.delete_suffix File.extname(@shortname)
+    end
+
+    # /home/dave/my_blog/assets/images/somefolder/myimage.jpg
+    #                                                     ^^^
+    def ext
+      @ext ||= File.extname(name)[1..-1].downcase
+    end
+
+    private
+
+    def cache
+      @cache ||= Cache::Source.new(@shortname)
+    end
+
+    def missing?
+      if File.exist? name
+        false
+
+      elsif PictureTag.continue_on_missing?
+        Utils.warning(missing_image_warning)
+        true
+
+      else
+        raise ArgumentError, missing_image_error
+      end
+    end
+
+    def check_cache
+      return if @missing
+      return if cache[:digest] && PictureTag.fast_build?
+
+      update_cache if source_digest != cache[:digest]
+    end
+
+    def update_cache
+      cache[:digest] = source_digest
+      cache[:width] = image.width
+      cache[:height] = image.height
+
+      cache.write
+    end
+
+    def image
+      @image ||= Image.open(name)
+    end
+
+    def source_digest
+      @source_digest ||= Digest::MD5.hexdigest(File.read(name))
+    end
+
+    def missing_image_warning
+      "JPT Could not find #{name}. Your site will have broken images. Continuing."
+    end
+
+    def missing_image_error
+      <<~HEREDOC
+        Could not find #{name}. You can force the build to continue anyway by
+        setting "picture: ignore_missing_images: true" in "_config.yml".
+      HEREDOC
+    end
+  end
+end

data/lib/jekyll_picture_tag/instructions/arg_splitter.rb

@@ -51,9 +51,10 @@ module PictureTag
       end
 
       def handle_special(char)
-        if char == '\\'
+        case char
+        when '\\'
           @escaped = true
-        elsif char == '"'
+        when '"'
           @in_quotes = !@in_quotes
           @word << char
         end

data/lib/jekyll_picture_tag/instructions/preset.rb

@@ -3,6 +3,7 @@ module PictureTag
     # Handles the specific tag image set to construct.
     class Preset
       attr_reader :name
+
       def initialize(name)
         @name = name
         @content = build_preset
@@ -39,9 +40,24 @@ module PictureTag
         setting_lookup('widths', 'media', media)
       end
 
-      # Image quality setting, possibly dependent on format.
-      def quality(format = nil)
-        setting_lookup('quality', 'format', format)
+      # Image quality setting. Surprisingly complicated; can depend on both format and width.
+      def quality(format = nil, width = nil)
+        setting = setting_lookup('quality', 'format', format)
+
+        return setting unless setting.is_a? Hash
+
+        parse_quality_hash(setting, width)
+      end
+
+      def parse_quality_hash(points, width)
+        # The points can be given in any order.
+        low, high = *points.keys.map(&:to_i).sort
+
+        case width
+        when 0..low then points[low]
+        when low..high then Utils.interpolate(points.keys, points.values, width)
+        when high..999_999 then points[high]
+        end
       end
 
       # Gravity setting (for imagemagick cropping)
@@ -80,9 +96,13 @@ module PictureTag
       end
 
       def grab_data_file
+        search_data('presets') || search_data('markup_presets') || no_preset
+      end
+
+      def search_data(key)
         PictureTag.site
                   .data
-                  .dig('picture', 'markup_presets', @name) || no_preset
+                  .dig('picture', key, @name)
       end
 
       def no_preset

data/lib/jekyll_picture_tag/instructions/set.rb

@@ -27,7 +27,7 @@ module PictureTag
       # These are our Media Query presets. It's really just a hash, and there
       # are no default values, so extracting this to its own class is overkill.
       def media_presets
-        PictureTag.site.data.dig('picture', 'media_presets') || {}
+        search_data('media_queries') || search_data('media_presets') || {}
       end
 
       def source_images
@@ -52,6 +52,10 @@ module PictureTag
 
       private
 
+      def search_data(key)
+        PictureTag.site.data.dig('picture', key)
+      end
+
       def build_source_images
         source_names = params.source_names
         media_presets = params.media_presets