jekyll-glossary_tooltip 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5f83067cb6ca64783230d5cbd9631e418b60fff839a7cdef44df1d1c7ec0412
+  data.tar.gz: 7f79aa92250c38f1650a4e5fdb9a2d1322f113a7689753270408312c12c928a4
+SHA512:
+  metadata.gz: e55ab549deddf53b0c1831d562f7814990da41e919a1686aa816390748a0c93ccee9368671b35346a9c0c352d58a4bd874501e270d13d62185642d4ff834b189
+  data.tar.gz: 969838c0f5cef1cd11786fb04c4d95d476d6974cac0ef3c04701c3b524e3dcdbcc9957d3ce19d09ec6f7df119b627a42cc67cc08a7dcff44ddf670d1a3bf3dcf

data/.ackrc

@@ -0,0 +1,3 @@
+--ignore-dir=coverage/
+--ignore-dir=spec/dest
+--ignore-dir=.jekyll-cache

data/.codeclimate.yml

@@ -0,0 +1,24 @@
+# Reference: https://docs.codeclimate.com/docs/advanced-configuration#section-checks
+# Reference of plugins: https://docs.codeclimate.com/docs/list-of-engines
+
+version: "2"
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-1-18-3
+  fixme:
+    enabled: true
+  eslint:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+ratings:
+  paths:
+  - "**.rb"
+  - "**.js"
+exclude_paths:
+- script/

data/.editorconfig

@@ -0,0 +1,20 @@
+# Modified version of https://github.com/ruby/ruby/blob/master/.editorconfig
+
+root = true
+
+[*]
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+tab_width = 4
+trim_trailing_whitespace = true
+
+[*.rb]
+indent_size = 2
+
+[*.gemspec]
+indent_size = 2
+
+[*.yml]
+indent_size = 2

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+# Reference: https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    #ignore:
+      #- dependency-name: "rubocop"

data/.gitignore

@@ -0,0 +1,21 @@
+# Contrary to ruby apps, ruby gems should not check in Gemfile.lock.
+# Reference: https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock
+# Same for Appraisals generated Gemfiles
+gemfiles/*gemfile.lock
+gemfiles/Gemfile*.lock
+
+# Bundle local config
+.bundle/
+
+# Package gem from ($rake install)
+pkg/
+
+# simplecov
+coverage/
+
+# rspec
+.jekyll-cache/
+.rspec_status
+spec/dest/
+spec/reports/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,150 @@
+# See pages relaed at https://docs.rubocop.org/rubocop/1.12/cops_layout.html
+
+# Rubocop extensions
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  Include:
+  - lib/**/*.rb
+  - spec/**/*.rb
+  Exclude:
+  # Travis: during build there will be a lot of rubocop config files in this pat which will cause build failure as the refer to gems which are not installed by this project.
+  # See https://github.com/rubocop/rubocop/issues/9832
+  - gemfiles/vendor/bundle/**/*
+
+Gemspec/DateAssignment:
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/DeprecatedConstants:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+  Exclude:
+  - lib/jekyll-glossary_tooltip/errors.rb
+Lint/EmptyInPattern:
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+Layout/LineLength:
+  Max: 120
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/NumberedParameterAssignment:
+  Enabled: true
+Lint/OrAssignmentToConstant:
+  Enabled: true
+Lint/RedundantDirGlobSort:
+  Enabled: true
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+Lint/SymbolConversion:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/TripleQuotes:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Lint/UnreachableCode:
+  Severity: error
+Lint/UselessAccessModifier:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: true
+  Max: 100
+Metrics/MethodLength:
+  Enabled: true
+  Max: 15
+
+Naming/FileName:
+  Enabled: false
+  Exclude:
+  - lib/jekyll-glossary_tooltip.rb
+Naming/InclusiveLanguage:
+  Enabled: true
+
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/Documentation:
+  Enabled: true
+  Exclude:
+  - lib/jekyll-glossary_tooltip/errors.rb
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+Style/EndlessMethod:
+  Enabled: true
+Style/HashConversion:
+  Enabled: true
+Style/HashExcept:
+  Enabled: true
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+Style/InPatternThen:
+  Enabled: true
+Style/MultilineInPatternThen:
+  Enabled: true
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/QuotedSymbols:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/RegexpLiteral:
+  Enabled: false
+Style/SingleLineMethods:
+  Enabled: true
+  Exclude:
+  - lib/jekyll-glossary_tooltip/errors.rb
+Style/StringChars:
+  Enabled: true
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/SwapValues:
+  Enabled: true
+
+
+# Reference: https://github.com/rubocop/rubocop-rake/blob/master/config/default.yml
+Rake:
+  Enabled: true
+
+# Reference:
+# https://docs.rubocop.org/rubocop-rspec/cops_rspec.html
+# https://github.com/rubocop/rubocop-rspec/blob/master/config/default.yml
+RSpec:
+  Enabled: true
+RSpec/FilePath:
+ # Disable to match structure of lib/. For jekyll plugin inclusion convention features, not having lib/jekyll/sth.rb but lib/jekyll-sth.rb
+  Enabled: false
+RSpec/IdenticalEqualityAssertion:
+  Enabled: true
+RSpec/Rails/AvoidSetupHook:
+  Enabled: false
+RSpec/BeforeAfterAll:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/.simplecov

@@ -0,0 +1,6 @@
+# vi: ft=ruby
+
+SimpleCov.start do
+  enable_coverage :branch    # Add branch coverage statistics.
+  minimum_coverage 90      # Minimum coverage percentage.
+end

data/.travis.yml

@@ -0,0 +1,30 @@
+# NOTE run $(travis lint) after modyifing this file.
+
+# Travis
+# - build lifecycle: https://docs.travis-ci.com/user/job-lifecycle
+# - config doc: https://config.travis-ci.com/
+# - ruby defaults: https://docs.travis-ci.com/user/languages/ruby/
+# Codeclimate setup: https://docs.codeclimate.com/docs/travis-ci-test-coverage
+
+version: ~> 1.0
+env:
+  global:
+    - CC_TEST_REPORTER_ID=8b8822cdaba8bb6c0a9d3f05bea9bc94dbf866ccdd1204913f5673b61caa61b1
+language: ruby
+# Buid matrix (rvm x gemfile = 2x2) with one version from each supported major version in range defined in .gemspec for
+rvm:
+  - 2.7.0
+  - 3.0.1
+gemfile:
+  - gemfiles/jekyll_3.7.x.gemfile
+  - gemfiles/jekyll_4.x.x.gemfile
+cache: bundler
+before_install: gem install bundler -v 2.2.18
+#install: bundle install # Default
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+#script: bundle exec rake # Default
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Appraisals

@@ -0,0 +1,11 @@
+# Override jekyll verion from .gemspec
+
+appraise "jekyll-3.7.x" do
+  gem "jekyll", "~> 3.7"
+  gem "kramdown", "2.3.1"
+  gem "kramdown-parser-gfm", "~> 1.0"
+end
+
+appraise "jekyll-4.x.x" do
+  gem "jekyll", "~> 4.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## [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/CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# How to contribute
+Please use GitHub tooling (issues, PRs) to disucssion and code contributions!
+
+When you open an PR, Travis will build your code, run tests, liters and so on.

data/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Put require=false on gem's that we don't need to import in code (cli exec only)
+
+source "https://rubygems.org"
+
+# Include dependencies from the .gemspec
+gemspec
+
+# Development dependencies
+# Should rather be here than in the .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
+end
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.18", require: false
+  gem "rubocop-rake", "~> 0.6", require: false
+  gem "rubocop-rspec", "~> 2.4", require: false
+  gem "simplecov", "~> 0.21"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Erik Westrup
+
+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,174 @@
+# Jekyll Glossary Tooltip Tag Plugin UNRELEASED
+[![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)
+[![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)
+
+<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.
+
+
+# Installation
+1. Add this gem to your Jekyll site's Gemfile
+   - Simply with `$ bundle add jekyll-glossary_tooltip` when standing in the Jekyll project
+   - Or manually by adding to `Gemfile`
+   ```ruby
+     gem 'jekyll-glossary_tooltip'
+   ```
+   and then running `$ bundle install`.
+1. In your site's `_config.yml`, enable the plugin:
+   ```yml
+   plugins:
+     - jekyll-glossary_tooltip
+   ```
+1. Create a `_data/glossary.yml` file, according to the 'Glossary Term Definition File' section below, with your terms.
+1. Use the liquid tag in a page like `{% glossary term_name %}`
+1. Add CSS styling for the tooltip from [jekyll-glossary_tooltip.css](lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css). You need to make sure that the pages where you will use the glossary tag have this styling applied. Typically this would mean 1) copying this file to your `assets/css/` directory 2) editing your theme's template for blog posts (or what pages you desire) to include this CSS in the header like `<link rel="stylesheet" href="/assets/css/jekyll-glossary_tooltip.css">`. However you could also copy this file's content in to your `main.css` or `main.scss` or however you build your site's CSS.
+1. Now just build your site and you will get nice nice term definition tooltips on mouse hover (or mobile, tap) for you terms!
+   ```console
+   $ bundle exec jekyll build
+   ```
+
+# 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
+
+```markdown
+- term: a_term_name           # Can contain spaces
+  definition: A description of the term
+  url: https://jekyllrb.com/  # Is optional
+- term: another term
+  definition: Some other term definition text
+```
+
+This could look something like:
+```markdown
+- term: Jekyll
+  definition: A Static Site Generator (SSG) built with ruby. Widely adopted as of GitHub Pages inclusion.
+  url: https://jekyllrb.com/
+- term: SSG
+  definition: A Static Site Generator compiles the website before deployment. Then the generated web content is simply retrieved as-is by the client without any code running at retrieve time.
+- term: Jamstack
+  definition: JavaScript + API + Markup - a way of buildin and hosting websites.
+  url: https://jamstack.org/
+```
+
+
+## Tag Usage
+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.
+
+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'.
+```
+
+
+## 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()`.
+
+
+# Development
+The structure of this plugin was inspired by [https://ayastreb.me/writing-a-jekyll-plugin/](https://ayastreb.me/writing-a-jekyll-plugin/), the plugin jekyll-sitemap and the [Bundler Gem tutorial](https://bundler.io/guides/creating_gem.html).
+
+After checking out the repo;
+1. Install [RVM](https://rvm.io/rvm/install) and install a supported ruby version (see .gemspec)
+1. run `script/setup` to install dependencies
+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).
+
+
+## Local development
+Following the setup at [how-to-specify-local-ruby-gems-in-your-gemfile](https://rossta.net/blog/how-to-specify-local-ruby-gems-in-your-gemfile.html), these are the steps needed to build a jekyll site with a local clone of this plugin for local testing.
+
+1. Clone this repo to your machine, say at `~/src/jekyll-glossary_tooltip`
+1. In your Jekyll project's `Gemfile`:
+   - Remove the `gem 'jekyll-glossary_tooltip'` part
+   - Add instead `gem 'jekyll-glossary_tooltip', github: 'erikw/jekyll-glossary_tooltip', branch: 'main'`
+1. Configure bundler to use a local path for this gem in this project:
+   - `$ bundle config --local local.jekyll-glossary_tooltip ~/src/jekyll-glossary_tooltip`
+1. Update the project: `$ bundle install`
+1. Now the project will build with the local clone of this plugin when issuing e.g. `bundle exec jekyll build`
+1. When you're done:
+  - Remove the local override with: `$ bundle config --delete local.jekyll-glossary_tooltip`
+  - Optionally restore the original gem include in `Gemfile` or keep building from a branch in the github repo.
+
+## Releasing
+Instructions for releasing on rubygems.org below. Optionally make a GitHub [release](https://github.com/erikw/jekyll-glossary_tooltip/releases) after this for the pushed git tag.
+
+## Using bundler/gem_tasks rake tasks
+Following instructions from [bundler.io](https://bundler.io/guides/creating_gem.html#releasing-the-gem):
+```console
+$ vi -p lib/jekyll-glossary_tooltip/version.rb CHANGELOG.md
+$ bundle exec rake build
+$ ver=$(ruby -r ./lib/jekyll-glossary_tooltip/version.rb -e 'puts Jekyll::GlossaryTooltip::VERSION')
+
+# Optional: test locally by including in another project
+$ gem install pkg/jekyll-glossary_tooltip-$ver.gem
+
+$ bundle exec rake release
+```
+
+## Using gem-release gem extension
+Using [gem-release](https://github.com/svenfuchs/gem-release):
+```console
+$ vi CHANGELOG.md && git add CHANGELOG.md && git commit -m "Update CHANGELOG.md" && git push
+$ gem bump --version minor --tag --sign --push --release
+```
+For `--version`, use `major|minor|patch` as needed.
+
+## Multi-versions
+* For ruby, just use RVM to switch between supported ruby version specified in `.gemspec`.
+* To run with different jekyll versions, [Appraisal](https://github.com/thoughtbot/appraisal) is used with [`Appraisals`](Appraisals) to generate different [`gemfiles/`](gemfiles/)
+   - To use a specific Gemfile, run like
+      ```console
+      $ BUNDLE_GEMFILE=gemfiles/jekyll_4.x.x.gemfile bundle exec rake spec
+      $ bundle exec appraisal jekyll-4.x.x rake spec
+      ```
+   - To run `rake spec` for all gemfiles:
+      ```console
+      $ bundle exec appraisal rake spec
+      ```
+   - To generate new/updated gemfiles from `Appraisals`
+      ```console
+      $ bundle exec appraisal install
+      $ bundle exec appraisal generate --travis
+      ```
+
+## Travis
+To use the [travis cli client](https://github.com/travis-ci/travis.rb) (installed from `Gemfile`):
+1. Get a GitHub OAuth token by
+   - going to [github.com/settings/tokens](https://github.com/settings/tokens)
+   - create a new token named `travis-cli`
+   - Set the scopes `repo`, `read:org`, `user:email` according to the [docs](https://docs.travis-ci.com/user/github-oauth-scopes).
+1. Set travis.com as the default so we don't need to add `--pro` to most commands
+   ```console
+   $ bundle exec travis endpoint --set-default --api-endpoint https://api.travis-ci.com/
+   ```
+1. Login with the cli client
+   ```console
+   $ bundle exec travis login --github-token $GITHUB_TOKEN
+   ```
+1. Now the cli client can be used (might need `--pro` to use travis.com)
+   ```console
+   $ bundle exec travis lint
+   $ bundle exec travis accounts
+   $ bundle exec travis status
+   $ bundle exec travis branches
+   $ bundle exec travis monitor
+   ```
+
+# Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/erikw/jekyll-glossary_tooltip.
+
+# 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,20 @@
+# frozen_string_literal: true
+
+# Run $(rake -T) to list all tasks.
+
+# Include default tasks like build, release, install etc. See https://github.com/rubygems/rubygems/blob/master/bundler/lib/bundler/gem_helper.rb#L46
+require "bundler/gem_tasks"
+
+# rspec: Testing framework. Adds 'spec' rake task.
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+# rubocop: Linting. Adds 'rubocop' rake task.
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:rubocop) do |t|
+  # See https://docs.rubocop.org/rubocop/usage/basic_usage.html
+  t.options = ['--display-cop-names', '--parallel']
+end
+
+# default task: Add spec and rubocop to default tasks.
+task default: %i[spec rubocop]

data/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x.x   | :white_check_mark: |
+| < 1.0   | :x:                |
+
+
+## Reporting a Vulnerability
+Please open a GitHub Issue in this repository for any potential issues!

data/gemfiles/README.md

@@ -0,0 +1 @@
+These Gemfiles are used from the CI pipeline in the build matrix to test specific versions of dependencies. They are generated by [Appraisal](https://github.com/thoughtbot/appraisal).

data/gemfiles/jekyll_3.7.x.gemfile

@@ -0,0 +1,23 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "~> 3.7"
+gem "kramdown", "2.3.1"
+gem "kramdown-parser-gfm", "~> 1.0"
+
+group :development, :test do
+  gem "rake", "~> 13.0", require: false
+  gem "travis", "~> 1.0", require: false
+  gem "appraisal", "~> 2.4", require: false
+end
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.18", require: false
+  gem "rubocop-rake", "~> 0.6", require: false
+  gem "rubocop-rspec", "~> 2.4", require: false
+  gem "simplecov", "~> 0.21"
+end
+
+gemspec path: "../"

data/gemfiles/jekyll_4.x.x.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.0"
+
+group :development, :test do
+  gem "rake", "~> 13.0", require: false
+  gem "travis", "~> 1.0", require: false
+  gem "appraisal", "~> 2.4", require: false
+end
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.18", require: false
+  gem "rubocop-rake", "~> 0.6", require: false
+  gem "rubocop-rspec", "~> 2.4", require: false
+  gem "simplecov", "~> 0.21"
+end
+
+gemspec path: "../"

data/jekyll-glossary_tooltip.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll-glossary_tooltip/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-glossary_tooltip"
+  spec.version       = Jekyll::GlossaryTooltip::VERSION
+  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.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.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/erikw/jekyll-glossary_tooltip/"
+  spec.metadata["changelog_uri"] = "https://github.com/erikw/jekyll-glossary_tooltip/blob/main/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 { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
+end

data/lib/jekyll-glossary_tooltip.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "jekyll-glossary_tooltip/version"
+require_relative "jekyll-glossary_tooltip/tag"
+
+module Jekyll
+  # Module for the plugin.
+  module GlossaryTooltip
+  end
+end

data/lib/jekyll-glossary_tooltip/errors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GlossaryTooltip
+    module Errors
+      class MissingTermDefinition < StandardError
+        def initialize(term_name); super("Glossary entry for '#{term_name}' does not contain a definition!") end
+      end
+      class MissingTermEntry < StandardError
+        def initialize(term_name); super("The term '#{term_name}' was not defined in the glossary") end
+      end
+      class MultipleTermEntries < StandardError
+        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
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+/* Tooltip from https://www.w3schools.com/css/css_tooltip.asp */
+.jekyll-glossary {
+  position: relative;
+  display: inline-block;
+  border-bottom: 3px dotted blue;
+  cursor: help;
+}
+
+.jekyll-glossary .jekyll-glossary-tooltip {
+  visibility: hidden;
+  width: 120px;
+  background-color: black;
+  color: #fff;
+  text-align: center;
+  font-size: 0.5em;
+  padding: 5px;
+  border-radius: 6px;
+
+  /* Position the tooltip text - see examples below! */
+  position: absolute;
+  z-index: 1;
+
+  width: 160px;
+  bottom: 100%;
+  left: 50%;
+  margin-left: -80px; /* Use half of the width to center the tooltip */
+
+}
+
+/* Show the tooltip text when you mouse over the tooltip container */
+.jekyll-glossary:hover .jekyll-glossary-tooltip {
+  visibility: visible;
+}
+
+/* Style the source link (if there is one provided in the glossary entry). */
+.jekyll-glossary-source-link:before {
+  content: "[source]";  // "(reference)", "<link>" or whatever you want.
+}

data/lib/jekyll-glossary_tooltip/tag.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll-glossary_tooltip/errors"
+
+module Jekyll
+  module GlossaryTooltip
+    # Custom liquid tag implementation.
+    class Tag < Liquid::Tag
+      def initialize(tag_name, text, tokens)
+        super
+        @term_query = text.strip
+      end
+
+      def render(context)
+        entry = lookup_entry(context.registers[:site], @term_query)
+        <<~HTML
+          <span class="jekyll-glossary">
+             #{@term_query}
+             <span class="jekyll-glossary-tooltip">#{entry["definition"]}#{render_tooltip_url(entry)}</span>
+          </span>
+        HTML
+      end
+
+      private
+
+      LOG_TAG = "Glossary Tag:"
+
+      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>" : ""
+      end
+
+      def lookup_entry(site, term_name)
+        entry = read_term_entry_from_config(site, term_name)
+        raise Errors::MissingTermDefinition, term_name unless entry["definition"]
+
+        entry["url"] = nil unless entry.key?("url")
+        entry
+      end
+
+      # Retrieve a term from the glossary via the site.
+      def read_term_entry_from_config(site, term_name)
+        raise Errors::NoGlossaryFile unless site.data["glossary"]
+
+        entries = site.data["glossary"].select do |entry|
+          entry.key?("term") and term_name.casecmp(entry["term"]).zero?
+        end
+
+        case entries.length
+        when 0
+          raise Errors::MissingTermEntry, term_name
+        when 1
+          entries[0]
+        else
+          raise Errors::MultipleTermEntries, term_name
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("glossary", Jekyll::GlossaryTooltip::Tag)

data/lib/jekyll-glossary_tooltip/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GlossaryTooltip
+    VERSION = "0.1.0"
+  end
+end

data/script/build

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+set -eux
+bundle exec rake $*

data/script/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jekyll-glossary_tooltip"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/script/lint

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+set -eux
+bundle exec rake rubocop $*

data/script/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+rvm install ruby-$(cat .ruby-version)
+gem install bundler -v 2.2.18
+bundle install

data/script/test

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+set -eux
+bundle exec rake spec $*

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-glossary_tooltip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Westrup
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+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.
+email:
+- erik.westrup@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ackrc"
+- ".codeclimate.yml"
+- ".editorconfig"
+- ".github/dependabot.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SECURITY.md
+- gemfiles/README.md
+- gemfiles/jekyll_3.7.x.gemfile
+- gemfiles/jekyll_4.x.x.gemfile
+- img/tooltip_screenshot.png
+- img/tooltip_screenshot.xcf
+- jekyll-glossary_tooltip.gemspec
+- lib/jekyll-glossary_tooltip.rb
+- lib/jekyll-glossary_tooltip/errors.rb
+- lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css
+- lib/jekyll-glossary_tooltip/tag.rb
+- lib/jekyll-glossary_tooltip/version.rb
+- script/build
+- script/console
+- script/lint
+- script/setup
+- script/test
+homepage: https://github.com/erikw/jekyll-glossary_tooltip/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/erikw/jekyll-glossary_tooltip/
+  source_code_uri: https://github.com/erikw/jekyll-glossary_tooltip/
+  changelog_uri: https://github.com/erikw/jekyll-glossary_tooltip/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+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
+test_files: []