jekyll_href 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6d09a2fc7a319e4fb417c383b15bb97acfc644cd795fefeba3faa5cbcf83403
+  data.tar.gz: d0a2c065d042a1ff2cefb8a973849585fafe7d57da8f8dd512e7cf4ac6161257
+SHA512:
+  metadata.gz: 034224a848331a861479db283806d0736e355cc042fdac5829405158f4bc777a6c15af2cf07b79739eaa272d40a452e3267a528c801fb14ddbdaa4444d336edb
+  data.tar.gz: 18f59ff3419338872629d589adb3e9380fc963e9bda568afde8a45d8fbd8124a90bc7b45099262beaa67b8829708a9b762f93df3b9dfd29e0c0bb7a76aeb1740

data/.rubocop.yml

@@ -0,0 +1,31 @@
+require: rubocop-jekyll
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 1.0.0 / 2022-03-11
+  * Made into a Ruby gem and published on RubyGems.org as [jekyll_href](https://rubygems.org/gems/jekyll_href).
+  * `bin/attach` script added for debugging
+  * Rubocop standards added
+  * Proper versioning and CHANGELOG.md added
+
+## 0.1.0 / 2020-12-29
+  * Initial version published

data/Gemfile

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,69 @@
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Mike Slinn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# `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`.
+
+
+### Syntax:
+```
+{% 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.
+
+
+## Installation
+
+Add this line to your Jekyll website's `Gemfile`, within the `jekyll_plugins` group:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_href'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_href
+
+## Usage
+
+```
+{% href https://mslinn.com The Awesome %}
+```
+
+Expands to this:
+```html
+<a href='https://mslinn.com' target='_blank' rel='nofollow'>The Awesome</a>
+```
+
+Which renders as this: <a href='https://mslinn.com' target='_blank' rel='nofollow'>The Awesome</a>
+
+
+```
+{% href follow https://mslinn.com The Awesome %}
+```
+
+Expands to this:
+```html
+<a href='https://mslinn.com' target='_blank'>The Awesome</a>
+```
+
+
+```
+ {% href notarget https://mslinn.com The Awesome %}
+```
+
+Expands to this:
+```html
+<a href='https://mslinn.com' rel='nofollow'>The Awesome</a>
+```
+
+
+```
+{% href follow notarget https://mslinn.com The Awesome %}
+```
+
+Expands to this:
+```html
+<a href='https://mslinn.com'>The Awesome</a>
+```
+
+```
+{% href match setting-up-django-oscar.html tutorial site %}
+```
+
+Expands to this:
+```html
+<a href='/blog/2021/02/11/setting-up-django-oscar.html'>tutorial site</a>
+```
+
+
+## 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).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll_href.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/jekyll_href.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_href/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll_href"
+  spec.version = JekyllHref::VERSION
+  spec.authors = ["Mike Slinn"]
+  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.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  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"
+
+  # 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) }
+  spec.require_paths = ["lib"]
+
+  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'
+end

data/lib/jekyll_href/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllHref
+  VERSION = "1.0.0"
+end

data/lib/jekyll_href.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require_relative "jekyll_href/version"
+
+# @author Copyright 2020 Michael Slinn
+# @license SPDX-License-Identifier: Apache-2.0
+#
+# Generates an href.
+# Note that the url should not be enclosed in quotes.
+#
+# If the link starts with 'http' or `match` is specified:
+#   The link will open in a new tab or window
+#   The link will include `rel=nofollow` for SEO purposes.
+#
+# To suppress the `nofollow` attribute, preface the link with the word `follow`.
+# To suppress the `target` attribute, preface the link with the word `notarget`.
+#
+# The `match` option looks through the pages collection for a URL with containing the provided substring.
+# Match implies follow and notarget.
+#
+# If a section called plugin-vars exists then its name/value pairs are available for substitution.
+#   plugin-vars:
+#     django-github: 'https://github.com/django/django/blob/3.1.7'
+#     django-oscar-github: 'https://github.com/django-oscar/django-oscar/blob/3.0.2'
+#
+#
+# @example General form
+#   {% href [follow] [notarget] [match] url text to display %}
+#
+# @example Generates `nofollow` and `target` attributes.
+#   {% href https://mslinn.com The Awesome %}
+#
+# @example Does not generate `nofollow` or `target` attributes.
+#   {% href follow notarget https://mslinn.com The Awesome %}
+#
+# @example Does not generate `nofollow` attribute.
+#   {% href follow https://mslinn.com The Awesome %}
+#
+# @example Does not generate `target` attribute.
+#   {% href notarget https://mslinn.com The Awesome %}
+#
+# @example Matches page with URL containing abc.
+#   {% href match abc The Awesome %}
+# @example Matches page with URL containing abc.
+#   {% href match abc.html#tag The Awesome %}
+#
+# @example Substitute name/value pair for the django-github variable:
+# {% 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
+
+      follow_index = tokens.index("follow")
+      if follow_index
+        tokens.delete_at(follow_index)
+        @follow = ""
+      end
+
+      target_index = tokens.index("notarget")
+      if target_index
+        tokens.delete_at(target_index)
+        @target = ""
+      end
+
+      match_index = tokens.index("match")
+      if match_index
+        tokens.delete_at(match_index)
+        @follow = ""
+        @match = true
+        @target = ""
+      end
+
+      @link = tokens.shift
+
+      @text = tokens.join(" ").strip
+      if @text.empty?
+        @text = "<code>${@link}</code>"
+        @link = "https://#{@link}"
+      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
+    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)
+      end
+      link
+    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>"
+    end
+  end
+end
+
+Liquid::Template.register_tag('href', JekyllHref::ExternalHref)

data/sig/jekyll_href.rbs

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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_href
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  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: rubocop-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'
+description: Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'.
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+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
+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
+  changelog_uri: https://github.com/mslinn/jekyll_href/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key: 
+specification_version: 4
+summary: Generates an 'a href' tag, possibly with target='_blank' and rel='nofollow'.
+test_files: []