jekyll_img 0.2.8 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc81e3ae00a242cf25f3444f45da2f621c692d6c7ee4760a17b59e8acc672c4d
-  data.tar.gz: 8b10b63f09b8b586343fd7a4ccc42c205ad1618cb9b422712d2300838799ead3
+  metadata.gz: 6665da5a9ea0fb8a14413e6bbcb177802b4419ead9470bdc3bbacdee5fafce73
+  data.tar.gz: 055d42f74d2c6361672132652779eb2a3a05e01d1e6d706932f03248ff9dca84
 SHA512:
-  metadata.gz: 97b5302cf184c4fa544498354f1a8bae327f1567c438d88a232eef174422425d9e416bd6b0568439c1df2544cfb9b534e3cf0603931e00b9b2ff6a708c00abd5
-  data.tar.gz: a3ebcc031fb6e63dc92073cf358a38c7092719df8fbf028a5e3376d5b3447e3a539647d0825f47a47c27b45121345c91fecd1af99fc00b1ee816906b71d9c638
+  metadata.gz: f4196b6105ee1f9c449440d9d134ef63db4196d839257bc1e333214c414785cacb9bef906074adbf532b470aa85e7df48a0231d8c556b3b54137b9a9b1233a20
+  data.tar.gz: d6585eb0051f441eaa9d00aec48e05e4a23e34045843feeb2e2d6a2255c6439229ce99c8c532deade048726af4b60d441d4c88521f30ab7b731cfcf4f013d4c2

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   # - rubocop-jekyll
   - rubocop-md
   - rubocop-performance
@@ -53,17 +53,20 @@ 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:
     - Rakefile
+    - Gemfile
+    - README.md
+    - CHANGELOG.md
 
 Naming/MemoizedInstanceVariableName:
   Enabled: false
@@ -86,6 +89,9 @@ Style/Documentation:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/OneClassPerFile:
+  Enabled: false
+
 Style/StringConcatenation:
   Exclude:
     - spec/**/*

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change Log
 
+## 0.2.11 /2026-09-11
+
+Not fixed yet:
+
+* Fixed bug related to max-width percentage specification
+
+## 0.2.10 /2026-07-04
+
+* Pry is no longer a production dependency
+
+## 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.
@@ -26,7 +46,7 @@
 * Corrected `README.md#Configuration` and fixed demo `_config.yml`
   so they correctly specify error handling for this plugin:
 
-  ```ruby
+  ```yaml
   img:
     die_on_img_error: false
     pry_on_img_error: false

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)
@@ -339,7 +345,7 @@ end
 And then execute:
 
 ```shell
-$ bundle
+$ bundle install
 ```
 
 

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,12 @@ 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}"
+    classes = classes.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,11 +6,11 @@ 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
+  SIZES = %w[eighthsize fullsize halfsize initial quartersize].freeze unless const_defined?(:SIZES)
+  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 unless const_defined?(:UNITS)
 
   def attr_alt
     "alt='#{@alt}'" if @alt
@@ -29,6 +29,19 @@ class ImgProperties
     " rel='nofollow'" if @nofollow
   end
 
+  # FIXME: this method does not work when max-width is specified as a % or a unit such as 15em
+  # @return class name: max_fullsize, max_halfsize, max_quartersize
+  def attr_max_width_class
+    return nil if @max_width == false || @max_width.nil? || max_width_unit_specified?
+
+    unless SIZES.include?(@max_width) || @max_width.end_with?('%')
+      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}" # FIXME: this only works with fullsize, halfsize, quartersize and not % or units
+  end
+
+  # FIXME: this method does not work when width is specified as a unit such as 15em
   def attr_size_class
     return nil if @size == false || @size.nil? || size_unit_specified?
 
@@ -40,7 +53,11 @@ class ImgProperties
   end
 
   def attr_style_img
-    "style='width: 100%; #{@style}'".squish
+    if size_unit_specified?
+      "width: #{@size};"
+    else
+      "style='width: 100%; #{@style}'".squish
+    end
   end
 
   def attr_target
@@ -54,6 +71,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 +119,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.11'.freeze
 end

data/lib/jekyll_img.rb

@@ -1,6 +1,5 @@
 require 'jekyll_plugin_support'
 require 'helper/jekyll_plugin_helper'
-require 'pry'
 require_relative 'img_builder'
 require_relative 'img_props'
 require_relative 'source'
@@ -36,9 +35,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'

data/lib/source.rb

@@ -41,7 +41,7 @@ class Source
     return result unless result.end_with? '.webp' # we know @path will be a webp after this
 
     files = sorted_files
-    return files[0] if files.count == 1
+    return files[0] if files.one?
 
     files.each do |filename|
       ext = File.extname filename

data/spec/img_builder_spec.rb

@@ -3,33 +3,43 @@ require_relative '../lib/img_builder'
 require_relative '../lib/img_props'
 require_relative '../lib/source'
 
-# Test ImgProperties
+class ImgTest
+  attr_accessor :page, :cite, :url
+
+  def initialize
+    @page = { 'path' => 'mypage.html' }
+    @cite = 'this is a cite'
+    @url  = 'http://localhost:4001/mypage.html'
+  end
+end
+
 class ImgPropertiesTest
   RSpec.describe ImgBuilder do
     Dir.chdir("demo")
     props = ImgProperties.new
     props.src = '/assets/images/jekyll.webp'
-    builder = described_class.new(props)
+    img = ImgTest.new
+    builder = described_class.new(img, props)
 
     it 'generates sources' do
       actual = builder.source.generate
-      desired = [
+      expected = [
         '<source srcset="/assets/images/jekyll.webp" type="image/webp">',
         '<source srcset="/assets/images/jekyll.png" type="image/png">'
       ]
-      expect(actual).to match_array(desired)
+      expect(actual).to match_array(expected)
     end
 
     it 'generates a figcaption' do
-      desired = <<~END_STRING
+      expected = <<~END_STRING
         <figcaption class='imgFigCaption '>
         </figcaption>
       END_STRING
-      expect(builder.generate_figcaption).to match_ignoring_whitespace(desired)
+      expect(builder.generate_figcaption).to match_ignoring_whitespace(expected)
     end
 
     it 'generates a picture' do
-      desired = <<~END_DESIRED
+      expected = <<~END_DESIRED
         <picture class='imgPicture'>
           <source srcset="/assets/images/jekyll.webp" type="image/webp">
           <source srcset="/assets/images/jekyll.png" type="image/png">
@@ -40,12 +50,12 @@ class ImgPropertiesTest
         </picture>
       END_DESIRED
       actual = builder.generate_picture
-      expect(actual).to match_ignoring_whitespace(desired)
+      expect(actual).to match_ignoring_whitespace(expected)
     end
 
     it 'generates a default img' do
-      desired = <<~END_IMG
-        <div class='imgWrapper imgFlex' style=' '>
+      expected = <<~END_IMG
+        <div class='imgWrapper imgFlex' style=''>
           <picture class='imgPicture'>
             <source srcset="/assets/images/jekyll.webp" type="image/webp">
             <source srcset="/assets/images/jekyll.png" type="image/png">
@@ -58,13 +68,13 @@ class ImgPropertiesTest
       END_IMG
 
       actual = builder.generate_wrapper
-      expect(actual).to match_ignoring_whitespace(desired)
+      expect(actual).to match_ignoring_whitespace(expected)
     end
 
     it 'generates an img wrapper with size and caption' do
       props.caption = 'This is a caption'
       props.size = '123px'
-      builder = described_class.new(props)
+      builder = described_class.new(img, props)
 
       caption = <<~END_CAPTION
         <figcaption class='imgFigCaption '>
@@ -72,8 +82,8 @@ class ImgPropertiesTest
         </figcaption>
       END_CAPTION
 
-      desired = <<~END_IMG
-        <div class='imgWrapper imgBlock' style='width: 123px; '>
+      expected = <<~END_IMG
+        <div class='imgWrapper imgBlock' style='width: 123px;'>
           <figure>
             <picture class='imgPicture'>
               <source srcset="/assets/images/jekyll.webp" type="image/webp">
@@ -91,7 +101,7 @@ class ImgPropertiesTest
       END_IMG
 
       actual = builder.generate_wrapper
-      expect(actual).to match_ignoring_whitespace(desired)
+      expect(actual).to match_ignoring_whitespace(expected)
     end
   end
 end

data/spec/img_props_spec.rb

@@ -71,30 +71,83 @@ class ImgPropertiesTest
       props.size = 'initial'
       expect(props.attr_size_class).to eq('initial')
 
+      props.target = 'moon'
+      expect(props.attr_target).to eq(" target='moon'")
+
+      props.title = 'The End'
+      expect(props.attr_title).to eq("title='The End'")
+
       props.size = '100px'
+      props.caption = 'A caption'
       expect(props.attr_size_class).to be_nil
-      expect(props.attr_style_img).to eq("style='width: 100%; '")
       expect(props.attr_width_style).to eq('width: 100px;')
+    end
+
+    it 'generates widths' do
+      props = described_class.new
+
+      props.size = '100px'
+      expect(props.attr_size_class).to be_nil
+      expect(props.attr_style_img).to eq('width: 100px;')
+      expect(props.attr_width_style).to eq('width: 100px;')
+
+      props.size = '100em'
+      expect(props.attr_size_class).to be_nil
+      expect(props.attr_style_img).to eq('width: 100em;')
+      expect(props.attr_width_style).to eq('width: 100em;')
 
       props.size = '10%'
       expect(props.attr_size_class).to be_nil
       expect(props.attr_width_style).to eq('width: 10%;')
-      expect(props.attr_style_img).to eq("style='width: 100%; '")
+      expect(props.attr_style_img).to eq('width: 10%;')
 
       props.size = 'fullsize'
       expect(props.attr_size_class).to eq('fullsize')
       expect(props.attr_width_style).to be_nil
 
-      props.target = 'moon'
-      expect(props.attr_target).to eq(" target='moon'")
+      props.size = 'halfsize'
+      expect(props.attr_size_class).to eq('halfsize')
+      expect(props.attr_width_style).to be_nil
 
-      props.title = 'The End'
-      expect(props.attr_title).to eq("title='The End'")
+      props.size = 'quartersize'
+      expect(props.attr_size_class).to eq('quartersize')
+      expect(props.attr_width_style).to be_nil
 
-      props.size = '100px'
-      props.caption = 'A caption'
-      expect(props.attr_size_class).to be_nil
-      expect(props.attr_width_style).to eq('width: 100px;')
+      props.size = 'eighthsize'
+      expect(props.attr_size_class).to eq('eighthsize')
+      expect(props.attr_width_style).to be_nil
+    end
+
+    it 'generates max_widths' do
+      props = described_class.new
+
+      props.max_width = '100px'
+      expect(props.attr_max_width_class).to be_nil
+      expect(props.attr_max_width_style).to eq('max-width: 100px;')
+
+      props.max_width = '100em'
+      expect(props.attr_max_width_class).to be_nil
+      expect(props.attr_max_width_style).to eq('max-width: 100em;')
+
+      props.max_width = '10%'
+      expect(props.attr_max_width_class).to be_nil
+      expect(props.attr_max_width_style).to eq('max-width: 10%;')
+
+      props.max_width = 'fullsize'
+      expect(props.attr_max_width_class).to eq('max_fullsize')
+      expect(props.attr_max_width_style).to be_nil
+
+      props.max_width = 'halfsize'
+      expect(props.attr_max_width_class).to eq('max_halfsize')
+      expect(props.attr_max_width_style).to be_nil
+
+      props.max_width = 'quartersize'
+      expect(props.attr_max_width_class).to eq('max_quartersize')
+      expect(props.attr_max_width_style).to be_nil
+
+      props.max_width = 'eighthsize'
+      expect(props.attr_max_width_class).to eq('max_eighthsize')
+      expect(props.attr_max_width_style).to be_nil
     end
   end
 end

data/spec/jekyll_img_spec.rb

@@ -5,7 +5,7 @@ require 'jekyll_plugin_support'
 require 'rspec/match_ignoring_whitespace'
 require_relative '../lib/jekyll_img'
 
-Registers = Struct.new(:page, :site) unless defined? :Registers
+Registers = Struct.new(:page, :site) unless defined? Registers
 
 # Mock for Collections
 class Collections
@@ -56,7 +56,7 @@ class MyTest
       )
     end
 
-    xit 'has no cite or url' do
+    it 'has no cite or url', skip: 'unfinished' do
       helper.reinitialize('src="./blah.webp"')
       img = described_class.send(
         :new,

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require_relative '../lib/jekyll_img'
 
 RSpec.configure do |config|
   config.filter_run_when_matching focus: true
-  config.order = 'random'
+  # config.order = 'random'
 
   # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
   config.example_status_persistence_file_path = 'spec/status_persistence.txt'

data/spec/status_persistence.txt

@@ -3,11 +3,13 @@ example_id                      | status | run_time        |
 ./spec/img_builder_spec.rb[1:1] | failed | 14.37 seconds   |
 ./spec/img_builder_spec.rb[1:2] | failed | 0.01498 seconds |
 ./spec/img_builder_spec.rb[1:3] | failed | 0.00093 seconds |
-./spec/img_props_spec.rb[1:1]   | passed | 0.00393 seconds |
-./spec/img_props_spec.rb[1:2]   | passed | 0.00006 seconds |
-./spec/img_props_spec.rb[1:3]   | passed | 0.00673 seconds |
-./spec/img_props_spec.rb[1:4]   | passed | 4.65 seconds    |
-./spec/img_props_spec.rb[1:5]   | passed | 0.00009 seconds |
+./spec/img_props_spec.rb[1:1]   | passed | 0.00174 seconds |
+./spec/img_props_spec.rb[1:2]   | passed | 0.00005 seconds |
+./spec/img_props_spec.rb[1:3]   | passed | 0.00189 seconds |
+./spec/img_props_spec.rb[1:4]   | passed | 0.00126 seconds |
+./spec/img_props_spec.rb[1:5]   | passed | 0.00006 seconds |
+./spec/img_props_spec.rb[1:6]   | passed | 0.00005 seconds |
+./spec/img_props_spec.rb[1:7]   | passed | 0.00005 seconds |
 ./spec/jekyll_img_spec.rb[1:1]  | failed | 40.84 seconds   |
 ./spec/source_spec.rb[1:1]      | passed | 0.00089 seconds |
 ./spec/source_spec.rb[1:2]      | passed | 0.0045 seconds  |

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_img
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.11
 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: 4.0.21
 specification_version: 4
 summary: Provides a Jekyll tag that generates images.
 test_files: