jekyll_href 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9419e6938b722e6707825cca7dad7e1fe17393cdc5cf4af11b66b39c0a64d368
-  data.tar.gz: f9dcabb8b9ba97cfc61de15cb7692143d5eb781e6089b8d3bef43e9dfa1569c4
+  metadata.gz: 57a2b255f64c147c2b16d784a3ff1045643164f980bd997e7c2ee7a832e42016
+  data.tar.gz: 4d484a1e4ec6548b0c913847fe4b179406bd5b76865cb2a5cb7a6de36c8624c4
 SHA512:
-  metadata.gz: 1fa6194e1d9edbd1600b12196ea62e4b7665b7c64c64f5341028f572b2a9660c2f8aa02c269771e8af60652af084a37e44616ea76cae8489141bf0f5da26a33b
-  data.tar.gz: 19845ac86ce700501d3b6a0217202597ba60c0a01994ef39c3190dc5c5f8f15d799660aa1a81c9e12f6a281430e997c92458b6342d52df6cc36e73dc9fd68c0e
+  metadata.gz: 9ab2372473793d3df613028f89533ebba7951b75ba54c8fd6da78fd70368d68cc969bcd11d1b1cd3ca5b88ef381001dcab15b85c65336481fe288372cf7dc370
+  data.tar.gz: 8cf2cf1a53f87197dea0dcabacf60766953f368d4d6c4a3e786bd29a0c128fb577c96b3a246f559ee26a2dd5e5952a7def825234af2375113f909c8a318fa956

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.2.8 / 2023-12-31
+
+* Fixed missing ' rel="nofollow"' for links without labels.
+
 
 ## 1.2.7 / 2023-12-09
 

data/jekyll_href.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_all_collections', '>= 0.3.3'
   spec.add_dependency 'jekyll_plugin_support', '>= 0.8.1'
+  spec.add_dependency 'typesafe_enum'
 end

data/lib/enums.rb

@@ -0,0 +1,21 @@
+require 'typesafe_enum'
+
+class LinkType < TypesafeEnum::Base
+  new :EXTERNAL
+  new :FRAGMENT
+  new :LOCAL
+  new :MAILTO
+  new :UNKNOWN
+end
+
+class LabelSource < TypesafeEnum::Base
+  new :FROM_PAGE_TITLE
+  new :FROM_EXPLICIT_LABEL
+  new :FROM_IMPLICIT_LABEL
+end
+
+class Hyphenation < TypesafeEnum::Base
+  new :NONE
+  new :SHY
+  new :WBR
+end

data/lib/hash_array.rb

@@ -10,7 +10,11 @@ module HashArray
     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}"
+        @logger.warn <<~END_WARN
+          HRef tags for '#{href.link}' have inconsistent 'follow' keyword options on line #{href.line_number} of #{enclosing_page}:
+            Previous value: #{pre_existing.follow}
+             Current value: #{href.follow}
+        END_WARN
       end
     else
       hash[enclosing_page] << href unless href.summary_exclude

data/lib/href_match.rb

@@ -18,15 +18,10 @@ module MSlinn
       end
     end
 
-    def handle_match
-      match_post
+    def handle_match(link)
       @follow = ''
       @target = '' unless @blank
-    end
-
-    # Might set @link and @text
-    def match_post
-      @path, @fragment = @link.split('#')
+      @path, @fragment = link.split('#')
 
       @logger.debug do
         <<~END_DEBUG

data/lib/href_page_title.rb

@@ -8,17 +8,17 @@ module MSlinn
       all_pages = @site.all_collections + @site.pages
       pages = if @match
                 all_pages.select { |page| page.url&.include? path }
-              elsif @label_source == :from_page_title
+              elsif @label_source == LabelSource::FROM_PAGE_TITLE
                 all_pages.select { |page| page.url == path }
               end
       pages&.first
     end
 
+    # Handles links to Jekyll pages
+    # Uses the linked page title as the link text
     def handle_page_title(linkk)
       @follow = @target = ''
-      @external_link = linkk.start_with? 'http'
-      @local_link = !@external_link
-      raise HRefError, 'href tags with page_title require local links.' unless @local_link
+      raise HRefError, 'href tags with page_title require local links.' unless @link_type == LinkType::LOCAL
 
       page = find_page linkk
       unless page
@@ -27,22 +27,7 @@ module MSlinn
         raise HRefError, msg
       end
       @text = @label = page.title
-    rescue HRefError => e
-      msg = format_error_message "#{e.message}\n<pre>  {% href #{@argument_string.strip} %}</pre>"
-      @text = "<div class='href_error'>#{msg}</div>"
-      @link = linkk
-
-      e.shorten_backtrace
-      @logger.error { "#{e.class} raised #{JekyllPluginHelper.remove_html_tags msg}" }
-      raise e if @die_on_href_error
-
-      "<div class='href_error'>HRefError raised in #{self.class};\n#{msg}</div>"
-    ensure
-      if @text.to_s.empty?
-        handle_empty_text linkk
-      else
-        handle_text linkk
-      end
+      handle_empty_text linkk if @text.to_s.empty?
       @label
     end
   end

data/lib/href_private.rb

@@ -10,7 +10,7 @@ module MSlinn
       if linkk.nil? || !linkk
         linkk = @helper.argv&.shift
         @helper.params&.shift
-        @helper.keys_values&.delete(linkk)
+        @helper.keys_values&.delete linkk
         return nil, error_no_uri if linkk.nil?
       elsif @url.to_s.empty?
         return nil, error_no_uri
@@ -29,32 +29,42 @@ module MSlinn
       "<div class='href_error'>HRefError: #{msg}</div>"
     end
 
-    # Sets @follow, @helper, @match, @path, @shy, @target, @url, @wbr
+    # Sets @follow, @helper, @match, @path, @target, @url, @hyphenation
     def globals_initial
       @path = @page['path']
-      AllCollectionsHooks.compute(@site)
-
-      @blank           = @helper.parameter_specified? 'blank'
-      @klass           = @helper.parameter_specified? 'class'
-      @follow          = @helper.parameter_specified?('follow') ? '' : " rel='nofollow'"
-      @label           = @helper.parameter_specified? 'label'
-      @match           = @helper.parameter_specified? 'match'
-      @shy             = @helper.parameter_specified? 'shy'
-      @style           = @helper.parameter_specified? 'style'
-      @summary         = @helper.parameter_specified? 'summary'
-      @summary_exclude = @helper.parameter_specified? 'summary_exclude'
-      @target          = @blank ? " target='_blank'" : nil
-      @target        ||= @helper.parameter_specified?('notarget') ? '' : " target='_blank'"
-      @url             = @helper.parameter_specified? 'url'
-      @wbr             = @helper.parameter_specified? 'wbr'
-
-      @label_source    = if @helper.parameter_specified? 'page_title'
-                           :from_page_title
-                         elsif @label
-                           :from_explicit_label
-                         else
-                           :from_implicit_label
-                         end
+      AllCollectionsHooks.compute @site
+      @hyphenation      = Hyphenation::NONE
+
+      @blank            = @helper.parameter_specified? 'blank'
+      @klass            = @helper.parameter_specified? 'class'
+      @follow_specified = @helper.parameter_specified?('follow')
+      @follow           = @follow_specified ? '' : ' rel="nofollow"'
+      @label            = @helper.parameter_specified? 'label'
+      @match            = @helper.parameter_specified? 'match'
+      @hyphenation      = Hyphenation::SHY if @helper.parameter_specified? 'shy'
+      @style            = @helper.parameter_specified? 'style'
+      @summary          = @helper.parameter_specified? 'summary'
+      @summary_exclude  = @helper.parameter_specified? 'summary_exclude'
+      @target           = @blank ? " target='_blank'" : nil
+      @target         ||= @helper.parameter_specified?('notarget') ? '' : " target='_blank'"
+      @url              = @helper.parameter_specified? 'url'
+
+      if @helper.parameter_specified? 'wbr' # <wbr> has precedence over &shy;
+        if @hyphenation == Hyphenation::SHY
+          @logger.info do
+            "Warning: wbr and shy were both specified for the href tag on line #{@line_number} (after front matter) of #{@page['path']}"
+          end
+        end
+        @hyphenation = Hyphenation::WBR
+      end
+
+      @label_source = if @helper.parameter_specified? 'page_title'
+                        LabelSource::FROM_PAGE_TITLE
+                      elsif @label
+                        LabelSource::FROM_EXPLICIT_LABEL
+                      else
+                        LabelSource::FROM_IMPLICIT_LABEL
+                      end
 
       return unless @tag_config
 
@@ -63,42 +73,45 @@ module MSlinn
       @pry_on_href_error = @tag_config['pry_on_href_error'] == true
     end
 
-    # Might set @external_link, @follow, @local_link, @linkk, @target, and @text
+    # Sets @link_type
+    # Might set @follow, @link, @link_save and @text
     def globals_update(tokens, linkk)
+      @link_type = LinkType::UNKNOWN
+
       if linkk.start_with? 'mailto:'
         handle_mailto linkk
         return
-      else
-        if @label_source == :from_page_title
-          handle_page_title linkk
-          return
-        end
-        @text = @label || tokens.join(' ').strip
-        if @text.to_s.empty?
-          handle_empty_text linkk
-        else
-          handle_text linkk
-        end
-        @link_save = @link
       end
 
-      if @external_link
-        @target = ''
-        return
-      end
-      @follow = ''
-      @target = '' unless @blank
+      @link_type = if linkk.start_with? 'http'
+                     LinkType::EXTERNAL
+                   elsif linkk.start_with? '#'
+                     LinkType::FRAGMENT
+                   else
+                     LinkType::LOCAL
+                   end
+
+      @follow = !@follow_specified && @link_type == LinkType::EXTERNAL ? ' rel="nofollow"' : ''
+
+      handle_page_title linkk if @label_source == LabelSource::FROM_PAGE_TITLE
+      @text = @label || tokens.join(' ').strip
+      @link = if @text.to_s.empty?
+                handle_empty_text linkk
+              else
+                linkk
+              end
+      @link_save = @link
+      return if @link_type == LinkType::EXTERNAL
+
+      @follow = @target = ''
+      nil
     end
 
+    # Sets @text and @link
     def handle_empty_text(linkk)
-      text = linkk
-      text = linkk&.gsub('/', '/&shy;') if @shy
-      text = linkk&.gsub('/', '/<wbr>') if @wbr
+      text = hyphenate linkk
       @text = "<code>#{text}</code>"
-      @external_link = linkk.start_with? 'http'
-      @local_link = !@external_link
-      @mailto_link = false
-      @link = if @external_link
+      @link = if linkk.start_with? '#'
                 linkk
               elsif insecure_ip_address linkk
                 "http://#{linkk}"
@@ -108,29 +121,28 @@ module MSlinn
     end
 
     def handle_mailto(linkk)
-      @mailto_link = true
-      @local_link = @external_link = false
+      @link_type = LinkType::MAILTO
       @link = linkk
       @target = @follow = ''
-      @text = @helper.argv.join(' ')
+      @text = @label || @helper.argv.join(' ')
       return unless @text.empty?
 
-      text = linkk.delete_prefix('mailto:')
+      text = hyphenate(linkk.delete_prefix('mailto:'))
       @text = "<code>#{text}</code>"
     end
 
-    def handle_text(linkk)
-      @link = if @shy
-                linkk&.gsub('/', '/&shy;')
-              elsif @wbr
-                linkk&.gsub('/', '/<wbr>')
-              else
-                linkk
-              end
+    def hyphenate(linkk)
+      if @hyphenation == Hyphenation::WBR
+        linkk&.gsub('/', '/<wbr>')
+      elsif @hyphenation == Hyphenation::SHY
+        linkk&.gsub('/', '/&shy;')
+      else
+        linkk
+      end
     end
 
     def insecure_ip_address(string)
-      return true if string.start_with? 'localhost'
+      return true if string.start_with?('localhost', 'http://localhost')
 
       return false unless IPAddress.valid? string
 

data/lib/href_summary.rb

@@ -6,9 +6,9 @@ module MSlinn
       return if @summary_exclude || @link_save.start_with?('mailto:') || @link_save.start_with?('#')
 
       @summary = @summary.to_s.empty? ? @text : @summary.to_s
-      if @summary == true
+      if @summary.to_s == 'true'
         warning = <<~END_WARNING
-          Warning: a href plugin keyword option was detected in the link text for #{@path} on line #{line_number}.
+          Warning: The 'summary' href plugin keyword option was detected in the link text for #{@path} on line #{line_number}.
           The href tag will not be included in the summary, and the link text will not have the word summary included.
           This is probably unintentional. Consider using the label option to correct this problem."
         END_WARNING

data/lib/href_tag.rb

@@ -3,6 +3,7 @@ require 'jekyll_all_collections'
 require 'jekyll_plugin_logger'
 require 'jekyll_plugin_support'
 require 'liquid'
+require_relative 'enums'
 require_relative 'jekyll_href/version'
 require_relative 'hash_array'
 
@@ -45,14 +46,17 @@ module MSlinn
 
       @helper_save = @helper.clone
       globals_update(@helper.argv, linkk) # Sets @link and @text, might clear @follow and @target
-      handle_match if @match
+      handle_match(@link) if @match
+      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
-      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

data/lib/jekyll_href/version.rb

@@ -1,3 +1,3 @@
 module JekyllHrefVersion
-  VERSION = '1.2.7'.freeze
+  VERSION = '1.2.8'.freeze
 end

data/lib/jekyll_href.rb

@@ -1,7 +1,7 @@
 require_relative 'href_tag'
 require_relative 'href_summary_tag'
 
-HrefError = Class.new(Liquid::Error)
+HrefError = Class.new Liquid::Error
 
 module JekyllHrefModule
   include MSlinn

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-27 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ipaddress
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: typesafe_enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Generates an ''a href'' tag, possibly with target=''_blank'' and rel=''nofollow''.
 
   '
@@ -81,6 +95,7 @@ files:
 - README.md
 - Rakefile
 - jekyll_href.gemspec
+- lib/enums.rb
 - lib/hash_array.rb
 - lib/href_match.rb
 - lib/href_page_title.rb