jekyll-glossary_tooltip 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02fc27dec8d3491d154f94d40a371caec17b2da3b189d157f708a7ce522a7076
-  data.tar.gz: 49e9d0b6e4f6312c7712df864f51345382e8562a3e124b471415824718ae13d2
+  metadata.gz: 101c1828dc5fe466819376a570327368e421dbdc9eefa31c9aedb660cab479db
+  data.tar.gz: eb71b1ebbea0819e97c3915b1cadc65f8bf40b91ed83f384cacdddd1e9a16a15
 SHA512:
-  metadata.gz: 64c423fc44f600f08a8acbe45e94a86d91300efbe69941177529275f9ec8c1d55bb46d728aeba0a4c2b8c43af24e53d1393baf06e431530f05fc6024a0404daa
-  data.tar.gz: 3d07bf135cee11a831071eee2c535eef932563eb7277a14e65db02a435d8e5ae85cd5b764d5afd0e4464e79d2367a829a9807b5755618d7c2048ccda4747e3ff
+  metadata.gz: 1d85579396ffdebe35a4c69c0e028acda18ff53a0d9c60eb56873a72a4ab3616ab7bcd718f22783fa807deb23774efade5657465e1292ced22afdd00421a6e51
+  data.tar.gz: bfbb20f9b579c5112f96cfb26d25880b14e05cf5784c45f43180c9bf4dd72b4a705f4adb76bf4813a1770388df4b87ffef096ea0819d50bc7eb9555893f7706d

data/.codeclimate.yml

@@ -21,4 +21,4 @@ ratings:
   - "**.rb"
   - "**.js"
 exclude_paths:
-- script/
+- scripts/

data/.devcontainer/devcontainer.json

@@ -0,0 +1,3 @@
+{
+	"postCreateCommand": "bash scripts/devcontainer_postCreateCommand.sh"
+}

data/.rubocop.yml

@@ -1,13 +1,13 @@
-# See pages relaed at https://docs.rubocop.org/rubocop/1.12/cops_layout.html
+# See pages related at https://docs.rubocop.org/rubocop/1.12/cops_layout.html
 
-# Rubocop extensions
-require:
+# Rubocop plugins
+plugins:
   - 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
+    - Exclude  # Merge my AllCops.Exclude with default excludes from https://github.com/rubocop/rubocop/blob/master/config/default.yml
 
 AllCops:
   TargetRubyVersion: 3.0
@@ -15,10 +15,10 @@ AllCops:
   - 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.
+  # Travis: during build there will be a lot of rubocop config files in this path 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/**/*
-  NewCops: enable
+  NewCops: disable
 
 Gemspec/DeprecatedAttributeAssignment:
   Enabled: true
@@ -179,21 +179,22 @@ Rake:
 # 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
 RSpec/ExcessiveDocstringSpacing:
   Enabled: true
 RSpec/SubjectDeclaration:
   Enabled: true
-RSpec/FactoryBot/SyntaxMethods:
-  Enabled: true
 RSpec/MultipleMemoizedHelpers:
   Enabled: true
   Max: 10
+RSpec/SpecFilePathFormat:
+ # 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/SpecFilePathSuffix:
+ # 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/IndexedLet:
+  Enabled: false

data/Appraisals

@@ -1,4 +1,4 @@
-# Override jekyll verion from .gemspec
+# Override jekyll version from .gemspec
 
 appraise "jekyll-3.7.x" do
   gem "jekyll", "~> 3.7"

data/CHANGELOG.md

@@ -5,6 +5,9 @@ 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.5.1] - 2025-03-10
+### Fixed
+- Strip newlines from generated HTML to prevent unnecessary spaces to be added. [#9](https://github.com/erikw/jekyll-glossary_tooltip/issues/9)
 
 ## [1.5.0] - 2022-09-08
 ### Added

data/Gemfile

@@ -23,6 +23,7 @@ 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"
+  gem "rubocop-rspec", "~> 3.5", require: false
+  gem "simplecov", "~> 0.22"
+  gem "json_pure", "~> 2.8", require: false # Solargraph pulls in v2.6.3 which fails build with " uninitialized constant JSON::Fragment"
 end

data/README.md

@@ -1,14 +1,20 @@
 # 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://app.travis-ci.com/github/erikw/jekyll-glossary_tooltip)
+[![Gem Downloads](https://img.shields.io/gem/dt/jekyll-glossary_tooltip?label=gem%20downloads)](https://rubygems.org/gems/jekyll-glossary_tooltip)
+[![Travis Build Status](https://img.shields.io/travis/com/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?logo=codefactor&logoColor=lightgrey)](#)
+[![SLOC](https://sloc.xyz/github/erikw/jekyll-glossary_tooltip?lower=true)](#)
+[![Number of programming languages used](https://img.shields.io/github/languages/count/erikw/jekyll-glossary_tooltip)](#)
+[![Top programming languages used](https://img.shields.io/github/languages/top/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)
 
+<p align="center">
+    <!-- Ref: https://dev.to/azure/adding-a-github-codespace-button-to-your-readme-5f6l -->
+    <a href="https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=390309485" title="Open in GitHub Codespaces" ><img alt="Open in GitHub Codespaces" src="https://github.com/codespaces/badge.svg"></a>
+</p>
 
 :point_right: **Live demo**: https://erikw.github.io/jekyll-glossary_tooltip/
 
@@ -107,9 +113,10 @@ The structure of this plugin was inspired by [https://ayastreb.me/writing-a-jeky
 
 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.
+1. run `scripts/setup` to install dependencies
+1. run `scripts/test` to run the tests
+   * Run a specific test with `bundle exec rspec -e "name of test example"`
+1.  You can also run `scripts/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
@@ -168,7 +175,7 @@ For `--version`, use `major|minor|patch` as needed.
    - To generate new/updated gemfiles from `Appraisals`
       ```shell
       bundle exec appraisal install
-      bundle exec appraisal generate --travis
+      bundle exec appraisal generate
       ```
 
 ## Travis

data/gemfiles/jekyll_3.7.x.gemfile

@@ -7,17 +7,20 @@ gem "kramdown", "2.3.1"
 gem "kramdown-parser-gfm", "~> 1.0"
 
 group :development, :test do
+  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
-  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"
+  gem "rubocop-rspec", "~> 3.5", require: false
+  gem "simplecov", "~> 0.22"
+  gem "json_pure", "~> 2.8", require: false
 end
 
 gemspec path: "../"

data/gemfiles/jekyll_4.x.x.gemfile

@@ -5,17 +5,20 @@ source "https://rubygems.org"
 gem "jekyll", "~> 4.0"
 
 group :development, :test do
+  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
-  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"
+  gem "rubocop-rspec", "~> 3.5", require: false
+  gem "simplecov", "~> 0.22"
+  gem "json_pure", "~> 2.8", require: false
 end
 
 gemspec path: "../"

data/jekyll-glossary_tooltip.gemspec

@@ -6,7 +6,7 @@ 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.email         = ["erik.westrup@icloud.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."

data/lib/jekyll-glossary_tooltip/tag.rb

@@ -15,12 +15,13 @@ module Jekyll
       def render(context)
         entry = lookup_entry(context.registers[:site], @opts[:term_query])
         @opts[:display] ||= @opts[:term_query]
-        <<~HTML
+        html = <<~HTML
           <span class="jekyll-glossary">
              #{@opts[:display]}
              <span class="jekyll-glossary-tooltip">#{entry["definition"]}#{render_tooltip_url(entry, context)}</span>
           </span>
         HTML
+        html.gsub("\n", "")
       end
 
       private

data/lib/jekyll-glossary_tooltip/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GlossaryTooltip
-    VERSION = "1.5.0"
+    VERSION = "1.5.1"
   end
 end

data/scripts/devcontainer_postCreateCommand.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# Devcontainer postCreateCommand.
+# Install dependencies for running this project in GitHub Codespaces.
+
+set -eux
+
+# For project.
+bundle install

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-glossary_tooltip
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Erik Westrup
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -36,13 +36,14 @@ description: This plugin simplifies for your readers and you by making it easy t
   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
+- erik.westrup@icloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".ackrc"
 - ".codeclimate.yml"
+- ".devcontainer/devcontainer.json"
 - ".editorconfig"
 - ".github/dependabot.yml"
 - ".github/workflows/cd.yml"
@@ -74,11 +75,12 @@ files:
 - lib/jekyll-glossary_tooltip/options_parser.rb
 - lib/jekyll-glossary_tooltip/tag.rb
 - lib/jekyll-glossary_tooltip/version.rb
-- script/build
-- script/console
-- script/lint
-- script/setup
-- script/test
+- scripts/build
+- scripts/console
+- scripts/devcontainer_postCreateCommand.sh
+- scripts/lint
+- scripts/setup
+- scripts/test
 homepage: https://github.com/erikw/jekyll-glossary_tooltip/
 licenses:
 - MIT
@@ -86,7 +88,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -104,8 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.5.11
+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.