jekyll_picture_tag 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f23ec3ce5d5f881be6bae85ef969945881f158c980d2c42bb1765e206ce4fb2
-  data.tar.gz: f09e7df7586ed7d84e2edbfb1f389542f39b6b44fb21d958a60a795a73392e11
+  metadata.gz: 112ac65fbe4fb0b25934864d20de4e840259aa7bac0b43c8d6724d3d0c1ded7d
+  data.tar.gz: 8d6d101b1849762e3e955c80b301049a3cab5d7bea6f9ad8469521fb8e7fe60c
 SHA512:
-  metadata.gz: 11da88e7d15102e11fa82df0a29622f58efed1d550e127cf5ddfedca12faf9a77451867d303457b96c3f391280b3cfb92cb458408a44855247385e8f1f84ba5b
-  data.tar.gz: 5e055b1a83dd0be96bca325b5d347315f643fd4f52761452d7544fb036992785760300d2fdee98ef2c95fbdf63298703e54ba8add17d7a7726a8398031e4befb
+  metadata.gz: 86c1e2e9f9e8f62fbbc1ae69975ac490f40358649725b6308c9b964ce29571bbdaef22c6f3a0036e8c3d6352bd799d3b05db080914b143283ba97d61282632d6
+  data.tar.gz: 17cf9d9e1d397651148191fd2c3d9cde68f2af59c17edabb18b9fb27ebba9ea534a42936f601bb999944d2ff884e09788e6301494896a2ceeae0c2d1b9c23aae

data/.rubocop.yml

@@ -24,7 +24,7 @@ AllCops:
     - '**/vendor/**/*'
 
 Layout/LineLength:
-  Max: 80
+  Max: 120
 
 # Disabled Cops
 Style/FrozenStringLiteralComment:
@@ -32,3 +32,6 @@ Style/FrozenStringLiteralComment:
 
 Style/StringConcatenation:
   Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

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

@@ -2,6 +2,12 @@
 ---
 # Release History
 
+* 2.1.0 29 January, 2024
+  * Check whether the vips CLI is installed before trying to use it. Thanks to @philrb for 
+    [#299](https://github.com/rbuchberger/jekyll_picture_tag/pull/299)
+  * Update minimum required mocha version to maintain compatibility with minitest
+* 2.0.4 August 16, 2022
+  * Fix backend format support detection for new versions of libvips & imagemagick
 * 2.0.3 April 1, 2021
   * Improve backend format support detection
 * 2.0.2 March 31, 2021

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/notes/html_attributes.md

@@ -1,5 +1,5 @@
 # HTML attributes
 
   Jekyll Picture Tag has comprehensive attribute support for all generated HTML. You can add
-  attributes both through the [liquid tag]({{ site.baseurl }}/usage), and the [preset]({{
-  site.baseurl }}/presets) (scroll down a bit).
+  attributes both through the [liquid tag]({{ site.baseurl }}{% link /users/liquid_tag/index.md %}),
+  and the [preset]({{ site.baseurl }}{% link /usage/users/presets/html_attributes.md %}) (scroll down a bit).

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

@@ -13,7 +13,7 @@ to make things outside the scope of JPT.
   ```yml
   # _data/picture.yml
 
-  markup_presets:
+  presets:
     direct:
       markup: direct_url
       fallback_width: 800
@@ -26,18 +26,16 @@ 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
 
-  markup_presets:
+  presets:
     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/docs/users/presets/markup_formats/readme.md

@@ -17,7 +17,7 @@ Example:
 ```yml
 # /_data/picture.yml
 
-markup_presets:
+presets:
   my_preset:
     markup: data_auto
 ```

data/jekyll_picture_tag.gemspec

@@ -48,7 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.14'
   spec.add_development_dependency 'minitest-rg'
-  spec.add_development_dependency 'mocha', '~> 1.9'
+  spec.add_development_dependency 'mocha', '~> 2.1'
   spec.add_development_dependency 'nokogiri', '~> 1.1'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 12.3'

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/parsers/image_backend.rb

@@ -8,25 +8,35 @@ module PictureTag
         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
-                          .map { |format| format.strip.delete_prefix('.') }
+        if command?('vips')
+          @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
+        else
+          @vips_formats = []
+        end
       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
+        if command?('convert')
+          @magick_formats ||= `convert -version`
+                              .scan(/Delegates.*/)
+                              .first
+                              .delete_prefix('Delegates (built-in):')
+                              .split
+        else
+          @magick_formats = []
+        end
       end
 
       # Returns an array of all known names of a format, for the purposes of
@@ -38,9 +48,29 @@ module PictureTag
 
       private
 
+      def error_string(format)
+        str = []
+        str << "No support for generating \"#{format}\" files in this environment!"
+        str << if command?('vips')
+                 "Libvips (installed) supports: \"#{vips_formats.join(', ')}\"."
+               else
+                 'Libvips is not installed.'
+               end
+        str << if command?('convert')
+                 "Imagemagick (installed) supports: \"#{magick_formats.join(', ')}\"."
+               else
+                 'Imagemagick is not installed.'
+               end
+        str.join(' ')
+      end
+
       def alternates
         [%w[jpg jpeg], %w[avif heic heif]]
       end
+
+      def command?(command)
+        system("which #{command} > /dev/null 2>&1")
+      end
     end
   end
 end

data/lib/jekyll_picture_tag/version.rb

@@ -1,3 +1,3 @@
 module PictureTag
-  VERSION = '2.0.3'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/readme.md

@@ -1,13 +1,25 @@
-![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.
+[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
@@ -37,16 +49,22 @@ Tag is your responsive images minion - give it simple instructions and it'll han
 * Configure it easily, or not at all.
 * Make Lighthouse happy.
 
-## Documentation:
+## Documentation
 
-https://rbuchberger.github.io/jekyll_picture_tag/
+<https://rbuchberger.github.io/jekyll_picture_tag/>
 
-## Changelog:
+## Changelog
 
-https://rbuchberger.github.io/jekyll_picture_tag/devs/releases
+<https://rbuchberger.github.io/jekyll_picture_tag/devs/releases>
 
 Recent releases:
 
+* 2.1.0 29 January, 2024
+  * Check whether the vips CLI is installed before trying to use it. Thanks to @philrb for
+    [#299](https://github.com/rbuchberger/jekyll_picture_tag/pull/299)
+  * Update minimum required mocha version to maintain compatibility with minitest
+* 2.0.4 August 16, 2022
+  * Fix backend format support detection for new versions of libvips & imagemagick
 * 2.0.3 April 1, 2021
   * Improve backend format support detection
 * 2.0.2 March 31, 2021
@@ -67,11 +85,11 @@ Recent releases:
   * Require Ruby >= 2.6, support Ruby 3.0
   * Require Jekyll >= 4.0
   * Cropping is changing.
-      * We now use the libvips
+    * 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
+    * 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.
@@ -83,14 +101,6 @@ Recent releases:
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_picture_tag
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Robert Wierzbowski
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -144,14 +144,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -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.