jekyll_img 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 893b2811f139eeae284d17d29a4b9c6b8348aebaf7b5fd54015bda14316bea17
-  data.tar.gz: 58f626e32417dfa0790115903453b575cacbab46d312144f741dbec6b05eb458
+  metadata.gz: 4f1c3ada28bfae9fa70ff421baa912391a64af4c156055e0f40438d6219c986b
+  data.tar.gz: 6915f59b67c6c0de7d91821553b4ecb7f246596f295d128ba6a850b6ddfb35af
 SHA512:
-  metadata.gz: d43b8d2c08e13776f29fa59d56750369243909ad74cb4ff66add5050576d49e83cf53a997932f3bf12797fa0fc67ec2e65f9fa782c8a201323a92c0f6c004435
-  data.tar.gz: 0ee7e15f89ef2a4f9755b418bd26893edcd77b3cdaa7c3015b6923509d0a0b077b1700161be9aeef227bd8f7b9fd39067e57e527d5ade7787bab577912a77019
+  metadata.gz: 0c8281613ba38488ce8b32ac074abca3ce3ed7310d0fd70a0f6d78c87039b66a40b25775172ff88e910dcdb09cd9b78549bf4a1773a982e5a8c23f2109679f0d
+  data.tar.gz: 8ada70004b3b1328372f2675ed7b80edf1c6b9a1b2fdd44154a2ad40af1d9d1a64bbda2d53034394c860b79fd9489b74de4dd4542f9daf6db6be534df13e7c85

data/.rubocop.yml

@@ -11,15 +11,17 @@ require:
 AllCops:
   Exclude:
       - vendor/**/*
-      - exe/**/*
+      - binstub/**/*
       - Gemfile*
       - Rakefile
   NewCops: enable
-  TargetRubyVersion: 2.6
 
 Gemspec/DeprecatedAttributeAssignment:
   Enabled: false
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Gemspec/RequireMFA:
   Enabled: false
 
@@ -42,7 +44,7 @@ Lint/RedundantCopDisableDirective:
     - jekyll_img.gemspec
 
 Metrics/AbcSize:
-  Max: 45
+  Max: 60
 
 Metrics/BlockLength:
   Max: 30
@@ -54,7 +56,7 @@ Metrics/CyclomaticComplexity:
   Max: 10
 
 Metrics/MethodLength:
-  Max: 30
+  Max: 40
 
 Metrics/PerceivedComplexity:
   Max: 10

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 0.2.0 / 2023-11-20
+
+* The [demo/](demo/) webapp has been upgraded to the latest features.
+* Improved error messages.
+* Renamed the `img` section of `_config.yml` to `jekyll_img`.
+* Renamed `continue_on_error` to `die_on_img_error` and reversed the meaning.
+* Now dependant on `jekyll_plugin_support` v0.8.0 or later, which had several breaking changes.
+* CSS for this plugin is now defined in `demo/assets/css/jekyll_img.css`.
+* Added a `pry_on_img_error` setting, which causes the `pry` debugger to be invoked when an `ImgError` is raised.
+  `pry` is now opened when an `ImgError` is raised if `_config.yml` contains:
+
+  ```yaml
+  jekyll_img:
+    pry_on_img_error: true
+  ```
+
 ## 0.1.6 / 2023-08-10
 
 * `.webp` file type is assumed and no longer needs to be specified.
@@ -34,7 +50,7 @@
 
 ## 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

data/README.md

@@ -33,7 +33,7 @@ For example, these two invocations yield the same result:
 {% img src="blah.webp" %}
 ```
 
-Would conceptually generate the following
+The above generates the following
 (to support the other options, the generated HTML can be a lot more complex):
 
 ```html
@@ -86,23 +86,26 @@ $ demo/_bin/debug -r
 - `wrapper_class='class1 class2 classN'` Extra CSS classes for wrapper <div>; no default value
 - `wrapper_style='background-color: black;'` CSS style for wrapper <div>; 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`,
+[`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 classes referenced by the `jekyll_img` plugin are in
+[`demo/assets/css/jekyll_img.css`](demo/assets/css/jekyll_img.css) and
+[`demo/assets/css/jekyll_plugin_support.css`](demo/assets/css/jekyll_plugin_support.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`:
+By default, errors cause Jekyll to abort.
+You can allow Jekyll to halt by setting the following in `_config.yml`:
 
 ```yaml
-img:
-  continue_on_error: true
+jekyll_img:
+  die_on_img_error: true
+  pry_on_img_error: true
 ```
 
 
@@ -119,7 +122,8 @@ CSS behavior differs for `<figure />` and `<img />`.
 For example, centering, floating right and left.
 That means the CSS and where it would need to be applied are completely different for
 naked `<img />` and `<figure />` tags.
-Handling all possible situations of these two scenarios would significantly raise the complexity of the plugin code. I know, because I went down that rabbit hole.
+Handling all possible situations of these two scenarios would significantly raise the complexity of the plugin code.
+I know, because I went down that rabbit hole.
 
 
 ### Wrapper &lt;div /&gt;
@@ -133,9 +137,12 @@ 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 `eighthsize`, `fullsize`, `halfsize`, `initial` or `quartersize`.
+The wrapper will not exceed the width of the tag that encloses it if the `size` parameter has values
+`eighthsize`, `fullsize`, `halfsize`, `initial` or `quartersize`.
 
-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) for the `size` parameter:
+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)
+for the `size` parameter:
 `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`.
@@ -197,6 +204,17 @@ jekyll_img (0.1.0)
     Generates Jekyll logger with colored output.
 ```
 
+
+### Debugging
+
+You can cause `pry` to open when an `ImgError` is raised by setting the following in `_config.yml`:
+
+```yaml
+jekyll_img:
+  pry_on_img_error: true
+```
+
+
 ### Testing
 
 Examine the output by running:

data/jekyll_img.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.version = JekyllImgVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.8.0'
 end

data/lib/img_props.rb

@@ -1,12 +1,10 @@
-class ImgError < StandardError; end
-
 # Properties from user
 # All methods are idempotent.
 # attr_ methods can be called after compute_dependant_properties
 # 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, :continue_on_error,
-                :id, :img_display, :nofollow, :src, :size, :style, :target, :title,
+  attr_accessor :align, :alt, :attr_wrapper_align_class, :attribute, :attribution, :caption, :classes, :die_on_img_error,
+                :id, :img_display, :local_src, :nofollow, :src, :size, :style, :target, :title,
                 :url, :wrapper_class, :wrapper_style
 
   SIZES = %w[eighthsize fullsize halfsize initial quartersize].freeze
@@ -33,7 +31,7 @@ class ImgProperties
 
     unless SIZES.include?(@size)
       msg = "'#{@size}' is not a recognized size; must be one of #{SIZES.join(', ')}, or an explicit unit."
-      raise ImgError, msg
+      raise Jekyll::ImgError, msg
     end
     @size
   end
@@ -69,7 +67,7 @@ class ImgProperties
   end
 
   def src_png
-    raise ImgError, "The 'src' parameter was not specified" if @src.to_s.empty?
+    raise Jekyll::ImgError, "The 'src' parameter was not specified" if @src.to_s.empty?
 
     @src.gsub('.webp', '.png')
   end
@@ -83,12 +81,16 @@ class ImgProperties
 
   def setup_src
     @src = @src.to_s.strip
-    raise ImgError, "The 'src' parameter was not specified", [] if @src.empty?
+    raise Jekyll::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)
+    return unless ImgProperties.local_path?(@src)
+
+    src = @src.start_with?('/') ? ".#{@src}" : @src
+    raise Jekyll::ImgError, "#{@src} does not exist" unless File.exist?(src)
   end
 
   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

data/lib/jekyll_img/version.rb

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

data/lib/jekyll_img.rb

@@ -1,5 +1,6 @@
 require 'jekyll_plugin_support'
 require 'jekyll_plugin_helper'
+require 'pry'
 require_relative 'img_builder'
 require_relative 'img_props'
 require_relative 'jekyll_img/version'
@@ -12,15 +13,17 @@ module ImgModule
 end
 
 module Jekyll
+  ImgError = JekyllSupport.define_error
+
   # Plugin implementation
   class Img < JekyllSupport::JekyllTag
     include JekyllImgVersion
 
-    def render_impl # rubocop:disable Metrics/AbcSize
+    def render_impl
       @helper.gem_file __FILE__ # This enables plugin attribution
 
-      config = @config['img']
-      @continue_on_error = config['continue_on_error'] == true if config
+      @die_on_img_error = @tag_config['die_on_img_error'] == true if @tag_config
+      @pry_on_img_error = @tag_config['pry_on_img_error'] == true if @tag_config
 
       props = ImgProperties.new
       props.attribute         = @helper.attribute
@@ -29,7 +32,7 @@ module Jekyll
       props.alt               = @helper.parameter_specified? 'alt'
       props.caption           = @helper.parameter_specified? 'caption'
       props.classes           = @helper.parameter_specified? 'class'
-      props.continue_on_error = @continue_on_error
+      props.die_on_img_error  = @die_on_img_error
       props.id                = @helper.parameter_specified? 'id'
       props.nofollow          = @helper.parameter_specified? 'nofollow'
       props.size              = @helper.parameter_specified?('size') || @helper.parameter_specified?('_size')
@@ -43,14 +46,14 @@ module Jekyll
 
       @builder = ImgBuilder.new(props)
       @builder.to_s
-    rescue ImgError => e
-      msg = <<~END_ERR
-        #{e.message} on line #{@line_number} (after front matter) of #{@page['path']}.
-        The offending argument string was: #{@argument_string}
-      END_ERR
-      raise ImgError, msg.red, [] unless @continue_on_error
-
-      @logger.warn msg
+    rescue ImgError => e # jekyll_plugin_support handles StandardError
+      e.shorten_backtrace
+      msg = format_error_message e.message
+      @logger.error { "#{e.class} raised #{msg}" }
+      binding.pry if @pry_on_img_error # rubocop:disable Lint/Debugger
+      raise e if @die_on_img_error
+
+      "<div class='jekyll_img_error'>#{e.class} raised in #{@tag_name} tag\n#{msg}</div>"
     end
 
     JekyllPluginHelper.register(self, ImgModule::PLUGIN_NAME)

data/spec/spec_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_img
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 description:
 email:
 - mslinn@mslinn.com
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Provides a Jekyll tag that generates images.