jekyll_picture_tag 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f9db202e681087ec43ee9cc26b3e32dbc76de45c394ea834039b72f100215e1
-  data.tar.gz: 2c195508efb7d9e05bda81dd529366f47fa25c5e1ce7bc6ca60edbd5e2db8a4f
+  metadata.gz: 5d6d2bf0edc139d12f269e614e3585ecf18ace2a48a92e9bc1367a6e654ba2d0
+  data.tar.gz: e6fe2197c58c368255472631adeef9dd9a593230c7655617ad66d00330ba4b4e
 SHA512:
-  metadata.gz: fc17dcd0e8a5ffb70f3ca67bf22e8bb34b2e9c5af61ffabaf5e92e853b01bec6a0b56a01f45ccc44f55be11112aed75e04ac293e4d8012af3b135ce20aaa84fb
-  data.tar.gz: '09b01489bcd3dc1e7428ae41fe6f603488f1863cc731ad0d70f5861cb1c3525dda04f7445a9f97d22f005b5a900c8d6ba019467f7379575fe07c0370e9a0d8cb'
+  metadata.gz: 8682488670153d69640703aa1cd128f57be84c979efff085d19144e4861c3a7d854ae9d638e766ce2398ccafec68b9243613b65b2186e51c83a3d89ef9bc3c9d
+  data.tar.gz: 631adc8189614973ab8ad6b14c2b08fd335abcf53cf8a7b6b63cd23f66bcfb9e5f2c800e188b0eeee46242d2a409db776ec5ad64bae0df4fd7c7ca4694429e49

data/docs/devs/releases.md

@@ -1,6 +1,9 @@
 ---
 ---
 # Release History
+* 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](/jekyll_picture_tag/users/notes/migration_2)
   * Switch from ImageMagick to libvips.
     * 🚀🔥🔥**MUCH MORE FASTER**🔥🔥🚀

data/docs/index.md

@@ -5,6 +5,11 @@
 
 _Responsive Images, Done Correctly._
 
+**Warning:** Deploying JPT can be tricky, especially with the new version using libvips. We depend
+on system libraries to generate images, whose presence varies greatly between different
+environments. Before investing a great deal of time, ensure that your deployment process can handle
+all image formats (both input and output) which you will use.
+
 **Note:** These docs are for versions >= 2.0. Documentation for the last stable 1.x version may be
 found by browsing the repository,
 [here](https://github.com/rbuchberger/jekyll_picture_tag/tree/v1.14.0/docs). This [migration

data/docs/users/deployment.md

@@ -0,0 +1,49 @@
+---
+sort: 4
+---
+
+# Deployment
+
+Deploying a site with JPT is surprisingly tricky. This is because we depend on system libraries
+(libvips and its dependencies) to generate images, but build environments have huge variation in
+what is actually present. Just because a site build works on your local machine, doesn't mean it
+will work when you try to deploy using a build service.
+
+Generally, anything which involves building locally and uploading the generated site somewhere, will
+work. Anything which pulls down a git repository and builds it in some container somewhere needs
+extra verification. Often some image formats will be supported, while others will not without
+installing additional packages.
+
+## Help Wanted
+
+We could really use help improving this page's guidance. I've created
+[this](https://github.com/rbuchberger/jekyll_picture_tag/issues/240) issue for feedback; I want to
+hear how you're deploying with JPT. I want to hear what worked well for you, and what did not. If
+you're extra motivated and cool, you could make a pull request adding that information to this page.
+
+## Netlify
+
+As of March 26, 2021, with version 2.0.0, Netlify is mostly broken. It only supports jpg. I want to
+support netlify as much as reasonably possible, so if a solution isn't found I'll re-add imagemagick
+as an alternate backend and offer it as a configurable setting. Until then, stick with version 1.14.
+
+## AWS S3
+
+This method has a somewhat difficult setup, but once configured it works _very_ well. Since you
+build the site locally, if your development build works then your production build will work.
+
+[This](https://aws.amazon.com/premiumsupport/knowledge-center/cloudfront-serve-static-website/) is
+the guide you want; **specifically the second option** (Using a website endpoint as the origin, with
+anonymous (public) access allowed). This allows you to have https and excellent performance.
+
+For deployment, you'll want to put together either some rake tasks or shell commands to do the
+following:
+
+* build: `JEKYLL_ENV=production bundle exec jekyll build`
+* push: `aws s3 sync _site s3://(your bucket here)`
+* invalidate: `aws cloudfront create-invalidation --distribution-id (your distribution id here) --paths '/*'`
+  * Cloudfront caches assets for 24 hours. This command invalidates that cache, so your changes go
+    live immediately.
+* deploy: `build && push && invalidate`
+
+(All of these depend on having the aws cli installed, with proper credentials configured.)

data/lib/jekyll_picture_tag/images/image_file.rb

@@ -2,6 +2,15 @@ module PictureTag
   # Basically a wrapper class for vips. Handles image operations.
   # Vips returns new images for Crop, resize, and autorotate operations.
   # Quality, metadata stripping, and format are applied on write.
+  #
+  # This deserves to be two classes and a factory, one for normal vips save and
+  # one for magicksave. This is illustrated by the fact that stubbing backend
+  # determination logic for its unit tests would basically require
+  # re-implementing it completely.
+  #
+  # I'm planning to implement standalone imagemagick as an alternative to vips,
+  # so when I add that I'll also do that refactoring. For now it works fine and
+  # it's not too bloated.
   class ImageFile
     def initialize(source, base)
       @source = source
@@ -35,13 +44,21 @@ module PictureTag
       image.autorot
     end
 
+    def handler
+      PictureTag.backend.handler_for(@base.format)
+    end
+
+    def quality_key
+      handler == :vips ? :Q : :quality
+    end
+
     def write_opts
       opts = PictureTag.preset['image_options'][@base.format] || {}
 
       opts[:strip] = PictureTag.preset['strip_metadata']
 
       # gifs don't accept a quality setting.
-      opts[:Q] = base.quality unless base.format == 'gif'
+      opts[quality_key] = base.quality unless base.format == 'gif'
 
       opts.transform_keys(&:to_sym)
     end
@@ -51,15 +68,12 @@ module PictureTag
     end
 
     def write(image)
-      begin
+      case handler
+      when :vips
         image.write_to_file(base.absolute_filename, **write_opts)
-      rescue Vips::Error
         # If vips can't handle it, fall back to imagemagick.
-        opts = write_opts.transform_keys do |key|
-          key == :Q ? :quality : key
-        end
-
-        image.magicksave(base.absolute_filename, **opts)
+      when :magick
+        image.magicksave(base.absolute_filename, **write_opts)
       end
 
       # Fix permissions. TODO - still necessary?

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

@@ -37,5 +37,12 @@ module PictureTag
         )
       end
     end
+
+    # Main job is to determine which backend should handle which image formats.
+    class Backend < Instruction
+      def source
+        PictureTag::Parsers::ImageBackend.new
+      end
+    end
   end
 end

data/lib/jekyll_picture_tag/parsers.rb

@@ -3,3 +3,4 @@ require_relative 'parsers/configuration'
 require_relative 'parsers/html_attributes'
 require_relative 'parsers/preset'
 require_relative 'parsers/tag_parser'
+require_relative 'parsers/image_backend'

data/lib/jekyll_picture_tag/parsers/image_backend.rb

@@ -0,0 +1,33 @@
+module PictureTag
+  module Parsers
+    # Returns information regarding image handlers
+    class ImageBackend
+      def handler_for(format)
+        if vips_formats.include? format
+          :vips
+        elsif magick_formats.include? format
+          :magick
+        else
+          raise "No support for generating #{format} files in this environment."
+        end
+      end
+
+      # Returns array of formats that vips can save to
+      def vips_formats
+        @vips_formats ||= `vips -l filesave`
+                          .scan(/\.[a-z]{1,5}/)
+                          .uniq
+                          .map { |format| format.strip.delete_prefix('.') }
+      end
+
+      # Returns an array of formats that imagemagick can handle.
+      def magick_formats
+        @magick_formats ||= `convert -version`
+                            .split("\n")
+                            .last
+                            .delete_prefix('Delegates (built-in):')
+                            .split
+      end
+    end
+  end
+end

data/lib/jekyll_picture_tag/version.rb

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

data/readme.md

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_picture_tag
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Robert Wierzbowski
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -320,6 +320,7 @@ files:
 - docs/users/configuration/kramdown_fix.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
@@ -395,6 +396,7 @@ files:
 - 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