jekyll-glossary_tooltip 1.3.1 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '09c7f3e8d1674d97b97e0b2f61a9aec54c9f63887ef44e186bb98cb17f1e316e'
4
- data.tar.gz: a04e4f54354a67f7133f9bbb49fa6a141464fdb1796caffe81d1e5253e781619
3
+ metadata.gz: d0d2a7c9c71b7870e1d4fe0afa64d23aed4e6511cada60c8c4cc86be19b32dfd
4
+ data.tar.gz: 1a20ab00bfd6d4f4c7ebeb7644c6ac49f04d4380bffea4fd5a831879ed37c7d2
5
5
  SHA512:
6
- metadata.gz: 6c4fa0607b999dc875677218c0c12392fd699d5f647b37dfc0802ff1b0612bf06e9ccf564a9c562e5d5b5a4ece98b010864b1933693e3cf173446feef17ba9bb
7
- data.tar.gz: 10a488c7d5dce9facceac915de46887d76142b0a59686c21c5a484bc116555dee5fe8cc90bd1fecea2cbeb29399f356bfc48e78d84faf42f91dfa8ed5e18454d
6
+ metadata.gz: 7b2fcc69854a22adeb846fd8278bc92bdb4ce4c74ac7c487aec2020d7dc971615a0122b75cafe56b3c5f9626ff3f3140229a5a705b43cea889f16dd93fb8843f
7
+ data.tar.gz: 1961474e8828979d106fb521ceac878d4511808dca15754853bb542d50e8f38a566f7d32a57dff07f61b2131fa82f316c4118bc3593f2895fb867a6c01374cb2
@@ -1,5 +1,6 @@
1
1
  # Reference: https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
2
2
  # Validation: https://dependabot.com/docs/config-file/validator/
3
+
3
4
  version: 2
4
5
  updates:
5
6
  - package-ecosystem: "bundler"
@@ -0,0 +1,30 @@
1
+ name: Continuous Deployment # Well, semi-continuous
2
+
3
+ on:
4
+ push:
5
+ tags: v[0-9]+.[0-9]+.[0-9]+
6
+ env:
7
+ RUBY_VER: 3.0.1
8
+ jobs:
9
+ test:
10
+ runs-on: ubuntu-latest
11
+ steps:
12
+ - uses: actions/checkout@v2
13
+ - name: Set up Ruby
14
+ uses: ruby/setup-ruby@v1
15
+ with:
16
+ ruby-version: ${{ env.RUBY_VER }}
17
+ bundler-cache: true
18
+ - name: Run CI Build with Rake
19
+ run: bundle exec rake
20
+ release-github:
21
+ needs: [test]
22
+ runs-on: ubuntu-latest
23
+ steps:
24
+ - uses: actions/checkout@v2
25
+ - name: Build and publish gem to GitHub Packages
26
+ if: contains(github.ref, 'refs/tags/v')
27
+ uses: jstastny/publish-gem-to-github@master
28
+ with:
29
+ token: ${{ github.token }}
30
+ owner: ${{ github.repository_owner }}
@@ -0,0 +1,37 @@
1
+ name: "CodeQL"
2
+
3
+ on:
4
+ push:
5
+ branches: [ main ]
6
+ pull_request:
7
+ # The branches below must be a subset of the branches above
8
+ branches: [ main ]
9
+ schedule:
10
+ - cron: '41 19 1 * *'
11
+
12
+ jobs:
13
+ analyze:
14
+ name: Analyze
15
+ runs-on: ubuntu-latest
16
+ permissions:
17
+ actions: read
18
+ contents: read
19
+ security-events: write
20
+
21
+ strategy:
22
+ fail-fast: false
23
+ matrix:
24
+ language: [ 'ruby' ]
25
+
26
+ steps:
27
+ - name: Checkout repository
28
+ uses: actions/checkout@v2
29
+
30
+ # Initializes the CodeQL tools for scanning.
31
+ - name: Initialize CodeQL
32
+ uses: github/codeql-action/init@v1
33
+ with:
34
+ languages: ${{ matrix.language }}
35
+
36
+ - name: Perform CodeQL Analysis
37
+ uses: github/codeql-action/analyze@v1
data/.gitignore CHANGED
@@ -8,7 +8,7 @@ gemfiles/Gemfile*.lock
8
8
  # Bundle local config
9
9
  .bundle/
10
10
 
11
- # Package gem from ($rake install)
11
+ # Package gem from $(rake install)
12
12
  pkg/
13
13
 
14
14
  # simplecov
@@ -19,3 +19,6 @@ coverage/
19
19
  .rspec_status
20
20
  spec/dest/
21
21
  spec/reports/
22
+
23
+ # Jekyll - when switching from gh-pages-source branch
24
+ _site/
data/.rubocop.yml CHANGED
@@ -21,9 +21,17 @@ AllCops:
21
21
 
22
22
  Gemspec/DateAssignment:
23
23
  Enabled: true
24
+ Gemspec/RequireMFA:
25
+ Enabled: true
24
26
 
25
27
  Layout/LineEndStringConcatenationIndentation:
26
28
  Enabled: true
29
+ Layout/EmptyLineBetweenDefs:
30
+ Enabled: true
31
+ Exclude:
32
+ - lib/jekyll-glossary_tooltip/errors.rb
33
+ Layout/SpaceBeforeBrackets:
34
+ Enabled: true
27
35
 
28
36
  Lint/AmbiguousAssignment:
29
37
  Enabled: true
@@ -37,10 +45,16 @@ Lint/EmptyBlock:
37
45
  Enabled: true
38
46
  Lint/EmptyClass:
39
47
  Enabled: true
40
- Layout/EmptyLineBetweenDefs:
48
+ Lint/AmbiguousOperatorPrecedence:
49
+ Enabled: true
50
+ Lint/AmbiguousRange:
51
+ Enabled: true
52
+ Lint/IncompatibleIoSelectWithFiberScheduler:
53
+ Enabled: true
54
+ Lint/RequireRelativeSelfPath:
55
+ Enabled: true
56
+ Lint/UselessRuby2Keywords:
41
57
  Enabled: true
42
- Exclude:
43
- - lib/jekyll-glossary_tooltip/errors.rb
44
58
  Lint/EmptyInPattern:
45
59
  Enabled: true
46
60
  Lint/LambdaWithoutLiteralBlock:
@@ -55,8 +69,6 @@ Lint/OrAssignmentToConstant:
55
69
  Enabled: true
56
70
  Lint/RedundantDirGlobSort:
57
71
  Enabled: true
58
- Layout/SpaceBeforeBrackets:
59
- Enabled: true
60
72
  Lint/SymbolConversion:
61
73
  Enabled: true
62
74
  Lint/ToEnumArguments:
@@ -87,6 +99,11 @@ Naming/FileName:
87
99
  - lib/jekyll-glossary_tooltip.rb
88
100
  Naming/InclusiveLanguage:
89
101
  Enabled: true
102
+ Naming/BlockForwarding:
103
+ Enabled: true
104
+
105
+ Security/IoMethods:
106
+ Enabled: true
90
107
 
91
108
  Style/ArgumentsForwarding:
92
109
  Enabled: true
@@ -134,6 +151,22 @@ Style/StringLiteralsInInterpolation:
134
151
  EnforcedStyle: double_quotes
135
152
  Style/SwapValues:
136
153
  Enabled: true
154
+ Style/FileRead:
155
+ Enabled: true
156
+ Style/FileWrite:
157
+ Enabled: true
158
+ Style/MapToHash:
159
+ Enabled: true
160
+ Style/NumberedParameters:
161
+ Enabled: true
162
+ Style/NumberedParametersLimit:
163
+ Enabled: true
164
+ Style/OpenStructUse:
165
+ Enabled: true
166
+ Style/RedundantSelfAssignmentBranch:
167
+ Enabled: true
168
+ Style/SelectByRegexp:
169
+ Enabled: true
137
170
 
138
171
 
139
172
  # Reference: https://github.com/rubocop/rubocop-rake/blob/master/config/default.yml
@@ -154,3 +187,9 @@ RSpec/Rails/AvoidSetupHook:
154
187
  Enabled: false
155
188
  RSpec/BeforeAfterAll:
156
189
  Enabled: false
190
+ RSpec/ExcessiveDocstringSpacing:
191
+ Enabled: true
192
+ RSpec/SubjectDeclaration:
193
+ Enabled: true
194
+ RSpec/FactoryBot/SyntaxMethods:
195
+ Enabled: true
data/.ruby-version CHANGED
@@ -1 +1 @@
1
- 3.0.1
1
+ 3.1.0
data/.simplecov CHANGED
@@ -1,6 +1,7 @@
1
1
  # vi: ft=ruby
2
2
 
3
3
  SimpleCov.start do
4
- enable_coverage :branch # Add branch coverage statistics.
5
- minimum_coverage 90 # Minimum coverage percentage.
4
+ enable_coverage :branch # Add branch coverage statistics.
5
+ minimum_coverage 90 # Minimum coverage percentage.
6
+ command_name "test:bdd" # Must be set for codeclimat reporter
6
7
  end
data/.travis.yml CHANGED
@@ -11,6 +11,7 @@ env:
11
11
  global:
12
12
  - CC_TEST_REPORTER_ID=8b8822cdaba8bb6c0a9d3f05bea9bc94dbf866ccdd1204913f5673b61caa61b1
13
13
  language: ruby
14
+ dist: focal # TODO Remove this when solved: https://github.com/rvm/rvm/issues/5133
14
15
  # Buid matrix (rvm x gemfile = 2x2) with one version from each supported major version in range defined in .gemspec for
15
16
  rvm:
16
17
  - 2.7.0
data/CHANGELOG.md CHANGED
@@ -1,16 +1,34 @@
1
+ # Changelog
2
+ All notable changes to this project will be documented in this file.
3
+
4
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
+
7
+ ## [Unreleased]
8
+
1
9
  ## [1.3.1] - 2021-08-18
2
- - Fix gemspec dependency range stynax.
10
+ ### Added
11
+ - GitHub workflow to publish to GitHub Packages.
12
+
13
+ ## [1.3.1] - 2021-08-18
14
+ ### Fixed
15
+ - gemspec dependency range stynax.
3
16
 
4
17
  ## [1.3.0] - 2021-08-07
18
+ ### Changed
5
19
  - Open the souce link from a tooltip in a new tab.
6
20
 
7
21
  ## [1.2.0] - 2021-08-06
8
- - Add bottom arrow to the tooltip.
22
+ ### Added
23
+ - Bottom arrow to the tooltip.
24
+ - Tooltip hover animation from invisible to visible.
25
+
26
+ ### Changed
9
27
  - Restyle the glossary term bottom border style and color.
10
- - Add tooltip hover animation from invisible to visible.
11
28
 
12
29
  ## [1.1.0] - 2021-08-06
13
- - 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 %}`.
30
+ ### Added
31
+ - 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 %}`.
14
32
 
15
33
  ## [1.0.0] - 2021-08-05
16
34
  - No changes from `v0.1.0` but just bumping to final first major release version!
data/OSSMETADATA ADDED
@@ -0,0 +1 @@
1
+ osslifecycle=active
data/README.md CHANGED
@@ -1,15 +1,22 @@
1
- # Jekyll Glossary Tooltip Tag Plugin
1
+ # 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)
2
2
  [![Gem Version](https://badge.fury.io/rb/jekyll-glossary_tooltip.svg)](https://badge.fury.io/rb/jekyll-glossary_tooltip)
3
3
  [![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)
4
- [![Travis Build Status](https://img.shields.io/travis/erikw/jekyll-glossary_tooltip/main?logo=travis)](https://travis-ci.com/erikw/jekyll-glossary_tooltip)
4
+ [![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)
5
5
  [![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/7ffb648ec4b77f3f9eb8/maintainability)](https://codeclimate.com/github/erikw/jekyll-glossary_tooltip/maintainability)
6
6
  [![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/7ffb648ec4b77f3f9eb8/test_coverage)](https://codeclimate.com/github/erikw/jekyll-glossary_tooltip/test_coverage)
7
+ [![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)
8
+ [![SLOC](https://img.shields.io/tokei/lines/github/erikw/jekyll-glossary_tooltip)](#)
9
+ [![License](https://img.shields.io/github/license/erikw/jekyll-glossary_tooltip)](LICENSE.txt)
10
+ [![OSS Lifecycle](https://img.shields.io/osslifecycle/erikw/jekyll-glossary_tooltip)](https://github.com/Netflix/osstracker)
11
+
12
+
13
+ :point_right: **Live demo**: https://erikw.github.io/jekyll-glossary_tooltip/
7
14
 
8
15
  <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'.">
9
16
 
10
17
  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.
11
18
 
12
- 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.
19
+ 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.
13
20
 
14
21
 
15
22
  # Installation
@@ -35,7 +42,7 @@ It's also possible to provide an optional URL to further term definition or sour
35
42
 
36
43
  # Usage
37
44
  ## Glossary Term Definition File
38
- Create a file `_data/glossary.yml` to host your shared term definition entries. This file should contain a list of term entries like
45
+ 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:
39
46
 
40
47
  ```markdown
41
48
  - term: a_term_name # Can contain spaces
@@ -92,7 +99,7 @@ After checking out the repo;
92
99
  1. run `script/test` to run the tests
93
100
  1. You can also run `script/console` for an interactive prompt that will allow you to experiment.
94
101
 
95
- 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).
102
+ To install this gem onto your local machine, run `bundle exec rake install`.
96
103
 
97
104
 
98
105
  ## Local development
@@ -175,6 +182,9 @@ To use the [travis cli client](https://github.com/travis-ci/travis.rb) (installe
175
182
  $ bundle exec travis monitor
176
183
  ```
177
184
 
185
+ ## Live Demo GitHub Pages
186
+ 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`!
187
+
178
188
  # Contributing
179
189
  Bug reports and pull requests are welcome on GitHub at https://github.com/erikw/jekyll-glossary_tooltip.
180
190
 
@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
8
8
  spec.authors = ["Erik Westrup"]
9
9
  spec.email = ["erik.westrup@gmail.com"]
10
10
 
11
- spec.summary = "Jekyll plugin providing a glossary liquid tag that will show a tooltip of a term definition in your site"
11
+ spec.summary = "Jekyll plugin providing a glossary liquid tag that will show a tooltip of a term definition in your site."
12
12
  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."
13
13
  spec.homepage = "https://github.com/erikw/jekyll-glossary_tooltip/"
14
14
  spec.license = "MIT"
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Jekyll
4
4
  module GlossaryTooltip
5
- VERSION = "1.3.1"
5
+ VERSION = "1.4.0"
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-glossary_tooltip
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.1
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Erik Westrup
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2021-08-18 00:00:00.000000000 Z
11
+ date: 2022-01-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -45,6 +45,8 @@ files:
45
45
  - ".codeclimate.yml"
46
46
  - ".editorconfig"
47
47
  - ".github/dependabot.yml"
48
+ - ".github/workflows/cd.yml"
49
+ - ".github/workflows/codeql-analysis.yml"
48
50
  - ".gitignore"
49
51
  - ".rspec"
50
52
  - ".rubocop.yml"
@@ -56,6 +58,7 @@ files:
56
58
  - CONTRIBUTING.md
57
59
  - Gemfile
58
60
  - LICENSE.txt
61
+ - OSSMETADATA
59
62
  - README.md
60
63
  - Rakefile
61
64
  - SECURITY.md
@@ -101,9 +104,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
101
104
  - !ruby/object:Gem::Version
102
105
  version: '0'
103
106
  requirements: []
104
- rubygems_version: 3.2.15
107
+ rubygems_version: 3.3.3
105
108
  signing_key:
106
109
  specification_version: 4
107
110
  summary: Jekyll plugin providing a glossary liquid tag that will show a tooltip of
108
- a term definition in your site
111
+ a term definition in your site.
109
112
  test_files: []