jekyll_href 1.2.11 → 1.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79cf3cccc7fc8072d6b2f7ae73d59845633f48026e0d0923d9749fbdcdd75ddf
-  data.tar.gz: 3e93f0d18068f86997210ddd93a3d90f899f28d82dd130c08177f4c70915e315
+  metadata.gz: 15395e432574a69be4a28def40f3c20bf199fa762f8ca94155408e864921c406
+  data.tar.gz: 4d7385465ad6ddd8b9f52c6efbb62f7fd757015d10f23017e63639ddfc8e6670
 SHA512:
-  metadata.gz: acafa56a136b24199a00febabfc2ff420974ae0d3e09eb6a772ce482691adc1709a765cc7a8e78ce7160eff6c819da8e72350c52160a8dc0c615cef4ee4063dc
-  data.tar.gz: c0c4e34adb9ef314b270f742860ee52ddcc82855f031693233ae8516d69e86c107bd0ed415958a872356e52e3afae58f5e82c53a4d43d5a8ae03a992b7f53adb
+  metadata.gz: 595817a332ef1fe8044249f075efc94a8fc6ba4f284ba2d97ef504d72cabf63799831c808e8450fe6c935d859c5296dda3805e42fd3ada764be2fe2c9985b616
+  data.tar.gz: 07b1e783d4b0015097229fda3a2257fdfc8b7b523673f212bdde3c7423eb889badd30a6f36b57c3dcd95eaea321f1f48cdd9db90f96cee167852b6f9b8aa4341

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 1.2.13 / 2024-12-23
+
+* Fixed reference to undefined `url_matches`.
+* References that point to draft pages are rendered differently in production mode,
+  and an info-level log message is generated.
+
+
+## 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
 

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

@@ -3,15 +3,15 @@ require_relative 'lib/jekyll_href/version'
 Gem::Specification.new do |spec|
   github = 'https://github.com/mslinn/jekyll_href'
 
-  spec.authors = ['Mike Slinn']
-  spec.bindir = 'exe'
+  spec.authors     = ['Mike Slinn']
+  spec.bindir      = 'exe'
   spec.description = <<~END_OF_DESC
     Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'.
   END_OF_DESC
-  spec.email = ['mslinn@mslinn.com']
-  spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.email    = ['mslinn@mslinn.com']
+  spec.files    = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
   spec.homepage = 'https://www.mslinn.com/jekyll_plugins/jekyll_href.html'
-  spec.license = 'MIT'
+  spec.license  = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
     'bug_tracker_uri'   => "#{github}/issues",
@@ -19,20 +19,21 @@ Gem::Specification.new do |spec|
     'homepage_uri'      => spec.homepage,
     'source_code_uri'   => github,
   }
-  spec.name = 'jekyll_href'
+  spec.name                 = 'jekyll_href'
+  spec.platform             = Gem::Platform::RUBY
   spec.post_install_message = <<~END_MESSAGE
 
     Thanks for installing #{spec.name}!
 
   END_MESSAGE
-  spec.require_paths = ['lib']
+  spec.require_paths         = ['lib']
   spec.required_ruby_version = '>= 2.6.0'
-  spec.summary = "Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'."
-  spec.version = JekyllHrefVersion::VERSION
+  spec.summary               = "Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'."
+  spec.version               = JekyllHrefVersion::VERSION
 
   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.3'
   spec.add_dependency 'typesafe_enum'
 end

data/lib/href_match.rb

@@ -2,19 +2,24 @@ 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 a valid local page</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}':\n  #{page_matches.map(&:url).join("\n  ")}" }
+        exit! 2
       end
     end
 
@@ -31,8 +36,7 @@ module JekyllSupport
         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_private.rb

@@ -26,7 +26,7 @@ module JekyllSupport
           <pre>{% href #{@argument_string.strip} %}</pre>
       END_MESSAGE
       @logger.error { JekyllSupport::JekyllPluginHelper.remove_html_tags msg.strip }
-      "<div class='href_error'>HRefError: #{msg}</div>"
+      "<div class='h_ref_error'>HRefError: #{msg}</div>"
     end
 
     # Sets @follow, @helper, @match, @path, @target, @url, @hyphenation

data/lib/href_summary.rb

@@ -29,7 +29,7 @@ module JekyllSupport
         summary_exclude: @summary_exclude,
         summary_href:    @summary_href
       )
-      if @link_save.start_with? 'http'
+      if @link_type == LinkType::EXTERNAL
         add_global_link_for_page mini_href
       else
         add_local_link_for_page mini_href

data/lib/href_summary_tag.rb

@@ -40,13 +40,10 @@ module JekyllSupport
         #{@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

data/lib/href_tag.rb

@@ -1,4 +1,5 @@
 require 'ipaddress'
+require 'jekyll_draft'
 require 'jekyll_all_collections'
 require 'jekyll_plugin_logger'
 require 'jekyll_plugin_support'
@@ -46,29 +47,55 @@ module JekyllSupport
 
       @helper_save = @helper.clone
       globals_update(@helper.argv, linkk) # Sets @link and @text, might clear @follow and @target
-      handle_match(@link) if @match
+      handle_match(linkk) if @match # Sets @text if not set by now, also @link_type, etc.
       raise HrefError, '@link_type was not set' if @link_type == LinkType::UNKNOWN
 
       save_summary
       klass = " class='#{@klass}'" if @klass
       style = " style='#{@style}'" if @style
+      if @link_type == LinkType::LOCAL && local_page_draft?(@link)
+        klass = "draft_link #{klass}".strip
+        return "<span #{klass}#{style} title='This page is not available yet.'>#{@text}</span>" if @mode == 'production'
+      end
+
       "<a href='#{@link}'#{klass}#{style}#{@target}#{@follow}>#{@text}</a>"
     rescue HRefError => e # jekyll_plugin_support handles StandardError
-      msg = format_error_message e.message
-      msg = "#{msg}\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
-
-      "<div class='href_error'>#{e.class} raised in #{self.class};\n#{msg}</div>"
+      @logger.error { e.logger_message }
+      exit 1 if @die_on_demo_tag_error
+
+      e.html_message
     end
 
     def to_s
       "On line #{line_number} of #{path}: #{follow} #{match} #{target} #{link} => '#{text}'"
     end
 
+    def local_page_draft?(url)
+      filetype = File.extname url
+      page_matches = @site.all_collections.map.select { |page| page.url == url }
+      case page_matches.length
+      when 0
+        return false unless %w[htm html md].include? filetype
+
+        msg = "HRef error: No url matches '#{url}', found on line #{@line_number} (after front matter)"
+        @logger.error { msg }
+        abort msg if @die_if_nomatch
+
+        @text = "<i class='h_ref_error'>#{url} is not a valid local page</i>"
+        @link_save = @link = '#'
+        true
+      when 1
+        @link = page_matches.first.url
+        @link = "#{@link}##{@fragment}" if @fragment
+        @link_save = @link
+        @text = page_matches.first.title unless @label
+        Jekyll::Draft.draft? page_matches.first
+      else
+        logger.error { "Error: More than one url matched '#{url}'. Collections are: #{page_matches.join(', ')}" }
+        exit! 2
+      end
+    end
+
     JekyllSupport::JekyllPluginHelper.register(self, 'href')
   end
 end

data/lib/jekyll_href/version.rb

@@ -1,3 +1,3 @@
 module JekyllHrefVersion
-  VERSION = '1.2.11'.freeze
+  VERSION = '1.2.13'.freeze
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.2.11
+  version: 1.2.13
 platform: ruby
 authors:
 - Mike Slinn
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-27 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ipaddress
@@ -58,14 +57,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: typesafe_enum
   requirement: !ruby/object:Gem::Requirement
@@ -136,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.0
 specification_version: 4
 summary: Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'.
 test_files: []