jekyll-glossary_tooltip 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0d2a7c9c71b7870e1d4fe0afa64d23aed4e6511cada60c8c4cc86be19b32dfd
-  data.tar.gz: 1a20ab00bfd6d4f4c7ebeb7644c6ac49f04d4380bffea4fd5a831879ed37c7d2
+  metadata.gz: 02fc27dec8d3491d154f94d40a371caec17b2da3b189d157f708a7ce522a7076
+  data.tar.gz: 49e9d0b6e4f6312c7712df864f51345382e8562a3e124b471415824718ae13d2
 SHA512:
-  metadata.gz: 7b2fcc69854a22adeb846fd8278bc92bdb4ce4c74ac7c487aec2020d7dc971615a0122b75cafe56b3c5f9626ff3f3140229a5a705b43cea889f16dd93fb8843f
-  data.tar.gz: 1961474e8828979d106fb521ceac878d4511808dca15754853bb542d50e8f38a566f7d32a57dff07f61b2131fa82f316c4118bc3593f2895fb867a6c01374cb2
+  metadata.gz: 64c423fc44f600f08a8acbe45e94a86d91300efbe69941177529275f9ec8c1d55bb46d728aeba0a4c2b8c43af24e53d1393baf06e431530f05fc6024a0404daa
+  data.tar.gz: 3d07bf135cee11a831071eee2c535eef932563eb7277a14e65db02a435d8e5ae85cd5b764d5afd0e4464e79d2367a829a9807b5755618d7c2048ccda4747e3ff

data/.rubocop.yml

@@ -18,8 +18,9 @@ AllCops:
   # 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/**/*
+  NewCops: enable
 
-Gemspec/DateAssignment:
+Gemspec/DeprecatedAttributeAssignment:
   Enabled: true
 Gemspec/RequireMFA:
   Enabled: true
@@ -193,3 +194,6 @@ RSpec/SubjectDeclaration:
   Enabled: true
 RSpec/FactoryBot/SyntaxMethods:
   Enabled: true
+RSpec/MultipleMemoizedHelpers:
+  Enabled: true
+  Max: 10

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.5.0] - 2022-09-08
+### Added
+- Support for embedded liqid tags in the url field. ([#3](https://github.com/erikw/jekyll-glossary_tooltip/issues/3])
+
+## [1.4.0] - 2021-08-18
+### Changed
+* Bump local ruby to 3.1.0
+
 ## [1.3.1] - 2021-08-18
 ### Added
 - GitHub workflow to publish to GitHub Packages.

data/README.md

@@ -5,7 +5,7 @@
 [![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)](#)
+[![SLOC](https://img.shields.io/tokei/lines/github/erikw/jekyll-glossary_tooltip?logo=codefactor&logoColor=lightgrey)](#)
 [![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)
 
@@ -20,13 +20,19 @@ It's also possible to provide an optional URL to for example a term definition s
 
 
 # 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`
+1. Add this gem to your Jekyll site's Gemfile in the `:jekyll_plugins` group:
+   * On CLI (in project root directory):
+   ```shell
+   bundle add --group jekyll_plugins jekyll-glossary_tooltip
+   ```
+   * Or manually:
    ```ruby
+   group :jekyll_plugins do
+     [...]
      gem 'jekyll-glossary_tooltip'
+   end
    ```
-   and then running `$ bundle install`.
+1. Run `$ bundle install`.
 1. In your site's `_config.yml`, enable the plugin:
    ```yml
    plugins:
@@ -36,8 +42,8 @@ It's also possible to provide an optional URL to for example a term definition s
 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
+   ```shell
+   bundle exec jekyll build
    ```
 
 # Usage
@@ -62,8 +68,14 @@ This could look something like:
 - term: Jamstack
   definition: JavaScript + API + Markup - a way of buildin and hosting websites.
   url: https://jamstack.org/
+- term: EmbeddedLiquidURL
+  definition: This definition has an URL with embedded liquid tags to make it dynamic at build time. Note special YAML syntax for being able to use liquid (1.)
+  url: >
+    {{ site.baseurl }}{% link page2.md %}
 ```
 
+1. See [here](https://documentation.platformos.com/use-cases/using-liquid-markup-yaml) for notes on using Liquid in YAML.
+
 
 ## Tag Usage
 On any page where you've made sure include the needed CSS styling, you can use the glossary tag simply like
@@ -122,22 +134,22 @@ Instructions for releasing on rubygems.org below. Optionally make a GitHub [rele
 
 ## 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')
+```shell
+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
+gem install pkg/jekyll-glossary_tooltip-$ver.gem
 
-$ bundle exec rake release
+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
+```shell
+vi CHANGELOG.md && git add CHANGELOG.md && git commit -m "Update CHANGELOG.md" && git push
+gem bump --version minor --tag --push --release --sign
 ```
 For `--version`, use `major|minor|patch` as needed.
 
@@ -145,18 +157,18 @@ For `--version`, use `major|minor|patch` as needed.
 * 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
+      ```shell
+      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
+      ```shell
+      bundle exec appraisal rake spec
       ```
    - To generate new/updated gemfiles from `Appraisals`
-      ```console
-      $ bundle exec appraisal install
-      $ bundle exec appraisal generate --travis
+      ```shell
+      bundle exec appraisal install
+      bundle exec appraisal generate --travis
       ```
 
 ## Travis
@@ -166,20 +178,20 @@ To use the [travis cli client](https://github.com/travis-ci/travis.rb) (installe
    - 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/
+   ```shell
+   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
+   ```shell
+   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
+   ```shell
+   bundle exec travis lint
+   bundle exec travis accounts
+   bundle exec travis status
+   bundle exec travis branches
+   bundle exec travis monitor
    ```
 
 ## Live Demo GitHub Pages

data/lib/jekyll-glossary_tooltip/tag.rb

@@ -18,7 +18,7 @@ module Jekyll
         <<~HTML
           <span class="jekyll-glossary">
              #{@opts[:display]}
-             <span class="jekyll-glossary-tooltip">#{entry["definition"]}#{render_tooltip_url(entry)}</span>
+             <span class="jekyll-glossary-tooltip">#{entry["definition"]}#{render_tooltip_url(entry, context)}</span>
           </span>
         HTML
       end
@@ -27,11 +27,13 @@ module Jekyll
 
       LOG_TAG = "Glossary Tag:"
 
-      def render_tooltip_url(entry)
+      def render_tooltip_url(entry, context)
         # 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.
-        anchor = "<br><a class=\"jekyll-glossary-source-link\" href=\"#{entry["url"]}\" target=\"_blank\"></a>"
-        entry["url"] ? anchor : ""
+        return "" if entry["url"].nil?
+
+        url = Liquid::Template.parse(entry["url"]).render(context).strip
+        "<br><a class=\"jekyll-glossary-source-link\" href=\"#{url}\" target=\"_blank\"></a>"
       end
 
       def lookup_entry(site, term_name)

data/lib/jekyll-glossary_tooltip/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-glossary_tooltip
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Erik Westrup
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll