jekyll_picture_tag 1.12.0 → 2.0.1

data/lib/jekyll_picture_tag/srcsets/basic.rb

@@ -53,11 +53,11 @@ module PictureTag
       end
 
       def width_attribute
-        files.first.source_width.to_s
+        source_image.width.to_s
       end
 
       def height_attribute
-        files.first.source_height.to_s
+        source_image.height.to_s
       end
 
       private
@@ -86,11 +86,7 @@ module PictureTag
       end
 
       def source_width
-        @source_width ||= if PictureTag.crop(@media)
-                            target_files.first.source_width
-                          else
-                            @source_image.width
-                          end
+        source_image.width
       end
 
       def target_files
@@ -112,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

data/lib/jekyll_picture_tag/version.rb

@@ -1,3 +1,3 @@
 module PictureTag
-  VERSION = '1.12.0'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/readme.md

@@ -1,5 +1,9 @@
+![Logo](docs/logo.svg)
+
 # Jekyll Picture Tag
 
+![Tests & Formatting](https://github.com/rbuchberger/jekyll_picture_tag/workflows/Tests%20&%20Formatting/badge.svg)
+
 **Responsive Images done correctly.**
 
 It's simple to throw a photo on a page and call it a day, but doing justice to users on all
@@ -24,7 +28,7 @@ different image entirely.
 
 **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 and organize. Jekyll Picture
-Tag is your responsive images minion - give it simple instructions and it'll handle the rest. 
+Tag is your responsive images minion - give it simple instructions and it'll handle the rest.
 
 ## Features
 
@@ -39,24 +43,51 @@ https://rbuchberger.github.io/jekyll_picture_tag/
 
 ## Changelog:
 
-https://rbuchberger.github.io/jekyll_picture_tag/releases
-
-Latest versions: 
-
-* 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
-* 1.11.0 July 27, 2020
-  * **Width and height attribute support!** Begone, page reflow.
-  * Cache image information between builds
-  * Change image naming format. This update will trigger all images to be regenerated, so you may
-    want to delete your generated images folder beforehand.
+https://rbuchberger.github.io/jekyll_picture_tag/devs/releases
+
+Recent releases:
+
+* 2.0.1 March 31, 2021
+  * Select imagemagick deliberately when appropriate, rather than simply rescuing all vips errors
+    and trying again. This will stop JPT from suppressing useful vips errors.
+* **2.0** March 25, 2021 - [Migration guide](https://rbuchberger.github.io/jekyll_picture_tag/users/notes/migration_2)
+  * Switch from ImageMagick to libvips.
+    * 🚀🔥🔥**MUCH MORE FASTER**🔥🔥🚀
+    * Will still attempt to use imagemagick if libvips cannot handle a
+      particular image format.
+    * Eliminate the ImageMagick v7 on Ubuntu pain we've been dealing with for so
+      long.
+  * Require Ruby >= 2.6, support Ruby 3.0
+  * Require Jekyll >= 4.0
+  * Cropping is changing.
+      * We now use the libvips
+        [smartcrop function](https://www.rubydoc.info/gems/ruby-vips/Vips/Image#smartcrop-instance_method),
+        which does some magic to keep the most useful part of the image.
+      * Geometry is renamed to 'crop', and reduced to simple aspect ratios only. (`width:height`)
+      * Gravity is gone, replaced by 'keep' which is translated to a libvips
+        [interestingness](https://www.rubydoc.info/gems/ruby-vips/Vips/Interesting) setting.
+  * Add stock presets and media queries, under the `jpt-` prefix.
+  * Add `format_quality` default settings for webp, avif, and jp2.
+  * Add image-format-specific write options.
+  * Overhaul user input handling; we can now validate inputs and give error
+    messages which are less useless. Stronger validation and nicer errors will be added in future
+    releases.
+  * Drop support for `markup_presets` and `media_presets`. They are now
+    officially and only `presets` and `media_queries`.
+  * Improve docs with an introductory tutorial and 'how-to' flow.
+
+* 1.14.0 January 10, 2021
+  * Gracefully handle empty tag arguments.
+  * Re-add metadata stripping. I removed it inadvertently when refactoring; now
+    there's a test and a setting to turn it off.
+  * Respect Jekyll's `--disable-disk-cache` argument.
+  * Add baseurl configuration, allowing increased plugin support (such as I18n via `jekyll-multiple-languages-plugin`)
+  * Tooling & test suite maintenance and improvements.
 
 ## 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
+guidelines](https://rbuchberger.github.io/jekyll_picture_tag/devs/contributing), or the
 [issues](https://github.com/rbuchberger/jekyll_picture_tag/issues) page for more.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_picture_tag
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Robert Wierzbowski
@@ -10,66 +10,122 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '2.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
-  type: :development
+        version: '4.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: objective_elements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.17
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,35 +139,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -125,110 +181,124 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: solargraph
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :runtime
+        version: 1.7.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
+        version: 0.10.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: mini_magick
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
+        version: 1.9.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
-  name: objective_elements
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
-  type: :runtime
+        version: 0.5.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
-  type: :runtime
+        version: 0.20.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
-      Jekyll Picture Tag is a liquid tag that adds responsive images to your
-      Jekyll static site.Jekyll Picture Tag automatically creates resized source
-      images, is fully configurable, and covers all use cases — including art
-      direction and resolution switching — with a little YAML configuration and a
-      simple template tag.
+      Jekyll Picture Tag adds responsive images to your Jekyll static site. It
+      automatically creates resized source images, is fully configurable, and
+      covers all use cases, including art direction and resolution switching, with
+      a little YAML configuration and a simple template tag.
 email:
 - robert@buchberger.cc
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
+- ".github/workflows/code-checks.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".solargraph.yml"
-- ".travis.yml"
-- Dockerfile
 - Gemfile
 - LICENSE.txt
 - Rakefile
+- docs/.envrc
 - docs/Gemfile
 - docs/Gemfile.lock
 - docs/_config.yml
@@ -240,15 +310,18 @@ files:
 - docs/devs/index.md
 - docs/devs/releases.md
 - docs/index.md
-- docs/users/configuration/cdn.md
+- docs/logo.png
+- docs/logo.svg
 - docs/users/configuration/directories.md
 - docs/users/configuration/disable.md
 - docs/users/configuration/fast_build.md
 - docs/users/configuration/ignore_missing.md
 - docs/users/configuration/index.md
 - docs/users/configuration/kramdown_fix.md
-- docs/users/configuration/relative_urls.md
 - docs/users/configuration/suppress_warnings.md
+- docs/users/configuration/urls.md
+- docs/users/deployment.md
+- docs/users/getting_started.md
 - docs/users/index.md
 - docs/users/installation.md
 - docs/users/liquid_tag/argument_reference/alternate_images.md
@@ -264,10 +337,10 @@ files:
 - docs/users/notes/github_pages.md
 - docs/users/notes/html_attributes.md
 - docs/users/notes/index.md
-- docs/users/notes/input_checking.md
 - docs/users/notes/kramdown_bug.md
 - docs/users/notes/managing_images.md
-- docs/users/notes/migration.md
+- docs/users/notes/migration_1.md
+- docs/users/notes/migration_2.md
 - docs/users/presets/cropping.md
 - docs/users/presets/default.md
 - docs/users/presets/examples.md
@@ -284,27 +357,29 @@ files:
 - docs/users/presets/media_queries.md
 - docs/users/presets/nomarkdown_override.md
 - docs/users/presets/pixel_ratio_srcsets.md
+- docs/users/presets/quality_width_graph.png
 - docs/users/presets/width_height_attributes.md
 - docs/users/presets/width_srcsets.md
-- jekyll-picture-tag.gemspec
+- docs/users/presets/writing_presets.md
+- docs/users/tutorial.md
 - jekyll_picture_tag.gemspec
-- lib/jekyll-picture-tag.rb
 - lib/jekyll_picture_tag.rb
 - lib/jekyll_picture_tag/cache.rb
-- lib/jekyll_picture_tag/cache/base.rb
-- lib/jekyll_picture_tag/cache/generated.rb
-- lib/jekyll_picture_tag/cache/source.rb
-- lib/jekyll_picture_tag/defaults/global.yml
-- lib/jekyll_picture_tag/defaults/presets.yml
-- lib/jekyll_picture_tag/generated_image.rb
-- lib/jekyll_picture_tag/img_uri.rb
+- lib/jekyll_picture_tag/defaults/global.rb
+- lib/jekyll_picture_tag/defaults/presets.rb
+- lib/jekyll_picture_tag/images.rb
+- lib/jekyll_picture_tag/images/generated_image.rb
+- lib/jekyll_picture_tag/images/image_file.rb
+- lib/jekyll_picture_tag/images/img_uri.rb
+- lib/jekyll_picture_tag/images/source_image.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
-- lib/jekyll_picture_tag/instructions/set.rb
-- lib/jekyll_picture_tag/instructions/tag_parser.rb
+- lib/jekyll_picture_tag/instructions/children/config.rb
+- lib/jekyll_picture_tag/instructions/children/context.rb
+- lib/jekyll_picture_tag/instructions/children/params.rb
+- lib/jekyll_picture_tag/instructions/children/parsers.rb
+- lib/jekyll_picture_tag/instructions/children/preset.rb
+- lib/jekyll_picture_tag/instructions/parents/conditional_instruction.rb
+- lib/jekyll_picture_tag/instructions/parents/env_instruction.rb
 - lib/jekyll_picture_tag/output_formats.rb
 - lib/jekyll_picture_tag/output_formats/auto.rb
 - lib/jekyll_picture_tag/output_formats/basic.rb
@@ -317,8 +392,14 @@ files:
 - lib/jekyll_picture_tag/output_formats/naked_srcset.rb
 - lib/jekyll_picture_tag/output_formats/picture.rb
 - lib/jekyll_picture_tag/output_formats/readme.md
+- lib/jekyll_picture_tag/parsers.rb
+- lib/jekyll_picture_tag/parsers/arg_splitter.rb
+- lib/jekyll_picture_tag/parsers/configuration.rb
+- lib/jekyll_picture_tag/parsers/html_attributes.rb
+- lib/jekyll_picture_tag/parsers/image_backend.rb
+- lib/jekyll_picture_tag/parsers/preset.rb
+- lib/jekyll_picture_tag/parsers/tag_parser.rb
 - lib/jekyll_picture_tag/router.rb
-- lib/jekyll_picture_tag/source_image.rb
 - lib/jekyll_picture_tag/srcsets.rb
 - lib/jekyll_picture_tag/srcsets/basic.rb
 - lib/jekyll_picture_tag/srcsets/pixel_ratio.rb
@@ -329,7 +410,8 @@ files:
 homepage: https://github.com/rbuchberger/jekyll_picture_tag
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  documentation_uri: https://rbuchberger.github.io/jekyll_picture_tag/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -338,17 +420,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubygems_version: 3.1.4
+requirements:
+- libvips
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Easy responsive images for Jekyll.