jekyll-glossary_tooltip 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83377b31e4fd2496cf08adebb7cafb28291c10c26d45261dcdcfab8048d3eb18
-  data.tar.gz: 5ecf00d0a3d0a8b44e029af82ee3a4a4cb9c9105c286f3c1913a003cff55ff29
+  metadata.gz: d0d2a7c9c71b7870e1d4fe0afa64d23aed4e6511cada60c8c4cc86be19b32dfd
+  data.tar.gz: 1a20ab00bfd6d4f4c7ebeb7644c6ac49f04d4380bffea4fd5a831879ed37c7d2
 SHA512:
-  metadata.gz: fec53c345bbeb2e580dbeb8eef9349d189f35885f2c952b3c27c7d14899933fb9f7f75bc02831fbf1d3b708474f9c523a583618f9ff9f878a25bb21a355fd784
-  data.tar.gz: 338b23717e6025ef834cb7cb719b5ad9d58958472c9d67870398f7c3777935e9d6373d9c1d93d2e4f991b8a61ded6decc3445ca72802550aa8c1c043e34aa7d3
+  metadata.gz: 7b2fcc69854a22adeb846fd8278bc92bdb4ce4c74ac7c487aec2020d7dc971615a0122b75cafe56b3c5f9626ff3f3140229a5a705b43cea889f16dd93fb8843f
+  data.tar.gz: 1961474e8828979d106fb521ceac878d4511808dca15754853bb542d50e8f38a566f7d32a57dff07f61b2131fa82f316c4118bc3593f2895fb867a6c01374cb2

data/.github/dependabot.yml

@@ -1,4 +1,6 @@
 # Reference: https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# Validation: https://dependabot.com/docs/config-file/validator/
+
 version: 2
 updates:
   - package-ecosystem: "bundler"

data/.github/workflows/cd.yml

@@ -0,0 +1,30 @@
+name: Continuous Deployment   # Well, semi-continuous
+
+on:
+  push:
+    tags: v[0-9]+.[0-9]+.[0-9]+
+env:
+  RUBY_VER: 3.0.1
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ env.RUBY_VER }}
+        bundler-cache: true
+    - name: Run CI Build with Rake
+      run: bundle exec rake
+  release-github:
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build and publish gem to GitHub Packages
+        if: contains(github.ref, 'refs/tags/v')
+        uses: jstastny/publish-gem-to-github@master
+        with:
+          token: ${{ github.token }}
+          owner: ${{ github.repository_owner }}

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,37 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '41 19 1 * *'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.gitignore

@@ -8,7 +8,7 @@ gemfiles/Gemfile*.lock
 # Bundle local config
 .bundle/
 
-# Package gem from ($rake install)
+# Package gem from $(rake install)
 pkg/
 
 # simplecov
@@ -19,3 +19,6 @@ coverage/
 .rspec_status
 spec/dest/
 spec/reports/
+
+# Jekyll - when switching from gh-pages-source branch
+_site/

data/.rubocop.yml

@@ -5,6 +5,10 @@ require:
   - rubocop-rake
   - rubocop-rspec
 
+inherit_mode:
+  merge:
+    - Exclude  # Merge my AllCops.Excllude with default exludes from https://github.com/rubocop/rubocop/blob/master/config/default.yml
+
 AllCops:
   TargetRubyVersion: 3.0
   Include:
@@ -17,9 +21,17 @@ AllCops:
 
 Gemspec/DateAssignment:
   Enabled: true
+Gemspec/RequireMFA:
+  Enabled: true
 
 Layout/LineEndStringConcatenationIndentation:
   Enabled: true
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+  Exclude:
+  - lib/jekyll-glossary_tooltip/errors.rb
+Layout/SpaceBeforeBrackets:
+  Enabled: true
 
 Lint/AmbiguousAssignment:
   Enabled: true
@@ -33,10 +45,16 @@ Lint/EmptyBlock:
   Enabled: true
 Lint/EmptyClass:
   Enabled: true
-Layout/EmptyLineBetweenDefs:
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+Lint/AmbiguousRange:
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+Lint/UselessRuby2Keywords:
   Enabled: true
-  Exclude:
-  - lib/jekyll-glossary_tooltip/errors.rb
 Lint/EmptyInPattern:
   Enabled: true
 Lint/LambdaWithoutLiteralBlock:
@@ -51,8 +69,6 @@ Lint/OrAssignmentToConstant:
   Enabled: true
 Lint/RedundantDirGlobSort:
   Enabled: true
-Layout/SpaceBeforeBrackets:
-  Enabled: true
 Lint/SymbolConversion:
   Enabled: true
 Lint/ToEnumArguments:
@@ -70,7 +86,6 @@ Lint/UselessAccessModifier:
 
 Metrics/AbcSize:
   Enabled: true
-  Max: 25
 Metrics/BlockLength:
   Enabled: true
   Max: 100
@@ -84,6 +99,11 @@ Naming/FileName:
   - lib/jekyll-glossary_tooltip.rb
 Naming/InclusiveLanguage:
   Enabled: true
+Naming/BlockForwarding:
+  Enabled: true
+
+Security/IoMethods:
+  Enabled: true
 
 Style/ArgumentsForwarding:
   Enabled: true
@@ -131,6 +151,22 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 Style/SwapValues:
   Enabled: true
+Style/FileRead:
+  Enabled: true
+Style/FileWrite:
+  Enabled: true
+Style/MapToHash:
+  Enabled: true
+Style/NumberedParameters:
+  Enabled: true
+Style/NumberedParametersLimit:
+  Enabled: true
+Style/OpenStructUse:
+  Enabled: true
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+Style/SelectByRegexp:
+  Enabled: true
 
 
 # Reference: https://github.com/rubocop/rubocop-rake/blob/master/config/default.yml
@@ -151,3 +187,9 @@ RSpec/Rails/AvoidSetupHook:
   Enabled: false
 RSpec/BeforeAfterAll:
   Enabled: false
+RSpec/ExcessiveDocstringSpacing:
+  Enabled: true
+RSpec/SubjectDeclaration:
+  Enabled: true
+RSpec/FactoryBot/SyntaxMethods:
+  Enabled: true

data/.ruby-version

@@ -1 +1 @@
-3.0.1
+3.1.0

data/.simplecov

@@ -1,6 +1,7 @@
 # vi: ft=ruby
 
 SimpleCov.start do
-  enable_coverage :branch    # Add branch coverage statistics.
-  minimum_coverage 90      # Minimum coverage percentage.
+  enable_coverage  :branch      # Add branch coverage statistics.
+  minimum_coverage 90           # Minimum coverage percentage.
+  command_name     "test:bdd"   # Must be set for codeclimat reporter
 end

data/.travis.yml

@@ -11,6 +11,7 @@ env:
   global:
     - CC_TEST_REPORTER_ID=8b8822cdaba8bb6c0a9d3f05bea9bc94dbf866ccdd1204913f5673b61caa61b1
 language: ruby
+dist: focal # TODO Remove this when solved: https://github.com/rvm/rvm/issues/5133
 # Buid matrix (rvm x gemfile = 2x2) with one version from each supported major version in range defined in .gemspec for
 rvm:
   - 2.7.0

data/CHANGELOG.md

@@ -1,5 +1,34 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.3.1] - 2021-08-18
+### Added
+- GitHub workflow to publish to GitHub Packages.
+
+## [1.3.1] - 2021-08-18
+### Fixed
+- gemspec dependency range stynax.
+
+## [1.3.0] - 2021-08-07
+### Changed
+- Open the souce link from a tooltip in a new tab.
+
+## [1.2.0] - 2021-08-06
+### Added
+- Bottom arrow to the tooltip.
+- Tooltip hover animation from invisible to visible.
+
+### Changed
+- Restyle the glossary term bottom border style and color.
+
 ## [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 %}`.
+### Added
+- 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/Gemfile

@@ -12,10 +12,11 @@ gemspec
 # Reference: https://github.com/rubygems/bundler/pull/7222
 # However there's an argument for using gemspec too: https://bundler.io/guides/creating_gem.html#testing-our-gem
 group :development, :test do
-  gem "rake", "~> 13.0", require: false
-  gem "travis", "~> 1.0", require: false
   gem "appraisal", "~> 2.4", require: false
   gem "gem-release", "~> 2.0", require: false
+  gem "rake", "~> 13.0", require: false
+  gem "solargraph", require: false
+  gem "travis", "~> 1.0", require: false
 end
 
 group :test do

data/OSSMETADATA

@@ -0,0 +1 @@
+osslifecycle=active

data/README.md

@@ -1,15 +1,22 @@
-# Jekyll Glossary Tooltip Tag Plugin
+# Jekyll Glossary Tooltip Tag Plugin [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Get%20a%20nifty%20tooltip%20for%20term%20definitions%20in%20your%20Jekyll%20blog%20with%20this%20plugin&url=https://github.com/erikw/jekyll-glossary_tooltip&via=erik_westrup&hashtags=jekyll,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)
+[![Travis Build Status](https://img.shields.io/travis/erikw/jekyll-glossary_tooltip/main?logo=travis)](https://app.travis-ci.com/github/erikw/jekyll-glossary_tooltip)
 [![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/7ffb648ec4b77f3f9eb8/maintainability)](https://codeclimate.com/github/erikw/jekyll-glossary_tooltip/maintainability)
 [![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/7ffb648ec4b77f3f9eb8/test_coverage)](https://codeclimate.com/github/erikw/jekyll-glossary_tooltip/test_coverage)
+[![CodeQL](https://github.com/erikw/jekyll-glossary_tooltip/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/erikw/jekyll-glossary_tooltip/actions/workflows/codeql-analysis.yml)
+[![SLOC](https://img.shields.io/tokei/lines/github/erikw/jekyll-glossary_tooltip)](#)
+[![License](https://img.shields.io/github/license/erikw/jekyll-glossary_tooltip)](LICENSE.txt)
+[![OSS Lifecycle](https://img.shields.io/osslifecycle/erikw/jekyll-glossary_tooltip)](https://github.com/Netflix/osstracker)
+
+
+:point_right: **Live demo**: https://erikw.github.io/jekyll-glossary_tooltip/
 
 <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.
+It's also possible to provide an optional URL to for example a term definition 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.
 
 
 # Installation
@@ -35,7 +42,7 @@ It's also possible to provide an optional URL to further term definition or sour
 
 # Usage
 ## Glossary Term Definition File
-Create a file `_data/glossary.yml` to host your shared term definition entries. This file should contain a list of term entries like
+Create a file `_data/glossary.yml` to host your shared term definition entries. This file should contain a list of term entries in the format of:
 
 ```markdown
 - term: a_term_name           # Can contain spaces
@@ -62,9 +69,9 @@ 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'.
 
@@ -72,12 +79,11 @@ The case-styling above works as there's still a case-insensitive match. But what
 {% 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
+{% glossary cat, display: cats %}
+{% glossary some term, display: some other display text %}
 ```
-Not that a term name can not contain a `,`, as this is the argument separator character.
+
+**Note** that a term name can not contain a `,`, as this is the argument separator character.
 
 
 ## CSS Style Override
@@ -93,7 +99,7 @@ After checking out the repo;
 1. run `script/test` to run the tests
 1.  You can also run `script/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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 
 ## Local development
@@ -176,6 +182,9 @@ To use the [travis cli client](https://github.com/travis-ci/travis.rb) (installe
    $ bundle exec travis monitor
    ```
 
+## Live Demo GitHub Pages
+The live demo source is in the branch [`gh-pages-source`](https://github.com/erikw/jekyll-glossary_tooltip/tree/gh-pages-source). Check its `README.md`!
+
 # Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/erikw/jekyll-glossary_tooltip.
 
@@ -184,3 +193,6 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 # 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/jekyll-glossary_tooltip.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Erik Westrup"]
   spec.email         = ["erik.westrup@gmail.com"]
 
-  spec.summary       = "Jekyll plugin providing a glossary liquid tag that will show a tooltip of a term definition in your site"
+  spec.summary       = "Jekyll plugin providing a glossary liquid tag that will show a tooltip of a term definition in your site."
   spec.description   = "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."
   spec.homepage      = "https://github.com/erikw/jekyll-glossary_tooltip/"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.7", "< 4"
+  spec.required_ruby_version = [">= 2.7", "< 4"]
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/erikw/jekyll-glossary_tooltip/"
@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
+  spec.add_dependency "jekyll", [">= 3.7", "< 5.0"]
 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

@@ -23,7 +23,11 @@ module Jekyll
 
           options[:term_query] = opt_segments[0]
           opt_segments.shift
+          parse_segments(options, opt_segments)
+          options
+        end
 
+        def parse_segments(options, opt_segments)
           opt_segments.each do |opt_segment|
             raise Errors::OptionsBadTagArgumentFormat, options[:term_name] unless opt_segment =~ ARGS_PATTERN
 
@@ -33,7 +37,6 @@ module Jekyll
 
             options[arg_name.to_sym] = arg_value
           end
-          options
         end
       end
     end

data/lib/jekyll-glossary_tooltip/tag.rb

@@ -30,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 = "1.1.0"
+    VERSION = "1.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-glossary_tooltip
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Erik Westrup
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -45,6 +45,8 @@ files:
 - ".codeclimate.yml"
 - ".editorconfig"
 - ".github/dependabot.yml"
+- ".github/workflows/cd.yml"
+- ".github/workflows/codeql-analysis.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -56,6 +58,7 @@ files:
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
+- OSSMETADATA
 - README.md
 - Rakefile
 - SECURITY.md
@@ -101,9 +104,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Jekyll plugin providing a glossary liquid tag that will show a tooltip of
-  a term definition in your site
+  a term definition in your site.
 test_files: []