jekyll_picture_tag 1.10.2 → 2.0.0pre1

data/lib/jekyll_picture_tag/instructions/children/context.rb

@@ -0,0 +1,24 @@
+module PictureTag
+  module Instructions
+    # Jekyll site info
+    class Site < Instruction
+      def source
+        PictureTag.context.registers[:site]
+      end
+    end
+
+    # Current page in jekyll site
+    class Page < Instruction
+      def source
+        PictureTag.context.registers[:page]
+      end
+    end
+
+    # Digs into jekyll context, returns current environment
+    class JekyllEnv < Instruction
+      def source
+        PictureTag.context.environments.first['jekyll']['environment']
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/instructions/children/params.rb

@@ -0,0 +1,90 @@
+module PictureTag
+  module Instructions
+    # Builds instances of all source images.
+    class SourceImages < Instruction
+      def source
+        {
+          source_names: PictureTag.params.source_names,
+          media_presets: PictureTag.params.media_presets
+        }
+      end
+
+      def coerce
+        sources = [PictureTag::SourceImage.new(source[:source_names].shift)]
+
+        while source[:source_names].any?
+          sources << PictureTag::SourceImage.new(
+            source[:source_names].shift, source[:media_presets].shift
+          )
+        end
+
+        sources
+      end
+    end
+
+    # Which crop to use for a given media query. Can be given either in params
+    # or preset.
+    class Crop < ConditionalInstruction
+      def source
+        super.merge(
+          { params: PictureTag.params.crop }
+        )
+      end
+
+      def coerce(media = nil)
+        raise ArgumentError unless valid?
+
+        source[:params][media] || value_hash[media]
+      end
+
+      def setting_basename
+        'crop'
+      end
+
+      def setting_prefix
+        'media'
+      end
+
+      def acceptable_types
+        super + [String]
+      end
+    end
+
+    # Which vips interestingness setting to use for a given media query. Can be
+    # given either in params or preset.
+    class Keep < ConditionalInstruction
+      def source
+        super.merge(
+          { params: PictureTag.params.keep }
+        )
+      end
+
+      def coerce(media = nil)
+        raise ArgumentError unless valid?
+
+        lookup[source[:params][media] || super(media)]
+      end
+
+      def lookup
+        {
+          'center' => :centre,
+          'centre' => :centre,
+          'attention' => :attention,
+          'entropy' => :entropy
+        }
+      end
+
+      def setting_basename
+        'keep'
+      end
+
+      def setting_prefix
+        'media'
+      end
+
+      def acceptable_types
+        super + [String]
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/instructions/children/parsers.rb

@@ -0,0 +1,41 @@
+module PictureTag
+  module Instructions
+    # PictureTag configuration
+    class Config < Instruction
+      def source
+        PictureTag::Parsers::Configuration.new
+      end
+    end
+
+    # Tag parameters
+    class Params < Instruction
+      def source
+        PictureTag::Parsers::TagParser.new PictureTag.raw_params
+      end
+    end
+
+    # Currently selected preset
+    class Preset < Instruction
+      def source
+        PictureTag::Parsers::Preset.new PictureTag.params.preset_name
+      end
+    end
+
+    # Handles non-image arguments to liquid tag and preset.
+    class HtmlAttributes < Instruction
+      def source
+        PictureTag::Parsers::HTMLAttributeSet.new PictureTag.params.leftovers
+      end
+    end
+
+    # TODO: rename to MediaQueries
+    # Returns user-defined media queries.
+    class MediaPresets < Instruction
+      def source
+        STOCK_MEDIA_QUERIES.merge(
+          PictureTag.site.data.dig('picture', 'media_queries') || {}
+        )
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/instructions/children/preset.rb

@@ -0,0 +1,182 @@
+require 'mime-types'
+
+module PictureTag
+  module Instructions
+    # Returns an instance of the correct markup format's corresponding class
+    class OutputClass < Instruction
+      private
+
+      def source
+        PictureTag.preset['markup']
+      end
+
+      def coerce
+        Object.const_get(class_name)
+      end
+
+      def class_name
+        'PictureTag::OutputFormats::' + Utils.titleize(source)
+      end
+
+      def valid?
+        source.is_a?(String) &&
+          !source.include?(' ') &&
+          Object.const_defined?(class_name)
+      end
+    end
+
+    # Image formats
+    class Formats < Instruction
+      private
+
+      def source
+        PictureTag.preset['formats']
+      end
+
+      def coerce
+        [source].flatten
+      end
+
+      def valid?
+        coerced.all? do |format|
+          types = MIME::Types.type_for(format)
+          format == 'original' ||
+            types.length == 1 && types.first.media_type == 'image'
+        end
+      end
+    end
+
+    # Fallback image format
+    class FallbackFormat < Instruction
+      private
+
+      def source
+        PictureTag.preset['fallback_format']
+      end
+
+      def valid?
+        types = MIME::Types.type_for(coerced)
+        coerced == 'original' ||
+          types.length == 1 && types.first.media_type == 'image'
+      end
+    end
+
+    # Fallback Image width
+    class FallbackWidth < Instruction
+      private
+
+      def source
+        PictureTag.preset['fallback_width']
+      end
+
+      def valid?
+        source.is_a? Integer
+      end
+
+      def error_message
+        <<~HEREDOC
+          fallback_width for preset '#{PictureTag.preset.name}' is invalid. It
+          should be a positive integer. You can use underscores as separators:
+            1200
+            1_200
+        HEREDOC
+      end
+    end
+
+    # Whether to add a {::nomarkdown} wrapper
+    class Nomarkdown < Instruction
+      private
+
+      def source
+        {
+          config: PictureTag.pconfig['nomarkdown'],
+          md_page: Utils.markdown_page?,
+          preset: PictureTag.preset['nomarkdown']
+        }
+      end
+
+      def valid?
+        source.fetch_values(:preset, :config).all? do |setting|
+          [true, false, nil].include? setting
+        end
+      end
+
+      def coerce
+        return source[:preset] unless source[:preset].nil?
+
+        source[:md_page] && source[:config]
+      end
+    end
+
+    # Returns widths for a given media query.
+    class Widths < ConditionalInstruction
+      private
+
+      def setting_name
+        'widths'
+      end
+
+      def setting_prefix
+        'media'
+      end
+
+      def acceptable_types
+        super + [Array]
+      end
+
+      def valid_hash?
+        hash = source[:hash]
+        return true if hash.nil?
+
+        hash.is_a?(Hash) && valid_hash_keys?(hash) && valid_hash_values?(hash)
+      end
+
+      def valid_hash_keys?(hash)
+        hash.keys.all? { |k| k.is_a? String }
+      end
+
+      def valid_hash_values?(hash)
+        hash.values.all? do |val|
+          val.is_a?(Array) && val.all? { |subval| subval.is_a? Integer }
+        end
+      end
+    end
+
+    # Returns quality for a given width.
+    class Quality < ConditionalInstruction
+      private
+
+      def setting_name
+        'quality'
+      end
+
+      def setting_prefix
+        'format'
+      end
+
+      def acceptable_types
+        super + [Integer, Hash]
+      end
+
+      def coerce(format = nil, width = nil)
+        setting = super(format)
+
+        return setting unless setting.is_a? Hash
+
+        parse_quality_hash(setting, width)
+      end
+
+      # Works out linearly interpolated quality settings.
+      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
+    end
+  end
+end

data/lib/jekyll_picture_tag/instructions/parents/conditional_instruction.rb

@@ -0,0 +1,69 @@
+module PictureTag
+  module Instructions
+    # Many inputs take a common format: a generic setting which applies all of
+    # the time, or more specific versions of that setting for specific
+    # circumstances. For example, quality can be set globally, or per image
+    # format. This instruction class handles those cases.
+    #
+    # To use, you must at minimum define setting_basename, setting_prefix, and
+    # add to the acceptable_types (or write your own validation).
+    class ConditionalInstruction < Instruction
+      def value(*args)
+        coerce(*args)
+      end
+
+      private
+
+      def setting_basename
+        raise NotImplementedError
+      end
+
+      # Special condition for setting; media, crop, etc
+      def setting_prefix
+        raise NotImplementedError
+      end
+
+      def acceptable_types
+        [NilClass]
+      end
+
+      def coerce(arg)
+        raise ArgumentError unless valid?
+
+        value_hash[arg]
+      end
+
+      def source
+        {
+          hash: PictureTag.preset[setting_prefix + '_' + setting_name],
+          default: PictureTag.preset[setting_name]
+        }
+      end
+
+      def value_hash
+        vals = source[:hash] || {}
+        vals.default = source[:default]
+
+        vals
+      end
+
+      def valid?
+        valid_hash? && valid_default?
+      end
+
+      def acceptable_type?(value)
+        acceptable_types.any? { |type| value.is_a? type }
+      end
+
+      def valid_hash?
+        source[:hash].nil? || source[:hash].values.all? do |v|
+          acceptable_type?(v)
+        end
+      end
+
+      def valid_default?
+        acceptable_type? source[:default]
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/instructions/parents/env_instruction.rb

@@ -0,0 +1,29 @@
+module PictureTag
+  module Instructions
+    # There are a few config settings which are environment dependent, and can
+    # either be booleans, environment names, or arrays of environment names.
+    # This class works it out and returns a boolean.
+    class EnvInstruction < Instruction
+      private
+
+      def coerce
+        get_bool(source)
+      end
+
+      def get_bool(value)
+        case value
+        when true, false, nil then value
+        when String then value == PictureTag.jekyll_env
+        when Array then value.include? PictureTag.jekyll_env
+        when Hash then get_bool(value[:setting])
+        else raise ArgumentError, error_message
+        end
+      end
+
+      def error_message
+        "JPT - #{setting_name} must be a boolean, an environment name," \
+          ' or an array of environment names.'
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/output_formats/basic.rb

@@ -6,6 +6,10 @@ module PictureTag
     class Basic
       include ObjectiveElements
 
+      def to_s
+        wrap(base_markup).to_s
+      end
+
       # Used for both the fallback image, and for the complete markup.
       def build_base_img
         img = SingleTag.new 'img'
@@ -23,10 +27,6 @@ module PictureTag
         img
       end
 
-      def to_s
-        wrap(base_markup).to_s
-      end
-
       private
 
       # Handles various wrappers around basic markup
@@ -76,9 +76,7 @@ module PictureTag
         image = GeneratedImage.new(
           source_file: PictureTag.source_images.first,
           format: PictureTag.fallback_format,
-          width: checked_fallback_width,
-          crop: PictureTag.crop,
-          gravity: PictureTag.gravity
+          width: checked_fallback_width
         )
 
         image.generate
@@ -86,13 +84,13 @@ module PictureTag
         image
       end
 
+      # It's only a candidate, because we don't know if the fallback width
+      # setting is larger than the source file.
       def fallback_candidate
         @fallback_candidate ||= GeneratedImage.new(
           source_file: PictureTag.source_images.first,
           format: PictureTag.fallback_format,
-          width: PictureTag.fallback_width,
-          crop: PictureTag.crop,
-          gravity: PictureTag.gravity
+          width: PictureTag.fallback_width
         )
       end
 
@@ -117,22 +115,14 @@ module PictureTag
         PictureTag.source_images.first
       end
 
-      def source_width
-        if PictureTag.crop
-          fallback_candidate.cropped_source_width
-        else
-          source.width
-        end
-      end
-
       def checked_fallback_width
         target = PictureTag.fallback_width
 
-        if target > source_width
+        if target > source.width
           Utils.warning "#{source.shortname} is smaller than the " \
-            "requested fallback width of #{target}px. Using #{source_width}" \
+            "requested fallback width of #{target}px. Using #{source.width}" \
             ' px instead.'
-          source_width
+          source.width
         else
           target
         end