jekyll_picture_tag 1.7.1 → 1.10.2

data/lib/jekyll_picture_tag/output_formats/data_attributes.rb

@@ -18,7 +18,10 @@ module PictureTag
       end
 
       def add_sizes(element, srcset)
-        element.attributes << { 'data-sizes' => srcset.sizes } if srcset.sizes
+        return unless srcset.sizes
+
+        attribute = PictureTag.preset['data_sizes'] ? 'data-sizes' : 'sizes'
+        element.attributes << { attribute => srcset.sizes }
       end
 
       def build_noscript(base_content)

data/lib/jekyll_picture_tag/router.rb

@@ -47,6 +47,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 +77,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

@@ -4,6 +4,7 @@ module PictureTag
   # to be reused by many different generated images.
   class SourceImage
     attr_reader :name, :shortname, :missing, :media_preset
+    attr_accessor :digest_guess
     include MiniMagick
 
     def initialize(relative_filename, media_preset = nil)
@@ -23,12 +24,16 @@ module PictureTag
     def digest
       @digest ||= if @missing
                     'x' * 6
+                  elsif PictureTag.fast_build? && @digest_guess
+                    # Digest guess will be handed off to this class by the first
+                    # generated image which needs it (via attr_accessor).
+                    @digest_guess
                   else
                     Digest::MD5.hexdigest(File.read(@name))[0..5]
                   end
     end
 
-    # Includes path relative to default sorce folder, and the original filename.
+    # Includes path relative to default source folder and the original filename.
     def base_name
       @shortname.delete_suffix File.extname(@shortname)
     end

data/lib/jekyll_picture_tag/srcsets/basic.rb

@@ -24,7 +24,7 @@ module PictureTag
       end
 
       def files
-        @files ||= widths.collect { |w| generate_file(w) }
+        @files ||= build_files
       end
 
       def to_a
@@ -46,15 +46,6 @@ 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]})"
@@ -62,24 +53,59 @@ module PictureTag
 
       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_targets = targets.dup.delete_if { |t| t >= image_width }
+          small_source_warn
 
-        small_targets.push image_width
+          files = target_files.reject { |f| f.width >= source_width }
+          files.push(generate_file(source_width))
+        end
+
+        files || target_files
+      end
+
+      def source_width
+        @source_width ||= if PictureTag.crop(@media)
+                            target_files.first.cropped_source_width
+                          else
+                            @source_image.width
+                          end
+      end
 
-        small_targets
+      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)

data/lib/jekyll_picture_tag/utils.rb

@@ -2,6 +2,24 @@ 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

data/lib/jekyll_picture_tag/version.rb

@@ -1,3 +1,3 @@
 module PictureTag
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.10.2'.freeze
 end

data/readme.md

@@ -1,21 +1,20 @@
 # Jekyll Picture Tag
 
-**Easy responsive images for Jekyll.**
+**Responsive Images done correctly.**
 
-It's easy to throw an image on a webpage and call it a day. Doing justice to your users by serving
-it efficiently on all browsers and screen sizes is tedious and tricky. Tedious, tricky things should be
-automated.
+It's simple to throw a photo on a page and call it a day, but doing justice to users on all
+different browsers and devices is tedious and tricky. Tedious, tricky things should be automated.
 
-Jekyll Picture Tag adds responsive images to your [Jekyll](http://jekyllrb.com) static site. It
-automatically creates resized, reformatted source images, is fully configurable, implements sensible
-defaults, and solves both the art direction and resolution switching problems with a little YAML
-configuration and a simple template tag.
+Jekyll Picture Tag automatically builds cropped, resized, and reformatted images, builds several
+kinds of markup, offers extensive configuration while requiring none, and solves both the art
+direction and resolution switching problems with a little YAML configuration and a simple template
+tag.
 
 ## Why use Responsive Images?
 
-**Performance:** The fastest sites are static sites, but when you plonk a 2mb picture of your dog at
-the top of a blog post you're throwing it all away.  Responsive images allow you to keep your site
-fast, without compromising image quality.
+**Performance:** The fastest sites are static sites, but if you plonk a 2mb picture of your dog at
+the top of a blog post you throw it all away. Responsive images allow you to keep your site fast,
+without compromising image quality.
 
 **Design:** Your desktop image may not work well on mobile, regardless of its resolution. We often
 want to do more than just resize images for different screen sizes, we want to crop them or use a
@@ -24,15 +23,39 @@ different image entirely.
 ## Why use Jekyll Picture Tag?
 
 **Developer Sanity:** If you want to serve multiple images in multiple formats and resolutions, you
-have a litany of markup to write and a big pile of images to generate. Jekyll Picture Tag is your
-responsive images minion - give it simple instructions and it'll handle the rest. 
+have a litany of markup to write and a big pile of images to generate and organize. Jekyll Picture
+Tag is your responsive images minion - give it simple instructions and it'll handle the rest. 
 
 ## Features
 
-* Automatic generation and organization of resized image files in basically any format(s).
-* Automatic generation of complex markup in several different formats.
-* No configuration required, extensive configuration available.
+* Generate piles of cropped, resized, and converted image files.
+* Generate corresponding markup in several different formats.
+* Configure it easily, or not at all.
+* Make Lighthouse happy.
 
 ## Documentation:
 
 https://rbuchberger.github.io/jekyll_picture_tag/
+
+## Changelog:
+
+https://rbuchberger.github.io/jekyll_picture_tag/releases
+
+Latest versions: 
+
+* 1.10.0 May 11, 2020
+  * **Image Cropping support!** access the power of ImageMagick's `crop` function.
+  * Don't issue a warning when `default` preset is not found.
+  * Documentation improvements
+* 1.10.1 July 2, 2020
+  * Bugfix for erroneously regenerated images
+* 1.10.2 July 6, 2020
+  * Bugfix for fallback image files not actually getting generated
+
+## Help Wanted
+
+Writing code is only part of the job; often the harder part is knowing what needs to be changed. Any
+and all feedback is greatly appreciated, especially in regards to documentation. What are your pain
+points? See the [contributing
+guidelines](https://rbuchberger.github.io/jekyll_picture_tag/contributing), or the
+[issues](https://github.com/rbuchberger/jekyll_picture_tag/issues) page for more.

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_picture_tag
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.10.2
 platform: ruby
 authors:
 - Robert Wierzbowski
 - Brendan Tobolaski
 - Robert Buchberger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,6 +152,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -186,14 +200,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -225,6 +239,7 @@ files:
 - ".ruby-version"
 - ".solargraph.yml"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - Rakefile
@@ -253,6 +268,7 @@ files:
 - lib/jekyll_picture_tag/generated_image.rb
 - lib/jekyll_picture_tag/img_uri.rb
 - lib/jekyll_picture_tag/instructions.rb
+- lib/jekyll_picture_tag/instructions/arg_splitter.rb
 - lib/jekyll_picture_tag/instructions/configuration.rb
 - lib/jekyll_picture_tag/instructions/html_attributes.rb
 - lib/jekyll_picture_tag/instructions/preset.rb
@@ -283,7 +299,7 @@ homepage: https://github.com/rbuchberger/jekyll_picture_tag
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -301,8 +317,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Easy responsive images for Jekyll.
 test_files: []