jekyll_img 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 709fbb2e5a2e031e00ed20fcc174da7bd7e7c3aac659d0cf776332dc76afad3d
-  data.tar.gz: 2f4bed1c27269cfe898571b7f1f90b1147b99d6c0d083d037efcddcd0cca252a
+  metadata.gz: 2f9a0ee86751118f5ed309e486751eede3ce4d5c3dad14ecbe7d695aefcc54ee
+  data.tar.gz: a42e9552fe07aadb4f24882280505f2b55fbeb5b4789e5cb27e7d2f8e9ec7e75
 SHA512:
-  metadata.gz: 1be4707688b9d379e2f1ef172c127fad2ff8edc01803df764325e047ceedbba7d38baf4a8a22ca03d7d9d0963da8348392f612e7b27040b3709cccdd32748a49
-  data.tar.gz: 0ff4b6747fe1448929c0f566858168387ef8e021642faa17740050bc382f7b6ed4f82275e93472b3507a51a207a8d1ffb5bb652bd222df430da58f41c967a2de
+  metadata.gz: ad481773b5aabb69f9e8a24c1c3477fa112298f10c9fd21f1f28c008eedb694991107532787c625a0ad736bea7baac2f23220494ad6b2e4b5b56471074bb88fe
+  data.tar.gz: efef2dd2953194241346f6b354f2429241b0c9d116b5251d97a79d9654d9323acfbb101d1a33ac8481635a365c269224f0bce242aa2e1062661e917a2ba5f0b7

data/.rubocop.yml

@@ -1,3 +1,13 @@
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+# inherit_gem:
+#  rubocop-jekyll: .rubocop.yml
+
 AllCops:
   Exclude:
       - vendor/**/*
@@ -7,17 +17,32 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
 
-Layout/HashAlignment:
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
   Enabled: false
 
+Layout/InitialIndentation:
+  Exclude:
+    - README.md
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
 Layout/LineLength:
   Max: 150
 
 Layout/MultilineMethodCallIndentation:
   Enabled: false
 
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - jekyll_img.gemspec
+
 Metrics/AbcSize:
-  Max: 40
+  Max: 45
 
 Metrics/BlockLength:
   Max: 30
@@ -34,8 +59,40 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Max: 10
 
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/CommandLiteral:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-Style/TrailingCommaInHashLiteral:
+Style/StringConcatenation:
+  Exclude:
+    - spec/**/*
+
+Style/StringLiterals:
   Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 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.
+
+## 0.1.3 / 2023-02-22
+  * 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)`
 

data/README.md

@@ -19,6 +19,7 @@ $ demo/_bin/debug -r
 
 `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
@@ -44,6 +45,16 @@ $ demo/_bin/debug -r
 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`:
+
+```yaml
+img:
+  continue_on_error: true
+```
+
+
 ## Design
 The most significant design issue was the decision that image size and formatting should not change
 whether it had a caption.

data/jekyll_img.gemspec

@@ -1,6 +1,6 @@
 require_relative 'lib/jekyll_img/version'
 
-Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
   github = 'https://github.com/mslinn/jekyll_img'
 
   spec.bindir = 'exe'
@@ -24,13 +24,10 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   END_MESSAGE
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.6.0'
-  spec.summary = 'Provides a Jekyll filter that creates formatted quotes.'
+  spec.summary = 'Provides a Jekyll tag that generates images.'
   spec.test_files = spec.files.grep %r{^(test|spec|features)/}
   spec.version = JekyllImgVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_plugin_support', '>= 0.3.1'
-
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rspec-match_ignoring_whitespace'
+  spec.add_dependency 'jekyll_plugin_support', '~> 0.6.0'
 end

data/lib/img_builder.rb

@@ -32,6 +32,7 @@ class ImgBuilder
           }
           #{generate_figure_caption}
         #{"</figure>\n" if @props.caption}
+        #{@props.attribute if @props.attribution}
       </div>
     END_HTML
     result.strip

data/lib/img_props.rb

@@ -1,10 +1,13 @@
+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, :caption, :classes, :id, :img_display, :nofollow, \
-                :src, :size, :style, :target, :title, :url, :wrapper_class, :wrapper_style
+  attr_accessor :align, :alt, :attr_wrapper_align_class, :attribute, :attribution, :caption, :classes, :continue_on_error,
+                :id, :img_display, :nofollow, :src, :size, :style, :target, :title,
+                :url, :wrapper_class, :wrapper_style
 
   SIZES = %w[eighthsize fullsize halfsize initial quartersize].freeze
 
@@ -28,8 +31,10 @@ class ImgProperties
   def attr_size_class
     return nil if @size == false || @size.nil? || size_unit_specified?
 
-    abort "'#{@size}' is not a recognized size; must be one of #{SIZES.join(', ')}, or an explicit unit." \
-      unless SIZES.include?(@size)
+    unless SIZES.include?(@size)
+      msg = "'#{@size}' is not a recognized size; must be one of #{SIZES.join(', ')}, or an explicit unit."
+      raise ImgError, msg
+    end
     @size
   end
 
@@ -60,11 +65,11 @@ class ImgProperties
     @img_display = @caption && @size ? 'imgBlock' : 'imgFlex'
 
     @alt   ||= @caption || @title
-    @title ||= @caption || @alt # rubocop:disable Naming/MemoizedInstanceVariableName
+    @title ||= @caption || @alt
   end
 
   def src_png
-    abort 'src parameter was not specified' if @src.to_s.empty?
+    raise ImgError, "The 'src' parameter was not specified" if @src.to_s.empty?
 
     @src.gsub('.webp', '.png')
   end
@@ -78,7 +83,7 @@ class ImgProperties
 
   def setup_src
     @src = @src.to_s.strip
-    abort 'src parameter was not specified' if @src.empty?
+    raise ImgError, "The 'src' parameter was not specified", [] if @src.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.2'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/lib/jekyll_img.rb

@@ -1,5 +1,5 @@
 require 'jekyll_plugin_support'
-require 'jekyll_plugin_support_helper'
+require 'jekyll_plugin_helper'
 require_relative 'img_builder'
 require_relative 'img_props'
 require_relative 'jekyll_img/version'
@@ -14,28 +14,45 @@ end
 module Jekyll
   # Plugin implementation
   class Img < JekyllSupport::JekyllTag
-    def render_impl
+    include JekyllImgVersion
+
+    def render_impl # rubocop:disable Metrics/AbcSize
+      @helper.gem_file __FILE__ # This enables plugin attribution
+
+      config = @config['img']
+      @continue_on_error = config['continue_on_error'] == true if config
+
       props = ImgProperties.new
-      props.align         = @helper.parameter_specified?('align') || 'inline'
-      props.alt           = @helper.parameter_specified? 'alt'
-      props.caption       = @helper.parameter_specified? 'caption'
-      props.classes       = @helper.parameter_specified? 'class'
-      props.id            = @helper.parameter_specified? 'id'
-      props.nofollow      = @helper.parameter_specified? 'nofollow'
-      props.size          = @helper.parameter_specified?('size') || @helper.parameter_specified?('_size')
-      props.src           = @helper.parameter_specified? 'src'
-      props.style         = @helper.parameter_specified? 'style'
-      props.target        = @helper.parameter_specified? 'target'
-      props.title         = @helper.parameter_specified? 'title'
-      props.url           = @helper.parameter_specified? 'url'
-      props.wrapper_class = @helper.parameter_specified? 'wrapper_class'
-      props.wrapper_style = @helper.parameter_specified? 'wrapper_style'
+      props.attribute         = @helper.attribute
+      props.attribution       = @helper.attribution
+      props.align             = @helper.parameter_specified?('align') || 'inline'
+      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.id                = @helper.parameter_specified? 'id'
+      props.nofollow          = @helper.parameter_specified? 'nofollow'
+      props.size              = @helper.parameter_specified?('size') || @helper.parameter_specified?('_size')
+      props.src               = @helper.parameter_specified? 'src'
+      props.style             = @helper.parameter_specified? 'style'
+      props.target            = @helper.parameter_specified? 'target'
+      props.title             = @helper.parameter_specified? 'title'
+      props.url               = @helper.parameter_specified? 'url'
+      props.wrapper_class     = @helper.parameter_specified? 'wrapper_class'
+      props.wrapper_style     = @helper.parameter_specified? 'wrapper_style'
 
       @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
     end
+
+    JekyllPluginHelper.register(self, ImgModule::PLUGIN_NAME)
   end
 end
-
-PluginMetaLogger.instance.info { "Loaded #{ImgModule::PLUGIN_NAME} v0.1.0 plugin." }
-Liquid::Template.register_tag(ImgModule::PLUGIN_NAME, Jekyll::Img)

data/spec/img_builder_spec.rb

@@ -4,11 +4,11 @@ require_relative '../lib/img_props'
 
 # Test ImgProperties
 class ImgPropertiesTest
-  RSpec.describe ImgBuilder do # rubocop:disable Metrics/BlockLength
+  RSpec.describe ImgBuilder do
     it 'generates a default img' do
       props = ImgProperties.new
       props.src = 'blah.webp'
-      builder = ImgBuilder.new(props)
+      builder = described_class.new(props)
       picture = <<~END_IMG
         <div class='imgWrapper imgFlex' style=' '>
           <picture class='imgPicture'>
@@ -22,7 +22,7 @@ class ImgPropertiesTest
         </div>
       END_IMG
 
-      expect(builder.send(:generate_figure_caption)).to be nil
+      expect(builder.send(:generate_figure_caption)).to be_nil
       expect(builder.send(:generate_wrapper)).to        match_ignoring_whitespace(picture)
     end
 
@@ -31,7 +31,7 @@ class ImgPropertiesTest
       props.caption = 'This is a caption'
       props.size = '123px'
       props.src = 'blah.webp'
-      builder = ImgBuilder.new(props)
+      builder = described_class.new(props)
 
       caption = <<~END_CAPTION
         <figcaption class='imgFigCaption '>

data/spec/img_props_spec.rb

@@ -1,39 +1,38 @@
 require_relative '../lib/img_props'
 
-# Test ImgProperties
 class ImgProperitesTest
-  RSpec.describe ImgProperties do # rubocop:disable Metrics/BlockLength
+  RSpec.describe ImgProperties do
     it 'detects relative paths' do
-      expect(ImgProperties.local_path?('abcdef')).to be false
-      expect(ImgProperties.local_path?('./abc')).to  be true
-      expect(ImgProperties.local_path?('/abc')).to   be true
+      expect(described_class.local_path?('abcdef')).to be false
+      expect(described_class.local_path?('./abc')).to  be true
+      expect(described_class.local_path?('/abc')).to   be true
     end
 
     it 'has other class methods' do
-      props = ImgProperties.new
+      props = described_class.new
       expect(props.send(:size_unit_specified?)).to be false
       expect(props.send(:url?, 'blah')).to         be false
       expect(props.send(:url?, 'http://blah')).to  be true
     end
 
     it 'does not generate attributes for most empty properties' do
-      props = ImgProperties.new
-      expect(props.attr_alt).to           be nil
+      props = described_class.new
+      expect(props.attr_alt).to           be_nil
       expect(props.attr_img_classes).to   eq('rounded shadow')
-      expect(props.attr_id).to            be nil
-      expect(props.attr_nofollow).to      be nil
-      expect(props.attr_size_class).to    be nil
+      expect(props.attr_id).to            be_nil
+      expect(props.attr_nofollow).to      be_nil
+      expect(props.attr_size_class).to    be_nil
       expect(props.attr_style_img).to     eq("style='width: 100%; '")
       expect(props.attr_target).to        eq(" target='_blank'")
-      expect(props.attr_title).to         be nil
-      expect(props.attr_width_style).to   be nil
+      expect(props.attr_title).to         be_nil
+      expect(props.attr_width_style).to   be_nil
 
       props.compute_dependant_properties
       expect(props.attr_wrapper_align_class).to eq('inline')
     end
 
     it 'raises exception if src was not specified' do
-      props = ImgProperties.new
+      props = described_class.new
       expect { props.src_png }.to raise_error(SystemExit)
       expect { props.send(:setup_src) }.to raise_error(SystemExit)
 
@@ -50,8 +49,8 @@ class ImgProperitesTest
       expect(props.src).to eq('/absolute/path.webp')
     end
 
-    it 'generates proper simple attributes' do # rubocop:disable Metrics/BlockLength
-      props = ImgProperties.new
+    it 'generates proper simple attributes' do
+      props = described_class.new
 
       props.alt = 'blah'
       expect(props.attr_alt).to eq("alt='blah'")
@@ -69,18 +68,18 @@ class ImgProperitesTest
       expect(props.attr_size_class).to eq('initial')
 
       props.size = '100px'
-      expect(props.attr_size_class).to be nil
+      expect(props.attr_size_class).to be_nil
       expect(props.attr_style_img).to eq("style='max-width: 100px;'")
       expect(props.attr_width_style).to eq('width: 100px;')
 
       props.size = '10%'
-      expect(props.attr_size_class).to be nil
+      expect(props.attr_size_class).to be_nil
       expect(props.attr_style_img).to eq("style='max-width: 10%;'")
       expect(props.attr_width_style).to eq('width: 10%;')
 
       props.size = 'fullsize'
       expect(props.attr_size_class).to eq('fullsize')
-      expect(props.attr_width_style).to be nil
+      expect(props.attr_width_style).to be_nil
 
       props.style = 'width: 30rem;'
       expect(props.attr_style_img).to eq("style='width: 30rem;'")
@@ -93,12 +92,12 @@ class ImgProperitesTest
 
       props.size = '100px'
       props.caption = 'A caption'
-      expect(props.attr_size_class).to be nil
+      expect(props.attr_size_class).to be_nil
       expect(props.attr_width_style).to eq('width: 100px;')
     end
 
     it 'generates proper alignment attributes' do
-      props = ImgProperties.new
+      props = described_class.new
 
       props.align = 'inline'
       props.compute_dependant_properties

data/spec/jekyll_img_spec.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 require 'jekyll_plugin_logger'
 require 'rspec/match_ignoring_whitespace'
@@ -32,7 +30,7 @@ class TestParseContext < Liquid::ParseContext
     @line_number = 123
 
     @registers = Registers.new(
-      { },
+      {},
       SiteMock.new
     )
   end
@@ -57,13 +55,13 @@ class MyTest
 
     it 'has no cite or url' do
       helper.reinitialize('src="./blah.webp"')
-      quote = Jekyll::Img.send(
+      img = described_class.send(
         :new,
         'img',
         helper.markup.dup,
         parse_context
       )
-      result = quote.send(:render_impl, helper.markup)
+      result = img.send(:render_impl, helper.markup)
       expect(result).to match_ignoring_whitespace <<-END_RESULT
         <img src="./blah.webp">
       END_RESULT

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_img
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -28,44 +28,16 @@ dependencies:
   name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.1
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-match_ignoring_whitespace
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 description:
 email:
 - mslinn@mslinn.com
@@ -87,7 +59,6 @@ files:
 - spec/img_props_spec.rb
 - spec/jekyll_img_spec.rb
 - spec/spec_helper.rb
-- spec/status_persistence.txt
 homepage: https://mslinn.com/jekyll/3000-jekyll-plugins.html#jekyll_img
 licenses:
 - MIT
@@ -118,11 +89,10 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Provides a Jekyll filter that creates formatted quotes.
+summary: Provides a Jekyll tag that generates images.
 test_files:
 - spec/img_builder_spec.rb
 - spec/img_props_spec.rb
 - spec/jekyll_img_spec.rb
 - spec/spec_helper.rb
-- spec/status_persistence.txt
 ...

data/spec/status_persistence.txt

@@ -1,10 +0,0 @@
-example_id                      | status | run_time        |
-------------------------------- | ------ | --------------- |
-./spec/img_builder_spec.rb[1:1] | passed | 0.00073 seconds |
-./spec/img_props_spec.rb[1:1]   | passed | 0.0001 seconds  |
-./spec/img_props_spec.rb[1:2]   | passed | 0.00008 seconds |
-./spec/img_props_spec.rb[1:3]   | failed | 0.00051 seconds |
-./spec/img_props_spec.rb[1:4]   | passed | 0.0011 seconds  |
-./spec/img_props_spec.rb[1:5]   | passed | 0.00019 seconds |
-./spec/img_props_spec.rb[1:6]   | failed | 0.00008 seconds |
-./spec/jekyll_img_spec.rb[1:1]  | failed | 0.00037 seconds |