jekyll_href 1.0.13 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6a4d85b016759a94f6242ea415a19cb5870f1e3b51e7f4c5141f95f6c817877
-  data.tar.gz: 072b91a1e7919924daecb086549caaad4f30a071a88b9ad4b32c81d92056d946
+  metadata.gz: e77bc04770e6fae8eeb1a595be3e3faf81fe6c77c023a9a711a3a97d51b3a828
+  data.tar.gz: c9ff34ea2c4611fefb8f36e99471ad55a490b60d68c255fbcc06ce3791acc90e
 SHA512:
-  metadata.gz: e816084465970281cfc16416f2cfcd30807d6f318833d9dfa39e2a48f178f3e0aa865f1ef5e53b4b6be90160fe9d0a6647cbb2eb166254953711e210c82e1fd4
-  data.tar.gz: 146e99be071aeae009e47dff919265b569bc4d314a4239a87d02606d4a8d72522096be01379fda529fbe194120202ae1f298b4a541686e554f95dd2632a8f40b
+  metadata.gz: 9727eed971f210d18ab6826a297b5563bf899ab1c14bbd9a988fa31405d1521357ca6fa48894ab3dfacfda11371f025c83908ed5ef1519ce7fb04ba9f25605d9
+  data.tar.gz: e82fbe117198467601a940fbc24fd9a2a40ec802b263e43324cfaaca7467f8b704f16ad1dc6214a02154ba88f04006de7f9830c08a2857c49a8614515f016f4e

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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

@@ -10,7 +10,8 @@ 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 +24,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 +34,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 +45,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 +68,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`

data/lib/jekyll_href/version.rb

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

data/lib/jekyll_href.rb

@@ -77,7 +77,7 @@ class ExternalHref < Liquid::Tag # rubocop:disable Metrics/ClassLength
     abort msg.red
   end
 
-  def globals_initial(liquid_context)
+  def globals_initial(liquid_context) # rubocop:disable Metrics/MethodLength
     # Sets @follow, @helper, @match, @page, @path, @site, @target, @url
     @helper.liquid_context = liquid_context
 
@@ -88,11 +88,13 @@ class ExternalHref < Liquid::Tag # rubocop:disable Metrics/ClassLength
 
     @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
+  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
@@ -116,13 +118,13 @@ class ExternalHref < Liquid::Tag # rubocop:disable Metrics/ClassLength
     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

data/spec/href_spec.rb

@@ -61,6 +61,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 +174,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 +222,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/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/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.13
+  version: 1.0.14
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-18 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll