jekyll_img 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc81e3ae00a242cf25f3444f45da2f621c692d6c7ee4760a17b59e8acc672c4d
-  data.tar.gz: 8b10b63f09b8b586343fd7a4ccc42c205ad1618cb9b422712d2300838799ead3
+  metadata.gz: 2fceb334580b84bf7a4238093ab6fb718d1b5fc84a087b1f554764be2ddae477
+  data.tar.gz: b0a489a01ee502e0bb4c6006610a8d82faf3561086fa4f57ce752158e0b9770a
 SHA512:
-  metadata.gz: 97b5302cf184c4fa544498354f1a8bae327f1567c438d88a232eef174422425d9e416bd6b0568439c1df2544cfb9b534e3cf0603931e00b9b2ff6a708c00abd5
-  data.tar.gz: a3ebcc031fb6e63dc92073cf358a38c7092719df8fbf028a5e3376d5b3447e3a539647d0825f47a47c27b45121345c91fecd1af99fc00b1ee816906b71d9c638
+  metadata.gz: 14a147fe5e8ee74caffa3c4919d31fc28389ed9c4d5571357fc4797f1efaba10960eb2cefe9a3ebc68a85e76a339acdc9916d1191df11a2f9d1381412fff085a
+  data.tar.gz: 9e7b3b29ea91638fd8f54e5320c9fc14ceef0456057cbd40d7b1d5e9c6803cfa65a01c7c76567e147be5cefcf270ce9721c328e65944b8c873ae63591956a180

data/.rubocop.yml

@@ -53,13 +53,13 @@ Metrics/BlockLength:
     - spec/img_props_spec.rb
 
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 15
 
 Metrics/MethodLength:
   Max: 40
 
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 15
 
 Naming/FileName:
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 0.2.9 / 2025-05-19
+
+* `max-width` option added.
+* `width` option added as an alias for `size`.
+  This requires new CSS classes to be defined:
+  `max_eighthsize`, `max_fullsize`, `max_halfsize`, and `max_quartersize`.
+* More CSS classes defined and more tests added to the Demo app to support `max-width`.
+* `width='calc(something)'` added.
+
+
 ## 0.2.8 / 2025-05-16
 
 * An image can now be lazily loaded by providing the `lazy` keyword.

data/README.md

@@ -249,12 +249,17 @@ $ demo/_bin/debug -r
 - `caption="A caption"` No default value
 - `classes="class1 class2 classN"` Extra <img> 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%'`
+- `max-width='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)
+- `nofollow`  Generates `rel='nofollow'`; only applicable when `url` is specified
+- `width='eighthsize|fullsize|halfsize|initial|quartersize|XXXYY|XXX%'`
+   Defines width of image (alias for `size`).
+  - `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 <img>; 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
@@ -314,8 +319,9 @@ Within the wrapper `<div />`, the embedded `<img />` is displayed with `width=10
 If a caption is required, the generated `<figure />` only makes the space taken by the generated HTML longer;
 the image&rsquo;s width and height are not affected.
 
-The wrapper will not exceed the width of the tag that encloses it if the `size` parameter has values
+The wrapper will not exceed the width of the tag that encloses it if the `width` parameter has values
 `eighthsize`, `fullsize`, `halfsize`, `initial` or `quartersize`.
+You can also use the `max-width` option.
 
 The wrapper's width can be defined independently of its enclosing tag by using
 [CSS units](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Values_and_units#numbers_lengths_and_percentages)

data/lib/img_builder.rb

@@ -44,10 +44,10 @@ class ImgBuilder
 
   # See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/picture
   def generate_picture
-    if @props.lazy && @props.size
+    if @props.lazy && (@props.size || @props.max_width)
       @img.logger.warn do
         <<~END_MSG.squish
-          Warning: lazy loading was specified, but the size attribute was specified for the href tag
+          Warning: lazy loading was specified, but the size or max_width attribute was specified for the href tag
           on line #{@img.line_number} (after front matter) of #{@img.page['path']}.
           Specify dimensions via style or class attributes instead.
         END_MSG
@@ -84,9 +84,11 @@ class ImgBuilder
   end
 
   def generate_wrapper
-    classes = "imgWrapper #{@props.img_display} #{@props.align} #{@props.attr_size_class} #{@props.wrapper_class}".squish
+    classes = ("imgWrapper #{@props.img_display} #{@props.align} #{@props.attr_size_class} " +
+              "#{@props.attr_max_width_class} #{@props.wrapper_class}").squish
+    styles = "#{@props.attr_width_style} #{@props.attr_max_width_style} #{@props.wrapper_style}".squish
     <<~END_HTML.remove_blank_lines
-      <div class='#{classes}' style='#{@props.attr_width_style} #{@props.wrapper_style}'>
+      <div class='#{classes}' style='#{styles}'>
         #{"<figure>\n" if @props.caption}
           #{@props.url ? generate_url_wrapper : generate_picture}
           #{generate_figcaption if @props.caption}

data/lib/img_props.rb

@@ -6,8 +6,8 @@ require 'uri'
 # All methods except compute_dependant_properties can be called in any order
 class ImgProperties
   attr_accessor :align, :alt, :attr_wrapper_align_class, :attribute, :attribution, :caption, :classes, :die_on_img_error,
-                :id, :img_display, :lazy, :local_src, :nofollow, :priority, :src, :size, :style, :target, :title,
-                :url, :wrapper_class, :wrapper_style
+                :id, :img_display, :lazy, :local_src, :max_width, :nofollow, :priority, :src, :size, :style,
+                :target, :title, :url, :wrapper_class, :wrapper_style
 
   SIZES = %w[eighthsize fullsize halfsize initial quartersize].freeze
   UNITS = %w[Q ch cm em dvh dvw ex in lh lvh lvw mm pc px pt rem rlh svh svw vb vh vi vmax vmin vw %].freeze
@@ -29,6 +29,16 @@ class ImgProperties
     " rel='nofollow'" if @nofollow
   end
 
+  def attr_max_width_class
+    return nil if @max_width == false || @max_width.nil? || max_width_unit_specified?
+
+    unless SIZES.include?(@max_width)
+      msg = "'#{@max_width}' is not a recognized size; must be one of #{SIZES.join(', ')}, or an explicit unit."
+      raise Jekyll::ImgError, msg
+    end
+    "max_#{@max_width}"
+  end
+
   def attr_size_class
     return nil if @size == false || @size.nil? || size_unit_specified?
 
@@ -54,6 +64,10 @@ class ImgProperties
     "title='#{@title}'" if @title && !@title.empty?
   end
 
+  def attr_max_width_style
+    "max-width: #{@max_width};" if max_width_unit_specified?
+  end
+
   def attr_width_style
     "width: #{@size};" if size_unit_specified?
   end
@@ -98,10 +112,18 @@ class ImgProperties
     # raise Jekyll::ImgError, "#{@src} does not exist" unless File.exist?(src)
   end
 
+  def max_width_unit_specified?
+    max_width_not_specified = @max_width == false || @max_width.to_s.strip.empty?
+    return false if max_width_not_specified
+
+    @max_width&.end_with?(*UNITS) || @max_width&.start_with?('calc')
+  end
+
   def size_unit_specified?
-    return false if @size == false || @size.to_s.strip.empty?
+    size_not_specified = @size == false || @size.to_s.strip.empty?
+    return false if size_not_specified
 
-    @size.end_with?(*UNITS)
+    @size&.end_with?(*UNITS) || @size&.start_with?('calc')
   end
 
   def url?(src)

data/lib/jekyll_img/version.rb

@@ -1,3 +1,3 @@
 module JekyllImgVersion
-  VERSION = '0.2.8'.freeze
+  VERSION = '0.2.9'.freeze
 end

data/lib/jekyll_img.rb

@@ -36,9 +36,12 @@ module Jekyll
       props.die_on_img_error  = @die_on_img_error
       props.id                = @helper.parameter_specified? 'id'
       props.lazy              = ' loading="lazy"' if @helper.parameter_specified?('lazy')
+      props.max_width         = @helper.parameter_specified?('max-width')
       props.nofollow          = @helper.parameter_specified? 'nofollow'
       props.priority          = ' fetchpriority="high"' if @helper.parameter_specified?('priority')
-      props.size              = @helper.parameter_specified?('size') || @helper.parameter_specified?('_size')
+      props.size              = @helper.parameter_specified?('size') ||
+                                @helper.parameter_specified?('_size') ||
+                                @helper.parameter_specified?('width')
       props.src               = @helper.parameter_specified? 'src'
       props.style             = @helper.parameter_specified? 'style'
       props.target            = @helper.parameter_specified? 'target'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_img
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Mike Slinn
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Provides a Jekyll tag that generates images.
 test_files: