jekyll_href 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e9e6357f4c5f4d4dd7815aab9142ab5dadfbc48b3ba719fdc6b1cd70265d3d3
-  data.tar.gz: '068d3c6821f1f8578fee4331179be452ad50fdfd620cc990a0dbdb1359f605cc'
+  metadata.gz: f273b4ad20431d42f67bd6a8bba43823e158b4239d385951371e5511f31483f6
+  data.tar.gz: 13ce74af244bd5d9d26c44a7ebeb340126f729f084cddf04c75d0b79e83e973e
 SHA512:
-  metadata.gz: d4411b3c9cfad7062eb75206f487e6e1a5589874479ae09815d044177069fd567b069875b9fabd4018dc9aafed9dc5dcc656354917c90935311ee958b6c1d5c2
-  data.tar.gz: abc4e78a0745ab9f455c5e1a1f85d0a41aa85c242f155c8d064503d5682df69806ef98c06c838833d37b1d3468713d5a21e798b7bf33570d48e2e27f76450fb8
+  metadata.gz: 69169786943109c5f2fb288a430d247f8fa3a46b4d94c78607c012f3a9abd4116f38e66a4071e11c8bb53e8d21e7b3efe716aaf32d7a93c73d670026a24038bc
+  data.tar.gz: b37d5401822827f70f9b1e00f5eef1e93f8cab00c97a808409d71e6f173d99c0dc7bab5e33c07c2e41b98d47a2749a2e9e771588f167c8b269fa50b07c47cc96

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.2.3 / 2023-05-16
+  * Added `label` option.
+
 ## 1.2.2 / 2023-03-25
   * Added **References** capability:
     * Added `summary_exclude` keyword option to `href` tag.

data/README.md

@@ -85,6 +85,15 @@ If both are specified, `blank` prevails.
 ### `follow`
 To suppress the `nofollow` attribute, preface the link with the word `follow`.
 
+### `label='whatever you want'`
+If the text to be linked contains an optional keyword argument,
+for example `summary`, that word will be removed from the displayed link text,
+unless the link text is provided via the `label` option.
+Both of the following produce the same output:
+```
+{% href https://mslinn.com label="This is a summary" %}
+{% href label="This is a summary" https://mslinn.com %}
+```
 
 ### `notarget`
 To suppress the `target` attribute, preface the link with the word `notarget`.
@@ -130,6 +139,7 @@ Expands to:
 ### `summary`
 The `summary` name/value option provides an override for the linked text in the **References** section
 generated by the `{% href_summary %}` tag.
+If the value is the empty string, or no value is provided, the `href` tag is not included in the page summary.
 
 
 ### `summary_exclude`

data/lib/href_tag.rb

@@ -55,6 +55,17 @@ module HrefTag
       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
+        warning = <<~END_WARNING
+          Warning: a 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
+        puts warning.red
+        return
+      end
+      return if @summary.class != String || @summary.empty?
+
       @summary = @summary[0].upcase + @summary[1..]
       @summary_href = "<a href='#{@link_save}'#{@target}#{@follow}>#{@summary}</a>"
       mini_href = MiniHref.new(
@@ -109,9 +120,10 @@ module HrefTag
       @path = @page['path']
       AllCollectionsHooks.compute(@site)
 
+      @blank           = @helper.parameter_specified? 'blank'
       @follow          = @helper.parameter_specified?('follow') ? '' : " rel='nofollow'"
       @match           = @helper.parameter_specified? 'match'
-      @blank           = @helper.parameter_specified? 'blank'
+      @label           = @helper.parameter_specified? 'label'
       @summary_exclude = @helper.parameter_specified? 'summary_exclude'
       @shy             = @helper.parameter_specified? 'shy'
       @summary         = @helper.parameter_specified? 'summary'
@@ -133,7 +145,7 @@ module HrefTag
         end
         return
       else
-        @text = tokens.join(' ').strip
+        @text = @label || tokens.join(' ').strip
         if @text.to_s.empty?
           text = linkk
           text = linkk.gsub('/', '/&shy;') if @shy

data/lib/jekyll_href/version.rb

@@ -1,3 +1,3 @@
 module JekyllHrefVersion
-  VERSION = '1.2.2'.freeze
+  VERSION = '1.2.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-13 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll