jekyll_href 1.0.12 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33ad179cd8d6770d3828246bdc51cdbe398f7fd3f50b0101481e2dacd597191e
-  data.tar.gz: 543a944799bdb811fd84f3afb4ce0b8239e2008208feb0612360307bd1843c69
+  metadata.gz: e77bc04770e6fae8eeb1a595be3e3faf81fe6c77c023a9a711a3a97d51b3a828
+  data.tar.gz: c9ff34ea2c4611fefb8f36e99471ad55a490b60d68c255fbcc06ce3791acc90e
 SHA512:
-  metadata.gz: be0fd539b076cedb893cee10a528f4a3c71d2ec01e84c16a26455ec4c4aacded321bc11f96ac8ff5d6647b2cdf3692aba9bb843e419d67c54aab9a47edb63ff9
-  data.tar.gz: f2d3abce3b08922eefa404905d1f61f319150662f891dd03171e716479d16e068e4e2a02b9975b5f609716f942876ee9b7d542d14236dba141fb4fcaa6e3ce66
+  metadata.gz: 9727eed971f210d18ab6826a297b5563bf899ab1c14bbd9a988fa31405d1521357ca6fa48894ab3dfacfda11371f025c83908ed5ef1519ce7fb04ba9f25605d9
+  data.tar.gz: e82fbe117198467601a940fbc24fd9a2a40ec802b263e43324cfaaca7467f8b704f16ad1dc6214a02154ba88f04006de7f9830c08a2857c49a8614515f016f4e

data/.rubocop.yml

@@ -1,6 +1,6 @@
-require: rubocop-jekyll
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
+#require: rubocop-jekyll
+#inherit_gem:
+#  rubocop-jekyll: .rubocop.yml
 
 AllCops:
   Exclude:
@@ -9,8 +9,11 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
 
-Gemspec/RequireMFA:
-  Enabled: false
+# Gemspec/RequireMFA:
+#   Enabled: false
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
 
 Layout/LineLength:
   Max: 150
@@ -32,3 +35,6 @@ Style/StringLiterals:
 
 Style/StringLiteralsInInterpolation:
   Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.0.14 / 2023-01-09
+  * Added `blank` parameter.
+
+## 1.0.13 / 2022-12-14
+  * Links with embedded spaces are now supported when the new 'url' named parameter is used. For example, instead of specifying:
+    ```
+    {% href http://link.com with space.html some text %}
+    ```
+    Instead specify (single and double quotes are equally valid):
+    ```
+    {% href url="http://link.com with space.html" some text %}
+    ```
+  * URLs can now contain environment variable references. For example, if $domain and $uri are environment variables:
+    ```
+    {% href url="http://$domain.html" some text %}
+    {% href url="$uri" some text %}
+    ```
+
 ## 1.0.12 / 2022-08-09
   * No longer abends if `plugin-vars` is not present in `_config.yml`
 

data/README.md

@@ -3,24 +3,134 @@
 ===========
 
 `Jekyll_href` is a Jekyll plugin that provides a new Liquid tag: `href`.
-The Liquid tag generates and `<a href>` HTML tag, by default containing `target="_blank"` and `rel=nofollow`.
-To suppress the `nofollow` attribute, preface the link with the word `follow`.
-To suppress the `target` attribute, preface the link with the word `notarget`.
-Also provides a convenient way to generate formatted and clickable URIs.
+It provides a convenient way to generate formatted and clickable URIs.
+The Liquid tag generates an `a href` HTML tag, which by default contains `target="_blank"` and `rel=nofollow`.
+
+If the url starts with `http`, or the `match` keyword is specified:
+ - The url will open in a new tab or window.
+ - The url will include `rel=nofollow` for SEO purposes.
+
+CAUTION: if linked text contains a single or double quote you will see the error message: `Liquid Exception: Unmatched quote`.
+Instead, use &apos; (`&apos;`), &quot; (`&quot;`), &lsquo; (`&lsquo;`), &rsquo; (`&rsquo;`), &ldquo; (`&ldquo;`), and &rdquo; (`&rdquo;`)
+
+In `_config.yml`, if a section called `plugin-vars` exists,
+then its name/value pairs are available for substitution.
+```yaml
+  plugin-vars:
+    django-github: 'https://github.com/django/django/blob/3.1.7'
+    django-oscar-github: 'https://github.com/django-oscar/django-oscar/blob/3.0.2'
+```
 
 
-### Syntax:
+## Syntax 1 (requires `url` does not have embedded spaces):
 ```
-{% href [match | [follow] [notarget]] [url] text to display %}
+{% href [match | [follow] [blank|notarget]] url text to display %}
 ```
-Note that the url should not be enclosed in quotes.
-Also please note that the square brackets denote optional parameters, and should not be typed.
+ 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.
 
-`match` will attempt to match the url fragment (specified as a regex) to a URL in any collection.
-If multiple documents have matching URL an error is thrown.
+
+## Syntax 2 (always works):
+This syntax is recommended when the URL contains a colon (:).
+```
+{% href [match | [follow] [blank|notarget]]
+  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.
+  3. The square brackets denote optional keyword parameters, and should not be typed.
+
+
+## Syntax 3 (implicit URL):
+```
+{% href [match | [follow] [blank|notarget]] www.domain.com %}
+```
+The URI provided, for example `www.domain.com`,
+is used to form the URL by prepending `https://`,
+in this case the result would be `https://www.domain.com`.
+The displayed URI is enclosed in `<code></code>`,
+so the resulting text is `<code>www.domain.com</code>`.
+
+
+## Environment Variable Expansion
+URLs can contain environment variable references.
+For example, if `$domain`, `$uri` and `$USER` are environment variables:
+```
+{% href http://$domain.html some text %}
+
+{% href url="$uri" some text %}
+
+{% href https://mslinn.html <code>USER=$USER</code> %}
+```
+
+## Optional Parameters
+### `blank`
+The `target='_blank'` attribute is not normally generated for relative links.
+To enforce the generation of this attribute, preface the link with the word `blank`.
+The `blank` and `notarget` parameters are mutually exclusive.
+If both are specified, `blank` prevails.
+
+### `follow`
+To suppress the `nofollow` attribute, preface the link with the word `follow`.
+
+
+### `notarget`
+To suppress the `target` attribute, preface the link with the word `notarget`.
+The `blank` and `notarget` parameters are mutually exclusive.
+If both are specified, `blank` prevails.
 
 
-### Additional Information
+### `match`
+`match` will attempt to match the url fragment (specified as a regex) to a URL in any collection.
+If multiple documents have matching URL an error is thrown.
+The `match` option looks through the pages collection for a URL with containing the provided substring.
+`Match` implies `follow` and `notarget`.
+
+
+## Examples
+ 1. Generates `nofollow` and `target` attributes:
+    ```
+    {% href https://mslinn.com The Awesome %}
+    ```
+
+ 2. Does not generate `nofollow` or `target` attributes.
+    ```
+    {% href follow notarget https://mslinn.com The Awesome %}
+    ```
+
+ 3. Does not generate `nofollow` attribute.
+    ```
+    {% href follow https://mslinn.com The Awesome %}
+    ```
+
+ 4. Does not generate `target` attribute.
+    ```
+    {% href notarget https://mslinn.com The Awesome %}
+    ```
+
+ 5. Matches page with URL containing abc.
+    ```
+    {% href match abc The Awesome %}
+    ```
+
+ 6. Matches page with URL containing abc.
+    ```
+    {% href match abc.html#tag The Awesome %}
+    ```
+
+ 7. Substitute name/value pair for the `django-github` variable defined above:
+    ```
+    {% href {{django-github}}/django/core/management/__init__.py#L398-L401
+      <code>django.core.management.execute_from_command_line</code> %}
+    ```
+    Substitutions are only made to the URL, not to the linked text.
+
+
+## Additional Information
 More information is available on my web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
 
 
@@ -42,9 +152,10 @@ Or install it yourself as:
 
     $ gem install jekyll_href
 
-## Usage
 
-### Defaults
+## Generated HTML
+
+### Without Keywords
 ```
 {% href https://mslinn.com The Awesome %}
 ```
@@ -56,7 +167,7 @@ Expands to this:
 
 Which renders as this: <a href='https://mslinn.com' target='_blank' rel='nofollow'>The Awesome</a>
 
-### `follow`
+### With `follow`
 ```
 {% href follow https://mslinn.com The Awesome %}
 ```
@@ -67,7 +178,7 @@ Expands to this:
 ```
 
 
-### `notarget`
+### With `notarget`
 ```
  {% href notarget https://mslinn.com The Awesome %}
 ```
@@ -78,7 +189,7 @@ Expands to this:
 ```
 
 
-### `follow notarget`
+### With `follow notarget`
 ```
 {% href follow notarget https://mslinn.com The Awesome %}
 ```
@@ -88,7 +199,7 @@ Expands to this:
 <a href='https://mslinn.com'>The Awesome</a>
 ```
 
-### `match`
+### With `match`
 Looks for a post with a matching URL.
 ```
 {% href match setting-up-django-oscar.html tutorial site %}
@@ -109,6 +220,7 @@ Expands to this:
 ```
 Which renders as: [`mslinn.com`](https://mslinn.com)
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -123,6 +235,21 @@ To install this gem onto your local machine, run:
 $ bundle exec rake install
 ```
 
+## Test
+A test web site is provided in the `demo` directory.
+ 1. Set breakpoints.
+
+ 2. Initiate a debug session from the command line:
+    ```shell
+    $ bin/attach demo
+    ```
+
+  3. Once the `Fast Debugger` signon appears, launch the test configuration called `Attach rdebug-ide`.
+
+  4. View the generated website at [`http://localhost:4444`](http://localhost:4444)
+
+
+## Release
 To release a new version,
   1. Update the version number in `version.rb`.
   2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.

data/jekyll_href.gemspec

@@ -36,6 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_all_collections'
   spec.add_dependency 'jekyll_plugin_logger'
+  spec.add_dependency 'key-value-parser'
+  spec.add_dependency 'shellwords'
 
   # spec.add_development_dependency 'debase'
   # spec.add_development_dependency 'rubocop-jekyll'

data/lib/jekyll_href/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllHrefVersion
-  VERSION = "1.0.12"
+  VERSION = "1.0.14"
 end

data/lib/jekyll_href.rb

@@ -1,136 +1,145 @@
 # frozen_string_literal: true
 
-require "jekyll_plugin_logger"
 require "jekyll_all_collections"
+require "jekyll_plugin_logger"
 require "liquid"
 require_relative "jekyll_href/version"
+require_relative './jekyll_tag_helper2'
 
 # @author Copyright 2020 Michael Slinn
 # @license SPDX-License-Identifier: Apache-2.0
-#
 # Generates an href.
-# Note that the url should not be enclosed in quotes.
-#
-# If the link starts with 'http' or `match` is specified:
-#   The link will open in a new tab or window
-#   The link will include `rel=nofollow` for SEO purposes.
-#
-# To suppress the `nofollow` attribute, preface the link with the word `follow`.
-# To suppress the `target` attribute, preface the link with the word `notarget`.
-#
-# The `match` option looks through the pages collection for a URL with containing the provided substring.
-# Match implies follow and notarget.
-#
-# If a section called plugin-vars exists then its name/value pairs are available for substitution.
-#   plugin-vars:
-#     django-github: 'https://github.com/django/django/blob/3.1.7'
-#     django-oscar-github: 'https://github.com/django-oscar/django-oscar/blob/3.0.2'
-#
-#
-# @example General form
-#   {% href [follow] [notarget] [match] url text to display %}
-#
-# @example Generates `nofollow` and `target` attributes.
-#   {% href https://mslinn.com The Awesome %}
-#
-# @example Does not generate `nofollow` or `target` attributes.
-#   {% href follow notarget https://mslinn.com The Awesome %}
-#
-# @example Does not generate `nofollow` attribute.
-#   {% href follow https://mslinn.com The Awesome %}
-#
-# @example Does not generate `target` attribute.
-#   {% href notarget https://mslinn.com The Awesome %}
-#
-# @example Matches page with URL containing abc.
-#   {% href match abc The Awesome %}
-# @example Matches page with URL containing abc.
-#   {% href match abc.html#tag The Awesome %}
-#
-# @example Substitute name/value pair for the django-github variable:
-# {% href {{django-github}}/django/core/management/__init__.py#L398-L401
-#   <code>django.core.management.execute_from_command_line</code> %}
-
-class ExternalHref < Liquid::Tag
+
+# 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 command_line [Hash, String, Liquid::Tag::Parser] the arguments from the web page.
-  # @param _parse_context [Liquid::ParseContext] tokenized command line
+  # @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, command_line, _parse_context)
+  def initialize(tag_name, markup, _tokens)
     super
+    markup = '' if markup.nil?
+    markup.strip!
 
     @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
-    @match = false
-    @tokens = command_line.strip.split
-    @follow = get_value("follow", " rel='nofollow'")
-    @target = get_value("notarget", " target='_blank'")
-
-    match_index = @tokens.index("match")
-    if match_index
-      @tokens.delete_at(match_index)
-      @follow = ""
-      @match = true
-      @target = ""
-    end
-
-    finalize @tokens
+    @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)
-    @site = liquid_context.registers[:site]
-    JekyllAllCollections::maybe_compute_all_collections(@site)
-
-    match(liquid_context) if @match
-    link = replace_vars(liquid_context, @link)
-    @target = @follow = "" if link.start_with? "mailto:"
-    @logger.debug { "@link=#{@link}; link=#{link}" }
-    "<a href='#{link}'#{@target}#{@follow}>#{@text}</a>"
+    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
 
-  def finalize(tokens)
-    @link = tokens.shift
-
-    @text = tokens.join(" ").strip
-    if @text.empty?
-      @text = "<code>#{@link}</code>"
-      @link = "https://#{@link}"
+  def compute_linkk # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    # Does not look at or compute @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
 
-    unless @link.start_with? "http"
-      @follow = ""
-      @target = ""
-    end
+  def dump_linkk_relations(linkk) # rubocop:disable Metrics/MethodLength
+    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 get_value(token, default_value)
-    value = default_value
-    target_index = @tokens.index(token)
-    if target_index
-      @tokens.delete_at(target_index)
-      value = ""
+  def globals_initial(liquid_context) # rubocop:disable Metrics/MethodLength
+    # 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]
+    JekyllAllCollections.maybe_compute_all_collections(@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
+
+  def globals_update(tokens, linkk) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # Might set @follow, @linkk, @target, and @text
+    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
-    value
+
+    return if @link.start_with? "http"
+
+    @follow = ''
+    @target = '' unless @blank
   end
 
-  def match(liquid_context) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-    config = @site.config['href']
-    die_if_nomatch = !config.nil? && config['nomatch'] && config['nomatch']=='fatal'
+  def handle_match
+    match_post
+    @follow = ''
+    @target = '' unless @blank
+  end
 
+  def match_post # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    # Might set @link and @text
+    config = @site.config['href']
+    die_if_nomatch = !config.nil? && config['nomatch'] && config['nomatch'] == 'fatal'
     path, fragment = @link.split('#')
 
-    @logger.debug {
+    @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)
     url_matches = all_urls.select { |url| url.include? path }
@@ -143,20 +152,22 @@ class ExternalHref < Liquid::Tag
       @link = url_matches.first
       @link = "#{@link}\##{fragment}" if fragment
     else
-      abort "Error: More than one url matched '#{path}': #{ url_matches.join(", ")}"
+      abort "Error: More than one url matched '#{path}': #{url_matches.join(", ")}"
     end
   end
 
-  def replace_vars(liquid_context, link)
+  def replace_vars(text)
+    # Replace names in plugin-vars with values
     variables = @site.config['plugin-vars']
-    return link unless variables
+    return text unless variables
 
     variables.each do |name, value|
-      link = link.gsub "{{#{name}}}", value
+      text = text.gsub "{{#{name}}}", value
     end
-    link
+    @logger.debug { "@link=#{@link}" }
+    text
   end
 end
 
-PluginMetaLogger.instance.info { "Loaded jeykll_href v#{JekyllHrefVersion::VERSION} plugin." }
+PluginMetaLogger.instance.info { "Loaded jekyll_href v#{JekyllHrefVersion::VERSION} plugin." }
 Liquid::Template.register_tag('href', ExternalHref)

data/lib/jekyll_tag_helper2.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'key_value_parser'
+
+# Parses arguments and options
+class JekyllTagHelper2
+  attr_reader :argv, :keys_values, :liquid_context, :logger, :markup, :params, :tag_name
+
+  # Expand a environment variable reference
+  def self.expand_env(str, die_if_undefined: false)
+    str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
+      envar = Regexp.last_match(1)
+      raise HrefError, "jekyll_href error: #{envar} is undefined".red, [] \
+        if !ENV.key?(envar) && die_if_undefined # Suppress stack trace
+
+      ENV[envar]
+    end
+  end
+
+  # strip leading and trailing quotes if present
+  def self.remove_quotes(string)
+    string.strip.gsub(/\A'|\A"|'\Z|"\Z/, '').strip if string
+  end
+
+  def initialize(tag_name, markup, logger)
+    # @keys_values was a Hash[Symbol, String|Boolean] but now it is Hash[String, String|Boolean]
+    @tag_name = tag_name
+    @markup = markup # Useful for debugging
+    @argv = Shellwords.split(JekyllTagHelper2.expand_env(markup))
+    @keys_values = KeyValueParser \
+      .new({}, { array_values: false, normalize_keys: false, separator: /=/ }) \
+      .parse(@argv)
+    @logger = logger
+    @logger.debug { "@keys_values='#{@keys_values}'" }
+  end
+
+  def delete_parameter(key)
+    return if @keys_values.empty?
+
+    @params.delete(key)
+    @argv.delete_if { |x| x == key or x.start_with?("#{key}=") }
+    @keys_values.delete(key)
+  end
+
+  # @return if parameter was specified, removes it from the available tokens and returns value
+  def parameter_specified?(name)
+    return false if @keys_values.empty?
+
+    key = name
+    key = name.to_sym if @keys_values.first.first.instance_of?(Symbol)
+    value = @keys_values[key]
+    delete_parameter(name)
+    value
+  end
+
+  PREDEFINED_SCOPE_KEYS = %i[include page].freeze
+
+  # Finds variables defined in an invoking include, or maybe somewhere else
+  # @return variable value or nil
+  def dereference_include_variable(name)
+    @liquid_context.scopes.each do |scope|
+      next if PREDEFINED_SCOPE_KEYS.include? scope.keys.first
+
+      value = scope[name]
+      return value if value
+    end
+    nil
+  end
+
+  # @return value of variable, or the empty string
+  def dereference_variable(name)
+    value = @liquid_context[name] # Finds variables named like 'include.my_variable', found in @liquid_context.scopes.first
+    value ||= @page[name] if @page # Finds variables named like 'page.my_variable'
+    value ||= dereference_include_variable(name)
+    value ||= ''
+    value
+  end
+
+  # Sets @params by replacing any Liquid variable names with their values
+  def liquid_context=(context)
+    @liquid_context = context
+    @params = @keys_values.map { |k, _v| lookup_variable(k) }
+  end
+
+  def lookup_variable(symbol)
+    string = symbol.to_s
+    return string unless string.start_with?('{{') && string.end_with?('}}')
+
+    dereference_variable(string.delete_prefix('{{').delete_suffix('}}'))
+  end
+
+  def page
+    @liquid_context.registers[:page]
+  end
+end

data/spec/href_spec.rb

@@ -0,0 +1,273 @@
+# frozen_string_literal: true
+
+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
+
+# Lets get this party started
+class MyTest # rubocop:disable Metrics/ClassLength
+  Dir.chdir 'demo'
+
+  RSpec.describe ExternalHref do
+    let(:logger) do
+      PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+    end
+
+    let(:parse_context) { TestParseContext.new }
+
+    let(:helper) do
+      JekyllTagHelper2.new(
+        'href',
+        'mailto:j.smith@super-fake-merger.com',
+        logger
+      )
+    end
+
+    it "Obtains internal link with blank" do
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'blank ./path/page.html internal link text'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      expect(href.follow).to eq('')
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss  SoundCloud RSS Feed'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'url="https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss" SoundCloud RSS Feed'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'super-fake-merger.com'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        '{{github}}/diasks2/confidential_info_redactor <code>confidential_info_redactor</code>'.dup,
+        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)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'follow https://www.mslinn.com Awesome'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'follow notarget https://www.mslinn.com Awesome'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'blank https://www.mslinn.com Awesome'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'www.mslinn.com'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'follow notarget www.mslinn.com'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'follow blank www.mslinn.com'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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>')
+    end
+
+    it "Obtains mailto without text" do
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'mailto:mslinn@mslinn.com'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      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
+      href = ExternalHref.send(
+        :new,
+        'href',
+        'mailto:mslinn@mslinn.com Mike Slinn'.dup,
+        parse_context
+      )
+      href.send(:globals_initial, parse_context)
+      linkk = href.send(:compute_linkk)
+      href.send(:globals_update, href.helper.argv, linkk)
+      expect(href.follow).to eq('')
+      expect(href.link).to   eq('mailto:mslinn@mslinn.com')
+      expect(href.target).to eq('')
+      expect(href.text).to   eq('Mike Slinn')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "fileutils"
+require_relative "../lib/jekyll_href"
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.order = "random"
+  config.run_all_when_everything_filtered = true
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = "../spec/status_persistence.txt"
+
+  config.filter_run_when_matching focus: true
+end

data/spec/status_persistence.txt

@@ -0,0 +1,15 @@
+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  |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.14
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: key-value-parser
+  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'
+- !ruby/object:Gem::Dependency
+  name: shellwords
+  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''.
 
   '
@@ -69,6 +97,10 @@ files:
 - jekyll_href.gemspec
 - lib/jekyll_href.rb
 - lib/jekyll_href/version.rb
+- lib/jekyll_tag_helper2.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
 licenses:
 - MIT
@@ -100,5 +132,8 @@ rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'.
-test_files: []
+test_files:
+- spec/href_spec.rb
+- spec/spec_helper.rb
+- spec/status_persistence.txt
 ...