jekyll_picture_tag 2.0.0pre1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7b9809326f283e0ec7db7ed8e4c9d142de92b5002e49e0addd75fff04c38d7d
-  data.tar.gz: 2a9686f1e39a3812337b9f0bc33ec9368211d26e3dd9c4b1960936457e00154c
+  metadata.gz: 3f9db202e681087ec43ee9cc26b3e32dbc76de45c394ea834039b72f100215e1
+  data.tar.gz: 2c195508efb7d9e05bda81dd529366f47fa25c5e1ce7bc6ca60edbd5e2db8a4f
 SHA512:
-  metadata.gz: 4710bd147e0973818f7eb846137b81bb8a90eae63da7a720ebe0802f323752631f3e487a7c5fac01d0ae655d3b0d7e82839206646e5abfe65de6c86166b25687
-  data.tar.gz: 53cc71fff10a85c23bd80ad68478db2bd5e3c2fa2024d5bf1953b9975728b7ea739695f9da05a8aad248cde951b06939241c1f176b78c27602fa6499cc90f86d
+  metadata.gz: fc17dcd0e8a5ffb70f3ca67bf22e8bb34b2e9c5af61ffabaf5e92e853b01bec6a0b56a01f45ccc44f55be11112aed75e04ac293e4d8012af3b135ce20aaa84fb
+  data.tar.gz: '09b01489bcd3dc1e7428ae41fe6f603488f1863cc731ad0d70f5861cb1c3525dda04f7445a9f97d22f005b5a900c8d6ba019467f7379575fe07c0370e9a0d8cb'

data/docs/devs/releases.md

@@ -1,23 +1,28 @@
 ---
 ---
 # Release History
-* **2.0** (TBD)
-  * Move from ImageMagick to libvips.
-    * **MUCH MORE FASTER**. Like a lot.
+* **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
+  * Require Ruby >= 2.6, support Ruby 3.0
   * Require Jekyll >= 4.0
-  * Cropping is changing; we now use vips' smartcrop function and an aspect
-    ratio. No more geometry and gravity, just an aspect ratio and an
-    optional interestingness (keep) setting.
-  * Add `format_quality` default settings for webp, avif, and jp2.
+  * 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 will be added in future releases.
+    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.
@@ -104,8 +109,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

@@ -3,7 +3,12 @@
 
 ![](logo.svg)
 
-Responsive Images, Done Correctly.
+_Responsive Images, Done Correctly._
+
+**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
 

data/docs/users/installation.md

@@ -25,7 +25,8 @@ sort: 1
 3. Install `libvips`. Most package managers know about it, otherwise it can be found
    [here](https://libvips.github.io/libvips/install.html).
 4. Install libvips dependencies for all image formats you will use, such as `libpng`, `libwebp`,
-   `libjpeg`, and `libheif` (for avif).
+   `libjpeg`, and `libheif` (for avif). Note that if you use a deployment or CI service, these
+   dependencies will be required there as well.
 5. Optional: Install `ImageMagick` for additional image formats. If vips runs into an image format
    it can't handle (jp2 on my particular installation), JPT will instruct it to try ImageMagick
    instead.

data/docs/users/notes/migration_2.md

@@ -35,8 +35,8 @@ move now. Again, speak up if this causes a great deal of pain.
 
 ## Image quality & write options.
 
-- If you have set `quality:` in a preset, it will likely stop having an effect. You need to set
-  `format_quality:` instead.
+- If you have set `quality:` in a preset, it will stop having an effect for webp, avif, and jp2
+  images. You need to set `format_quality:` instead.
 
 Previously, all image formats used a default quality of 75. We have now set a default quality for 3
 formats:

data/docs/users/presets/cropping.md

@@ -1,5 +1,5 @@
 ---
-sort: 6
+sort: 7
 ---
 
 # Cropping

data/docs/users/presets/default.md

@@ -1,5 +1,5 @@
 ---
-sort: 12
+sort: 14
 ---
 
 # Default preset

data/docs/users/presets/examples.md

@@ -1,7 +1,7 @@
 ---
-sort: 1
+sort: 2
 ---
-# Example presets
+# Examples
 
 The following example media queries & presets (except for `default`) are built-in with a `jpt-`
 prefix. For example, the `desktop` media query below can be used with `jpt-desktop`, and the `webp`

data/docs/users/presets/fallback_image.md

@@ -1,5 +1,5 @@
 ---
-sort: 10
+sort: 11
 ---
 
 # Fallback Image

data/docs/users/presets/html_attributes.md

@@ -1,5 +1,5 @@
 ---
-sort: 9
+sort: 10
 ---
 
 # Arbitrary HTML Attributes

data/docs/users/presets/image_formats.md

@@ -1,5 +1,5 @@
 ---
-sort: 3
+sort: 4
 ---
 
 # Image Formats

data/docs/users/presets/image_quality.md

@@ -1,5 +1,5 @@
 --- 
-sort: 7
+sort: 8
 ---
 
 # Image Quality & Options
@@ -75,8 +75,7 @@ _Example:_ `strip_metadata: false`
 
 _Default:_ `true`
 
-Remove EXIF data, which can save a few tens of kilobytes per image. This is set globally, not
-per-format.
+Remove EXIF data, which can save a few tens of kilobytes per image. This is set for all formats.
 
 ## Image Format Options
 
@@ -113,7 +112,8 @@ available for a given image format, search for the method `vips_(format)save` in
 [this](https://libvips.github.io/libvips/API/current/VipsForeignSave.html) API documentation. For
 example, png options can be found by searching for `vips_pngsave()`, leading
 [here](https://libvips.github.io/libvips/API/current/VipsForeignSave.html#vips-pngsave). See the
-optional arguments. 
+optional arguments. `avif`'s options are under `vips_heifsave()`,
+[here](https://libvips.github.io/libvips/API/current/VipsForeignSave.html#vips-heifsave).
 
 For all formats, note that
 - `Q:` (quality) is handled by the settings above.

data/docs/users/presets/index.md

@@ -2,7 +2,7 @@
 sort: 3
 ---
 
-# Writing Presets
+# Presets
 
 Presets are named collections of settings that determine basically everything
 about JPT's output. Think of them like frameworks that you can plug images into;
@@ -70,68 +70,6 @@ media_queries:
 
 More information [here](media_queries).
 
-## How to write a preset
-
-### 0. Pick a name
-
-* Preset names should be a single word, and they can't contain periods.
-* `default` is used when you don't specify one in a liquid tag.
-* Anything beginning with `jpt-` is off limits.
-
-### 1. Pick a Markup Format
-
-The high level, overall markup format is controlled with the `markup:` setting, documented
-[here](markup_formats). You probably want the default setting of `auto`, unless you're doing some
-form of post-processing.
-
-If you have a lot of images below-the-fold, consider setting up lazy-loading with an appropriate
-javascript library (there are tons) and `data_auto`.
-
-### 2. Choose a srcset format.
- 
-For images that are different sizes on different screens (most images), use a [width-based
-srcset](width_srcsets) (which is the default). When using this format, it's important to create a
-sizes attribute, documented at the link above.
-
-Use a [pixel-ratio srcset](pixel_ratio_srcsets) when the image will always be the same size,
-regardless of screen width (thumbnails, avatars, icons, etc). 
-
-### 3. Choose a set of image widths.
-
-For width-based srcsets, set `widths:`. For pixel-ratio srcsets, set `base_width:` and
-`pixel_ratios:`. You want 3-6 sizes that cover a wide range of devices.
-
-### 4. Choose a set of image formats.
-
-Accomplish this by setting `formats: [format1, format2, etc...]`
-
-* `webp` has [broad support](https://caniuse.com/?search=webp) and is an obvious choice.
-* `avif` has [bad](https://caniuse.com/?search=avif) (but improving) support, and for some reason is slow to generate, but gets better
-  file sizes than webp.
-* `jp2` is [Apple's baby](https://caniuse.com/?search=jp2).
-* `original` spits out whatever you put in.
-
-Order matters; browsers will use the first one they support. 
-
-* `[webp, original]` is a good compromise of build resources, support, and performance.
-* `[webp, jp2, original]` brings Safari users along for the ride.
-* `[avif, original]` If you don't care about browsers that aren't chrome, or build time.
-* `[avif, webp, jp2, original]` might be overkill, but it keeps everyone happy.
-
-### 5. Turn on dimension attributes.
-
-This step prevents page reflow on image load (especially when lazy loading), but requires some prep.
-
-1. Make sure your CSS is correct. You need something like `width: 100%` and `height: auto` (which
-   is why they aren't turned on by default.) Without this step, you'll get crazy sizes and/or
-   stretched images.
-2. Set `dimension_attributes: true`
-
-### 6. Make any other changes you need
-
-Here's a list of all preset settings available:
+## Reference
 
 {% include list.liquid %}
-
-(Note that the `data_*` output formats have a few special options, documented on their respective
-pages.)

data/docs/users/presets/link_source.md

@@ -1,5 +1,5 @@
 ---
-sort: 11
+sort: 12
 ---
 
 # Source Image Link

data/docs/users/presets/media_queries.md

@@ -1,5 +1,5 @@
 ---
-sort: 2
+sort: 3
 ---
 
 # Media Queries

data/docs/users/presets/nomarkdown_override.md

@@ -1,5 +1,5 @@
 ---
-sort: 12
+sort: 13
 ---
 
 # Nomarkdown Override

data/docs/users/presets/pixel_ratio_srcsets.md

@@ -1,5 +1,5 @@
 ---
-sort: 5
+sort: 6
 ---
 
 # Pixel Ratio Srcsets

data/docs/users/presets/width_srcsets.md

@@ -1,5 +1,5 @@
 ---
-sort: 4
+sort: 5
 ---
 
 # Width Based Srcsets

data/docs/users/presets/writing_presets.md

@@ -0,0 +1,65 @@
+---
+sort: 1
+---
+
+# How to write a preset
+
+## 0. Pick a name
+
+* Preset names should be a single word, and they can't contain periods.
+* `default` is used when you don't specify one in a liquid tag.
+* Anything beginning with `jpt-` is off limits.
+
+## 1. Pick a Markup Format
+
+The high level, overall markup format is controlled with the `markup:` setting, documented
+[here](markup_formats). You probably want the default setting of `auto`, unless you're doing some
+form of post-processing.
+
+If you have a lot of images below-the-fold, consider setting up lazy-loading with an appropriate
+javascript library (there are tons) and `data_auto`.
+
+## 2. Choose a srcset format.
+ 
+For images that are different sizes on different screens (most images), use a [width-based
+srcset](width_srcsets) (which is the default). When using this format, it's important to create a
+sizes attribute, documented at the link above.
+
+Use a [pixel-ratio srcset](pixel_ratio_srcsets) when the image will always be the same size,
+regardless of screen width (thumbnails, avatars, icons, etc). 
+
+## 3. Choose a set of image widths.
+
+For width-based srcsets, set `widths:`. For pixel-ratio srcsets, set `base_width:` and
+`pixel_ratios:`. You want 3-6 sizes that cover a wide range of devices.
+
+## 4. Choose a set of image formats.
+
+Accomplish this by setting `formats: [format1, format2, etc...]`
+
+* `webp` has [broad support](https://caniuse.com/?search=webp) and is an obvious choice.
+* `avif` has [bad](https://caniuse.com/?search=avif) (but improving) support, and for some reason is slow to generate, but gets better
+  file sizes than webp.
+* `jp2` is [Apple's baby](https://caniuse.com/?search=jp2).
+* `original` spits out whatever you put in.
+
+Order matters; browsers will use the first one they support. 
+
+* `[webp, original]` is a good compromise of build resources, support, and performance.
+* `[webp, jp2, original]` brings Safari users along for the ride.
+* `[avif, original]` If you don't care about browsers that aren't chrome, or build time.
+* `[avif, webp, jp2, original]` might be overkill, but it keeps everyone happy.
+
+## 5. Consider enabling dimension attributes.
+
+This step prevents page reflow on image load (especially when lazy loading), but requires some prep.
+
+1. Make sure your CSS is correct. You need something like `width: 100%` and `height: auto` (which
+   is why they aren't turned on by default.) Without this step, you'll get crazy sizes and/or
+   stretched images.
+2. Set `dimension_attributes: true`
+
+## 6. Make any other necessary changes.
+
+Look through the options in the sidebar to the left, adjust as required. Note that the `data_*`
+output formats have a few special options, documented on their respective pages.

data/jekyll_picture_tag.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test)/})
   end
 
-  spec.required_ruby_version = ['>= 2.6', '< 3']
+  spec.required_ruby_version = ['>= 2.6', '< 4.0']
 
   # addressable is used to url-encode image filenames.
   spec.add_runtime_dependency 'addressable', '~> 2.6'

data/lib/jekyll_picture_tag/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_picture_tag
 version: !ruby/object:Gem::Version
-  version: 2.0.0pre1
+  version: 2.0.0
 platform: ruby
 authors:
 - Robert Wierzbowski
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -359,6 +359,7 @@ files:
 - docs/users/presets/quality_width_graph.png
 - docs/users/presets/width_height_attributes.md
 - docs/users/presets/width_srcsets.md
+- docs/users/presets/writing_presets.md
 - docs/users/tutorial.md
 - jekyll_picture_tag.gemspec
 - lib/jekyll_picture_tag.rb
@@ -420,15 +421,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - libvips
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Easy responsive images for Jekyll.