jekyll_href 1.2.10 → 1.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ff34de3543f22694104004179a170c7eccaed4ab74c8c454d5d6f9e7e1b95b6
-  data.tar.gz: cba2381032c48b897e1f1835ce2484b0b5d1c589d077359bade41be88984c9f8
+  metadata.gz: 9b91d0d8398def7c990920615a1e12f97de4472f5444ae9fc3869504d49084b8
+  data.tar.gz: 19f84b38dc1f3205763a1be316671bad0ac65a3af25621e5455164f362c39ec8
 SHA512:
-  metadata.gz: ca46777a4c3d5bd9eeb1b859715d73f45ea793d97b183a862e25eb78c8688387bc91d25ca353c21cfe7b734e4a9aa74d5c12a163872b07dcd3cc1ca179393a18
-  data.tar.gz: 25a5d7c61e1baf54b767a0b1824c263a52f0bfdf054a428b5290f655ca4c9fe701c633406c8c6da165d14bc0852a1b21a7fcba0f9e1dce03c10fb50917796259
+  metadata.gz: 92e483de85abd7cfdf2aeede0de99d0cc0772d3d112b6652394f04f3f97f52d6aaa2b4f39ac150c02cbd25d0162b56809b8c8dec1a356d5a9777b86d888b21aa
+  data.tar.gz: fd835168ec7beb443ea70c646aac51cb80b4ab9a9826f881b74ee0af6670ad9ffe74937e3e063f762f44b32d7c060f4c69faeda6d8fe0935fd68525c8d3dbdf2

data/.rubocop.yml

@@ -37,6 +37,9 @@ Metrics/BlockLength:
     - jekyll_plugin_support.gemspec
   Max: 30
 
+Metrics/ClassLength:
+  Max: 150
+
 Metrics/CyclomaticComplexity:
   Max: 25
 

data/CHANGELOG.md

@@ -1,9 +1,20 @@
 # Change Log
 
+## 1.2.12 / 2024-08-17
+
+* Enhanced `match` so that if no label parameter is provided, the title of the matched web page is used.
+* Now dependent on jekyll_plugin_support v1.0.2+ for better error handling.
+
+
+## 1.2.11 / 2024-07-27
+
+* Fixed an unqualified reference to `JekyllPluginHelper`.
+* Shortened the very long stack dump for an error condition.
+
 
 ## 1.2.10 / 2024-07-23
 
-* Make compatible with jekyll_plugin_support 1.0.0
+* Make compatible with `jekyll_plugin_support` 1.0.0
 
 
 ## 1.2.9 / 2024-07-17

data/README.md

@@ -46,7 +46,22 @@ href_summary:
   pry_on_href_error: true  # Default value is false
 ```
 
-## Syntax 1 (requires `url` without embedded spaces)
+## Suppprted Syntaxes
+
+Square brackets in the [BNF notation](https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form)
+below denote optional keyword parameters, and are not meant to be typed.
+
+## Syntax 1 (most verbose, but provides best results and enables implicit matching title)
+
+```html
+{% href [match | [follow] [blank|notarget] [summary_exclude]] url="local_page.html" label="text to display" %}
+```
+
+1. The url can be #relative, a page in the Jekyll website, or prefaced with a protocol, such as `https:`
+2. If `match` is provided, and `label` is not provided, then the title of the matched page is used as the label.
+
+
+## Syntax 2 (requires `url` without embedded spaces)
 
 ```html
 {% href [match | [follow] [blank|notarget] [page_title] [summary_exclude]] url text to display %}
@@ -54,10 +69,9 @@ href_summary:
 
 1. The url must be a single token, without embedded spaces.
 2. The url need not be enclosed in quotes.
-3. The square brackets denote optional keyword parameters, and should not be typed.
 
 
-## Syntax 2 (always works)
+## Syntax 3 (always works)
 
 This syntax is recommended when the URL contains a colon (:).
 
@@ -68,10 +82,9 @@ This syntax is recommended when the URL contains a colon (:).
 
 1. Each of the above examples contain an embedded newline, which is legal.
 2. The url must be enclosed by either single or double quotes.
-3. The square brackets denote optional keyword parameters, and should not be typed.
 
 
-## Syntax 3 (implicit URL)
+## Syntax 4 (implicit URL)
 
 ```html
 {% href [match | [follow] [blank|notarget] [page_title] [summary_exclude]] [shy|wbr] www.domain.com %}
@@ -287,6 +300,21 @@ Expands to:
 
    Substitutions are only made to the URL, not to the linked text.
 
+8. Dollar signs
+
+   If the URL has a dollar sign in it, jekyll_href will attempt to replace an environment variable with its value.
+   That will likely fail silently. To work around the problem, replace dollar signs in URLs with $.
+
+   For example, given this URL:
+   https://ammonite.io/#import$ivy
+   rewrite as:
+   https://ammonite.io/#import$ivy.
+
+   Here is a complete invocation:
+
+   {% href url="https://ammonite.io/#import$ivy"
+           label="<code>import &dollar;ivy</code>" %}
+
 
 ## References Generation
 

data/jekyll_href.gemspec

@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ipaddress'
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_all_collections'
-  spec.add_dependency 'jekyll_plugin_support', '>= 1.0.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 1.0.2'
   spec.add_dependency 'typesafe_enum'
 end

data/lib/hash_array.rb

@@ -6,7 +6,7 @@ module HashArray
 
   def add_link_for_page(href, hash)
     enclosing_page = href.path
-    hash[enclosing_page] = [] if hash[enclosing_page].nil?
+    hash[enclosing_page] = hash[enclosing_page] || []
     pre_existing = hash[enclosing_page].find { |h| h.link_save == href.link_save }
     if pre_existing
       if pre_existing.follow != href.follow

data/lib/href_match.rb

@@ -1,20 +1,24 @@
-module MSlinn
+module JekyllSupport
   class HRefTag
     private
 
-    def compute_link_and_text(all_urls)
-      url_matches = all_urls.select { |url| url&.include? @path }
-      case url_matches.length
+    def compute_link_and_text
+      page_matches = @site.all_collections.map.select { |page| page.url&.include? @path }
+      case page_matches.length
       when 0
-        abort "href error: No url matches '#{@link}', found on line #{@line_number} (after front matter) of #{@path}" if @die_if_nomatch
+        msg = "HRef error: No url matches '#{@link}', found on line #{@line_number} (after front matter) of #{@path}"
+        @logger.error { msg }
+        abort msg if @die_if_nomatch
+        @text = "<i class='h_ref_error'>#{@link} is not available</i>"
         @link_save = @link = '#'
-        @text = "<i>#{@link} is not available</i>"
       when 1
-        @link = url_matches.first
+        @link = page_matches.first.url
         @link = "#{@link}##{@fragment}" if @fragment
         @link_save = @link
+        @text = page_matches.first.title unless @label
       else
-        abort "Error: More than one url matched '#{@path}': #{url_matches.join(', ')}"
+        logger.error { "Error: More than one url matched '#{@path}': #{url_matches.join(', ')}" }
+        exit! 2
       end
     end
 
@@ -31,8 +35,7 @@ module MSlinn
         END_DEBUG
       end
 
-      all_urls = @site.all_collections.map(&:url)
-      compute_link_and_text(all_urls)
+      compute_link_and_text
     end
   end
 end

data/lib/href_page_title.rb

@@ -1,4 +1,4 @@
-module MSlinn
+module JekyllSupport
   class HRefTag
     private
 

data/lib/href_private.rb

@@ -1,4 +1,4 @@
-module MSlinn
+module JekyllSupport
   class HRefTag
     private
 
@@ -25,8 +25,8 @@ module MSlinn
         No URL was provided on #{@path}:#{@line_number} (after front matter).
           <pre>{% href #{@argument_string.strip} %}</pre>
       END_MESSAGE
-      @logger.error { JekyllPluginHelper.remove_html_tags msg.strip }
-      "<div class='href_error'>HRefError: #{msg}</div>"
+      @logger.error { JekyllSupport::JekyllPluginHelper.remove_html_tags msg.strip }
+      "<div class='h_ref_error'>HRefError: #{msg}</div>"
     end
 
     # Sets @follow, @helper, @match, @path, @target, @url, @hyphenation

data/lib/href_summary.rb

@@ -1,4 +1,4 @@
-module MSlinn
+module JekyllSupport
   class HRefTag
     private
 

data/lib/href_summary_tag.rb

@@ -2,10 +2,8 @@ require 'jekyll_plugin_logger'
 require 'jekyll_plugin_support'
 require_relative 'jekyll_href/version'
 
-module MSlinn
-  class HrefSummary < JekyllSupport::JekyllTag
-    include JekyllHrefVersion
-
+module JekyllSupport
+  class HrefSummary < JekyllTag
     # Class instance variables accumulate hrefs across invocations.
     # These are hashes of arrays;
     # the hash keys are page paths (strings) and the hash values are arrays of HRefTags.
@@ -42,13 +40,10 @@ module MSlinn
         #{@helper.attribute if @helper.attribution && have_refs}
       END_RENDER
     rescue HRefError => 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_href_error
+      @logger.error { e.logger_message }
+      exit! 1 if @die_on_demo_block_error
 
-      "<div class='href_error'>#{e.class} raised in #{self.class};\n#{msg}</div>"
+      e.html_message
     end
 
     def render_global_refs
@@ -85,6 +80,6 @@ module MSlinn
       END_RENDER
     end
 
-    ::JekyllSupport::JekyllPluginHelper.register(self, 'href_summary')
+    JekyllSupport::JekyllPluginHelper.register(self, 'href_summary')
   end
 end

data/lib/href_tag.rb

@@ -11,13 +11,13 @@ require_relative 'hash_array'
 # @license SPDX-License-Identifier: Apache-2.0
 # Generates an href.
 
-module MSlinn
+module JekyllSupport
   MiniHref = Struct.new(:follow, :html, :link, :line_number, :link_save, :path, :summary_exclude, :summary_href, keyword_init: true)
 
   HRefError = JekyllSupport.define_error
 
   # Implements href Jekyll tag
-  class HRefTag < JekyllSupport::JekyllTag
+  class HRefTag < JekyllTag
     attr_reader :follow, :helper, :line_number, :link_save, :match, :page, :path, :site,
                 :summary, :summary_exclude, :summary_href, :target, :text, :url
     attr_accessor :link
@@ -46,29 +46,25 @@ module MSlinn
 
       @helper_save = @helper.clone
       globals_update(@helper.argv, linkk) # Sets @link and @text, might clear @follow and @target
-      handle_match(@link) if @match
-      raise HrefError, "@link_type was not set" if @link_type == LinkType::UNKNOWN
+      handle_match(linkk) if @match # Sets @text if not set by now
+      raise HrefError, '@link_type was not set' if @link_type == LinkType::UNKNOWN
 
       save_summary
       klass = " class='#{@klass}'" if @klass
       style = " style='#{@style}'" if @style
       "<a href='#{@link}'#{klass}#{style}#{@target}#{@follow}>#{@text}</a>"
     rescue HRefError => e # jekyll_plugin_support handles StandardError
-      msg = format_error_message "#{e.message}\n<pre>  {% href #{@argument_string.strip} %}</pre>"
-      @text = "<div class='href_error'>#{msg}</div>"
-      e.shorten_backtrace
-      @logger.error "#{e.class} raised #{msg}"
-      binding.pry if @pry_on_img_error # rubocop:disable Lint/Debugger
-      raise e if @die_on_href_error
+      @logger.error { e.logger_message }
+      exit 1 if @die_on_demo_tag_error
 
-      "<div class='href_error'>#{e.class} raised in #{self.class};\n#{msg}</div>"
+      e.html_message
     end
 
     def to_s
       "On line #{line_number} of #{path}: #{follow} #{match} #{target} #{link} => '#{text}'"
     end
 
-    ::JekyllSupport::JekyllPluginHelper.register(self, 'href')
+    JekyllSupport::JekyllPluginHelper.register(self, 'href')
   end
 end
 

data/lib/jekyll_href/version.rb

@@ -1,3 +1,3 @@
 module JekyllHrefVersion
-  VERSION = '1.2.10'.freeze
+  VERSION = '1.2.12'.freeze
 end

data/lib/jekyll_href.rb

@@ -1,8 +1,5 @@
 require_relative 'href_tag'
 require_relative 'href_summary_tag'
 
-HrefError = Class.new Liquid::Error
-
-module JekyllHrefModule
-  include MSlinn
+module JekyllSupport
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.2.10
+  version: 1.2.12
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ipaddress
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: typesafe_enum
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'.