jekyll_href 1.2.2 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e9e6357f4c5f4d4dd7815aab9142ab5dadfbc48b3ba719fdc6b1cd70265d3d3
-  data.tar.gz: '068d3c6821f1f8578fee4331179be452ad50fdfd620cc990a0dbdb1359f605cc'
+  metadata.gz: 13925ae2b44abe077101e5302d6aee8a640cdf3c50dcb4a29c76e2c355dae039
+  data.tar.gz: cf41c3a1c8424fc3e3ba67ccf6f27238e71766c72ed7006442291d855a933c4f
 SHA512:
-  metadata.gz: d4411b3c9cfad7062eb75206f487e6e1a5589874479ae09815d044177069fd567b069875b9fabd4018dc9aafed9dc5dcc656354917c90935311ee958b6c1d5c2
-  data.tar.gz: abc4e78a0745ab9f455c5e1a1f85d0a41aa85c242f155c8d064503d5682df69806ef98c06c838833d37b1d3468713d5a21e798b7bf33570d48e2e27f76450fb8
+  metadata.gz: afa3c62bf2806362a3e52d6978a8ea9ad3b5eb21e5f685b5328c04c0e19728e680a58961bd0daac805fcfbef1f031e98c6de769b085c9c8e4f058a209793c325
+  data.tar.gz: ce210b8cecefb1282991e9f4cca6ca5f80e7d94b9738f875f4848e9c445e24744e57c5a93f099e83362ed6e10448a38499f1907b96a04ef402db63710589f2aa

data/.rubocop.yml

@@ -64,7 +64,7 @@ Metrics/MethodLength:
   Max: 40
 
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 20
 
 Naming/FileName:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.2.4 / 2023-05-18
+  * When only a URI is provided, the plugin now generates the `http` scheme for IP4 & IP6 loopback addresses like 
+    `localhost`, and `127.0.0.0`, as well as private IP4 addresses like 192.168.0.0 and 172.16.0.0; 
+    otherwise it generates the `https` scheme.
+
+## 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/jekyll_href.gemspec

@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   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 'ipaddress'
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_all_collections', '~> 0.3.0', '>= 0.3.1'
   spec.add_dependency 'jekyll_plugin_support', '~> 0.6.0', '>= 0.6.1'

data/lib/href_tag.rb

@@ -1,3 +1,4 @@
+require 'ipaddress'
 require 'jekyll_all_collections'
 require 'jekyll_plugin_logger'
 require 'jekyll_plugin_support'
@@ -55,6 +56,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 +121,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,13 +146,19 @@ 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
           text = linkk.gsub('/', '/<wbr>') if @wbr
           @text = "<code>#{text}</code>"
-          @link = linkk.start_with?('http') ? linkk : "https://#{linkk}"
+          @link = if linkk.start_with?('http')
+                    linkk
+                  elsif insecure_ip_address linkk
+                    "http://#{linkk}"
+                  else
+                    "https://#{linkk}"
+                  end
         else
           @link = if @shy
                     linkk.gsub('/', '/&shy;')
@@ -198,6 +217,19 @@ module HrefTag
       end
     end
 
+    def insecure_ip_address(string)
+      return true if string.start_with? 'localhost'
+
+      return false unless IPAddress.valid? string
+
+      ip_address = IPAddress string
+      return true if ip_address.loopback? || ip_address.private?
+    rescue StandardError
+      false
+    ensure
+      false
+    end
+
     # Replace names in plugin-vars with values
     def replace_vars(text)
       variables = @site.config['plugin-vars']

data/lib/jekyll_href/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.4
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-13 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  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: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -119,9 +133,5 @@ 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:
-- spec/hash_array_spec.rb
-- spec/href_spec.rb
-- spec/spec_helper.rb
-- spec/status_persistence.txt
+test_files: []
 ...