jekyll_picture_tag 1.13.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46fd8634e4d9eff8493b340560d84e8a398eb77db81a511529f0b670f111de7c
-  data.tar.gz: 103f00baec1839e018094b5c3d3522ecff13849e3bda46353ddde9e70e2040fb
+  metadata.gz: 61b3c53bfa81070e0457626c7ffe32c528bd6cafcc6627b5899d4737f83e2fd8
+  data.tar.gz: 25abc195daaee489892452b4fb1622fcb4585e1b09ee34bb1a2a4b568d2a1f68
 SHA512:
-  metadata.gz: 14afd21d6a1cd36bac48b20e79047e1df845b458e763d0eb590125fa45dd2eef431cc27836f22073878d807dc5118787f40fe8b2ffc15579bd6edf4c70f0411b
-  data.tar.gz: bd9131318cd312b340ff337db88127c9b8b14f78c2bfc64ec04dd6f9d27db87a08d36a59bf5aa550f51ede5c2a6b9cdda8554c60f2cecc64db5e914a1f28a84f
+  metadata.gz: 075f856f3407ee8e1c68f785759a600ea04ddbfcff08944fd4796157c842a2c0583044b726580ed5030b81fd0f8b82c962345e583eef4c492fd2edda7a03fe48
+  data.tar.gz: 66f7afa3af4d32ac61d67e21f4a7844d86c2f195043f3f607b706a30a40e3be040e21654ef601cd5f12edf7535f6e1401edb2ae1f17a50c56de91eb5b1a03c70

data/.envrc

@@ -0,0 +1,4 @@
+# if you run bundle install --binstubs, you won't have to use bundle exec all the time.
+export PATH=$(git rev-parse --show-toplevel)/bin:$PATH
+# Suppress a few vips warnings that pop up during the tests
+export VIPS_WARNING=0

data/.github/workflows/code-checks.yml

@@ -0,0 +1,33 @@
+name: 'Tests & Formatting'
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  schedule:
+    # Run weekly; github deletes caches that haven't been used in a week.
+    - cron: '0 0 * * 0'
+
+jobs:
+  checks:
+    runs-on: ubuntu-20.04
+
+    steps:
+
+      - name: Install system dependencies
+        run: sudo apt install libjpeg-dev webp libpng-dev libavifile-0.7c2 libopenjpip7 imagemagick libvips-tools
+
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      # Version taken from .ruby-version file.
+      # Also runs bundle install.
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - run: bundle exec rake test
+
+      - run: bundle exec rubocop

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/docs/.bundle/
 /.yardoc
 /Gemfile.lock
 /_yardoc/
@@ -13,3 +14,5 @@ jekyll-picture-tag.iml
 /docs/_site/
 /docs/.jekyll-cache/
 /docs/.sass-cache/
+/bin/
+/docs/bin/

data/.rubocop.yml

@@ -1,81 +1,34 @@
-# Disabled
+# Exclude unimportant files
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  Include:
+    - 'lib/**/*.rb'
+    - 'test/**/*.rb'
+    - 'Gemfile'
+    - 'Rakefile'
+    - '*.gemspec'
+
+  Exclude:
+    - '**/.bundle/*'
+    - '**/.git/*'
+    - '**/.github/*'
+    - '**/bin/**/*'
+    - '**/coverage/**/*'
+    - '**/docs/**/*'
+    - '**/imagemagick/*'
+    - '**/pkg/**/*'
+    - '**/vendor/**/*'
+
+Layout/LineLength:
+  Max: 80
+
+# Disabled Cops
 Style/FrozenStringLiteralComment:
   Enabled: false
 
 Style/StringConcatenation:
   Enabled: false
-
-# New cops, enabled. We aren't using the 'NewCops' setting because then rubocop
-# updates can break our CI.
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Lint/BinaryOperatorWithIdenticalOperands:
-  Enabled: true
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-Lint/DuplicateElsifCondition:
-  Enabled: true
-Lint/DuplicateRescueException:
-  Enabled: true
-Lint/EmptyConditionalBody:
-  Enabled: true
-Lint/FloatComparison:
-  Enabled: true
-Lint/MissingSuper:
-  Enabled: true
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-Lint/OutOfRangeRegexpRef:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/SelfAssignment:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-Lint/TopLevelReturnWithArgument:
-  Enabled: true
-Lint/UnreachableLoop:
-  Enabled: true
-Style/AccessorGrouping:
-  Enabled: true
-Style/ArrayCoercion:
-  Enabled: true
-Style/BisectedAttrAccessor:
-  Enabled: true
-Style/CaseLikeIf:
-  Enabled: true
-Style/ExplicitBlockArgument:
-  Enabled: true
-Style/ExponentialNotation:
-  Enabled: true
-Style/GlobalStdStream:
-  Enabled: true
-Style/HashAsLastArrayItem:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashLikeCase:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Style/OptionalBooleanParameter:
-  Enabled: true
-Style/RedundantAssignment:
-  Enabled: true
-Style/RedundantFetchBlock:
-  Enabled: true
-Style/RedundantFileExtensionInRequire:
-  Enabled: true
-Style/RedundantRegexpCharacterClass:
-  Enabled: true
-Style/RedundantRegexpEscape:
-  Enabled: true
-Style/SingleArgumentDig:
-  Enabled: true
-Style/SlicingWithRange:
-  Enabled: true

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.6.6

data/docs/.envrc

@@ -0,0 +1,2 @@
+# if you run bundle install --binstubs, you won't have to use bundle exec all the time.
+export PATH=$(git rev-parse --show-toplevel)/docs/bin:$PATH

data/docs/devs/contributing/code.md

@@ -2,7 +2,18 @@
 sort: 4
 ---
 
-# Code Guidelines
+# Code
+
+## Commit guidelines
+
+* The commit log should be a history of small, coherent changes. Commits are cheap, make no attempt
+  to minimize the number of them! Yes, it's messy. Yes it makes the commit log longer. It's also far
+  more useful than a nice, tidy, one-commit-per-pull-request log.
+
+* Follow the existing commit message style. Start with a capitalized, present tense verb and say
+  what the commit does. If the reason why isn't obvious, explain in the extended message.
+
+## Code Guidelines
 
 * Generally, go for straightforward and readable rather than terse and clever. I'm not actually a
   very good programmer; I need simple code that's easy to understand.
@@ -31,14 +42,13 @@ criteria:
 * Maintain "no configuration required" - a new user must be able to add JPT to their gemfile, bundle
   install, and start writing picture tags in their site without touching a yml file.
 
-* 100% test coverage (Meaning that when running the unit and integration tests together, every line
-  of code in the `lib` folder must run at least once.)
+* Good test coverage, > 90%. Not every line must be tested, but every line that matters should be.
 
 * No failing tests
 
 * No rubocop warnings
 
-### Thanks!
+## Thanks!
 
 As I said, don't let any of the rules & guidelines scare you away. They're the rules for merging
 into master, not submitting a pull request. I'm thrilled to receive any help at all.

data/docs/devs/contributing/docs.md

@@ -4,10 +4,28 @@ sort: 2
 
 # Docs
 
-They run on github pages, which is based on jekyll. You can preview as you edit:
+The docs are a mini-project in the docs folder. They don't have a dedicated git repository, but they
+do have their own Gemfile. They run on Github Pages, which is based on Jekyll.
 
-0. Follow the [setup instructions](setup)
-1. `$ cd docs`
-2. `$ bundle install`
-3. `$ bundle exec jekyll serve`
-4. In a web browser, navigate to `localhost:4000/jekyll_picture_tag/`
+The format is simple; markdown files with a few lines of metadata at the top, organized into
+subdirectories. We're using the [jekyll-rtd-theme](https://jekyll-rtd-theme.rundocs.io/).
+
+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
+$ cd jekyll_picture_tag/docs
+$ direnv allow # (optional)
+$ bundle install --binstubs # --binstubs is optional.
+```
+
+If you use direnv or add `docs/bin` to your `PATH` another way, the `--binstubs` flag allows you to
+skip `bundle exec`.
+
+To preview:
+
+``` sh
+$ jekyll serve --livereload # (prefix with `bundle exec` if necessary)
+```
+
+* In a web browser, navigate to `localhost:4000/jekyll_picture_tag/`

data/docs/devs/contributing/setup.md

@@ -4,10 +4,30 @@ sort: 1
 
 ## Setup
 
-It's pretty standard:
+I use [asdf](https://github.com/asdf-vm/asdf) and [direnv](https://direnv.net/) (via
+[asdf-direnv](https://github.com/asdf-community/asdf-direnv)). They add convenience, but they aren't
+required by any means.
 
+### With asdf & direnv:
+
+```sh
+$ git clone git@github.com:rbuchberger/jekyll_picture_tag.git
+$ cd jekyll_picture_tag
+$ direnv allow
+$ asdf install
+$ bundle install --binstubs
 ```
+
+### Without asdf & direnv
+
+```sh
 $ git clone git@github.com:rbuchberger/jekyll_picture_tag.git
 $ cd jekyll_picture_tag
+# Install the correct version of ruby, with the bundler gem.
 $ bundle install
 ```
+
+* The currently targeted ruby version can be found in the `.ruby-version` file in the project root;
+  ensure your version manager of choice knows about it.
+* If you add the project's `bin/` folder to your path, and run `bundle install --binstubs`, you won't
+  have to use `bundle exec` for `rake` commands and such.

data/docs/devs/contributing/testing.md

@@ -2,40 +2,22 @@
 sort: 3
 ---
 
-## How to run the tests
-
-You probably only need to use docker if it's inconvenient to install ImageMagick 7.
-
-### Bare Metal
-
-```note
-Depending on your environment, you may need to prefix all rake commands with
-`bundle exec`.
-```
-
-`rake test` runs the test suite (both unit tests and integration tests). Ignore the mini_magick
-`method redefined` warnings (unless you know how to fix them?) 
-
-`rake unit` runs just the unit tests, while `rake integration` runs the integration tests. The unit
-test coverage isn't stellar, but both unit and integration tests together hit 100%.
-
-Speaking of coverage, simplecov is set up -- you'll get a measurement of coverage in the test output
-and a nice report in the `coverage` directory. I'd like to move to mutation based coverage testing,
-but that's a project for another day.
-
-The tests do output a few images to the `/tmp/` directory, which I'm pretty sure means it won't work
-on Windows. This is fixable if there is a need, so if that gets in your way just ask.
-
-`rake rubocop` checks code formatting, `rake rubocop:auto_correct` will try to fix any rubocop
-issues, if possible.
-
-`rake` will run all tests and rubocop.
-
-### Docker
-
-The following commands will build and run the tests inside a docker image.
-
-```bash
-$ docker build . -t jpt
-$ docker run -t jpt
-```
+# Tests
+
+The primary way to run these checks is `rake`:
+
+| rake command                | function                        |
+|-----------------------------|---------------------------------|
+| `rake unit`                 | Unit tests only                 |
+| `rake integration`          | Integration tests only          |
+| `rake test`                 | Both unit and integration tests |
+| `rake rubocop`              | Check code formatting           |
+| `rake rubocop:auto_correct` | Fix rubocop issues, if possible |
+| `rake`                      | Run all checks                  |
+
+* Ignore the mini_magick `method redefined` warnings (unless you know how to fix them?) 
+* Depending on your environment, you may need to prefix all rake commands with `bundle exec`
+* Simplecov is set up -- you'll get a measurement of coverage in the test output and a nice report
+  in the `coverage` directory.
+* The tests use the `/tmp/` directory directly, which I'm pretty sure means it won't work on
+  Windows. This is fixable, so if that gets in your way just ask.

data/docs/devs/releases.md

@@ -1,6 +1,47 @@
 ---
 ---
 # Release History
+
+* 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.
+* **2.0** March 25, 2021 - [Migration guide](/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.
 * 1.13.0 November 23, 2020
   * Add image quality interpolation; allows for variable image quality based on image size.
   * Bugfix: Perform format, resize, and quality changes simultaneously rather than individually.
@@ -49,12 +90,12 @@
   * link_source will now target the base source image, rather than finding the
     biggest one.
   * Remove fastimage dependency, add addressable dependency.
-  * Moderately significant refactoring and code cleanup 
+  * Moderately significant refactoring and code cleanup
   * Decent set of tests added
 * 1.6.0 Jul  2, 2019:
   * Missing Preset warning respects `data_dir` setting
   * Add `continue_on_missing` option
-* 1.5.0 Jun 26, 2019: 
+* 1.5.0 Jun 26, 2019:
   * better `{::nomarkdown}` necessity detection
   * allow user to override `{::nomarkdown}` autodetection
 * 1.4.0 Jun 26, 2019:
@@ -77,8 +118,8 @@
   * auto-orient images before stripping metadata
 * 1.0.2 Jan 18, 2019: Fix ruby version specification
 * 1.0.1 Jan 13, 2019: Added ruby version checking
-* **1.0.0** Nov 27, 2018: Rewrite from the ground up. See the 
-* [migration guide]({{ site.baseurl }}/users/notes/migration).
+* **1.0.0** Nov 27, 2018: Rewrite from the ground up. See the [migration guide]({{ site.baseurl
+  }}/users/notes/migration_1).
 * 0.2.2 Aug  2, 2013: Bugfixes
 * 0.2.1 Jul 17, 2013: Refactor again, add Liquid parsing.
 * 0.2.0 Jul 14, 2013: Rewrite code base, bring in line with Jekyll Image Tag.

data/docs/index.md

@@ -1,9 +1,19 @@
 ---
 ---
 
-# Jekyll Picture Tag
+![](logo.svg)
 
-Responsive Images, Done Correctly.
+_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
+guide](users/notes/migration_2) documents how to upgrade an existing site.
 
 ## Quick start / Demo
 
@@ -31,17 +41,33 @@ Responsive Images, Done Correctly.
 
 ### "That's cool, but I just want webp."
 
-Create `_data/picture.yml`, add the following:
+Use a built-in preset!
 
-```yml
-presets:
-  default:
-    formats: [webp, original]
-```
+{% raw %} `{% picture jpt-webp test.jpg %}` {% endraw %}
 
-**Note:** Order matters! `[webp, jpg]` will offer webp-images first.  The
-browser will pick the *first* format it can work with. So if the order is
-reversed `[jpg, webp]` it will use the jpg image before the webp.
+```html
+<!-- Formatted for readability -->
+
+<picture>
+  <source
+    type="image/webp"
+    srcset="
+      /generated/test-400-195f7d192.webp   400w,
+      /generated/test-600-195f7d192.webp   600w,
+      /generated/test-800-195f7d192.webp   800w,
+      /generated/test-1000-195f7d192.webp 1000w
+    ">
+  <source
+    type="image/jpeg"
+    srcset="
+      /generated/test-400-195f7d.jpg   400w,
+      /generated/test-600-195f7d.jpg   600w,
+      /generated/test-800-195f7d.jpg   800w,
+      /generated/test-1000-195f7d.jpg 1000w
+    ">
+  <img src="/generated/test-800-195f7dGUW.jpg">
+</picture>
+```
 
 ### Here's a more complete demonstration:
 
@@ -67,9 +93,8 @@ presets:
     size: 500px
 ```
 
-Imagemagick can easily crop images to an aspect ratio, though you should **read
-the whole installation guide before using this feature**. With the above preset,
-if you write this:
+Cropping images is easy as well; simply give an aspect ratio. With the above preset, if you write
+this:
 
 {% raw %}
 `{% picture test.jpg 3:2 mobile: test2.jpg 1:1 --alt Alternate Text %}`
@@ -124,7 +149,7 @@ switching problems *solved*, with a one-liner and a nicely readable config file
 that is 1/3 as long as the output markup. Lighthouse is happy, and you don't
 even need to crop things yourself.
 
-That isn't a complete demonstration of Jekyll Picture Tag's feature set; it can
-(among other things) add width & height attributes to prevent page reflow, add a
-link to the source image (or anywhere else), and adjust image quality. See the
-docs for more.
+This is far from a complete demonstration of Jekyll Picture Tag's feature set;
+it can (among other things) add width & height attributes to prevent page
+reflow, add a link to the source image (or anywhere else), and adjust image
+quality. See the docs for more.