jekyll_picture_tag 1.8.0 → 1.11.0

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
@@ -69,12 +69,32 @@ module PictureTag
         element.media = srcset.media_attribute if srcset.media
       end
 
-      # File, not HTML
+      # GeneratedImage class, not HTML
       def build_fallback_image
-        GeneratedImage.new(
+        return fallback_candidate if fallback_candidate.exists?
+
+        image = GeneratedImage.new(
+          source_file: PictureTag.source_images.first,
+          format: PictureTag.fallback_format,
+          width: checked_fallback_width,
+          crop: PictureTag.crop,
+          gravity: PictureTag.gravity
+        )
+
+        image.generate
+
+        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: checked_fallback_width
+          width: PictureTag.fallback_width,
+          crop: PictureTag.crop,
+          gravity: PictureTag.gravity
         )
       end
 
@@ -95,15 +115,26 @@ module PictureTag
         content.add_parent anchor
       end
 
+      def source
+        PictureTag.source_images.first
+      end
+
+      def source_width
+        if PictureTag.crop
+          fallback_candidate.source_width
+        else
+          source.width
+        end
+      end
+
       def checked_fallback_width
-        source = PictureTag.source_images.first
         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

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/router.rb

@@ -9,6 +9,7 @@ module PictureTag
   # gets big, I'll refactor.
   module Router
     attr_accessor :instructions, :context
+
     # Context forwarding
 
     # Global site data
@@ -47,6 +48,14 @@ module PictureTag
       @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
@@ -69,6 +78,14 @@ module PictureTag
       config.pconfig
     end
 
+    def disabled?
+      config.disabled?
+    end
+
+    def fast_build?
+      config.fast_build?
+    end
+
     # Preset forwarding
 
     def widths(media)

data/lib/jekyll_picture_tag/source_image.rb

@@ -3,79 +3,100 @@ module PictureTag
   # advantage by storing expensive file reads and writes in instance variables,
   # to be reused by many different generated images.
   class SourceImage
-    attr_reader :name, :shortname, :missing, :media_preset
+    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
-      @name = grab_file relative_filename
       @media_preset = media_preset
+
+      @missing = missing?
+      check_cache
+    end
+
+    def digest
+      @digest ||= cache[:digest] || ''
     end
 
     def width
-      @width ||= if @missing
-                   999_999
-                 else
-                   image.width
-                 end
+      @width ||= cache[:width] || 999_999
     end
 
-    def digest
-      @digest ||= if @missing
-                    'x' * 6
-                  else
-                    Digest::MD5.hexdigest(File.read(@name))[0..5]
-                  end
+    def height
+      @height ||= cache[:height] || 999_999
     end
 
-    # Includes path relative to default sorce folder, and the original filename.
+    # /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
 
-    # File exention
+    # /home/dave/my_blog/assets/images/somefolder/myimage.jpg
+    #                                                     ^^^
     def ext
-      # [1..-1] will strip the leading period.
-      @ext ||= File.extname(@name)[1..-1].downcase
+      @ext ||= File.extname(name)[1..-1].downcase
     end
 
     private
 
-    def image
-      @image ||= Image.open(@name)
+    def cache
+      @cache ||= Cache::Source.new(@shortname)
     end
 
-    # Turn a relative filename into an absolute one, and make sure it exists.
-    def grab_file(source_file)
-      source_name = File.join(PictureTag.source_dir, source_file)
-
-      if File.exist? source_name
-        @missing = false
+    def missing?
+      if File.exist? name
+        false
 
       elsif PictureTag.continue_on_missing?
-        @missing = true
-        Utils.warning missing_image_warning(source_name)
+        Utils.warning(missing_image_warning)
+        true
 
       else
-        raise ArgumentError, missing_image_error(source_name)
+        raise ArgumentError, missing_image_error
       end
+    end
 
-      source_name
+    def check_cache
+      return if @missing
+      return if cache[:digest] && PictureTag.fast_build?
+
+      update_cache if source_digest != cache[:digest]
     end
 
-    def missing_image_warning(source_name)
-      <<~HEREDOC
-        Could not find #{source_name}. Your site will have broken images in it.
-        Continuing.
-      HEREDOC
+    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(source_name)
+    def missing_image_error
       <<~HEREDOC
-        Jekyll Picture Tag could not find #{source_name}. You can force the
-        build to continue anyway by setting "picture: ignore_missing_images:
-        true" in "_config.yml". This setting can also accept a jekyll build
-        environment, or an array of environments.
+        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

data/lib/jekyll_picture_tag/srcsets/basic.rb

@@ -23,8 +23,9 @@ module PictureTag
         @format ||= files.first.format
       end
 
+      # GeneratedImage class
       def files
-        @files ||= widths.collect { |w| generate_file(w) }
+        @files ||= build_files
       end
 
       def to_a
@@ -46,40 +47,74 @@ module PictureTag
         nil
       end
 
-      # Check our source image size vs requested sizes
-      def check_widths(targets)
-        if targets.any? { |t| t > @source_image.width }
-          handle_small_source(targets, @source_image.width)
-        else
-          targets
-        end
-      end
-
       # Generates an HTML attribute
       def media_attribute
         "(#{PictureTag.media_presets[@media]})"
       end
 
+      def width_attribute
+        files.first.source_width.to_s
+      end
+
+      def height_attribute
+        files.first.source_height.to_s
+      end
+
       private
 
-      def handle_small_source(targets, image_width)
-        Utils.warning(
-          " #{@source_image.shortname} is #{image_width}px wide, smaller than" \
-          " at least one size in the set #{targets}. Will not enlarge."
-        )
+      def build_files
+        # By 'files', we mean the GeneratedImage class.
+        return target_files if target_files.all?(&:exists?)
+
+        # This triggers GeneratedImage to actually build an image file.
+        files = checked_targets
+        files.each(&:generate)
+
+        files
+      end
+
+      def checked_targets
+        if target_files.any? { |f| f.width > source_width }
+
+          small_source_warn
 
-        small_targets = targets.dup.delete_if { |t| t >= image_width }
+          files = target_files.reject { |f| f.width >= source_width }
+          files.push(generate_file(source_width))
+        end
 
-        small_targets.push image_width
+        files || target_files
+      end
 
-        small_targets
+      def source_width
+        @source_width ||= if PictureTag.crop(@media)
+                            target_files.first.source_width
+                          else
+                            @source_image.width
+                          end
+      end
+
+      def target_files
+        @target_files ||= widths.collect { |w| generate_file(w) }
+      end
+
+      def small_source_warn
+        Utils.warning(
+          <<~HEREDOC
+            #{@source_image.shortname}
+            is #{source_width}px wide (after cropping, if applicable),
+            smaller than at least one size in the set #{widths}.
+            Will not enlarge.
+          HEREDOC
+        )
       end
 
       def generate_file(width)
         GeneratedImage.new(
           source_file: @source_image,
           width: width,
-          format: @input_format
+          format: @input_format,
+          crop: PictureTag.crop(@media),
+          gravity: PictureTag.gravity(@media)
         )
       end
     end

data/lib/jekyll_picture_tag/srcsets/pixel_ratio.rb

@@ -6,11 +6,9 @@ module PictureTag
       private
 
       def widths
-        target = PictureTag.preset['pixel_ratios'].collect do |p|
+        PictureTag.preset['pixel_ratios'].collect do |p|
           p * PictureTag.preset['base_width']
         end
-
-        check_widths target
       end
 
       def build_srcset_entry(file)

data/lib/jekyll_picture_tag/srcsets/width.rb

@@ -22,7 +22,7 @@ module PictureTag
       private
 
       def widths
-        check_widths PictureTag.widths(@media)
+        PictureTag.widths(@media)
       end
 
       def build_srcset_entry(file)