jekyll_picture_tag 1.13.0 → 2.0.2

data/lib/jekyll_picture_tag.rb

@@ -5,9 +5,12 @@ require_relative 'jekyll_picture_tag/cache'
 require_relative 'jekyll_picture_tag/images'
 require_relative 'jekyll_picture_tag/instructions'
 require_relative 'jekyll_picture_tag/output_formats'
+require_relative 'jekyll_picture_tag/parsers'
 require_relative 'jekyll_picture_tag/router'
 require_relative 'jekyll_picture_tag/srcsets'
 require_relative 'jekyll_picture_tag/utils'
+require_relative 'jekyll_picture_tag/defaults/presets'
+require_relative 'jekyll_picture_tag/defaults/global'
 
 # Title: Jekyll Picture Tag
 # Authors: Rob Wierzbowski   : @robwierzbowski
@@ -60,7 +63,9 @@ module PictureTag
     def render(context)
       setup(context)
 
-      if PictureTag.disabled?
+      if PictureTag.disabled? || PictureTag.raw_params.empty?
+        Utils.warning 'You have called JPT without any arguments.'
+
         ''
       else
         PictureTag.output_class.new.to_s
@@ -70,11 +75,9 @@ module PictureTag
     private
 
     def setup(context)
+      PictureTag.clear_instructions
       PictureTag.context = context
-
-      # Now that we have both the tag parameters and the context object, we can
-      # build our instruction set.
-      PictureTag.instructions = Instructions::Set.new(@raw_params)
+      PictureTag.raw_params = @raw_params
 
       # We need to explicitly prevent jekyll from overwriting our generated
       # image files:

data/lib/jekyll_picture_tag/cache.rb

@@ -1,3 +1,64 @@
-require_relative 'cache/base'
-require_relative 'cache/source'
-require_relative 'cache/generated'
+require 'json'
+
+module PictureTag
+  # Store expensive bits of information between text files. Originally cached
+  # width & heights of images in addition to digests, now just image digests.
+  class Cache
+    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.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')
+    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
+
+    def template
+      { digest: nil }
+    end
+  end
+end

data/lib/jekyll_picture_tag/defaults/global.rb

@@ -0,0 +1,18 @@
+module PictureTag
+  # Default settings for _config.yml
+  DEFAULT_CONFIG = {
+    'picture' => {
+      'source' => '',
+      'output' => 'generated',
+      'suppress_warnings' => false,
+      'relative_url' => true,
+      'cdn_environments' => ['production'],
+      'nomarkdown' => true,
+      'ignore_missing_images' => false,
+      'disabled' => false,
+      'fast_build' => false,
+      'ignore_baseurl' => false,
+      'baseurl_key' => 'baseurl'
+    }
+  }.freeze
+end

data/lib/jekyll_picture_tag/defaults/presets.rb

@@ -0,0 +1,57 @@
+module PictureTag
+  DEFAULT_PRESET = { 'markup' => 'auto',
+                     'formats' => ['original'],
+                     'widths' => [400, 600, 800, 1000],
+                     'fallback_width' => 800,
+                     'fallback_format' => 'original',
+                     'noscript' => false,
+                     'link_source' => false,
+                     'quality' => 75,
+                     'format_quality' => { 'webp' => 50,
+                                           'avif' => 30,
+                                           'jp2' => 30 },
+                     'data_sizes' => true,
+                     'keep' => 'attention',
+                     'dimension_attributes' => false,
+                     'strip_metadata' => true,
+                     'image_options' => {
+                       'avif' => { 'compression' => 'av1', 'speed' => 8 }
+                     } }.freeze
+
+  STOCK_PRESETS = {
+    'jpt-webp' => { 'formats' => %w[webp original] },
+
+    'jpt-avif' => { 'formats' => %w[avif webp original] },
+
+    'jpt-lazy' => { 'markup' => 'data_auto',
+                    'noscript' => true,
+                    'formats' => %w[webp original],
+                    'attributes' => { 'parent' => 'class="lazy"' } },
+
+    'jpt-loaded' => { 'formats' => %w[avif jp2 webp original],
+                      'dimension_attributes' => true },
+
+    'jpt-direct' => { 'markup' => 'direct_url',
+                      'fallback_format' => 'webp',
+                      'fallback_width' => 600 },
+
+    'jpt-thumbnail' => { 'base_width' => 250,
+                         'pixel_ratios' => [1, 1.5, 2],
+                         'formats' => %w[webp original],
+                         'fallback_width' => 250,
+                         'attributes' => { 'picture' => 'class="icon"' } },
+
+    'jpt-avatar' => { 'base_width' => 100,
+                      'pixel_ratios' => [1, 1.5, 2],
+                      'fallback_width' => 100,
+                      'crop' => '1:1' }
+  }.freeze
+
+  STOCK_MEDIA_QUERIES = {
+    'jpt-mobile' => 'max-width: 480px',
+    'jpt-tablet' => 'max-width: 768',
+    'jpt-laptop' => 'max-width: 1024px',
+    'jpt-desktop' => 'max-width: 1200',
+    'jpt-wide' => 'min-width: 1201'
+  }.freeze
+end

data/lib/jekyll_picture_tag/images.rb

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

data/lib/jekyll_picture_tag/images/generated_image.rb

@@ -1,18 +1,20 @@
-require 'mini_magick'
+require 'ruby-vips'
 
 module PictureTag
-  # Represents a generated image file.
+  # Represents a generated image, but not the file itself. Its purpose is to
+  # make its properties available for query, and hand them off to the ImageFile
+  # class for generation.
   class GeneratedImage
-    attr_reader :width, :format
+    attr_reader :width
 
-    include MiniMagick
-
-    def initialize(source_file:, width:, format:, crop: nil, gravity: '')
+    def initialize(source_file:, width:, format:)
       @source = source_file
       @width  = width
-      @format = process_format format
-      @crop = crop
-      @gravity = gravity
+      @raw_format = format
+    end
+
+    def format
+      @format ||= process_format(@raw_format)
     end
 
     def exists?
@@ -43,77 +45,40 @@ module PictureTag
 
     # Post crop
     def source_width
-      update_cache unless cache[:width]
-
-      cache[:width]
+      image.width
     end
 
     # Post crop
     def source_height
-      update_cache unless cache[:height]
-
-      cache[:height]
+      image.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}")
+    def quality
+      PictureTag.quality(format, width)
     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
+    private
 
-    # Hash all inputs and truncate, so we know when they change without getting too long.
+    # 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]
+      @id ||= Digest::MD5.hexdigest(settings.join)[0..8]
     end
 
-    # Post crop, before resizing and reformatting
-    def image
-      @image ||= open_image
+    def settings
+      [@source.digest, @source.crop, @source.keep, quality]
     end
 
-    def open_image
-      image_base = Image.open(@source.name)
-      image_base.combine_options do |i|
-        i.auto_orient
-        if @crop
-          i.gravity @gravity
-          i.crop @crop
-        end
-      end
-
-      @source_dimensions = { width: image_base.width, height: image_base.height }
-
-      image_base
+    def image
+      @image ||= Vips::Image.new_from_file @source.name
     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
+      return if @source.missing
 
-    def quality
-      PictureTag.quality(@format, @width)
+      ImageFile.new(@source, self)
     end
 
     def process_format(format)

data/lib/jekyll_picture_tag/images/image_file.rb

@@ -0,0 +1,105 @@
+module PictureTag
+  # Basically a wrapper class for vips. Handles image operations.
+  # Vips returns new images for Crop, resize, and autorotate operations.
+  # Quality, metadata stripping, and format are applied on write.
+  #
+  # This deserves to be two classes and a factory, one for normal vips save and
+  # one for magicksave. This is illustrated by the fact that stubbing backend
+  # determination logic for its unit tests would basically require
+  # re-implementing it completely.
+  #
+  # I'm planning to implement standalone imagemagick as an alternative to vips,
+  # so when I add that I'll also do that refactoring. For now it works fine and
+  # it's not too bloated.
+  class ImageFile
+    def initialize(source, base)
+      @source = source
+      @base = base
+
+      build
+    end
+
+    private
+
+    attr_reader :source, :base
+
+    def build
+      notify
+
+      mkdir
+
+      image = load_image
+
+      image = process(image)
+
+      write(image)
+    end
+
+    # Processing pipeline
+    def process(image)
+      image = crop(image) if source.crop?
+
+      image = resize(image)
+
+      image.autorot
+    end
+
+    def handler
+      PictureTag.backend.handler_for(@base.format)
+    end
+
+    def quality_key
+      handler == :vips ? :Q : :quality
+    end
+
+    def write_opts
+      opts = PictureTag.preset['image_options'][@base.format] || {}
+
+      opts[:strip] = PictureTag.preset['strip_metadata']
+
+      # gifs don't accept a quality setting, and PNGs don't on older versions of
+      # vips. Since it's not remarkably useful anyway, we'll ignore them.
+      opts[quality_key] = base.quality unless %w[gif png].include? base.format
+
+      opts.transform_keys(&:to_sym)
+    end
+
+    def load_image
+      Vips::Image.new_from_file source.name
+    end
+
+    def write(image)
+      case handler
+      when :vips
+        image.write_to_file(base.absolute_filename, **write_opts)
+        # If vips can't handle it, fall back to imagemagick.
+      when :magick
+        image.magicksave(base.absolute_filename, **write_opts)
+      end
+
+      # Fix permissions. TODO - still necessary?
+      FileUtils.chmod(0o644, base.absolute_filename)
+    end
+
+    def notify
+      puts 'Generating new image file: ' + base.name
+    end
+
+    def resize(image)
+      image.resize(scale_value)
+    end
+
+    def crop(image)
+      image.smartcrop(*source.dimensions,
+                      interesting: PictureTag.keep(@source.media_preset))
+    end
+
+    def scale_value
+      base.width.to_f / source.width
+    end
+
+    def mkdir
+      FileUtils.mkdir_p(File.dirname(base.absolute_filename))
+    end
+  end
+end

data/lib/jekyll_picture_tag/images/img_uri.rb

@@ -18,7 +18,7 @@ module PictureTag
     # |     domain       |  baseurl   |       directory       | filename
     def to_s
       Addressable::URI.escape(
-        File.join(domain, baseurl, directory, @filename)
+        File.join(domain, PictureTag.baseurl, directory, @filename)
       )
     end
 
@@ -29,21 +29,14 @@ module PictureTag
     # |     domain       |  baseurl   |    j-p-t output dir   | filename
     def domain
       if PictureTag.cdn?
-        PictureTag.pconfig['cdn_url']
-      elsif PictureTag.pconfig['relative_url']
+        PictureTag.cdn_url
+      elsif PictureTag.relative_url
         ''
       else
         PictureTag.config['url'] || ''
       end
     end
 
-    # https://example.com/my-base-path/assets/generated-images/image.jpg
-    #                     ^^^^^^^^^^^^^
-    # |     domain       |  baseurl   |       directory       | filename
-    def baseurl
-      PictureTag.config['baseurl'] || ''
-    end
-
     # https://example.com/my-base-path/assets/generated-images/image.jpg
     #                                  ^^^^^^^^^^^^^^^^^^^^^^^^
     # |     domain       |  baseurl   |       directory       | filename