jekyll_href 1.1.0 → 1.2.2

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.1.0'.freeze
+  VERSION = '1.2.2'.freeze
 end

data/lib/jekyll_href.rb

@@ -1,177 +1,9 @@
-require 'jekyll_all_collections'
-require 'jekyll_plugin_logger'
-require 'liquid'
-require_relative 'jekyll_href/version'
-require_relative './jekyll_tag_helper2'
+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 < Liquid::Tag # rubocop:disable Metrics/ClassLength
-  attr_reader :follow, :helper, :line_number, :match, :page, :path, :site, :text, :target, :url
-  attr_accessor :link
-
-  # @param tag_name [String] is the name of the tag, which we already know.
-  # @param markup [String] the arguments from the web page.
-  # @param _tokens [Liquid::ParseContext] tokenized command line
-  #        By default it has two keys: :locale and :line_numbers, the first is a Liquid::I18n object, and the second,
-  #        a boolean parameter that determines if error messages should display the line number the error occurred.
-  #        This argument is used mostly to display localized error messages on Liquid built-in Tags and Filters.
-  #        See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
-  # @return [void]
-  def initialize(tag_name, markup, _tokens)
-    super
-    markup = '' if markup.nil?
-    markup.strip!
-
-    @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
-    @helper = JekyllTagHelper2.new(tag_name, markup, @logger)
-  end
-
-  # Method prescribed by the Jekyll plugin lifecycle.
-  # @param liquid_context [Liquid::Context]
-  # @return [String]
-  def render(liquid_context)
-    super
-    globals_initial(liquid_context)
-    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
-
-  def globals_initial(liquid_context)
-    # Sets @follow, @helper, @match, @page, @path, @site, @target, @url
-    @helper.liquid_context = liquid_context
-
-    @page = liquid_context.registers[:page]
-    @path = @page['path']
-    @site = liquid_context.registers[:site]
-    AllCollectionsHooks.compute(@site)
-
-    @follow = @helper.parameter_specified?('follow') ? '' : " rel='nofollow'"
-    @match  = @helper.parameter_specified?('match')
-    @blank  = @helper.parameter_specified?('blank')
-    @target = @blank ? " target='_blank'" : nil
-    @target ||= @helper.parameter_specified?('notarget') ? '' : " target='_blank'"
-    @url    = @helper.parameter_specified?('url')
-  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 = "<code>#{linkk}</code>"
-        @link = "https://#{linkk}"
-      else
-        @link = linkk
-      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
+module JekyllHrefModule
+  include HrefTag
+  include HrefSummaryTag
 end
-
-PluginMetaLogger.instance.info { "Loaded jekyll_href v#{JekyllHrefVersion::VERSION} plugin." }
-Liquid::Template.register_tag('href', ExternalHref)

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