jekyll_href 1.0.13 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6a4d85b016759a94f6242ea415a19cb5870f1e3b51e7f4c5141f95f6c817877
-  data.tar.gz: 072b91a1e7919924daecb086549caaad4f30a071a88b9ad4b32c81d92056d946
+  metadata.gz: '0656497a33e45341646549dc55a45747f8418acd5f84298e145134bf7c10eec5'
+  data.tar.gz: 2c938cbc5e5f09bc2b8ea42ea11dde9d28e44e74512d7ebc203bccc2d127a8f6
 SHA512:
-  metadata.gz: e816084465970281cfc16416f2cfcd30807d6f318833d9dfa39e2a48f178f3e0aa865f1ef5e53b4b6be90160fe9d0a6647cbb2eb166254953711e210c82e1fd4
-  data.tar.gz: 146e99be071aeae009e47dff919265b569bc4d314a4239a87d02606d4a8d72522096be01379fda529fbe194120202ae1f298b4a541686e554f95dd2632a8f40b
+  metadata.gz: cdbdfe53569e693e1a81cb3e30b773cc239f81ce05f46ad2f20fe638dfef0777ca4cbcafd79ba9faedc9af1bb416f2a9628abbf8d82f423dd66ef36233059402
+  data.tar.gz: 1a74a3ace7f95d965a4db351501b908345257ab6138ab9ad3f4647499230e2d2a24fcd02c17fd0577376c913dc60cb3689b526046097a33a107ccea3ea3ce484

data/.rubocop.yml

@@ -21,7 +21,19 @@ Layout/LineLength:
 Layout/MultilineMethodCallIndentation:
   Enabled: false
 
-Metrics/BlockLength:
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Style/FrozenStringLiteralComment:
   Enabled: false
 
 Style/PercentLiteralDelimiters:

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.1.0 / 2023-02-03
+  * Updated to `jekyll_all_collections` plugin v0.2.0.
+  * Fixed insidious bug where a valid link was not used properly.
+
+## 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:
     ```

data/README.md

@@ -4,13 +4,17 @@
 
 `Jekyll_href` is a Jekyll plugin that provides a new Liquid tag: `href`.
 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`.
+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 ‘, ’, “, ”
+CAUTION: if linked text contains a single or double quote,
+you will see the error message: `Liquid Exception: Unmatched quote`.
+Instead, use ' (`'`), " (`"`), ‘ (`‘`),
+’ (`’`), “ (`“`), and ” (`”`)
 
 In `_config.yml`, if a section called `plugin-vars` exists,
 then its name/value pairs are available for substitution.
@@ -23,7 +27,7 @@ then its name/value pairs are available for substitution.
 
 ## 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 %}
 ```
  1. The url must be a single token, without embedded spaces.
  2. The url need not be enclosed in quotes.
@@ -33,10 +37,10 @@ then its name/value pairs are available for substitution.
 ## Syntax 2 (always works):
 This syntax is recommended when the URL contains a colon (:).
 ```
-{% href [match | [follow] [notarget]]
+{% href [match | [follow] [blank|notarget]]
   url="http://link.com with space.html" some text %}
 
-{% href [match | [follow] [notarget]]
+{% 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.
@@ -44,6 +48,17 @@ This syntax is recommended when the URL contains a colon (:).
   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:
@@ -56,12 +71,20 @@ For example, if `$domain`, `$uri` and `$USER` are environment variables:
 ```
 
 ## 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.
 
 
 ### `match`
@@ -111,7 +134,8 @@ The `match` option looks through the pages collection for a URL with containing
 
 
 ## 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).
+More information is available on my website about
+[my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
 
 
 ## Installation
@@ -128,10 +152,6 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
-
-    $ gem install jekyll_href
-
 
 ## Generated HTML
 
@@ -203,7 +223,8 @@ 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.
+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.
 
 Install development dependencies like this:
 ```
@@ -216,7 +237,7 @@ $ bundle exec rake install
 ```
 
 ## Test
-A test web site is provided in the `demo` directory.
+A test website is provided in the `demo` directory.
  1. Set breakpoints.
 
  2. Initiate a debug session from the command line:

data/Rakefile

@@ -1,4 +1,2 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
 task default: %i[]

data/jekyll_href.gemspec

@@ -1,47 +1,39 @@
-# frozen_string_literal: true
+require_relative 'lib/jekyll_href/version'
 
-require_relative "lib/jekyll_href/version"
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  github = 'https://github.com/mslinn/jekyll_href'
 
-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.homepage = "https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#href"
-  spec.license = "MIT"
+  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.license = 'MIT'
   spec.metadata = {
-    "allowed_push_host" => "https://rubygems.org",
-    "bug_tracker_uri"   => "#{github}/issues",
-    "changelog_uri"     => "#{github}/CHANGELOG.md",
-    "homepage_uri"      => spec.homepage,
-    "source_code_uri"   => github,
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{github}/issues",
+    'changelog_uri'     => "#{github}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => github,
   }
-  spec.name = "jekyll_href"
+  spec.name = 'jekyll_href'
   spec.post_install_message = <<~END_MESSAGE
 
     Thanks for installing #{spec.name}!
 
   END_MESSAGE
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.6.0"
+  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.test_files = spec.files.grep(%r!^(test|spec|features)/!)
   spec.version = JekyllHrefVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_all_collections'
+  spec.add_dependency 'jekyll_all_collections', '>= 0.2.0'
   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'
-  # spec.add_development_dependency 'rubocop-rake'
-  # spec.add_development_dependency 'rubocop-rspec'
-  # spec.add_development_dependency 'ruby-debug-ide'
 end

data/lib/jekyll_href/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module JekyllHrefVersion
-  VERSION = "1.0.13"
+  VERSION = '1.1.0'.freeze
 end

data/lib/jekyll_href.rb

@@ -1,9 +1,7 @@
-# frozen_string_literal: true
-
-require "jekyll_all_collections"
-require "jekyll_plugin_logger"
-require "liquid"
-require_relative "jekyll_href/version"
+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
@@ -49,8 +47,10 @@ class ExternalHref < Liquid::Tag # rubocop:disable Metrics/ClassLength
 
   private
 
-  def compute_linkk # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    # Does not look at or compute @link
+  # Does not look at or compute @link
+  def compute_linkk
+    return @link if @link
+
     linkk = @url
     if linkk.nil? || !linkk
       linkk = @helper.argv&.shift
@@ -63,7 +63,7 @@ class ExternalHref < Liquid::Tag # rubocop:disable Metrics/ClassLength
     linkk
   end
 
-  def dump_linkk_relations(linkk) # rubocop:disable Metrics/MethodLength
+  def dump_linkk_relations(linkk)
     msg = <<~END_MESSAGE
       jekyll_href error: no url was provided on #{@path}:#{@line_number}.
         @helper.markup=#{@helper.markup}
@@ -84,16 +84,18 @@ class ExternalHref < Liquid::Tag # rubocop:disable Metrics/ClassLength
     @page = liquid_context.registers[:page]
     @path = @page['path']
     @site = liquid_context.registers[:site]
-    JekyllAllCollections.maybe_compute_all_collections(@site)
+    AllCollectionsHooks.compute(@site)
 
     @follow = @helper.parameter_specified?('follow') ? '' : " rel='nofollow'"
     @match  = @helper.parameter_specified?('match')
-    @target = @helper.parameter_specified?('notarget') ? '' : " target='_blank'"
+    @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/MethodLength
-    # Might set @follow, @linkk, @target, and @text
+  # Might set @follow, @linkk, @target, and @text
+  def globals_update(tokens, linkk)
     if linkk.start_with? 'mailto:'
       @link = linkk
       @target = @follow = ''
@@ -104,7 +106,7 @@ class ExternalHref < Liquid::Tag # rubocop:disable Metrics/ClassLength
       end
       return
     else
-      @text = tokens.join(" ").strip
+      @text = tokens.join(' ').strip
       if @text.to_s.empty?
         @text = "<code>#{linkk}</code>"
         @link = "https://#{linkk}"
@@ -113,23 +115,23 @@ class ExternalHref < Liquid::Tag # rubocop:disable Metrics/ClassLength
       end
     end
 
-    return if @link.start_with? "http"
+    return if @link.start_with? 'http'
 
     @follow = ''
-    @target = ''
+    @target = '' unless @blank
   end
 
   def handle_match
     match_post
     @follow = ''
-    @target = ''
+    @target = '' unless @blank
   end
 
-  def match_post # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-    # Might set @link and @text
+  # 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('#')
+    @die_if_nomatch = !config.nil? && config['nomatch'] && config['nomatch'] == 'fatal'
+    @path, @fragment = @link.split('#')
 
     @logger.debug do
       <<~END_DEBUG
@@ -140,22 +142,26 @@ class ExternalHref < Liquid::Tag # rubocop:disable Metrics/ClassLength
     end
 
     all_urls = @site.all_collections.map(&:url)
-    url_matches = all_urls.select { |url| url.include? path }
+    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 = "#"
+      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
+      @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
 
+  # Replace names in plugin-vars with values
   def replace_vars(text)
-    # Replace names in plugin-vars with values
     variables = @site.config['plugin-vars']
     return text unless variables
 

data/lib/jekyll_tag_helper2.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'shellwords'
 require 'key_value_parser'
 

data/spec/href_spec.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 require 'jekyll_plugin_logger'
 require 'yaml'
@@ -61,6 +59,22 @@ class MyTest # rubocop:disable Metrics/ClassLength
       )
     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,
@@ -158,7 +172,39 @@ class MyTest # rubocop:disable Metrics/ClassLength
       expect(href.text).to   eq('Awesome')
     end
 
-    it "Obtains external link with follow and notarget but without text" do
+    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',
@@ -174,6 +220,22 @@ class MyTest # rubocop:disable Metrics/ClassLength
       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,

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "liquid"
 require "fileutils"
 require_relative "../lib/jekyll_href"

data/spec/status_persistence.txt

@@ -1,11 +1,15 @@
-example_id                                                       | status | run_time        |
----------------------------------------------------------------- | ------ | --------------- |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:1] | passed | 0.06693 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:2] | passed | 0.06422 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:3] | passed | 0.03492 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:4] | passed | 0.05285 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:5] | passed | 0.04698 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:6] | passed | 0.05677 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:7] | passed | 0.04366 seconds |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:8] | passed | 0.0328 seconds  |
-/mnt/f/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:9] | passed | 0.05795 seconds |
+example_id                                                        | status | run_time        |
+----------------------------------------------------------------- | ------ | --------------- |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:1]  | passed | 0.00581 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:2]  | passed | 0.00416 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:3]  | passed | 0.00401 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:4]  | passed | 0.00384 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:5]  | passed | 0.00401 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:6]  | passed | 0.00405 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:7]  | passed | 0.00501 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:8]  | passed | 0.00461 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:9]  | passed | 0.00397 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:10] | passed | 0.0039 seconds  |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:11] | passed | 0.00404 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:12] | passed | 0.00427 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_href/spec/href_spec.rb[1:13] | passed | 0.0041 seconds  |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.1.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-18 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: jekyll_plugin_logger
   requirement: !ruby/object:Gem::Requirement