jekyll_img 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 680dc86da728e4001fcbaf29a400b217690bd0242dd64a85a38e803286e0caa6
-  data.tar.gz: 53e917f32db474dd507794e8467cd5e1fc6e3036428133e1b27f48fea0be4e4b
+  metadata.gz: 893b2811f139eeae284d17d29a4b9c6b8348aebaf7b5fd54015bda14316bea17
+  data.tar.gz: 58f626e32417dfa0790115903453b575cacbab46d312144f741dbec6b05eb458
 SHA512:
-  metadata.gz: c1792d517f0913bf3ef12a2c116e27f02d35ba56cf783d2bb230f0258c388a58861ad7e212783e4745f9a4ca261193e327d86fb965f2a576525ab54ae607c42b
-  data.tar.gz: 1c7f2ecc873f7b625bf18e42f50c191ccfeee09dcbc2a4a502b3f02ad8d81f1488730a51b9e9beb5580c13791e5bf1f784810aa4031d3c180db4d4075dd6940a
+  metadata.gz: d43b8d2c08e13776f29fa59d56750369243909ad74cb4ff66add5050576d49e83cf53a997932f3bf12797fa0fc67ec2e65f9fa782c8a201323a92c0f6c004435
+  data.tar.gz: 0ee7e15f89ef2a4f9755b418bd26893edcd77b3cdaa7c3015b6923509d0a0b077b1700161be9aeef227bd8f7b9fd39067e57e527d5ade7787bab577912a77019

data/CHANGELOG.md

@@ -1,16 +1,42 @@
+# Change Log
+
+## 0.1.6 / 2023-08-10
+
+* `.webp` file type is assumed and no longer needs to be specified.
+  For example, instead of writing this:
+
+  ```html
+  {% img src="blah.webp" %}
+  ```
+
+  You can now write:
+
+  ```html
+  {% img src="blah" %}
+  ```
+
+
 ## 0.1.5 / 2023-05-30
-  * Updated dependencies
+
+* Updated dependencies
+
 
 ## 0.1.4 / 2023-04-02
-  * Added [`attribution` support](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution).
-  * Fixed `style=' false'` that appeared when the `style` and `wrapper_style` attributes were not provided.
+
+* Added [`attribution` support](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution).
+* Fixed `style=' false'` that appeared when the `style` and `wrapper_style` attributes were not provided.
+
 
 ## 0.1.3 / 2023-02-22
-  * Added `img/continue_on_error` configuration parameter.
+
+* Added `img/continue_on_error` configuration parameter.
+
 
 ## 0.1.2 / 2023-02-14
-  * Fixed `img_props.rb:91:in `size_unit_specified?': undefined method `end_with?' for false:FalseClass (NoMethodError)`
+
+* Fixed `img_props.rb:91:in `size_unit_specified?': undefined method `end_with?' for false:FalseClass (NoMethodError)`
 
 
 ## 0.1.1 / 2023-02-12
-  * Initial release
+
+* Initial release

data/README.md

@@ -1,51 +1,102 @@
-`jekyll_img`
-[![Gem Version](https://badge.fury.io/rb/jekyll_img.svg)](https://badge.fury.io/rb/jekyll_img)
-===========
+# `jekyll_img` [![Gem Version](https://badge.fury.io/rb/jekyll_img.svg)](https://badge.fury.io/rb/jekyll_img)
+
 
 `Jekyll_img` is a Jekyll plugin that embeds images in HTML documents, with alignment options,
 flexible resizing, default styling, overridable styling, an optional caption, and an optional URL.
 
+If you are not using `webp` images in your Jekyll website, this plugin is not for you.
+Please read the next section for details.
+If you have a use case that would benefit from expanding the supported file types,
+please describe your use case on the [issue tracker](https://github.com/mslinn/jekyll_img/issues/5).
+
 See [demo/index.html](demo/index.html) for examples.
 
+
+## Image Fallback
+
+This plugin provides support for the
+[`webp`](https://developers.google.com/speed/webp) image format,
+with a fallback to `png` format by using the HTML
+[`picture`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/picture) element.
+
+This means that 2 versions of every image are required: a `webp` version, and a `png` version.
+
+You specify the desired image with a `webp` filetype (or no filetype),
+and the plugin generates a `picture` element that contains a primary
+`source` sub-element that specifies the given image URL,
+and a secondary `img` sub-element with a [`png`](https://en.wikipedia.org/wiki/PNG) filetype.
+
+For example, these two invocations yield the same result:
+
+```html
+{% img src="blah" %}
+{% img src="blah.webp" %}
+```
+
+Would conceptually generate the following
+(to support the other options, the generated HTML can be a lot more complex):
+
+```html
+<picture>
+  <source srcset="blah.webp" type="image/webp" />
+  <source srcset="blah.png" type="image/png" />
+  <img src="blah.png" />
+</picture>
+```
+
+The above would fetch and display `blah.webp` if the web browser supported `webp` format,
+otherwise it would fetch and display `blah.png`.
+
+
+## Demo
+
 Run the demo website by typing:
+
 ```shell
 $ demo/_bin/debug -r
 ```
+
 ... and point your web browser to http://localhost:4444
 
 
 ## Usage
-    {% img [Options] src='path' %}
+
+```html
+{% img [Options] src='path' %}
+```
 
 `Options` are:
 
- - `attribution` See [`jekyll_plugin_support`](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution).
- - `align="left|inline|right|center"` Default value is `inline`
- - `alt="Alt text"` Default value is the `caption` text, if provided
- - `caption="A caption"` No default value
- - `classes="class1 class2 classN"` Extra &lt;img&gt; classes; default is `rounded shadow`
- - `id="someId"` No default value
- - `nofollow`  Generates `rel='nofollow'`; only applicable when `url` is specified
- - `size='eighthsize|fullsize|halfsize|initial|quartersize|XXXYY|XXX%'`
+- `attribution` See [`jekyll_plugin_support`](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution).
+- `align="left|inline|right|center"` Default value is `inline`
+- `alt="Alt text"` Default value is the `caption` text, if provided
+- `caption="A caption"` No default value
+- `classes="class1 class2 classN"` Extra &lt;img&gt; classes; default is `rounded shadow`
+- `id="someId"` No default value
+- `nofollow`  Generates `rel='nofollow'`; only applicable when `url` is specified
+- `size='eighthsize|fullsize|halfsize|initial|quartersize|XXXYY|XXX%'`
    Defines width of image.
-   - `initial` is the default behavior.
-   - `eighthsize`, `fullsize`, `halfsize`, and `quartersize` are relative to the enclosing tag's width.
-   - CSS units can also be used, for those cases `XXX` is a float and `YY` is `unit` (see below)
- - `style='css goes here'` CSS style for &lt;img&gt;; no default
- - `target='none|whatever'` Only applicable when `url` is specified; default value is `_blank`
- - `title="A title"` Default value is `caption` text, if provided
- - `url='https://domain.com'` No default value
- - `wrapper_class='class1 class2 classN'` Extra CSS classes for wrapper &lt;div&gt;; no default value
- - `wrapper_style='background-color: black;'` CSS style for wrapper &lt;div&gt;; no default value
+  - `initial` is the default behavior.
+  - `eighthsize`, `fullsize`, `halfsize`, and `quartersize` are relative to the enclosing tag's width.
+  - CSS units can also be used, for those cases `XXX` is a float and `YY` is `unit` (see below)
+- `style='css goes here'` CSS style for &lt;img&gt;; no default
+- `target='none|whatever'` Only applicable when `url` is specified; default value is `_blank`
+- `title="A title"` Default value is `caption` text, if provided
+- `url='https://domain.com'` No default value
+- `wrapper_class='class1 class2 classN'` Extra CSS classes for wrapper &lt;div&gt;; no default value
+- `wrapper_style='background-color: black;'` CSS style for wrapper &lt;div&gt;; no default value
 
 [`unit`](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Values_and_units#numbers_lengths_and_percentages) is one of: `Q`, `ch`, `cm`, `em`, `dvh`, `dvw`, `ex`, `in`, `lh`,
 `lvh`, `lvw`, `mm`, `pc`, `px`, `pt`, `rem`, `rlh`, `svh`, `svw`, `vb`,
 `vh`, `vi`, `vmax`, `vmin`, or `vw`.
 
-CSS classes referenced by the `jekyll_img` plugin are at the bottom of [demo/assets/css/style.css](demo/assets/css/style.css). CSS marker classes are included, so CSS selectors can be used for additional styling.
+CSS classes referenced by the `jekyll_img` plugin are at the bottom of
+[`demo/assets/css/style.css`](demo/assets/css/style.css).
+CSS marker classes are included, so CSS selectors can be used for additional styling.
 
 
 ## Configuration
+
 By default, any errors cause Jekyll to abort.
 You can allow Jekyll to continue by setting the following in `_config.yml`:
 
@@ -56,6 +107,7 @@ img:
 
 
 ## Design
+
 The most significant design issue was the decision that image size and formatting should not change
 whether it had a caption.
 HTML captions exist within a `<figure />` element, which also surrounds the image.
@@ -71,6 +123,7 @@ Handling all possible situations of these two scenarios would significantly rais
 
 
 ### Wrapper &lt;div /&gt;
+
 To make the plugin code more manageable,
 the plugin always encloses the generated HTML & CSS within a wrapper `<div />`.
 The wrapper allows for a simple, consistent approach regardless of whether a caption is generated or not.
@@ -101,21 +154,26 @@ end
 
 And then execute:
 
-    $ bundle install
+```shell
+$ bundle
+```
 
 
 ## Additional Information
+
 More information is available on
 [Mike Slinn&rsquo;s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
 
 
 ## Development
+
 After checking out the repo, run `bin/setup` to install dependencies.
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 
 To build and install this gem onto your local machine, run:
+
 ```shell
 $ bundle exec rake install
 jekyll_img 0.1.0 built to pkg/jekyll_img-0.1.0.gem.
@@ -123,6 +181,7 @@ jekyll_img (0.1.0) installed.
 ```
 
 Examine the newly built gem:
+
 ```shell
 $ gem info jekyll_img
 
@@ -139,28 +198,37 @@ jekyll_img (0.1.0)
 ```
 
 ### Testing
+
 Examine the output by running:
+
 ```shell
 $ demo/_bin/debug -r
 ```
+
 ... and pointing your web browser to http://localhost:4444/
 
 ### Unit Tests
+
 Either run `rspec` from Visual Studio Code's *Run and Debug* environment
 (<kbd>Ctrl</kbd>-<kbd>shift</kbd>-<kbd>D</kbd>) and view the *Debug Console* output,
 or run it from the command line:
+
 ```shell
 $ rspec
 ```
 
 ### Build and Push to RubyGems
+
 To release a new version,
-  1. Update the version number in `version.rb`.
-  2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
-  3. Run the following:
-     ```shell
-     $ bundle exec rake release
-     ```
+
+1. Update the version number in `version.rb`.
+2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
+3. Run the following:
+
+   ```shell
+   $ bundle exec rake release
+   ```
+
      The above creates a git tag for the version, commits the created tag,
      and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
 

data/lib/img_props.rb

@@ -85,6 +85,9 @@ class ImgProperties
     @src = @src.to_s.strip
     raise ImgError, "The 'src' parameter was not specified", [] if @src.empty?
 
+    filetype = File.extname(URI(@src).path)
+    @src += '.webp' if filetype.empty?
+
     @src = "/assets/images/#{@src}" unless ImgProperties.local_path?(@src) || url?(@src)
   end
 

data/lib/jekyll_img/version.rb

@@ -1,3 +1,3 @@
 module JekyllImgVersion
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_img
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-25 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll