jekyll-glossary_tooltip 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27106561fba42677dd2324409e4cf8ad78dfdf8e0bfa598e2c8a4a5aff25583e
-  data.tar.gz: 9aef06b73017f60dc04bebc53b38e1a06cd46d24572440a7b5b5d3a52f987aba
+  metadata.gz: 83377b31e4fd2496cf08adebb7cafb28291c10c26d45261dcdcfab8048d3eb18
+  data.tar.gz: 5ecf00d0a3d0a8b44e029af82ee3a4a4cb9c9105c286f3c1913a003cff55ff29
 SHA512:
-  metadata.gz: a70b8ea06d041483fea246db14b00dabe1a54cdcad869982f5edb4428fa3f1b70d263df0cd8a474194bddf3e249875bc3bfb4aa518f02da36fe8e2a412cdf79e
-  data.tar.gz: 7e41762075d3b7e346da21e54d3707b0f2e090554175a6f4a439cc7818ae8c217d73da921651f37760030b790d65c158fe0a73b9da0bf0db0bf938141caf2a4a
+  metadata.gz: fec53c345bbeb2e580dbeb8eef9349d189f35885f2c952b3c27c7d14899933fb9f7f75bc02831fbf1d3b708474f9c523a583618f9ff9f878a25bb21a355fd784
+  data.tar.gz: 338b23717e6025ef834cb7cb719b5ad9d58958472c9d67870398f7c3777935e9d6373d9c1d93d2e4f991b8a61ded6decc3445ca72802550aa8c1c043e34aa7d3

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,3 +1,6 @@
+## [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!
 

data/README.md

@@ -67,7 +67,17 @@ Here I'm taling about {% glossary term_name %} in a blog post.
 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%}
+
+TODO mention that a term name can't contain comma
 ```
+Not that a term name can not contain a `,`, as this is the argument separator character.
 
 
 ## CSS Style Override
@@ -171,3 +181,6 @@ 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!

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/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

data/lib/jekyll-glossary_tooltip/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GlossaryTooltip
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-glossary_tooltip
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Erik Westrup
@@ -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