jekyll_picture_tag 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62e94c65637b912d5e44da1f3d0a9dac3c2ec8a9f8e538ebac99e2560a348356
-  data.tar.gz: c845a01518248c1f77fbcdb115546627803e7be27516149e717e09edd07dc75e
+  metadata.gz: abfaaaa312c42464c11595294a11c10848f810cb6c1c63ce085b73b557501f8f
+  data.tar.gz: 31c075ac80ee1ee500999b4f54c05d1b0b29b4a13230a3f84914dc4b9a035325
 SHA512:
-  metadata.gz: f322901c3b54fe9a4564ca480be283bdde4a68e1da505fbe309671546f551686a01f9c03dfa5159a14754f53791e342700f35e33cb7a0b71577ea2e86e282a75
-  data.tar.gz: 251b9ed64c11dd6e4a460151703234c80d1d0f4bbd6c05f8fda412a7404bf7c8193e65761b5aac6633628e9bec49c587b8fd53dee1961b7a82c0f04d68435fb8
+  metadata.gz: 5372b24c10a7049e20f1e2546a2f20cb2c0714cd4f8f8482e7005f503f9b192fe00ad5b4e07599e715cb280dad366a4477d3dd85ad5fc82743ac24309bf1688b
+  data.tar.gz: 66640daa48af3f8507a0d0675bd0fc6527a77c02401cdc06bc3ce967d946c61e53233a1a51b0e31812e5dbb462fb2cb37a42681e9b6fa1b00e31a9b7ea8763e0

data/docs/notes.md

@@ -12,7 +12,17 @@
 
   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 bi make sure that your hosting
+  site.baseurl }}/presets) (scroll down a bit).
+
+* ### Input checking
+
+  Jekyll Picture Tag is very trusting. It doesn't do much checking of your inputs, and it does not
+  fail gracefully if you for example pass it a string when it expects an array. It's on the to-do
+  list, but for now if you get cryptic errors then double-check your settings and tag arguments.
+
+* ### Git LFS
+
+  I'm Putting this here because it bit me: If you want to use git LFS, make sure that your hosting
   provider makes those images available during the build process.  Netlify, for example, does not.
   You won't find this out until you have gone through the entire migration process and try to deploy
   for the first time.

data/docs/output.md

@@ -6,7 +6,7 @@
 This is a listing of the various text arrangements that JPT can give you. Select one by setting
 `markup:` in the relevant [markup preset]({{ site.baseurl }}/presets).
 
-Example: 
+Example:
 
 ```yml
 # /_data/picture.yml
@@ -18,35 +18,46 @@ markup_presets:
 
 ## Standard HTML:
 
-* **`picture`:** `<picture>` element surrounding a `<source>` tag for each required srcset, and a
+- **`picture`:** `<picture>` element surrounding a `<source>` tag for each required srcset, and a
   fallback `<img>`.
 
-* **`img`:** output a single `<img>` tag with a `srcset` entry.
+- **`img`:** output a single `<img>` tag with a `srcset` entry.
 
-* **`auto`:** Supply an img tag when you have only one srcset, otherwise supply a picture tag.
+- **`auto`:** Supply an img tag when you have only one srcset, otherwise supply a picture tag.
 
 ## Javascript Friendly:
 
-* **`data_picture`, `data_img`, `data_auto`:** Analogous to their 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). Include a
-basic `img` fallback within a `<noscript>` tag by setting `noscript: true` in the preset. This
-allows you to keep working images for your non-javascript-enabled users.
+- **`data_picture`, `data_img`, `data_auto`:** Analogous to their counterparts above, 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).
 
-  *Example:* 
+#### Special Options
 
-  ```yml
-  # /_data/picture.yml
-  markup_presets:
-    lazy: 
-      markup: data_auto
-      noscript: true
-  ```
+The following preset configuration settings only apply to the `data_` output formats.
+
+- **noscript**
+
+  _Format:_ `noscript: true|false`
+
+  _Default:_ `false`
+
+  Include a basic `img` fallback within a `<noscript>` tag, giving your javascript-disabled users
+  something to look at.
+
+- **data_sizes**
+
+  _Format:_ `data_sizes: true|false`
+
+  _Default:_ `true`
+
+  This option sets whether you would like JPT's auto-generated sizes to be returned as a
+  `data-sizes` attribute or a normal `sizes` attribute. (Useful for interfacing nicely with all the
+  various JS image libraries out there.)
 
 ## Fragments:
 
-* `direct_url`: Generates an image and returns only its url. Uses `fallback_` properties (width
-and format).
+- **`direct_url`**: Generates an image and returns only its url. Uses `fallback_` properties (width
+  and format).
 
-* `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.
+- **`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.

data/docs/presets.md

@@ -9,6 +9,9 @@ this file, and probably the `_data/` directory as well.
 
 Here's an [example data file]({{ site.baseurl }}/example_presets).
 
+Any settings which are specific to particular output formats are documented on the [output
+formats]({{site.baseurl}}/output) page.
+
 ## Required Knowledge
 
 If you don't know the difference between resolution switching and art direction, stop now and read

data/docs/releases.md

@@ -2,6 +2,8 @@
 ---
 # Release History
 
+* 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

data/lib/jekyll_picture_tag/defaults/presets.yml

@@ -6,3 +6,4 @@ fallback_format: original
 noscript: false
 link_source: false
 quality: 75
+data_sizes: true

data/lib/jekyll_picture_tag/output_formats/data_attributes.rb

@@ -18,7 +18,10 @@ module PictureTag
       end
 
       def add_sizes(element, srcset)
-        element.attributes << { 'data-sizes' => srcset.sizes } if srcset.sizes
+        return unless srcset.sizes
+
+        attribute = PictureTag.preset['data_sizes'] ? 'data-sizes' : 'sizes'
+        element.attributes << { attribute => srcset.sizes }
       end
 
       def build_noscript(base_content)

data/lib/jekyll_picture_tag/version.rb

@@ -1,3 +1,3 @@
 module PictureTag
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.8.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_picture_tag
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Robert Wierzbowski
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2019-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler