jekyll_picture_tag 1.10.2 → 2.0.0pre1

data/lib/jekyll_picture_tag/output_formats/img.rb

@@ -3,6 +3,8 @@ module PictureTag
     # Represents a bare <img> tag with a srcset attribute.
     # Used when <picture> is unnecessary.
     class Img < Basic
+      private
+
       def srcset
         @srcset ||= build_srcset(
           PictureTag.source_images.first, PictureTag.formats.first
@@ -17,8 +19,17 @@ module PictureTag
 
         img.attributes << PictureTag.html_attributes['parent']
 
+        add_dimensions(img, srcset)
+
         img
       end
+
+      def add_dimensions(img, srcset)
+        return unless PictureTag.preset['dimension_attributes']
+
+        img.width = srcset.width_attribute
+        img.height = srcset.height_attribute
+      end
     end
   end
 end

data/lib/jekyll_picture_tag/output_formats/picture.rb

@@ -3,7 +3,13 @@ module PictureTag
     # Represents a <picture> tag, enclosing at least 2 <source> tags and an
     # <img> tag.
     class Picture < Basic
+      private
+
       def srcsets
+        @srcsets ||= build_srcsets
+      end
+
+      def build_srcsets
         formats = PictureTag.formats
         # Source images are provided in reverse order and must be flipped:
         images = PictureTag.source_images.reverse
@@ -37,6 +43,22 @@ module PictureTag
         source
       end
 
+      def build_base_img
+        img = super
+
+        # Only add source dimensions if there is a single source image.
+        # Currently you can't use both art direction and intrinsic image sizes.
+        if PictureTag.preset['dimension_attributes'] &&
+           PictureTag.source_images.length == 1
+          img.attributes << {
+            width: srcsets.first.width_attribute,
+            height: srcsets.first.height_attribute
+          }
+        end
+
+        img
+      end
+
       def base_markup
         picture = DoubleTag.new(
           'picture',

data/lib/jekyll_picture_tag/parsers.rb

@@ -0,0 +1,5 @@
+require_relative 'parsers/arg_splitter'
+require_relative 'parsers/configuration'
+require_relative 'parsers/html_attributes'
+require_relative 'parsers/preset'
+require_relative 'parsers/tag_parser'

data/lib/jekyll_picture_tag/{instructions → parsers}/arg_splitter.rb

@@ -1,5 +1,5 @@
 module PictureTag
-  module Instructions
+  module Parsers
     # This class takes in the arguments passed to the liquid tag, and splits it
     # up into 'words' (correctly handling quotes and backslash escapes.)
     #
@@ -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/parsers/configuration.rb

@@ -0,0 +1,28 @@
+module PictureTag
+  module Parsers
+    # Global config (big picture). loads jekyll data/config files, and the j-p-t
+    # defaults from included yml files.
+    class Configuration
+      # returns jekyll's configuration (picture is a subset)
+      def [](key)
+        content[key]
+      end
+
+      private
+
+      def content
+        @content ||= setting_merge(DEFAULT_CONFIG, PictureTag.site.config)
+      end
+
+      def setting_merge(default, jekyll)
+        jekyll.merge default do |_key, config_setting, default_setting|
+          if default_setting.respond_to? :merge
+            setting_merge(default_setting, config_setting)
+          else
+            config_setting
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/{instructions → parsers}/html_attributes.rb

@@ -1,5 +1,5 @@
 module PictureTag
-  module Instructions
+  module Parsers
     # Handles HTML attributes, sourced from configuration and the liquid tag,
     # sent to various elements.
     # Stored as a hash, with string keys.

data/lib/jekyll_picture_tag/parsers/preset.rb

@@ -0,0 +1,43 @@
+module PictureTag
+  module Parsers
+    # Handles the specific tag image set to construct.
+    class Preset
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def [](key)
+        content[key]
+      end
+
+      protected
+
+      def content
+        @content ||= DEFAULT_PRESET.merge settings
+      end
+
+      private
+
+      def settings
+        PictureTag.site.data.dig('picture', 'presets', name) ||
+          STOCK_PRESETS[name] ||
+          no_preset
+      end
+
+      def no_preset
+        unless name == 'default'
+          Utils.warning(
+            <<~HEREDOC
+              Preset "#{name}" not found in #{PictureTag.config['data_dir']}/picture.yml
+              under 'presets' key, or in stock presets. Using default values."
+            HEREDOC
+          )
+        end
+
+        {}
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/{instructions → parsers}/tag_parser.rb

@@ -1,5 +1,5 @@
 module PictureTag
-  module Instructions
+  module Parsers
     # Tag Parsing Responsibilities:
     #
     #  {% picture mypreset a.jpg 3:2 mobile: b.jpg --alt "Alt" --link "/" %}
@@ -9,17 +9,16 @@ module PictureTag
     # string), hands them to ArgSplitter (which breaks them up into an array of
     # words), extracts the preset name (if present), source image name(s),
     # associated media queries (if present), and image-related arguments such as
-    # crop and gravity. HTML attributes are handed off to its respective class
+    # crop and keep. HTML attributes are handed off to its respective class
     # (as 'leftovers')
     #
     # Media presets and source names are stored as arrays in their correct
-    # orders. Gravities and geometries are stored in a hash, keyed by their
+    # orders. Crop settings are stored in a hash, keyed by their
     # relevant media presets. Note that the base image will have a media preset
     # of nil, which is a perfectly fine hash key.
-    #
     class TagParser
-      attr_reader :preset_name, :source_names, :media_presets, :gravities,
-                  :geometries, :leftovers
+      attr_reader :preset_name, :source_names, :media_presets, :keep,
+                  :crop, :leftovers
 
       def initialize(raw_params)
         @raw_params = raw_params
@@ -27,8 +26,8 @@ module PictureTag
 
         @media_presets = []
         @source_names = []
-        @geometries = {}
-        @gravities = {}
+        @keep = {}
+        @crop = {}
 
         parse_params
       end
@@ -51,14 +50,18 @@ module PictureTag
       end
 
       def parse_param(param)
+        # Media query, i.e. 'mobile:'
         if param.match?(/[\w\-]+:$/)
           add_media_source
 
-        elsif Utils::GRAVITIES.include?(param.downcase)
-          @gravities[@media_presets.last] = @params.shift
+        # Smartcrop interestingness setting. We label it 'keep', since it
+        # determines what to keep when cropping.
+        elsif %w[none centre center entropy attention].include?(param.downcase)
+          @keep[@media_presets.last] = @params.shift
 
-        elsif param.match?(Utils::GEOMETRY_REGEX)
-          @geometries[@media_presets.last] = @params.shift
+        # Aspect ratio, i.e. '16:9'
+        elsif param.match?(/\A\d+:\d+\z/)
+          @crop[@media_presets.last] = @params.shift
 
         else
           raise_error(param)

data/lib/jekyll_picture_tag/router.rb

@@ -1,114 +1,57 @@
 module PictureTag
   # The rest of the application doesn't care where the instruction logic
-  # resides. The following module 'routes' method calls to the right place, so
-  # the rest of the application can just call 'PictureTag.(some method)'
-
-  # At first I thought I'd do some sweet dynamic metaprogramming here, but it
-  # ended up complicated and clever, rather than convenient and understandable.
-  # This way is not strictly DRY, but it's straightforward and readable. If it
-  # gets big, I'll refactor.
+  # resides. This module 'routes' method calls to the right place, so
+  # information consumers can just call 'PictureTag.(some method)'
+  #
+  # This is accomplished with a bit of metaprogramming, which is hopefully not
+  # unnecessarily clever or complicated. Missing methods are converted to class
+  # names, which are looked up under the Instructions module namespace.
+  #
+  # Instantiated Instructions are stored in a hash, keyed by method name.
   module Router
-    attr_accessor :instructions, :context
-    # Context forwarding
+    # These two attributes encompass everything passed in by Jekyll.
+    attr_accessor :raw_params, :context
 
-    # Global site data
-    def site
-      @context.registers[:site]
+    def method_missing(method_name, *args)
+      if instruction_exists?(method_name)
+        instruction(method_name).value(*args)
+      else
+        super
+      end
     end
 
-    # Page which tag is called from
-    def page
-      @context.registers[:page]
+    def respond_to_missing?(method_name, *args)
+      instruction_exists?(method_name) || super
     end
 
-    # Instructions forwarding
-
-    def config
-      @instructions.config
+    # Required at least for testing; instructions are persisted between tags
+    # otherwise.
+    def clear_instructions
+      instructions.clear
     end
 
-    def preset
-      @instructions.preset
-    end
-
-    def media_presets
-      @instructions.media_presets
-    end
-
-    def html_attributes
-      @instructions.html_attributes
-    end
-
-    def output_class
-      @instructions.output_class
-    end
-
-    def source_images
-      @instructions.source_images
-    end
-
-    def crop(media = nil)
-      @instructions.crop(media)
-    end
-
-    def gravity(media = nil)
-      @instructions.gravity(media)
-    end
-
-    # Config Forwarding
-
-    def source_dir
-      config.source_dir
-    end
-
-    def dest_dir
-      config.dest_dir
-    end
-
-    def continue_on_missing?
-      config.continue_on_missing?
-    end
-
-    def cdn?
-      config.cdn?
-    end
-
-    def pconfig
-      config.pconfig
-    end
-
-    def disabled?
-      config.disabled?
-    end
-
-    def fast_build?
-      config.fast_build?
-    end
-
-    # Preset forwarding
-
-    def widths(media)
-      preset.widths(media)
-    end
+    private
 
-    def formats
-      preset.formats
+    def instruction(method_name)
+      instructions[method_name] ||= instruction_class(method_name).new
     end
 
-    def fallback_format
-      preset.fallback_format
+    def instructions
+      @instructions ||= {}
     end
 
-    def fallback_width
-      preset.fallback_width
+    def instruction_exists?(method_name)
+      Object.const_defined? instruction_class_name(method_name.to_sym)
     end
 
-    def nomarkdown?
-      preset.nomarkdown?
+    # Class names can't contain question marks, so we strip them.
+    def instruction_class(method_name)
+      Object.const_get instruction_class_name(method_name)
     end
 
-    def quality(format)
-      preset.quality(format)
+    def instruction_class_name(method_name)
+      'PictureTag::Instructions::' +
+        Utils.titleize(method_name.to_s.delete_suffix('?'))
     end
   end
 end

data/lib/jekyll_picture_tag/srcsets/basic.rb

@@ -23,6 +23,7 @@ module PictureTag
         @format ||= files.first.format
       end
 
+      # GeneratedImage class
       def files
         @files ||= build_files
       end
@@ -51,6 +52,14 @@ module PictureTag
         "(#{PictureTag.media_presets[@media]})"
       end
 
+      def width_attribute
+        source_image.width.to_s
+      end
+
+      def height_attribute
+        source_image.height.to_s
+      end
+
       private
 
       def build_files
@@ -77,11 +86,7 @@ module PictureTag
       end
 
       def source_width
-        @source_width ||= if PictureTag.crop(@media)
-                            target_files.first.cropped_source_width
-                          else
-                            @source_image.width
-                          end
+        source_image.width
       end
 
       def target_files
@@ -103,9 +108,7 @@ module PictureTag
         GeneratedImage.new(
           source_file: @source_image,
           width: width,
-          format: @input_format,
-          crop: PictureTag.crop(@media),
-          gravity: PictureTag.gravity(@media)
+          format: @input_format
         )
       end
     end

data/lib/jekyll_picture_tag/utils.rb

@@ -2,28 +2,10 @@ module PictureTag
   # This is a little module to hold logic that doesn't fit other places. If it
   # starts getting big, refactor.
   module Utils
-    # These are valid ImageMagick gravity arguments (relevant to our use
-    # case):
-    GRAVITIES =
-      %w[center
-         north
-         northeast
-         east
-         southeast
-         south
-         southwest
-         west
-         northwest].freeze
-
-    # This is an attempt to recognize valid imagemagick geometry arguments
-    # with regex. It only tries to match values which don't preserve aspect
-    # ratio, as they're the ones people might actually need here.
-    GEOMETRY_REGEX = /\A\d*%?[x:]?\d*[%!]?([+-]\d+){,2}\Z/i.freeze
-
     class << self
       # Configure Jekyll to keep our generated files
       def keep_files
-        dest_dir = PictureTag.config['picture']['output']
+        dest_dir = PictureTag.pconfig['output']
 
         # Chop a slash off the end, if it's there. Doesn't work otherwise.
         dest_dir = dest_dir[0..-2] if dest_dir =~ %r{/\z}
@@ -35,7 +17,7 @@ module PictureTag
 
       # Print a warning to the console
       def warning(message)
-        return if PictureTag.config['picture']['suppress_warnings']
+        return if PictureTag.pconfig['suppress_warnings']
 
         warn 'Jekyll Picture Tag Warning: '.yellow + message
       end
@@ -63,6 +45,28 @@ module PictureTag
       def titleize(input)
         input.split('_').map(&:capitalize).join
       end
+
+      def snakeize(input)
+        input.scan(/[A-Z][a-z]+/).map(&:downcase).join('_')
+      end
+
+      # Linear interpolator. Pass it 2 values in the x array, 2 values
+      # in the y array, and an x value, returns a y value.
+      def interpolate(xvals, yvals, xval)
+        xvals.map!(&:to_f)
+        yvals.map!(&:to_f)
+
+        # Slope
+        m = (yvals.last - yvals.first) / (xvals.last - xvals.first)
+        # Value of y when x=0
+        b = yvals.first - (m * xvals.first)
+        # y = mx + b
+        (m * xval) + b
+      end
+
+      def aspect_float(width, height)
+        width.to_f / height
+      end
     end
   end
 end