jekyll_href 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22db125f99912c6bd0a7cbbaa15ca8311cc7914a80ecbe6a828535ad5844fa96
-  data.tar.gz: 3ce4d813af1541bdae8269fa370233ffe21c890de48da1e8e400eba67be59823
+  metadata.gz: 9e9e6357f4c5f4d4dd7815aab9142ab5dadfbc48b3ba719fdc6b1cd70265d3d3
+  data.tar.gz: '068d3c6821f1f8578fee4331179be452ad50fdfd620cc990a0dbdb1359f605cc'
 SHA512:
-  metadata.gz: 1f4a20b4e784614fb2e21a29c274fe5a1d69f522ae728772860c8933d27305c16aa03cd4b4d2a15b49c0d65da8ce5bf5e3ca61171c6d27a073a783046b0f6c89
-  data.tar.gz: b5eceadcf6aabfa9f80459f79848af9176cd81dd17e073de61b8e21dc4f6ba3a09ed197d029773411a0a9ca22bf1df74119729675f6c1d4736cbeba173038529
+  metadata.gz: d4411b3c9cfad7062eb75206f487e6e1a5589874479ae09815d044177069fd567b069875b9fabd4018dc9aafed9dc5dcc656354917c90935311ee958b6c1d5c2
+  data.tar.gz: abc4e78a0745ab9f455c5e1a1f85d0a41aa85c242f155c8d064503d5682df69806ef98c06c838833d37b1d3468713d5a21e798b7bf33570d48e2e27f76450fb8

data/.rubocop.yml

@@ -25,8 +25,7 @@ Gemspec/RequireMFA:
 
 Layout/HashAlignment:
   EnforcedColonStyle: table
-  Exclude:
-    - jekyll_href.gemspec
+  EnforcedHashRocketStyle: table
 
 Layout/InitialIndentation:
   Exclude:
@@ -34,6 +33,8 @@ Layout/InitialIndentation:
 
 Layout/LineLength:
   Max: 150
+  Exclude:
+    - spec/**/*
 
 Layout/MultilineMethodCallIndentation:
   Enabled: false
@@ -70,11 +71,17 @@ Naming/FileName:
     - Rakefile
 
 RSpec/ExampleLength:
-  Max: 20
+  Max: 40
+
+RSpec/FilePath:
+  Enabled: false
 
 RSpec/MultipleExpectations:
   Max: 15
 
+RSpec/MultipleMemoizedHelpers:
+  Max: 20
+
 Style/CommandLiteral:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.2.2 / 2023-03-25
+  * Added **References** capability:
+    * Added `summary_exclude` keyword option to `href` tag.
+    * Added `href_summary` tag.
+  * If a URL appears in more than one `href` with different `follow` values a warning is logged.
+
 ## 1.2.1 / 2023-03-21
   * Added `shy` and `wbr` options.
 

data/README.md

@@ -35,7 +35,7 @@ plugin-vars:
 
 ## Syntax 1 (requires `url` does not have embedded spaces)
 ```
-{% href [match | [follow] [blank|notarget]] url text to display %}
+{% href [match | [follow] [blank|notarget] [summary_exclude]] url text to display %}
 ```
  1. The url must be a single token, without embedded spaces.
  2. The url need not be enclosed in quotes.
@@ -45,11 +45,8 @@ plugin-vars:
 ## Syntax 2 (always works)
 This syntax is recommended when the URL contains a colon (:).
 ```
-{% href [match | [follow] [blank|notarget]]
+{% href [match | [follow] [blank|notarget]] [summary_exclude]
   url="http://link.com with space.html" some text %}
-
-{% href [match | [follow] [blank|notarget]]
-  url='http://link.com with space.html' some text %}
 ```
   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.
@@ -58,7 +55,7 @@ This syntax is recommended when the URL contains a colon (:).
 
 ## Syntax 3 (implicit URL)
 ```
-{% href [match | [follow] [blank|notarget]] [shy|wbr] www.domain.com %}
+{% href [match | [follow] [blank|notarget] [summary_exclude]] [shy|wbr] www.domain.com %}
 ```
 The URI provided, for example `www.domain.com`,
 is used to form the URL by prepending `https://`,
@@ -117,7 +114,7 @@ Expands to:
 ```
 
 ### `shy`
-`shy` is only applicable for syntax 3 (implicit URL).
+The `shy` keyword option is only applicable for syntax 3 (implicit URL).
 This option causes displayed urls to have an [`­`](https://developer.mozilla.org/en-US/docs/Web/CSS/hyphens) inserted after each slash (/).
 If both `shy` and `wbr` are specified, `wbr` prevails.
 
@@ -130,8 +127,21 @@ Expands to:
 <a href="https://mslinn.com/path/to/page.html" rel="nofollow" target="_blank">mslinn.com/&shy;path/&shy;to/&shy;page.html</a>
 ```
 
+### `summary`
+The `summary` name/value option provides an override for the linked text in the **References** section
+generated by the `{% href_summary %}` tag.
+
+
+### `summary_exclude`
+The `summary_exclude` keyword option prevents this `href` tag from appearing in the summary
+ produced by the [<code>href_summary</code> tag](#href_summary).
+You probably want all of your menu items (whose links are generated by the `href` tag) to have this keyword option.
+
+`mailto:` links are always excluded, so there is no need to use this keyword option for those types of links.
+
+
 ### `wbr`
-`wbr` is only applicable for syntax 3 (implicit URL).
+The `wbr` keyword option is only applicable for syntax 3 (implicit URL).
 It add [line break opportunites](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/wbr).
 This option causes displayed urls to have an `&lt;wbr&gt;` inserted after each slash (/).
 If both `shy` and `wbr` are specified, `wbr` prevails.
@@ -185,6 +195,81 @@ Expands to:
     Substitutions are only made to the URL, not to the linked text.
 
 
+## References Generation
+The `href` usages on each page can be summarized at the bottom of the pages in a **References** section.
+Links are presented in the summary in the order they appear in the page.
+
+The summary is produced by the `href_summary` tag.
+Usage is:
+
+```html
+{% href_summary [options] %}
+```
+
+`Href` tag options are used to generate the summary links,
+just as they were in the text above the **References** summary section.
+The only exception is the `summary` option, which overrides the linked text.
+
+If more than one `href` tag specifies a URL,
+the first one that appears in the page sets the value of the linked text.
+
+If a URL appears in more than one `href` with different `follow` values, a warning is logged.
+
+
+### Included `href` Tags
+The following `href` tags are included in the summary:
+
+ - Those with links that start with `http` are always included.
+ - Those with [relative links](https://www.w3.org/TR/WD-html40-970917/htmlweb.html#h-5.1.2),
+   and have the `include_local` keyword option.
+
+### Excluded `href` Tags
+The following `href` tags are excluded from the summary:
+
+ - Those with links that start with `mailto:`.
+ - Those having the `summary_exclude` keyword option.
+
+
+### Example
+Given these `href` and `href_summary` usages in a web page:
+
+```html
+{% href https://rubygems.org RubyGems.org %}
+{% href summary="Mothership" https://jekyllrb.com/ Jekyll %}
+{% href summary="Mike Slinn" mslinn.com %}
+{% href https://mslinn.com Mike Slinn %}
+{% href summary="Front page of this website" / Front page %}
+
+{% href_summary attribution include_local %}
+```
+
+Then the generated HTML looks like the following:
+
+```html
+<h2 id="reference">References</h2>
+<ol>
+  <li><a href='https://rubygems.org' rel='nofollow' target='_blank'>RubyGems.org</a></li>
+  <li><a href='https://jekyllrb.com/' rel='nofollow' target='_blank'>Mothership</a></li>
+  <li><a href='https://mslinn.com/' rel='nofollow' target='_blank'><code>mslinn.com</code></a></li>
+</ol>
+
+<h2 id="local_reference">Local References</h2>
+<ol>
+  <li><a href='/'>Front page of this website</a></li>
+</ol>
+
+<div id="jps_attribute_735866" class="jps_attribute">
+  <div>
+    <a href="https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#href" target="_blank" rel="nofollow">
+      Generated by the jekyll_href v1.2.2 Jekyll plugin, written by Mike Slinn 2023-04-13.
+    </a>
+  </div>
+</div>
+```
+
+You can read about the `attribution` option [here](https://www.mslinn.com/jekyll/10200-jekyll-plugin-support.html#attribution).
+
+
 ## Additional Information
 More information is available on my website about
 [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).

data/jekyll_href.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   END_OF_DESC
   spec.email = ['mslinn@mslinn.com']
   spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
-  spec.homepage = 'https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#href'
+  spec.homepage = 'https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#href'
   spec.license = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_all_collections', '~> 0.3.0', '>= 0.3.1'
+  spec.add_dependency 'jekyll_plugin_support', '~> 0.6.0', '>= 0.6.1'
 end

data/lib/hash_array.rb

@@ -0,0 +1,32 @@
+module HashArray
+  def reset
+    @local_hrefs = {}
+    @global_hrefs = {}
+  end
+
+  def add_link_for_page(href, hash)
+    enclosing_page = href.path
+    hash[enclosing_page] = [] if hash[enclosing_page].nil?
+    pre_existing = hash[enclosing_page].find { |h| h.link_save == href.link_save }
+    if pre_existing
+      if pre_existing.follow != href.follow
+        @logger.warn "HRef tags for '#{href.link}' have inconsistent 'follow' keyword options on line #{href.line_number} of #{enclosing_page}"
+      end
+    else
+      hash[enclosing_page] << href unless href.summary_exclude
+    end
+  end
+
+  def add_local_link_for_page(href)
+    add_link_for_page(href, HashArray.instance_variable_get(:@local_hrefs))
+  end
+
+  def add_global_link_for_page(href)
+    add_link_for_page(href, HashArray.instance_variable_get(:@global_hrefs))
+  end
+
+  module_function :add_link_for_page, :add_local_link_for_page, :add_global_link_for_page, :reset
+  public :add_local_link_for_page, :add_global_link_for_page, :reset
+
+  reset
+end

data/lib/href_summary_tag.rb

@@ -0,0 +1,79 @@
+require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
+require_relative 'jekyll_href/version'
+
+module HrefSummaryTag
+  class HrefSummary < JekyllSupport::JekyllTag # rubocop:disable Metrics/ClassLength
+    include JekyllHrefVersion
+
+    # 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.
+    # {
+    #   'path/to/page1.html': [ HRefTag1, HRefTag2 ],
+    #   'path/to/page2.html': [ HRefTag3, HRefTag4 ],
+    # }
+    @hrefs = {}
+    @hrefs_local = {}
+
+    class << self
+      attr_accessor :hrefs, :hrefs_local
+    end
+
+    include JekyllHrefVersion
+
+    # Method prescribed by the Jekyll plugin lifecycle.
+    # @param liquid_context [Liquid::Context]
+    # @return [String]
+    def render_impl
+      @helper.gem_file __FILE__ # Enables attribution
+      @include_local = @helper.parameter_specified? 'include_local'
+      global_refs = render_global_refs
+      local_refs  = render_local_refs
+      have_refs = !(global_refs + local_refs).empty?
+      <<~END_RENDER
+        #{global_refs}
+        #{local_refs}
+        #{@helper.attribute if @helper.attribution && have_refs}
+      END_RENDER
+    end
+
+    def render_global_refs
+      hrefs = HashArray.instance_variable_get(:@global_hrefs)
+      path = @page['path']
+      entries = hrefs[path]&.select { |h| h.path == path }
+      return '' if entries.nil? || entries.empty?
+
+      summaries = entries.map { |href| "<li>#{href.summary_href}</li>" }
+
+      <<~END_RENDER
+        <h2 id="reference">References</h2>
+        <ol>
+          #{summaries.join "\n  "}
+        </ol>
+      END_RENDER
+    rescue StandardError => e
+      @logger.error { "#{self.class} died with a #{e.full_message}" }
+      exit 1
+    end
+
+    def render_local_refs
+      return '' unless @include_local
+
+      hrefs = HashArray.instance_variable_get(:@local_hrefs)
+      path = @page['path']
+      entries = hrefs[path]&.select { |h| h.path == path }
+      return '' if entries.nil? || entries.empty?
+
+      summary = entries.map { |href| "<li>#{href.summary_href}</li>" }
+      <<~END_RENDER
+        <h2 id="local_reference">Local References</h2>
+        <ol>
+        #{summary.join("\n  ")}
+        </ol>
+      END_RENDER
+    end
+
+    JekyllPluginHelper.register(self, 'href_summary')
+  end
+end

data/lib/href_tag.rb

@@ -0,0 +1,214 @@
+require 'jekyll_all_collections'
+require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
+require 'liquid'
+require_relative 'jekyll_href/version'
+require_relative 'hash_array'
+
+# @author Copyright 2020 Michael Slinn
+# @license SPDX-License-Identifier: Apache-2.0
+# Generates an href.
+
+module HrefTag
+  MiniHref = Struct.new(:follow, :html, :link, :line_number, :link_save, :path, :summary_exclude, :summary_href, keyword_init: true)
+
+  # Implements href Jekyll tag
+  class HrefTag < JekyllSupport::JekyllTag # rubocop:disable Metrics/ClassLength
+    attr_reader :follow, :helper, :line_number, :link_save, :match, :page, :path, :site,
+                :summary, :summary_exclude, :summary_href, :target, :text, :url
+    attr_accessor :link
+
+    include JekyllHrefVersion
+    include HashArray
+    include Comparable
+
+    def <=>(other)
+      return nil unless other.is_a?(self.class)
+
+      [follow, match, path, target, text] <=> [other.follow, other.match, other.path, other.target, other.text]
+    end
+
+    def to_s
+      "On line #{line_number} of #{path}: #{follow} #{match} #{target} #{link} => '#{text}'"
+    end
+
+    # Method prescribed by the Jekyll plugin lifecycle.
+    # @param liquid_context [Liquid::Context]
+    # @return [String]
+    def render_impl
+      globals_initial
+      linkk = compute_linkk
+      linkk = replace_vars(linkk)
+      linkk.delete_prefix('./') # normalize relative links
+      @url = linkk if @url
+      @link_save = linkk
+      @helper_save = @helper.clone
+      globals_update(@helper.argv, linkk) # Sets @link and @text, might clear @follow and @target
+      handle_match if @match
+      save_summary
+      "<a href='#{@link}'#{@target}#{@follow}>#{@text}</a>"
+    end
+
+    private
+
+    def save_summary
+      return if @summary_exclude || @link_save.start_with?('mailto:') || @link_save.start_with?('#')
+
+      @summary = @summary.to_s.empty? ? @text : @summary.to_s
+      @summary = @summary[0].upcase + @summary[1..]
+      @summary_href = "<a href='#{@link_save}'#{@target}#{@follow}>#{@summary}</a>"
+      mini_href = MiniHref.new(
+        follow:          @follow,
+        html:            @summary_href,
+        line_number:     @line_number,
+        link:            @link_save,
+        link_save:       @link_save,
+        path:            @path,
+        summary_exclude: @summary_exclude,
+        summary_href:    @summary_href
+      )
+      if @link_save.start_with? 'http'
+        add_global_link_for_page mini_href
+      else
+        add_local_link_for_page mini_href
+      end
+    end
+
+    # Does not look at or compute @link
+    def compute_linkk
+      return @link if @link
+
+      linkk = @url
+      if linkk.nil? || !linkk
+        linkk = @helper.argv&.shift
+        @helper.params&.shift
+        @helper.keys_values&.delete(linkk)
+        dump_linkk_relations(linkk) if linkk.nil?
+      elsif @url.to_s.empty?
+        dump_linkk_relations(linkk)
+      end
+      linkk
+    end
+
+    def dump_linkk_relations(linkk)
+      msg = <<~END_MESSAGE
+        jekyll_href error: no url was provided on #{@path}:#{@line_number}.
+          @helper.markup=#{@helper.markup}
+          @helper.argv='#{@helper.argv}'
+          linkk='#{linkk}'
+          @match='#{@match}'
+          @url='#{@url}'
+          @follow='#{@follow}
+          @target='#{@target}'
+      END_MESSAGE
+      abort msg.red
+    end
+
+    # Sets @follow, @helper, @match, @path, @shy, @target, @url, @wbr
+    def globals_initial
+      @path = @page['path']
+      AllCollectionsHooks.compute(@site)
+
+      @follow          = @helper.parameter_specified?('follow') ? '' : " rel='nofollow'"
+      @match           = @helper.parameter_specified? 'match'
+      @blank           = @helper.parameter_specified? 'blank'
+      @summary_exclude = @helper.parameter_specified? 'summary_exclude'
+      @shy             = @helper.parameter_specified? 'shy'
+      @summary         = @helper.parameter_specified? 'summary'
+      @target          = @blank ? " target='_blank'" : nil
+      @target        ||= @helper.parameter_specified?('notarget') ? '' : " target='_blank'"
+      @url             = @helper.parameter_specified? 'url'
+      @wbr             = @helper.parameter_specified? 'wbr'
+    end
+
+    # Might set @follow, @linkk, @target, and @text
+    def globals_update(tokens, linkk)
+      if linkk.start_with? 'mailto:'
+        @link = linkk
+        @target = @follow = ''
+        @text = @helper.argv.join(' ')
+        if @text.empty?
+          text = linkk.delete_prefix('mailto:')
+          @text = "<code>#{text}</code>"
+        end
+        return
+      else
+        @text = tokens.join(' ').strip
+        if @text.to_s.empty?
+          text = linkk
+          text = linkk.gsub('/', '/&shy;') if @shy
+          text = linkk.gsub('/', '/<wbr>') if @wbr
+          @text = "<code>#{text}</code>"
+          @link = linkk.start_with?('http') ? linkk : "https://#{linkk}"
+        else
+          @link = if @shy
+                    linkk.gsub('/', '/&shy;')
+                  elsif @wbr
+                    linkk.gsub('/', '/<wbr>')
+                  else
+                    linkk
+                  end
+        end
+        @link_save = @link
+      end
+
+      return if @link.start_with? 'http'
+
+      @follow = ''
+      @target = '' unless @blank
+    end
+
+    def handle_match
+      match_post
+      @follow = ''
+      @target = '' unless @blank
+    end
+
+    # Might set @link and @text
+    def match_post
+      config = @site.config['href']
+      @die_if_nomatch = !config.nil? && config['nomatch'] && config['nomatch'] == 'fatal'
+      @path, @fragment = @link.split('#')
+
+      @logger.debug do
+        <<~END_DEBUG
+          @link=#{@link}
+          @site.posts.docs[0].url  = #{@site.posts.docs[0].url}
+          @site.posts.docs[0].path = #{@site.posts.docs[0].path}
+        END_DEBUG
+      end
+
+      all_urls = @site.all_collections.map(&:url)
+      compute_link_and_text(all_urls)
+    end
+
+    def compute_link_and_text(all_urls)
+      url_matches = all_urls.select { |url| url&.include? @path }
+      case url_matches.length
+      when 0
+        abort "href error: No url matches '#{@link}'" if @die_if_nomatch
+        @link_save = @link = '#'
+        @text = "<i>#{@link} is not available</i>"
+      when 1
+        @link = url_matches.first
+        @link = "#{@link}##{@fragment}" if @fragment
+        @link_save = @link
+      else
+        abort "Error: More than one url matched '#{@path}': #{url_matches.join(', ')}"
+      end
+    end
+
+    # Replace names in plugin-vars with values
+    def replace_vars(text)
+      variables = @site.config['plugin-vars']
+      return text unless variables
+
+      variables.each do |name, value|
+        text = text.gsub "{{#{name}}}", value
+      end
+      text
+    end
+
+    JekyllPluginHelper.register(self, 'href')
+  end
+end

data/lib/jekyll_href/version.rb

@@ -1,3 +1,3 @@
 module JekyllHrefVersion
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.2.2'.freeze
 end

data/lib/jekyll_href.rb

@@ -1,168 +1,9 @@
-require 'jekyll_all_collections'
-require 'jekyll_plugin_logger'
-require 'jekyll_plugin_support'
-require 'liquid'
-require_relative 'jekyll_href/version'
+require_relative 'href_tag'
+require_relative 'href_summary_tag'
 
-# @author Copyright 2020 Michael Slinn
-# @license SPDX-License-Identifier: Apache-2.0
-# Generates an href.
+HrefError = Class.new(Liquid::Error)
 
-# Implements href Jekyll tag
-class ExternalHref < JekyllSupport::JekyllTag # rubocop:disable Metrics/ClassLength
-  attr_reader :follow, :helper, :line_number, :match, :page, :path, :site, :text, :target, :url
-  attr_accessor :link
-
-  include JekyllHrefVersion
-
-  # Method prescribed by the Jekyll plugin lifecycle.
-  # @param liquid_context [Liquid::Context]
-  # @return [String]
-  def render_impl
-    globals_initial
-    linkk = compute_linkk
-    linkk = replace_vars(linkk)
-    @link_save = linkk
-    @helper_save = @helper.clone
-    globals_update(@helper.argv, linkk) # Sets @link and @text, might clear @follow and @target
-    handle_match if @match
-
-    "<a href='#{@link}'#{@target}#{@follow}>#{@text}</a>"
-  end
-
-  private
-
-  # Does not look at or compute @link
-  def compute_linkk
-    return @link if @link
-
-    linkk = @url
-    if linkk.nil? || !linkk
-      linkk = @helper.argv&.shift
-      @helper.params&.shift
-      @helper.keys_values&.delete(linkk)
-      dump_linkk_relations(linkk) if linkk.nil?
-    elsif @url.to_s.empty?
-      dump_linkk_relations(linkk)
-    end
-    linkk
-  end
-
-  def dump_linkk_relations(linkk)
-    msg = <<~END_MESSAGE
-      jekyll_href error: no url was provided on #{@path}:#{@line_number}.
-        @helper.markup=#{@helper.markup}
-        @helper.argv='#{@helper.argv}'
-        linkk='#{linkk}'
-        @match='#{@match}'
-        @url='#{@url}'
-        @follow='#{@follow}
-        @target='#{@target}'
-    END_MESSAGE
-    abort msg.red
-  end
-
-  # Sets @follow, @helper, @match, @path, @shy, @target, @url, @wbr
-  def globals_initial
-    @path = @page['path']
-    AllCollectionsHooks.compute(@site)
-
-    @follow = @helper.parameter_specified?('follow') ? '' : " rel='nofollow'"
-    @match  = @helper.parameter_specified?('match')
-    @blank  = @helper.parameter_specified?('blank')
-    @shy    = @helper.parameter_specified?('shy')
-    @target = @blank ? " target='_blank'" : nil
-    @target ||= @helper.parameter_specified?('notarget') ? '' : " target='_blank'"
-    @url    = @helper.parameter_specified?('url')
-    @wbr    = @helper.parameter_specified?('wbr')
-  end
-
-  # Might set @follow, @linkk, @target, and @text
-  def globals_update(tokens, linkk)
-    if linkk.start_with? 'mailto:'
-      @link = linkk
-      @target = @follow = ''
-      @text = @helper.argv.join(' ')
-      if @text.empty?
-        text = linkk.delete_prefix('mailto:')
-        @text = "<code>#{text}</code>"
-      end
-      return
-    else
-      @text = tokens.join(' ').strip
-      if @text.to_s.empty?
-        text = linkk
-        text = linkk.gsub('/', '/&shy;') if @shy
-        text = linkk.gsub('/', '/<wbr>') if @wbr
-        @text = "<code>#{text}</code>"
-        @link = "https://#{linkk}"
-      else
-        @link = if @shy
-                  linkk.gsub('/', '/&shy;')
-                elsif @wbr
-                  linkk.gsub('/', '/<wbr>')
-                else
-                  linkk
-                end
-      end
-    end
-
-    return if @link.start_with? 'http'
-
-    @follow = ''
-    @target = '' unless @blank
-  end
-
-  def handle_match
-    match_post
-    @follow = ''
-    @target = '' unless @blank
-  end
-
-  # Might set @link and @text
-  def match_post
-    config = @site.config['href']
-    @die_if_nomatch = !config.nil? && config['nomatch'] && config['nomatch'] == 'fatal'
-    @path, @fragment = @link.split('#')
-
-    @logger.debug do
-      <<~END_DEBUG
-        @link=#{@link}
-        @site.posts.docs[0].url  = #{@site.posts.docs[0].url}
-        @site.posts.docs[0].path = #{@site.posts.docs[0].path}
-      END_DEBUG
-    end
-
-    all_urls = @site.all_collections.map(&:url)
-    compute_link_and_text(all_urls)
-  end
-
-  def compute_link_and_text(all_urls)
-    url_matches = all_urls.select { |url| url&.include? @path }
-    case url_matches.length
-    when 0
-      abort "href error: No url matches '#{@link}'" if @die_if_nomatch
-      @link = '#'
-      @text = "<i>#{@link} is not available</i>"
-    when 1
-      @link = url_matches.first
-      @link = "#{@link}##{@fragment}" if @fragment
-    else
-      abort "Error: More than one url matched '#{@path}': #{url_matches.join(', ')}"
-    end
-  end
-
-  # Replace names in plugin-vars with values
-  def replace_vars(text)
-    variables = @site.config['plugin-vars']
-    return text unless variables
-
-    variables.each do |name, value|
-      text = text.gsub "{{#{name}}}", value
-    end
-    @logger.debug { "@link=#{@link}" }
-    text
-  end
-
-  JekyllPluginHelper.register(self, 'href')
+module JekyllHrefModule
+  include HrefTag
+  include HrefSummaryTag
 end

data/spec/hash_array_spec.rb

@@ -0,0 +1,43 @@
+module HashArraySpec
+  require_relative '../lib/hash_array'
+
+  RSpec.describe HashArray do
+    let(:logger) do
+      PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+    end
+
+    let(:parse_context) { TestParseContext.new }
+
+    [1, 2, 3, 4, 11, 22, 33, 44].each do |x|
+      let("href#{x}".to_sym) do
+        domain, where = if x.even?
+                          ['https://domain.com/', 'External']
+                        else
+                          ['', 'Internal']
+                        end
+        href = HrefTag::HrefTag.send(
+          :new,
+          'href',
+          + "#{domain}path/page#{x}.html #{where} link text #{x}",
+          parse_context
+        )
+        href.render(TestLiquidContext.new)
+        href
+      end
+    end
+
+    it 'accumulates arrays of href_tag' do
+      described_class.reset
+      [href1, href3, href11, href33].each { |x| described_class.add_local_link_for_page x }
+      [href2, href4, href22, href44].each { |x| described_class.add_global_link_for_page x }
+
+      local_hrefs = described_class.instance_variable_get :@local_hrefs
+      value = { 'index.html' => [href1, href3, href11, href33] }
+      expect(local_hrefs).to match_array(value)
+
+      global_hrefs = described_class.instance_variable_get :@global_hrefs
+      value = { 'index.html' => [href2, href4, href22, href44] }
+      expect(global_hrefs).to match_array(value)
+    end
+  end
+end

data/spec/href_spec.rb

@@ -1,49 +1,10 @@
-require 'jekyll'
-require 'jekyll_plugin_logger'
-require 'yaml'
 require_relative '../lib/jekyll_href'
 
-Registers = Struct.new(:page, :site)
-
-# Mock for Collections
-class Collections
-  def values
-    []
-  end
-end
-
-# Mock for Site
-class SiteMock
-  attr_reader :config
-
-  def initialize
-    @config = YAML.safe_load(File.read('_config.yml'))
-  end
-
-  def collections
-    Collections.new
-  end
-end
-
-# Mock for Liquid::ParseContent
-class TestParseContext < Liquid::ParseContext
-  attr_reader :line_number, :registers
-
-  def initialize
-    super
-    @line_number = 123
-
-    @registers = Registers.new(
-      { 'path' => 'https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss' },
-      SiteMock.new
-    )
-  end
-end
-
 class MyTest
   Dir.chdir 'demo'
+  HashArray.reset
 
-  RSpec.describe ExternalHref do
+  RSpec.describe HrefTag::HrefTag do
     let(:logger) do
       PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
     end
@@ -58,209 +19,194 @@ class MyTest
       )
     end
 
-    it "Obtains internal link with blank" do
+    it 'obtains internal link with blank' do
       href = described_class.send(
         :new,
         'href',
-        + 'blank ./path/page.html internal link text',
+        + 'blank path/page.html internal link text',
         parse_context
       )
-      href.send :globals_initial
-      linkk = href.send :compute_linkk
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq('')
-      expect(href.link).to   eq('./path/page.html')
+      expect(href.link).to   eq('path/page.html')
       expect(href.target).to eq(" target='_blank'")
       expect(href.text).to   eq('internal link text')
     end
 
-    it "Obtains external link with text" do
+    it 'obtains external link with text' do
       href = described_class.send(
         :new,
         'href',
-        + 'https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss  SoundCloud RSS Feed',
+        + 'summary_exclude https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss  SoundCloud RSS Feed',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq(" rel='nofollow'")
       expect(href.link).to   eq('https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss')
       expect(href.target).to eq(" target='_blank'")
       expect(href.text).to   eq('SoundCloud RSS Feed')
     end
 
-    it "Obtains external link using url parameter with text" do
+    it 'obtains external link using url parameter with text' do
       href = described_class.send(
         :new,
         'href',
-        + 'url="https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss" SoundCloud RSS Feed',
+        + 'summary_exclude url="https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss" SoundCloud RSS Feed',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq(" rel='nofollow'")
       expect(href.link).to   eq('https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss')
       expect(href.target).to eq(" target='_blank'")
       expect(href.text).to   eq('SoundCloud RSS Feed')
     end
 
-    it "Obtains external link without scheme or text" do
+    it 'obtains external link without scheme or text' do
       href = described_class.send(
         :new,
         'href',
         + 'super-fake-merger.com',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq(" rel='nofollow'")
       expect(href.link).to   eq('https://super-fake-merger.com')
       expect(href.target).to eq(" target='_blank'")
       expect(href.text).to   eq('<code>super-fake-merger.com</code>')
     end
 
-    it "Expands YAML hash with link text" do
+    it 'expands YAML hash with link text' do
       href = described_class.send(
         :new,
         'href',
         + '{{github}}/diasks2/confidential_info_redactor <code>confidential_info_redactor</code>',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      linkk = href.send(:replace_vars, linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq(" rel='nofollow'")
       expect(href.link).to   eq('https://github.com/diasks2/confidential_info_redactor')
       expect(href.target).to eq(" target='_blank'")
       expect(href.text).to   eq('<code>confidential_info_redactor</code>')
     end
 
-    it "Obtains external link with follow" do
+    it 'obtains external link with follow' do
       href = described_class.send(
         :new,
         'href',
         + 'follow https://www.mslinn.com Awesome',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq('')
       expect(href.link).to   eq('https://www.mslinn.com')
       expect(href.target).to eq(" target='_blank'")
       expect(href.text).to   eq('Awesome')
     end
 
-    it "Obtains external link with follow and notarget" do
+    it 'obtains external link with follow and notarget' do
       href = described_class.send(
         :new,
         'href',
         + 'follow notarget https://www.mslinn.com Awesome',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq('')
       expect(href.link).to   eq('https://www.mslinn.com')
       expect(href.target).to eq('')
       expect(href.text).to   eq('Awesome')
     end
 
-    it "Obtains external link with blank" do
+    it 'obtains external link with blank' do
       href = described_class.send(
         :new,
         'href',
         + 'blank https://www.mslinn.com Awesome',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq(" rel='nofollow'")
       expect(href.link).to   eq('https://www.mslinn.com')
       expect(href.target).to eq(" target='_blank'")
       expect(href.text).to   eq('Awesome')
     end
 
-    it "Implicitly computes external link from text" do
+    it 'implicitly computes external link from text' do
       href = described_class.send(
         :new,
         'href',
         + 'www.mslinn.com',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq(" rel='nofollow'")
       expect(href.link).to   eq('https://www.mslinn.com')
       expect(href.target).to eq(" target='_blank'")
       expect(href.text).to   eq('<code>www.mslinn.com</code>')
     end
 
-    it "Implicitly computes external link from text with follow and notarget" do
+    it 'implicitly computes external link from text with follow and notarget' do
       href = described_class.send(
         :new,
         'href',
         + 'follow notarget www.mslinn.com',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq('')
       expect(href.link).to   eq('https://www.mslinn.com')
       expect(href.target).to eq('')
       expect(href.text).to   eq('<code>www.mslinn.com</code>')
     end
 
-    it "Implicitly computes external link from text with blank" do
+    it 'implicitly computes external link from text with blank' do
       href = described_class.send(
         :new,
         'href',
         + 'follow blank www.mslinn.com',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq('')
       expect(href.link).to   eq('https://www.mslinn.com')
       expect(href.target).to eq(" target='_blank'")
       expect(href.text).to   eq('<code>www.mslinn.com</code>')
+
+      # hrefs = HashArray.instance_variable_get(:@global_hrefs)
+      # expect(hrefs).to eq(
+      #   {
+      #     "index.html" => [
+      #       "<a href='https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss' target='_blank' rel='nofollow'>SoundCloud RSS Feed</a>",
+      #       "<a href='https://github.com/diasks2/confidential_info_redactor' target='_blank' rel='nofollow'><code>confidential_info_redactor</code></a>",
+      #       "<a href='https://super-fake-merger.com' target='_blank' rel='nofollow'><code>super-fake-merger.com</code></a>",
+      #       "<a href='https://www.mslinn.com' target='_blank'><code>www.mslinn.com</code></a>"
+      #     ],
+      #   }
+      # )
     end
 
-    it "Obtains mailto without text" do
+    it 'obtains mailto without text' do
       href = described_class.send(
         :new,
         'href',
         + 'mailto:mslinn@mslinn.com',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq('')
       expect(href.link).to   eq('mailto:mslinn@mslinn.com')
       expect(href.target).to eq('')
       expect(href.text).to   eq('<code>mslinn@mslinn.com</code>')
     end
 
-    it "Obtains mailto with text" do
+    it 'obtains mailto with text' do
       href = described_class.send(
         :new,
         'href',
         + 'mailto:mslinn@mslinn.com Mike Slinn',
         parse_context
       )
-      href.send(:globals_initial, parse_context)
-      linkk = href.send(:compute_linkk)
-      href.send(:globals_update, href.helper.argv, linkk)
+      href.render TestLiquidContext.new
       expect(href.follow).to eq('')
       expect(href.link).to   eq('mailto:mslinn@mslinn.com')
       expect(href.target).to eq('')

data/spec/spec_helper.rb

@@ -1,10 +1,13 @@
-require "liquid"
-require "fileutils"
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'liquid'
+require 'fileutils'
+require 'yaml'
 require_relative "../lib/jekyll_href"
 
 RSpec.configure do |config|
   config.filter_run :focus
-  config.order = "random"
+  # config.order = "random"
   config.run_all_when_everything_filtered = true
 
   # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
@@ -12,3 +15,65 @@ RSpec.configure do |config|
 
   config.filter_run_when_matching focus: true
 end
+
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def initialize
+    @config = YAML.safe_load(File.read('../demo/_config.yml'))
+    @config['env'] = { 'JEKYLL_ENV' => 'development' }
+  end
+
+  def collections
+    Collections.new
+  end
+end
+
+class TestLiquidContext < Liquid::Context
+  def initialize
+    super
+
+    page = {
+      "content"     => "blah blah",
+      "description" => "Jekyll plugin support demo",
+      "dir"         => "/",
+      "excerpt"     => nil,
+      "layout"      => "default",
+      "name"        => "index.html",
+      "path"        => "index.html",
+      "title"       => "Welcome",
+      "url"         => "/",
+    }
+
+    @content = "Interior of the tag"
+    @registers = Registers.new(
+      page,
+      SiteMock.new
+    )
+  end
+end
+
+# Mock for Liquid::ParseContent
+class TestParseContext < Liquid::ParseContext
+  attr_reader :line_number, :registers
+
+  def initialize
+    super
+    @line_number = 123
+
+    @registers = Registers.new(
+      { 'path' => 'path/to/page.html' },
+      SiteMock.new
+    )
+  end
+end

data/spec/status_persistence.txt

@@ -1,15 +1,29 @@
 example_id                                                        | status | run_time        |
 ----------------------------------------------------------------- | ------ | --------------- |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:1]  | passed | 0.00817 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:2]  | passed | 0.00349 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:3]  | passed | 0.0033 seconds  |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:4]  | passed | 0.00307 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:5]  | passed | 0.00315 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:6]  | passed | 0.0032 seconds  |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:7]  | passed | 0.0035 seconds  |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:8]  | passed | 0.00323 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:9]  | passed | 0.0032 seconds  |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:10] | passed | 0.00307 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:11] | passed | 0.00317 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:12] | passed | 0.00357 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:13] | passed | 0.0035 seconds  |
+./spec/hash_array_spec.rb[1:1]                                    | passed | 0.17104 seconds |
+./spec/href_spec.rb[1:1]                                          | passed | 0.03236 seconds |
+./spec/href_spec.rb[1:2]                                          | passed | 0.02884 seconds |
+./spec/href_spec.rb[1:3]                                          | passed | 0.02956 seconds |
+./spec/href_spec.rb[1:4]                                          | passed | 0.02841 seconds |
+./spec/href_spec.rb[1:5]                                          | passed | 0.02897 seconds |
+./spec/href_spec.rb[1:6]                                          | passed | 0.02866 seconds |
+./spec/href_spec.rb[1:7]                                          | passed | 0.02966 seconds |
+./spec/href_spec.rb[1:8]                                          | passed | 0.02983 seconds |
+./spec/href_spec.rb[1:9]                                          | passed | 0.02735 seconds |
+./spec/href_spec.rb[1:10]                                         | passed | 0.02928 seconds |
+./spec/href_spec.rb[1:11]                                         | passed | 0.02861 seconds |
+./spec/href_spec.rb[1:12]                                         | passed | 0.02958 seconds |
+./spec/href_spec.rb[1:13]                                         | passed | 0.02714 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:1]  | passed | 0.02582 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:2]  | passed | 0.01031 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:3]  | passed | 0.01045 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:4]  | passed | 0.01038 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:5]  | passed | 0.01081 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:6]  | passed | 0.01053 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:7]  | passed | 0.01125 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:8]  | passed | 0.01113 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:9]  | passed | 0.01088 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:10] | passed | 0.01066 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:11] | failed | 0.06099 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:12] | passed | 0.01096 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:13] | passed | 0.01028 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,6 +44,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: jekyll_plugin_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 description: 'Generates an ''a href'' tag, possibly with target=''_blank'' and rel=''nofollow''.
 
   '
@@ -59,19 +79,23 @@ files:
 - README.md
 - Rakefile
 - jekyll_href.gemspec
+- lib/hash_array.rb
+- lib/href_summary_tag.rb
+- lib/href_tag.rb
 - lib/jekyll_href.rb
 - lib/jekyll_href/version.rb
+- spec/hash_array_spec.rb
 - spec/href_spec.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt
-homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#href
+homepage: https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#href
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/mslinn/jekyll_href/issues
   changelog_uri: https://github.com/mslinn/jekyll_href/CHANGELOG.md
-  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#href
+  homepage_uri: https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#href
   source_code_uri: https://github.com/mslinn/jekyll_href
 post_install_message: |2+
 
@@ -96,6 +120,7 @@ signing_key:
 specification_version: 4
 summary: Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'.
 test_files:
+- spec/hash_array_spec.rb
 - spec/href_spec.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt