jekyll_picture_tag 2.0.1 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d6d2bf0edc139d12f269e614e3585ecf18ace2a48a92e9bc1367a6e654ba2d0
-  data.tar.gz: e6fe2197c58c368255472631adeef9dd9a593230c7655617ad66d00330ba4b4e
+  metadata.gz: 53c3ec9a79c58aae1d5dbead4e7d3071a4a28c69589f98ff93e87d0fc6aa64f3
+  data.tar.gz: 8ebe081b0754f009df43de9beb4917dd911ef223393bcea29d029f8a1b546e09
 SHA512:
-  metadata.gz: 8682488670153d69640703aa1cd128f57be84c979efff085d19144e4861c3a7d854ae9d638e766ce2398ccafec68b9243613b65b2186e51c83a3d89ef9bc3c9d
-  data.tar.gz: 631adc8189614973ab8ad6b14c2b08fd335abcf53cf8a7b6b63cd23f66bcfb9e5f2c800e188b0eeee46242d2a409db776ec5ad64bae0df4fd7c7ca4694429e49
+  metadata.gz: 3ad2303c3383cbb9e63bcf4e07560a717f4bbf317f714e005a7feabe72eb53a17981f6e1874c974686d1dd0a83ca90ad851b62890b33f8748051dbb8412dd267
+  data.tar.gz: b2beab9bd484db516d7d70bf4a2aec8bdf7b0192acfa92dd6c98afe283988831a2064ecb5c85462d0f54104b8ca9fd914a66ab5ff94067c9ba98ab385fd869a3

data/docs/devs/contributing/docs.md

@@ -13,7 +13,7 @@ subdirectories. We're using the [jekyll-rtd-theme](https://jekyll-rtd-theme.rund
 You can preview as you edit; first the setup:
 
 ``` sh
-$ git clone git@github.com:rbuchberger/jekyll_picture_tag.git # if you haven't already
+$ git clone https://github.com/rbuchberger/jekyll_picture_tag.git # if you haven't already
 $ cd jekyll_picture_tag/docs
 $ direnv allow # (optional)
 $ bundle install --binstubs # --binstubs is optional.

data/docs/devs/contributing/setup.md

@@ -11,7 +11,7 @@ required by any means.
 ### With asdf & direnv:
 
 ```sh
-$ git clone git@github.com:rbuchberger/jekyll_picture_tag.git
+$ git clone https://github.com/rbuchberger/jekyll_picture_tag.git
 $ cd jekyll_picture_tag
 $ direnv allow
 $ asdf install
@@ -21,7 +21,7 @@ $ bundle install --binstubs
 ### Without asdf & direnv
 
 ```sh
-$ git clone git@github.com:rbuchberger/jekyll_picture_tag.git
+$ git clone https://github.com/rbuchberger/jekyll_picture_tag.git
 $ cd jekyll_picture_tag
 # Install the correct version of ruby, with the bundler gem.
 $ bundle install

data/docs/devs/releases.md

@@ -1,6 +1,14 @@
 ---
 ---
 # Release History
+
+* 2.0.3 April 1, 2021
+  * Improve backend format support detection
+* 2.0.2 March 31, 2021
+  * Do not pass a quality argument when generating PNG files.
+    * It only works on newer versions of vips, breaking builds when using older
+      versions (such as when deploying to netlify.)
+    * It's not remarkably useful in the first place.
 * 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.

data/docs/index.md

@@ -5,10 +5,10 @@
 
 _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.
+**Warning:** Deploying JPT can be tricky. 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,

data/docs/users/deployment.md

@@ -14,6 +14,16 @@ work. Anything which pulls down a git repository and builds it in some container
 extra verification. Often some image formats will be supported, while others will not without
 installing additional packages.
 
+I have created a [testing repository](https://github.com/rbuchberger/jpt_tester) for this purpose.
+It's just a barebones jekyll site with JPT, that tries to generate a bunch of image formats. Feel
+free to use it for your own test builds.
+
+```yaml
+presets:
+  default:
+    formats: [avif, webp, jp2, png, gif, original]
+```
+
 ## Help Wanted
 
 We could really use help improving this page's guidance. I've created
@@ -23,15 +33,29 @@ you're extra motivated and cool, you could make a pull request adding that infor
 
 ## 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.
+Ensure you're using version 2.0.2 or later. No support for `jp2` or `avif` files. They have beta
+homebrew support (by setting the build command to `brew install whatever && do_your_build`), but
+attempting to install `libheif` this way runs over the time limit.
+
+```
+Libvips known savers: csv, mat, v, vips, ppm, pgm, pbm, pfm, hdr, png, jpg, jpeg, jpe, webp, tif,
+tiff
+
+Imagemagick known savers: bzlib, cairo, djvu, fftw, fontconfig, freetype, jbig, jng, jpeg, lcms,
+lqr, ltdl, lzma, openexr, pangocairo, png, rsvg, tiff, wmf, x, xml, zlib
+```
+
+They run an old version of libvips, so cropping attention may not work the same way as it does
+locally.
 
 ## 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.
 
+There is one caveat: other than the site root, links need to point to an html file. `/blog` won't
+work, you need `/blog.html` or `/blog/index.html`. If you know a way to fix this, please speak up!
+
 [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.
@@ -47,3 +71,24 @@ following:
 * deploy: `build && push && invalidate`
 
 (All of these depend on having the aws cli installed, with proper credentials configured.)
+
+## AWS Amplify
+
+[This](https://www.bsmth.de/blog/deploying-jekyll-github-actions-aws-amplify) article may be useful;
+I haven't gotten it to work with a full set of image formats. The default build image doesn't
+support jp2 and avif, but Amplify allows you to use a custom build image. If you take the time to
+create one which can generate jpg, png, webp, jp2, and avif files, it would be marvelous of you to
+share it.
+
+## Github Pages
+
+GitHub Pages only allows a very short whitelist of plugins, which sadly does not include JPT. You could run it locally, then commit and push the generated site to your Pages branch. 
+
+Or use GitHub Actions to do this for you automatically. Here’s [an Actions workflow to build a JPT-enabled site and deploy it](https://gist.github.com/elstudio/38bacfe7aab63da082a418fd3a1ddb66). Commit that yaml file to the `.github/workflows` folder of your source repository, and Actions will build and deploy your site whenever you push changes to `main`.
+
+See [How to use Jekyll Picture Tag or any Jekyll plugin with GitHub Pages](https://www.elstudio.us/code/use-any-jekyll-plugin-with-github-pages) for details of how it works.
+
+
+## Cloudflare pages
+
+They have the same restrictions as netlify: jpg, webp, and png work. jp2 and avif are no-go.

data/docs/users/installation.md

@@ -13,11 +13,11 @@ sort: 1
     ```ruby
     # Gemfile
 
-    gem 'jekyll', ~> '4.0'
+    gem 'jekyll', '~> 4.0'
 
     group :jekyll_plugins do
       # (other jekyll plugins)
-      gem 'jekyll_picture_tag', ~> '2.0'
+      gem 'jekyll_picture_tag', '~> 2.0'
     end
     ```
 

data/docs/users/presets/markup_formats/fragments.md

@@ -26,9 +26,7 @@ to make things outside the scope of JPT.
   {% endraw %}
   ```
 
-- `naked_srcset`: Builds a srcset and nothing else (not even the surrounding quotes). Note that the
-  (image) `format` setting must still be an array, even if you only give it one
-  value. (This is on the list of things to improve.)
+- `naked_srcset`: Builds a srcset and nothing else (not even the surrounding quotes).
 
   ```yml
   # _data/picture.yml
@@ -37,7 +35,7 @@ to make things outside the scope of JPT.
     only_srcset:
       markup: naked_srcset
       widths: [800, 1200, 1600]
-      format: [webp]
+      formats: webp
   ```
 
   ```

data/docs/users/presets/markup_formats/javascript_friendly.md

@@ -7,7 +7,7 @@ sort: 2
 These are analogous to their plain HTML counterparts, but instead of `src`,
 `srcset`, and `sizes`, you get `data-src`, `data-srcset`, and `data-sizes`. This
 allows you to use javascript for things like [lazy
-loading](https://github.com/verlok/lazyload).
+loading](https://github.com/verlok/vanilla-lazyload).
 
 - `data_picture`
 

data/lib/jekyll_picture_tag/defaults/presets.rb

@@ -49,9 +49,9 @@ module PictureTag
 
   STOCK_MEDIA_QUERIES = {
     'jpt-mobile' => 'max-width: 480px',
-    'jpt-tablet' => 'max-width: 768',
+    'jpt-tablet' => 'max-width: 768px',
     'jpt-laptop' => 'max-width: 1024px',
-    'jpt-desktop' => 'max-width: 1200',
-    'jpt-wide' => 'min-width: 1201'
+    'jpt-desktop' => 'max-width: 1200px',
+    'jpt-wide' => 'min-width: 1201px'
   }.freeze
 end

data/lib/jekyll_picture_tag/images/image_file.rb

@@ -57,8 +57,9 @@ module PictureTag
 
       opts[:strip] = PictureTag.preset['strip_metadata']
 
-      # gifs don't accept a quality setting.
-      opts[quality_key] = base.quality unless base.format == 'gif'
+      # gifs don't accept a quality setting, and PNGs don't on older versions of
+      # vips. Since it's not remarkably useful anyway, we'll ignore them.
+      opts[quality_key] = base.quality unless %w[gif png].include? base.format
 
       opts.transform_keys(&:to_sym)
     end

data/lib/jekyll_picture_tag/parsers/image_backend.rb

@@ -3,31 +3,54 @@ module PictureTag
     # Returns information regarding image handlers
     class ImageBackend
       def handler_for(format)
-        if vips_formats.include? format
+        if (vips_formats & all_names(format)).any?
           :vips
-        elsif magick_formats.include? format
+        elsif (magick_formats & all_names(format)).any?
           :magick
         else
-          raise "No support for generating #{format} files in this environment."
+          raise error_string(format)
         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
+        @vips_formats ||= `vips -l`
+                          .split('/n')
+                          .select { |line| line.include? 'ForeignSave' }
+                          .flat_map { |line| line.scan(/\.[a-z]{1,5}/) }
                           .map { |format| format.strip.delete_prefix('.') }
+                          .uniq
       end
 
       # Returns an array of formats that imagemagick can handle.
       def magick_formats
         @magick_formats ||= `convert -version`
-                            .split("\n")
-                            .last
+                            .scan(/Delegates.*/)
+                            .first
                             .delete_prefix('Delegates (built-in):')
                             .split
       end
+
+      # Returns an array of all known names of a format, for the purposes of
+      # parsing supported output formats.
+      def all_names(format)
+        alts = alternates.select { |a| a.include? format }.flatten
+        alts.any? ? alts : [format]
+      end
+
+      private
+
+      def error_string(format)
+        <<~HEREDOC
+          No support for generating #{format} files in this environment!
+          Libvips known savers: #{vips_formats.join(', ')}
+          Imagemagick known savers:  #{magick_formats.join(', ')}
+        HEREDOC
+      end
+
+      def alternates
+        [%w[jpg jpeg], %w[avif heic heif]]
+      end
     end
   end
 end

data/lib/jekyll_picture_tag/version.rb

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

data/readme.md

@@ -1,13 +1,26 @@
-![Logo](docs/logo.svg)
-
 # Jekyll Picture Tag
 
+## Help Wanted
+
+My life just got a lot busier; I'd really like a maintainer or two to help. I'm not abandoning JPT,
+I just don't have a ton of time to put into hacking on it.
+
+If you've been learning Ruby and you want to move beyond tutorials and throwaway projects, I'd love
+to hear from you. I'd be happy to help you gain experience and credibility, if you're willing to
+help me maintain this project!
+
+If you're interested, contact me: robert@buchberger.cc
+
+![Logo](docs/logo.svg)
+
 ![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
-different browsers and devices is tedious and tricky. Tedious, tricky things should be automated.
+different browsers and devices is tedious and tricky. Tedious, tricky things should be automated. 
+[This blog post further elaborates on that theme.](https://robert-buchberger.com/blog/2021/responsive_images.html)
+
 
 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
@@ -47,6 +60,13 @@ https://rbuchberger.github.io/jekyll_picture_tag/devs/releases
 
 Recent releases:
 
+* 2.0.3 April 1, 2021
+  * Improve backend format support detection
+* 2.0.2 March 31, 2021
+  * Do not pass a quality argument when generating PNG files.
+    * It only works on newer versions of vips, breaking builds when using older
+      versions (such as when deploying to netlify.)
+    * It's not remarkably useful in the first place.
 * 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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_picture_tag
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.4
 platform: ruby
 authors:
 - Robert Wierzbowski
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -334,7 +334,6 @@ files:
 - docs/users/liquid_tag/examples.md
 - docs/users/liquid_tag/index.md
 - docs/users/notes/git_lfs.md
-- docs/users/notes/github_pages.md
 - docs/users/notes/html_attributes.md
 - docs/users/notes/index.md
 - docs/users/notes/kramdown_bug.md
@@ -431,7 +430,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - libvips
-rubygems_version: 3.2.3
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: Easy responsive images for Jekyll.

data/docs/users/notes/github_pages.md

@@ -1,5 +0,0 @@
-# Github Pages?
-
-  Github Pages only allows a very short whitelist of plugins, which sadly does not include JPT. You
-  can either run it locally, then commit and push the generated files (rather than the source
-  files), or just host it some other way. I recommend Netlify.