jekyll_href 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6d09a2fc7a319e4fb417c383b15bb97acfc644cd795fefeba3faa5cbcf83403
-  data.tar.gz: d0a2c065d042a1ff2cefb8a973849585fafe7d57da8f8dd512e7cf4ac6161257
+  metadata.gz: 04b0c09f10bc5a0bb0bf261e2a3ddab3aea102e5d3514b5aef5abd3678f796c2
+  data.tar.gz: e30198e5c5a4a1a0faa1bc7fc56075a6689fd7686e953f297be17aca1f8c80fb
 SHA512:
-  metadata.gz: 034224a848331a861479db283806d0736e355cc042fdac5829405158f4bc777a6c15af2cf07b79739eaa272d40a452e3267a528c801fb14ddbdaa4444d336edb
-  data.tar.gz: 18f59ff3419338872629d589adb3e9380fc963e9bda568afde8a45d8fbd8124a90bc7b45099262beaa67b8829708a9b762f93df3b9dfd29e0c0bb7a76aeb1740
+  metadata.gz: 6e5d0d5b784d7e4bcaa3869515598c61587e081880d6d1a0a642797a245dcc461f066999b11216ee48f727dabf4f57a765b5bb38841909c36dc5e7a41a099dbc
+  data.tar.gz: 5f795dbcd6f8548799ceeabf2ede0edc2e2f2be6a9e958e148825d2672cff6c1fdd3cb32877413148c2e2b97f753948794a9da3bdfa804aaa09ad83ab70efa4c

data/.rubocop.yml

@@ -9,6 +9,9 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
 
+Gemspec/RequireMFA:
+  Enabled: false
+
 Layout/LineLength:
   Max: 150
 

data/README.md

@@ -1,19 +1,26 @@
-# `Jekyll_href`
+`Jekyll_href`
+[![Gem Version](https://badge.fury.io/rb/jekyll_href.svg)](https://badge.fury.io/rb/jekyll_href)
+===========
 
 `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.
 
 
 ### Syntax:
 ```
-{% href [match | [follow] [notarget]] url text to display %}
+{% href [match | [follow] [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.
 
 
+### 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).
+
+
 ## Installation
 
 Add this line to your Jekyll website's `Gemfile`, within the `jekyll_plugins` group:
@@ -34,6 +41,7 @@ Or install it yourself as:
 
 ## Usage
 
+### Defaults
 ```
 {% href https://mslinn.com The Awesome %}
 ```
@@ -45,7 +53,7 @@ Expands to this:
 
 Which renders as this: <a href='https://mslinn.com' target='_blank' rel='nofollow'>The Awesome</a>
 
-
+### `follow`
 ```
 {% href follow https://mslinn.com The Awesome %}
 ```
@@ -56,6 +64,7 @@ Expands to this:
 ```
 
 
+### `notarget`
 ```
  {% href notarget https://mslinn.com The Awesome %}
 ```
@@ -66,6 +75,7 @@ Expands to this:
 ```
 
 
+### `follow notarget`
 ```
 {% href follow notarget https://mslinn.com The Awesome %}
 ```
@@ -75,26 +85,55 @@ Expands to this:
 <a href='https://mslinn.com'>The Awesome</a>
 ```
 
+### `match`
+Looks for a post with a matching URL.
 ```
 {% href match setting-up-django-oscar.html tutorial site %}
 ```
 
-Expands to this:
+Might expand to this:
 ```html
 <a href='/blog/2021/02/11/setting-up-django-oscar.html'>tutorial site</a>
 ```
 
+### URI
+```html
+{% href mslinn.com %}
+```
+Expands to this:
+```html
+<a href='https://mslinn.com' target='_blank' rel='nofollow'><code>mslinn.com</code></a>
+```
+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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Install development dependencies like this:
+```
+$ BUNDLE_WITH="development" bundle install
+```
+
+To install this gem onto your local machine, run:
+```shell
+$ bundle exec rake install
+```
+
+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.
+  3. Run the following:
+     ```shell
+     $ bundle exec rake release
+     ```
+     The above creates a git tag for the version, commits the created tag,
+     and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll_href.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mslinn/jekyll_href.
 
 
 ## License

data/jekyll_href.gemspec

@@ -3,38 +3,42 @@
 require_relative "lib/jekyll_href/version"
 
 Gem::Specification.new do |spec|
-  spec.name = "jekyll_href"
-  spec.version = JekyllHref::VERSION
+  github = "https://github.com/mslinn/jekyll_href"
+
   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.summary = "Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'."
-  spec.description = "Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'."
-  spec.homepage = "https://github.com/mslinn/jekyll_href"
+  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.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  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,
+  }
+  spec.name = "jekyll_href"
+  spec.post_install_message = <<~END_MESSAGE
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/mslinn/jekyll_href"
-  spec.metadata["changelog_uri"] = "https://github.com/mslinn/jekyll_href/CHANGELOG.md"
+    Thanks for installing #{spec.name}!
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  END_MESSAGE
   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 = JekyllHref::VERSION
+
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_plugin_logger'
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-jekyll'
+  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,5 @@
 # frozen_string_literal: true
 
 module JekyllHref
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/jekyll_href.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "jekyll_plugin_logger"
+require "liquid"
 require_relative "jekyll_href/version"
 
 # @author Copyright 2020 Michael Slinn
@@ -48,101 +50,102 @@ require_relative "jekyll_href/version"
 # {% href {{django-github}}/django/core/management/__init__.py#L398-L401
 #   <code>django.core.management.execute_from_command_line</code> %}
 
-module JekyllHref
-  class Error < StandardError; end
-
-  class ExternalHref < Liquid::Tag
-    # @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 tokens [Liquid::ParseContext] tokenized command line
-    # @return [void]
-    def initialize(tag_name, command_line, tokens) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      super
-
-      @follow = " rel='nofollow'"
-      @match = false
-      @target = " target='_blank'"
-
-      tokens = command_line.strip.split
+class ExternalHref < Liquid::Tag
+  # @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 tokens [Liquid::ParseContext] tokenized command line
+  # @return [void]
+  def initialize(tag_name, command_line, tokens)
+    super
+
+    @match = false
+    @tokens = command_line.strip.split
+    @follow = get_value("follow", " rel='nofollow'")
+    @target = get_value("notarget", " target='_blank'")
+    @logger = PluginMetaLogger.instance.new_logger(self)
+
+    match_index = tokens.index("match")
+    if match_index
+      tokens.delete_at(match_index)
+      @follow = ""
+      @match = true
+      @target = ""
+    end
 
-      follow_index = tokens.index("follow")
-      if follow_index
-        tokens.delete_at(follow_index)
-        @follow = ""
-      end
+    finalize tokens
+  end
 
-      target_index = tokens.index("notarget")
-      if target_index
-        tokens.delete_at(target_index)
-        @target = ""
-      end
+  # Method prescribed by the Jekyll plugin lifecycle.
+  # @return [String]
+  def render(context)
+    match(context) if @match
+    link = replace_vars(context, @link)
+    @logger.debug { "@link=#{@link}; link=#{link}" }
+    "<a href='#{link}'#{@target}#{@follow}>#{@text}</a>"
+  end
 
-      match_index = tokens.index("match")
-      if match_index
-        tokens.delete_at(match_index)
-        @follow = ""
-        @match = true
-        @target = ""
-      end
+  private
 
-      @link = tokens.shift
+  def finalize(tokens)
+    @link = tokens.shift
 
-      @text = tokens.join(" ").strip
-      if @text.empty?
-        @text = "<code>${@link}</code>"
-        @link = "https://#{@link}"
-      end
+    @text = tokens.join(" ").strip
+    if @text.empty?
+      @text = "<code>${@link}</code>"
+      @link = "https://#{@link}"
+    end
 
-      unless @link.start_with? "http"
-        @follow = ""
-        @target = ""
-      end
+    unless @link.start_with? "http"
+      @follow = ""
+      @target = ""
     end
+  end
 
-    def match(context) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
-      site = context.registers[:site]
-      config = site.config['href']
-      die_if_nomatch = !config.nil? && config['nomatch'] && config['nomatch']=='fatal'
-
-      path, fragment = @link.split('#')
-
-      # puts "@link=#{@link}"
-      # puts "site.posts[0].url = #{site.posts.docs[0].url}"
-      # puts "site.posts[0].path = #{site.posts.docs[0].path}"
-      posts = site.posts.docs.select { |x| x.url.include?(path) }
-      case posts.length
-      when 0
-        if die_if_nomatch
-          abort "href error: No url matches '#{@link}'"
-        else
-          @link = "#"
-          @text = "<i>#{@link} is not available</i>"
-        end
-      when 1
-        @link = "#{@link}\##{fragment}" if fragment
-      else
-        abort "Error: More than one url matched: #{ matches.join(", ")}"
-      end
+  def get_value(token, default_value)
+    value = default_value
+    target_index = tokens.index(token)
+    if target_index
+      @tokens.delete_at(target_index)
+      value = ""
     end
+    value
+  end
 
-    def replace_vars(context, link)
-      variables = context.registers[:site].config['plugin-vars']
-      variables.each do |name, value|
-        # puts "#{name}=#{value}"
-        link = link.gsub("{{#{name}}}", value)
+  def match(context) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    site = context.registers[:site]
+    config = site.config['href']
+    die_if_nomatch = !config.nil? && config['nomatch'] && config['nomatch']=='fatal'
+
+    path, fragment = @link.split('#')
+
+    @logger.debug { "@link=#{@link}" }
+    @logger.debug { "site.posts[0].url  = #{site.posts.docs[0].url}" }
+    @logger.debug { "site.posts[0].path = #{site.posts.docs[0].path}" }
+    posts = site.posts.docs.select { |x| x.url.include?(path) }
+    case posts.length
+    when 0
+      if die_if_nomatch
+        abort "href error: No url matches '#{@link}'"
+      else
+        @link = "#"
+        @text = "<i>#{@link} is not available</i>"
       end
-      link
+    when 1
+      @link = "#{@link}\##{fragment}" if fragment
+    else
+      abort "Error: More than one url matched: #{ matches.join(", ")}"
     end
+  end
 
-    # Method prescribed by the Jekyll plugin lifecycle.
-    # @return [String]
-    def render(context)
-      match(context) if @match
-      link = replace_vars(context, @link)
-      # puts "@link=#{@link}; link=#{link}"
-      "<a href='#{link}'#{@target}#{@follow}>#{@text}</a>"
+  def replace_vars(context, link)
+    variables = context.registers[:site].config['plugin-vars']
+    variables.each do |name, value|
+      # puts "#{name}=#{value}"
+      link = link.gsub("{{#{name}}}", value)
     end
+    link
   end
 end
 
-Liquid::Template.register_tag('href', JekyllHref::ExternalHref)
+PluginMetaLogger.instance.info { "Loaded jeykll_href v#{JekyllHref::VERSION} plugin." }
+Liquid::Template.register_tag('href', ExternalHref)

metadata

@@ -1,65 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.5.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: jekyll_plugin_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: debase
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-jekyll
+  name: ruby-debug-ide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,7 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'.
+description: 'Generates an ''a href'' tag, possibly with target=''_blank'' and rel=''nofollow''.
+
+'
 email:
 - mslinn@mslinn.com
 executables: []
@@ -103,24 +77,25 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - jekyll_href.gemspec
 - lib/jekyll_href.rb
 - lib/jekyll_href/version.rb
-- sig/jekyll_href.rbs
-homepage: https://github.com/mslinn/jekyll_href
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#href
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org/
-  homepage_uri: https://github.com/mslinn/jekyll_href
-  source_code_uri: https://github.com/mslinn/jekyll_href
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_href/issues
   changelog_uri: https://github.com/mslinn/jekyll_href/CHANGELOG.md
-post_install_message: 
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#href
+  source_code_uri: https://github.com/mslinn/jekyll_href
+post_install_message: |2+
+
+  Thanks for installing jekyll_href!
+
 rdoc_options: []
 require_paths:
 - lib
@@ -135,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'.

data/Gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in jekyll_href.gemspec
-gemspec
-
-gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jekyll_href (1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    coderay (1.1.3)
-    diff-lcs (1.5.0)
-    method_source (1.0.0)
-    parallel (1.21.0)
-    parser (3.1.1.0)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.18.4)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.8.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    rubocop-jekyll (0.12.0)
-      rubocop (~> 1.18.0)
-      rubocop-performance (~> 1.2)
-    rubocop-performance (1.13.3)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  bundler
-  jekyll_href!
-  pry
-  rake (~> 13.0)
-  rspec
-  rubocop
-  rubocop-jekyll
-
-BUNDLED WITH
-   2.3.7

data/sig/jekyll_href.rbs

@@ -1,4 +0,0 @@
-module JekyllHref
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end