jekyll_picture_tag 1.11.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fdaad2f56cc244f8bce4ffcf5689630fe71ec0b7e091d91e289a1dc7d6740d8
-  data.tar.gz: 971d590896ef6396a86c8ce6f6dd7fef46804443b4c2b76226e5e774dc5cd204
+  metadata.gz: 3f9db202e681087ec43ee9cc26b3e32dbc76de45c394ea834039b72f100215e1
+  data.tar.gz: 2c195508efb7d9e05bda81dd529366f47fa25c5e1ce7bc6ca60edbd5e2db8a4f
 SHA512:
-  metadata.gz: 77fa8b7e4b3db8839a988f0613b8e3b0257ff92f7e379db12bf9de1da3644acf7d6a6bfa0fb82b900fb71d2e6775d842d2187ec1e13617cf268098f98ad41e12
-  data.tar.gz: b9efeae7cff9bc5a962d9c076d735c00011ad231cbac264b232a29a6f4ec3af101d9f905a0cde61283b0b739b8d9388e92ccad7f600aacccc382c2845edbd71e
+  metadata.gz: fc17dcd0e8a5ffb70f3ca67bf22e8bb34b2e9c5af61ffabaf5e92e853b01bec6a0b56a01f45ccc44f55be11112aed75e04ac293e4d8012af3b135ce20aaa84fb
+  data.tar.gz: '09b01489bcd3dc1e7428ae41fe6f603488f1863cc731ad0d70f5861cb1c3525dda04f7445a9f97d22f005b5a900c8d6ba019467f7379575fe07c0370e9a0d8cb'

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,6 +1,34 @@
-Style/FrozenStringLiteralComment:
-  Enabled: false
+# 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

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/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'github-pages', group: :jekyll_plugins
-gem 'jekyll-theme-slate'
+group :jekyll_plugins do
+  gem 'github-pages'
+  gem 'jekyll-rtd-theme'
+end

data/docs/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -28,12 +28,12 @@ GEM
     execjs (2.7.0)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    ffi (1.12.2)
+    ffi (1.13.1)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
-    github-pages (204)
+    github-pages (206)
       github-pages-health-check (= 1.16.1)
-      jekyll (= 3.8.5)
+      jekyll (= 3.8.7)
       jekyll-avatar (= 0.7.0)
       jekyll-coffeescript (= 1.1.1)
       jekyll-commonmark-ghpages (= 0.1.6)
@@ -72,7 +72,7 @@ GEM
       mercenary (~> 0.3)
       minima (= 2.5.1)
       nokogiri (>= 1.10.4, < 2.0)
-      rouge (= 3.13.0)
+      rouge (= 3.19.0)
       terminal-table (~> 1.4)
     github-pages-health-check (1.16.1)
       addressable (~> 2.3)
@@ -80,13 +80,13 @@ GEM
       octokit (~> 4.0)
       public_suffix (~> 3.0)
       typhoeus (~> 1.3)
-    html-pipeline (2.12.3)
+    html-pipeline (2.13.0)
       activesupport (>= 2)
       nokogiri (>= 1.4)
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.5)
+    jekyll (3.8.7)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -136,6 +136,8 @@ GEM
       addressable (~> 2.0)
       jekyll (>= 3.5, < 5.0)
       rubyzip (>= 1.3.0)
+    jekyll-rtd-theme (0.1.6)
+      github-pages (~> 206)
     jekyll-sass-converter (1.5.2)
       sass (~> 3.4)
     jekyll-seo-tag (2.6.1)
@@ -202,9 +204,9 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.14.0)
+    minitest (5.14.1)
     multipart-post (2.1.1)
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     octokit (4.18.0)
       faraday (>= 0.9)
@@ -215,7 +217,7 @@ GEM
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rouge (3.13.0)
+    rouge (3.19.0)
     ruby-enum (0.8.0)
       i18n
     rubyzip (2.3.0)
@@ -236,14 +238,14 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   github-pages
-  jekyll-theme-slate
+  jekyll-rtd-theme
 
 BUNDLED WITH
    2.1.4

data/docs/_config.yml

@@ -1,13 +1,9 @@
-theme: jekyll-theme-slate
+remote_theme: rundocs/jekyll-rtd-theme
+
 title: Jekyll Picture Tag
+description: Images for Jekyll, done correctly.
+lang: en-US
 
-url: ''
 baseurl: '/jekyll_picture_tag'
-
-defaults:
-  - 
-    scope: 
-      path: ''
-    values:
-      layout: directory
-  
+readme_index: 
+  with_frontmatter: true

data/docs/devs/contributing/code.md

@@ -0,0 +1,54 @@
+---
+sort: 4
+---
+
+# 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.
+
+* Refactoring is welcome, especially in the name of the previous point.
+
+* I'm very reluctant to introduce breaking changes to configuration settings. This rule isn't
+  absolute, but I'm not going to do it without a good reason.
+
+* Don't disable cops without strong justification.
+
+* I generally try to write tests before writing code, especially when fixing bugs. This
+  gives us some confidence that what we think we're testing and what we're actually testing aren't
+  too different.
+
+## Hard rules
+
+These aren't the rules for submitting a pull request, these are the rules for merging into master.
+I'm thrilled to receive any help at all, and I'm more than happy to help with meeting these
+criteria:
+
+* Liquid tag syntax can only be extended; no breaking changes. I'm not willing to force
+  users to dig through their entire site and change every picture tag in order to update to the
+  latest version.
+
+* 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.
+
+* Good test coverage, > 90%. Not every line must be tested, but every line that matters should be.
+
+* No failing tests
+
+* No rubocop warnings
+
+## 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

@@ -0,0 +1,31 @@
+---
+sort: 2
+---
+
+# Docs
+
+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.
+
+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/index.md

@@ -0,0 +1,15 @@
+---
+---
+# Contributing
+
+Bug reports, feature requests, and feedback are very welcome, either through
+github issues or via email: robert@buchberger.cc 
+
+Pull requests are encouraged! I'm happy to answer questions and provide
+assistance along the way.  Don't let any of the recommendations/requests in this
+guide stop you from submitting one.
+
+I think one of the biggest opportunities for improvement in this plugin is its
+documentation. I'd really love help here, and all you need to know is markdown.
+
+{% include list.liquid %}

data/docs/devs/contributing/setup.md

@@ -0,0 +1,33 @@
+---
+sort: 1
+---
+
+## Setup
+
+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

@@ -0,0 +1,23 @@
+---
+sort: 3
+---
+
+# 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/index.md

@@ -0,0 +1,7 @@
+---
+sort: 2
+---
+
+# Development
+
+{% include list.liquid %}

data/docs/devs/releases.md

@@ -0,0 +1,118 @@
+---
+---
+# Release History
+* **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.
+    * Allows for actual lossless webp: simply set quality to 100.
+    * Improves fresh (no cached images) build times by ~15%
+    * Fix problems with poor image quality.
+* 1.12.0 July 30, 2020
+  * Documentation overhaul. Now with 87% less scrolling!
+  * Rename `markup_presets` and `media_presets` to `presets` and
+    `media_queries`. The old names were bad and caused confusion. The old names
+    will continue to work until the next major version is released.
+* 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.
+* 1.10.2 July 6, 2020
+  * Bugfix for fallback image files not actually getting generated
+* 1.10.1 July 2, 2020
+  * Bugfix for erroneously regenerated images
+* 1.10.0 May 11, 2020
+  * **Image Cropping support!** access the power of ImageMagick's `crop` function.
+  * Don't issue a warning when `default` preset is not found.
+  * Documentation improvements
+* 1.9.0 Feb 2, 2020
+  * Add `fast_build` global setting
+  * Add `disabled` global setting
+  * Reduce unnecessary disk IO; sites with many source images should see build
+  times improve when no new images need to be generated.
+  * Add support for empty attributes; specifically so best-practice for
+    decorative images (`alt=""`) is possible.
+* 1.8.0 Nov 25, 2019
+  * Add `data_sizes` setting for the `data_` family of output formats.
+* 1.7.1 Nov 14, 2019
+  * Fix some HTML attribute related bugs
+  * Add a few items to the FAQ
+* 1.7.0 Aug 12, 2019
+  * Add support for setting generated image quality, either generally or
+    specific to given formats.
+  * Add support for spaces and other url-encoded characters in filenames
+  * Documentation restructure - Moved it out of the wiki, into the `docs`
+    folder.
+  * Bugfix: Fallback image width will now be checked against source image width.
+  * Bugfix: Minor fix to nomarkdown wrapper output
+  * 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
+  * 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:
+  * better `{::nomarkdown}` necessity detection
+  * allow user to override `{::nomarkdown}` autodetection
+* 1.4.0 Jun 26, 2019:
+  * Rename gem from `jekyll-picture-tag` to `jekyll_picture_tag`, allowing us to
+    use rubygems again.
+  * Add new output format: `naked_srcset`.
+* 1.3.1 Jun 21, 2019: Bugfix
+* 1.3.0 Jun  7, 2019:
+  * Initial compatibility with Jekyll 4.0
+  * bugfixes
+  * change to generated image naming-- The first build after this update will be
+    longer, and you might want to clear out your generated images.
+* 1.2.0 Feb  9, 2019:
+  * Add nomarkdown fix
+  * noscript option
+  * relative url option
+  * anchor tag wrappers
+* 1.1.0 Jan 22, 2019:
+  * Add direct_url markup format,
+  * 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.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.
+* 0.1.1 Jul  5, 2013: Quick round of code improvements.
+* 0.1.0 Jul  5, 2013: Initial release.