jekyll_href 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6d09a2fc7a319e4fb417c383b15bb97acfc644cd795fefeba3faa5cbcf83403
-  data.tar.gz: d0a2c065d042a1ff2cefb8a973849585fafe7d57da8f8dd512e7cf4ac6161257
+  metadata.gz: d29ce08e7cf07fc3acbe97e979f72e74d5110a32e3005d56b3910519f8edee6b
+  data.tar.gz: 798085924055ba3509413dccef85dcd584c2d781c3d32403d03ce9125b163349
 SHA512:
-  metadata.gz: 034224a848331a861479db283806d0736e355cc042fdac5829405158f4bc777a6c15af2cf07b79739eaa272d40a452e3267a528c801fb14ddbdaa4444d336edb
-  data.tar.gz: 18f59ff3419338872629d589adb3e9380fc963e9bda568afde8a45d8fbd8124a90bc7b45099262beaa67b8829708a9b762f93df3b9dfd29e0c0bb7a76aeb1740
+  metadata.gz: 13184917dbf55acf5e84fa64b01bc3c8c7446a75c5db61eadeca5087ee8c701d031687ca1c7c9412c00472635691369d4cd44f70bb8ae56e4789aeba1afdc956
+  data.tar.gz: b83722150b30f7845e26e7c065f982230581813aaefd5fac19ec33fecc19ef759f089d23b18b52892e932e8cca228880d4c849168101441ff6e676e9f6c4145a

data/.rubocop.yml

@@ -12,6 +12,9 @@ AllCops:
 Layout/LineLength:
   Max: 150
 
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
 Layout/MultilineMethodCallIndentation:
   Enabled: false
 

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/.vscode/launch.json

@@ -0,0 +1,75 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "cwd": "${workspaceRoot}",
+      "name": "Attach rdebug-ide",
+      "request": "attach",
+      "remoteHost": "localhost",
+      "remotePort": "1234",
+      "remoteWorkspaceRoot": "/",
+      "restart": true,
+      "showDebuggerOutput": true,
+      "type": "Ruby",
+    },
+    {
+      "cwd": "${workspaceRoot}",
+      "debuggerPort": "1234",
+      "name": "Debug Jekyll",
+      "program": "/usr/local/bin/jekyll",
+                   "args": [
+                     "serve",
+                     "--livereload_port", "35721",
+                     "--force_polling",
+                     "--host", "0.0.0.0",
+                     "--port", "4001",
+                     "--future",
+                     "--incremental",
+                     "--livereload",
+                     "--drafts",
+                     "--unpublished"
+                   ],
+      "request": "launch",
+      "restart": true,
+      "showDebuggerOutput": true,
+      "stopOnEntry": true,
+      "type": "Ruby",
+    },
+    {
+      "name": "Debug Local Ruby",
+      "type": "Ruby",
+      "request": "launch",
+      "program": "${workspaceRoot}/main.rb"
+    },
+    {
+      "args": [
+        "-I",
+        "${workspaceRoot}",
+        "${file}"
+      ],
+      "cwd": "${workspaceRoot}",
+      "name": "RSpec - active spec file only",
+      "program": "/home/mslinn/.gems/bin/rspec",
+      "showDebuggerOutput": false,
+      "request": "launch",
+      "type": "Ruby",
+      "useBundler": true,
+    },
+    {
+      "args": [
+        "-I",
+        "${workspaceRoot}"
+      ],
+      "cwd": "${workspaceRoot}",
+      "name": "RSpec - all",
+      "program": "/home/mslinn/.gems/bin/rspec",
+      "request": "launch",
+      "showDebuggerOutput": false,
+      "type": "Ruby",
+      "useBundler": true,
+    }
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "ruby.rubocop.configFilePath": ".rubocop.yml",
+  "ruby.rubocop.useBundler": true
+}

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## HEAD / 2022-03-12
+  * Added unit tests
+
 ## 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

data/Gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in jekyll_href.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "rake"

data/Gemfile.lock

@@ -1,25 +1,76 @@
 PATH
   remote: .
   specs:
-    jekyll_href (1.0.0)
+    jekyll_href (1.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     coderay (1.1.3)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.9)
+    debase (0.2.4.1)
+      debase-ruby_core_source (>= 0.10.2)
+    debase-ruby_core_source (0.10.14)
     diff-lcs (1.5.0)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.15.5)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.8.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-sass-converter (2.2.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
     method_source (1.0.0)
     parallel (1.21.0)
     parser (3.1.1.0)
       ast (~> 2.4.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (4.0.6)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.2.1)
     rexml (3.2.5)
+    rouge (3.28.0)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -50,20 +101,33 @@ GEM
     rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-debug-ide (0.7.3)
+      rake (>= 0.8.1)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.8.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   bundler
+  debase
+  jekyll
   jekyll_href!
   pry
-  rake (~> 13.0)
+  rake
   rspec
   rubocop
   rubocop-jekyll
+  rubocop-rake
+  ruby-debug-ide
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -1,4 +1,6 @@
-# `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`.

data/Rakefile

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

data/jekyll_href.gemspec

@@ -32,9 +32,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'debase'
+  spec.add_development_dependency 'jekyll'
   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 'rubocop-rake'
+  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.2'
 end

data/lib/jekyll_href.rb

@@ -47,102 +47,139 @@ require_relative "jekyll_href/version"
 # @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'"
+  class HrefSetup
+    attr_reader :follow, :match_keyword, :tokens, :target, :text
 
-      tokens = command_line.strip.split
+    def initialize(tag_line, parse_context)
+      @tokens = tag_line.strip.split
+      @parse_context = parse_context
+      @follow = get_value('follow', " rel='nofollow'")
+      @target = get_value('notarget', " target='_blank'")
 
-      follow_index = tokens.index("follow")
-      if follow_index
-        tokens.delete_at(follow_index)
-        @follow = ""
+      @match_keyword = false
+      match_index = @tokens.index('match')
+      if match_index
+        context.delete_at(match_index)
+        @follow = ''
+        @match_keyword = true
+        @target = ''
       end
 
-      target_index = tokens.index("notarget")
-      if target_index
-        tokens.delete_at(target_index)
-        @target = ""
-      end
+      finalize
+    end
 
-      match_index = tokens.index("match")
-      if match_index
-        tokens.delete_at(match_index)
-        @follow = ""
-        @match = true
-        @target = ""
+    def replace_vars(variables)
+      variables.each do |name, value|
+        @link = @link.gsub("{{#{name}}}", value)
       end
+      @link
+    end
+
+    private
 
-      @link = tokens.shift
+    def finalize
+      @link = @tokens.shift
 
-      @text = tokens.join(" ").strip
+      @text = @tokens.join(' ').strip
       if @text.empty?
         @text = "<code>${@link}</code>"
         @link = "https://#{@link}"
       end
 
-      unless @link.start_with? "http"
-        @follow = ""
-        @target = ""
+      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'
+    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
+  end
 
-      path, fragment = @link.split('#')
+  class HrefRender
+    def initialize(context, href_setup)
+      @context = context
+      @site = @context.registers[:site]
+      @config = @site.config
+      @href_setup = href_setup
+      match(context) if @href_setup.match_keyword
+    end
+
+    def link
+      @href_setup.replace_vars @config['plugin-vars']
+    end
+
+    private
+
+    def handle_no_args
+      href_config = @config['href']
+      die_if_nomatch = !href_config.nil? &&
+                        href_config['nomatch'] &&
+                        href_config['nomatch'] == 'fatal'
+      if die_if_nomatch
+        abort "href error: No url matches '#{@link}'"
+      else
+        @link = "#"
+        @text = "<i>#{@link} is not available</i>"
+      end
+    end
 
-      # 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) }
+    def match
+      path, fragment = @link.split('#')
+      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
+        handle_no_args
       when 1
         @link = "#{@link}\##{fragment}" if fragment
       else
-        abort "Error: More than one url matched: #{ matches.join(", ")}"
+        abort "Error: More than one url matched: #{matches.join(", ")}"
       end
     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
+  class HrefTag < Liquid::Tag
+    # @param tag_name [String] is the name of the tag, which we already know.
+    # @param tag_line [Hash, String, Liquid::Tag::Parser] the contents between {% and %} in the web page (should be a string).
+    # @param parse_context [Liquid::ParseContext] looks like:
+    #   <Liquid::ParseContext:0x00005595446e5800
+    #     @template_options={
+    #       :line_numbers=>true,
+    #       :locale=>#<Liquid::I18n:0x00005595446e5760 @path="/home/mslinn/.gems/gems/liquid-4.0.3/lib/liquid/locales/en.yml">},
+    #     @locale=#<Liquid::I18n:0x00005595446e5760
+    #     @path="/home/mslinn/.gems/gems/liquid-4.0.3/lib/liquid/locales/en.yml">,
+    #     @warnings=[],
+    #     @depth=0,
+    #     @partial=false,
+    #     @options={:line_numbers=>true, :locale=>#<Liquid::I18n:0x00005595446e5760
+    #     @path="/home/mslinn/.gems/gems/liquid-4.0.3/lib/liquid/locales/en.yml">},
+    #     @error_mode=:strict,
+    #     @line_number=9,
+    #     @trim_whitespace=false>
+    # @return [void]
+    def initialize(tag_name, tag_line, parse_context)
+      super
+      @href_setup = HrefSetup.new(tag_line, parse_context)
     end
 
     # Method prescribed by the Jekyll plugin lifecycle.
+    # @param context [Liquid::Context] Context keeps the variable stack and resolves variables, as well as keywords
     # @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>"
+      href_render = HrefRender.new(context, @href_setup)
+      "<a href='#{href_render.link}'#{@href_setup.target}#{@href_setup.follow}>#{@href_setup.text}</a>"
     end
   end
 end
 
-Liquid::Template.register_tag('href', JekyllHref::ExternalHref)
+Liquid::Template.register_tag('href', JekyllHref::HrefTag)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_href
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Mike Slinn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debase
+  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: 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
@@ -94,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-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: ruby-debug-ide
+  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
@@ -102,6 +158,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".ruby-version"
+- ".vscode/launch.json"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock