jekyll-glossary_tooltip 0.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f83067cb6ca64783230d5cbd9631e418b60fff839a7cdef44df1d1c7ec0412
-  data.tar.gz: 7f79aa92250c38f1650a4e5fdb9a2d1322f113a7689753270408312c12c928a4
+  metadata.gz: dc3418ab4d3f9ec90d2216634147be734c56f8f1dc0fb743ef2ae2fb32f1ab7a
+  data.tar.gz: 7d400181ba68bf52ace6e6dfd1c92f6e9b2fb53530e4929e7d79ad94465adc6f
 SHA512:
-  metadata.gz: e55ab549deddf53b0c1831d562f7814990da41e919a1686aa816390748a0c93ccee9368671b35346a9c0c352d58a4bd874501e270d13d62185642d4ff834b189
-  data.tar.gz: 969838c0f5cef1cd11786fb04c4d95d476d6974cac0ef3c04701c3b524e3dcdbcc9957d3ce19d09ec6f7df119b627a42cc67cc08a7dcff44ddf670d1a3bf3dcf
+  metadata.gz: 38abe820838fbeddd3380802102f47a5337fb1a772d6d453ba20f4112aa3c793a38e40c84fe8b2d51aa381263731df08fb9c8efe5348bfc18cfb94b283a83cf8
+  data.tar.gz: 47467bc867e32d924438fcce2e6047ec0b7e7683a220355616a6fcc41c9a9849d41c17424007e1b61a23fd22ab18bcec001ab0975dcc3b76b70706ac4351ca20

data/.rubocop.yml

@@ -68,12 +68,15 @@ Lint/UnreachableCode:
 Lint/UselessAccessModifier:
   Enabled: false
 
+Metrics/AbcSize:
+  Enabled: true
+  Max: 25
 Metrics/BlockLength:
   Enabled: true
   Max: 100
 Metrics/MethodLength:
   Enabled: true
-  Max: 15
+  Max: 25
 
 Naming/FileName:
   Enabled: false

data/CHANGELOG.md

@@ -1,2 +1,16 @@
+## [1.3.0] - 2021-08-07
+- Open the souce link from a tooltip in a new tab.
+
+## [1.2.0] - 2021-08-06
+- Add bottom arrow to the tooltip.
+- Restyle the glossary term bottom border style and color.
+- Add tooltip hover animation from invisible to visible.
+
+## [1.1.0] - 2021-08-06
+- Add optional `display:` argument to set a different term display name, rather than using the term name as defined in the glossary file. Usage: `{% glossary term_name, display: Different Name To Display %}`.
+
+## [1.0.0] - 2021-08-05
+- No changes from `v0.1.0` but just bumping to final first major release version!
+
 ## [0.1.0] - 2021-08-05
 - First release version. The plugin is fully working but I suspect that there might be a few point releases just to nail the release process. Once this is working, there will soon be an 1.0.0 release!

data/README.md

@@ -1,4 +1,4 @@
-# Jekyll Glossary Tooltip Tag Plugin UNRELEASED
+# Jekyll Glossary Tooltip Tag Plugin
 [![Gem Version](https://badge.fury.io/rb/jekyll-glossary_tooltip.svg)](https://badge.fury.io/rb/jekyll-glossary_tooltip)
 [![Gem Downloads](https://ruby-gem-downloads-badge.herokuapp.com/jekyll-glossary_tooltip?color=brightgreen&type=total&label=gem%20downloads)](https://rubygems.org/gems/jekyll-glossary_tooltip)
 [![Travis Build Status](https://img.shields.io/travis/erikw/jekyll-glossary_tooltip/main?logo=travis)](https://travis-ci.com/erikw/jekyll-glossary_tooltip)
@@ -7,7 +7,6 @@
 
 <img src="/img/tooltip_screenshot.png" width="256" align="right" alt="Screenshot of the glossary tooltip term definition" title="Example of tooltip definition of the term 'Jekyll'.">
 
-
 This plugin simplifies for your readers and you by making it easy to define terms or abbreviations that needs an explanation. Define a common dictionary of terms and their definition in a YAML file. Then inside markdown files you can use the provided glossary liquid tag to insert a tooltip for a defined word from the dictionary. The tooltip will show the term definition on mouse hover.
 
 It's also possible to provide an optional URL to further term definition or source reference. To also support mobile devices, this URL link is placed inside the tooltip pop-up itself, rather than making the term itself clickable. This is so that on mobile device, you will first tap the word to get the hover tooltip, then click the link in the tooltip if desired.
@@ -63,13 +62,22 @@ This could look something like:
 On any page where you've made sure include the needed CSS styling, you can use the glossary tag simply like
 
 ```markdown
-Here I'm taling about {% glossary term_name %} in a blog post.
+Here I'm talking about {% glossary term_name %} in a blog post.
 
-The term name can contain spaces like {% glossary operating system }.
+The term name can contain spaces like {% glossary operating system %}.
 
 Even if the term is defined in _data/glossary.yml as 'term_name', the matching is case-insensitive meaning that I can look it up using {% glossary TeRM_NaME %}. Note that the term is displayed as defined in the tag rather than the definition, here meaing 'TeRM_NaME'.
+
+The case-styling above works as there's still a case-insensitive match. But what about when you actually want to dispaly the term differently? Maybe the term is defined as "cat" but you want to use the plural "cats"? Then you can supply an optional `display` argument. The syntax is:
+{% glossary <term>, display: <diplay name> %}
+
+This could be e.g.
+{% glossary cat, display: cats %}
+{% glossary some term, display: some other display text %}
 ```
 
+**Note** that a term name can not contain a `,`, as this is the argument separator character.
+
 
 ## CSS Style Override
 Simply modify the rules [jekyll-glossary_tooltip.css](lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css) that you copied to your project. The tooltip is based on this [tutorial](https://www.w3schools.com/css/css_tooltip.asp). View the generated HTML output to see the HTML tags that are styled, or check the [tag.rb](lib/jekyll-glossary_tooltip/tag.rb) implementation in the method `render()`.
@@ -172,3 +180,9 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/erikw/
 
 # License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+# Acknowledgement
+Thanks to [ayastreb/jekyll-maps](https://github.com/ayastreb/jekyll-maps) for inspiration on project structure and options parsing!
+
+# More Jekyll
+Check out my other Jekyll repositories [here](https://github.com/erikw?tab=repositories&q=jekyll-&type=&language=&sort=).

data/lib/jekyll-glossary_tooltip.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "jekyll-glossary_tooltip/version"
+require_relative "jekyll-glossary_tooltip/options_parser"
 require_relative "jekyll-glossary_tooltip/tag"
+require_relative "jekyll-glossary_tooltip/version"
 
 module Jekyll
   # Module for the plugin.

data/lib/jekyll-glossary_tooltip/errors.rb

@@ -13,6 +13,15 @@ module Jekyll
         def initialize(term_name); super("The term '#{term_name}' was defined multiple times in the glossary") end
       end
       class NoGlossaryFile < StandardError; def initialize; super("No data.glossary found") end end
+      class OptionsNoTermNameInTag < StandardError
+        def initialize; super("No term name argument for the glossary tag supplied") end
+      end
+      class OptionsBadTagArgumentFormat < StandardError
+        def initialize(term_name); super("The glossary tag for term '#{term_name}' has a bad argument format") end
+      end
+      class OptionsUnknownTagArgument < StandardError
+        def initialize(arg); super("An unknown tag argument #{arg} was encountered") end
+      end
     end
   end
 end

data/lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css

@@ -2,7 +2,7 @@
 .jekyll-glossary {
   position: relative;
   display: inline-block;
-  border-bottom: 3px dotted blue;
+  border-bottom: 2px dotted #0074bd;
   cursor: help;
 }
 
@@ -36,3 +36,24 @@
 .jekyll-glossary-source-link:before {
   content: "[source]";  // "(reference)", "<link>" or whatever you want.
 }
+
+/* Arrow created with borders. */
+.jekyll-glossary .jekyll-glossary-tooltip::after {
+  content: " ";
+  position: absolute;
+  top: 100%;
+  left: 50%;
+  margin-left: -5px;
+  border-width: 5px;
+  border-style: solid;
+  border-color: black transparent transparent transparent;
+}
+
+/* Animation from invisible to visible on hover. */
+.jekyll-glossary .jekyll-glossary-tooltip {
+  opacity: 0;
+  transition: opacity 1s;
+}
+.jekyll-glossary:hover .jekyll-glossary-tooltip {
+  opacity: 1;
+}

data/lib/jekyll-glossary_tooltip/options_parser.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "jekyll-glossary_tooltip/errors"
+
+module Jekyll
+  module GlossaryTooltip
+    # Stripped down & modified version of
+    # https://github.com/ayastreb/jekyll-maps/blob/master/lib/jekyll-maps/options_parser.rb
+    class OptionsParser
+      ARGS_PATTERN = %r{\s*(\w[-_\w]*):\s*(\w[^,\n\r]*)}
+      ARGS_ALLOWED = %w[
+        display
+      ].freeze
+
+      class << self
+        def parse(raw_options)
+          options = {
+            term_query: nil,
+            display: nil
+          }
+          opt_segments = raw_options.strip.split(",")
+          raise Errors::OptionsNoTermNameInTag unless opt_segments.length.positive?
+
+          options[:term_query] = opt_segments[0]
+          opt_segments.shift
+
+          opt_segments.each do |opt_segment|
+            raise Errors::OptionsBadTagArgumentFormat, options[:term_name] unless opt_segment =~ ARGS_PATTERN
+
+            arg_name = Regexp.last_match(1)
+            arg_value = Regexp.last_match(2)
+            raise Errors::OptionsUnknownTagArgument, arg_name unless ARGS_ALLOWED.include?(arg_name)
+
+            options[arg_name.to_sym] = arg_value
+          end
+          options
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-glossary_tooltip/tag.rb

@@ -7,16 +7,17 @@ module Jekyll
   module GlossaryTooltip
     # Custom liquid tag implementation.
     class Tag < Liquid::Tag
-      def initialize(tag_name, text, tokens)
+      def initialize(tag_name, args, tokens)
         super
-        @term_query = text.strip
+        @opts = OptionsParser.parse(args)
       end
 
       def render(context)
-        entry = lookup_entry(context.registers[:site], @term_query)
+        entry = lookup_entry(context.registers[:site], @opts[:term_query])
+        @opts[:display] ||= @opts[:term_query]
         <<~HTML
           <span class="jekyll-glossary">
-             #{@term_query}
+             #{@opts[:display]}
              <span class="jekyll-glossary-tooltip">#{entry["definition"]}#{render_tooltip_url(entry)}</span>
           </span>
         HTML
@@ -29,7 +30,8 @@ module Jekyll
       def render_tooltip_url(entry)
         # The content of the anchor is set from the CSS class jekyll-glossary-source-link,
         # so that the plugin user can customize the text without touching ruby source.
-        entry["url"] ? "<br><a class=\"jekyll-glossary-source-link\" href=\"#{entry["url"]}\"></a>" : ""
+        anchor = "<br><a class=\"jekyll-glossary-source-link\" href=\"#{entry["url"]}\" target=\"_blank\"></a>"
+        entry["url"] ? anchor : ""
       end
 
       def lookup_entry(site, term_name)

data/lib/jekyll-glossary_tooltip/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GlossaryTooltip
-    VERSION = "0.1.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-glossary_tooltip
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Erik Westrup
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -68,6 +68,7 @@ files:
 - lib/jekyll-glossary_tooltip.rb
 - lib/jekyll-glossary_tooltip/errors.rb
 - lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css
+- lib/jekyll-glossary_tooltip/options_parser.rb
 - lib/jekyll-glossary_tooltip/tag.rb
 - lib/jekyll-glossary_tooltip/version.rb
 - script/build