elixir-toolkit-theme-plugins 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 989e78f7e6995bb095549eb94361934f40c944b45c207f24820d91c518006280
-  data.tar.gz: ae7e2b72145732bcdcfc52cabb325eae06c1910a5de7fe2781b958184f93e318
+  metadata.gz: 8c89eb377a675bfe33fabd2c0a4b85f5a2a69224f2969d2b77bd8769ed0d3926
+  data.tar.gz: d1a6d47ad43ec14f31826c45794a8f66da4d291a5e6dc8ae1311ed91fc47952c
 SHA512:
-  metadata.gz: 2869b8b726d00bb4c58e105c97563e61836f122b449decfa13851d8f7a09d1c489b96121f41af6c0a97c6fbc9f34809b2c64ffb0907943fe2f3041e8a82150f9
-  data.tar.gz: 07eea18abf4bbe4bb3bcca9303bc4a21c121a1d5d6c98309c8d8df3a3383dc468f9fcb2e1be910b6b289e7dc827e7cd939b67b510bd97c72fd5e8cc663a27fb6
+  metadata.gz: 8cf38f17e18d4db1240fa2a7a5a771bfffa5d9338688db9be1980ce6001b26ecbd399c879eee1e344b5ef3eb08dd6dc95cc054dc921539166696cf763dcebf86
+  data.tar.gz: e921fb66f5c9462050779973e9fe4277cc2a646a2b22cff6062db00c8f9acfb8efb3de0c57fef4987f2400bc5b440523eb49d400ffa2ef432607fd42a3c923e0

data/README.md

@@ -7,3 +7,54 @@ This features include:
 * An improved way of tagging tools from a central tools table in the content of a page.
 * Making sure the correct Git branch is detected when the theme is being deployed.
 
+## Local development
+
+### Requirements
+
+* **Ruby** (the release workflow uses Ruby 3.3)
+* **Bundler**
+
+### Building the gem locally
+
+The gem version is read from [`lib/elixir-toolkit-theme-plugins/version.rb`](lib/elixir-toolkit-theme-plugins/version.rb), so bump `VERSION` there first if needed. Then build from the root of this repository:
+
+```sh
+gem build elixir-toolkit-theme-plugins.gemspec
+```
+
+This produces `elixir-toolkit-theme-plugins-<VERSION>.gem`. Built gems are ignored by `.gitignore`, so they will not show up in `git status`.
+
+To install your local build into your Ruby installation:
+
+```sh
+gem install ./elixir-toolkit-theme-plugins-<VERSION>.gem
+```
+
+### Testing with an ETT deployment
+
+You need a Jekyll site that uses the theme to see the plugins in action. Either works:
+
+* the [theme repository](https://github.com/ELIXIR-Belgium/elixir-toolkit-theme) itself, which is a full Jekyll site
+* the [example site](https://github.com/ELIXIR-Belgium/elixir-toolkit-theme-example)
+
+
+Pin that exact version in the site's `Gemfile`:
+
+```ruby
+gem "elixir-toolkit-theme-plugins", "<VERSION>"
+```
+
+Followed by `bundle install`. This is the closest match to what users get from RubyGems.
+
+#### What to check
+
+The plugins only do something on pages that use them, so make sure your test site exercises them:
+
+* The `{% tool "tool_id" %}` tag and the resource tables read `_data/tool_and_resource_list.yml` from the **site root**. Run `jekyll` from that root, otherwise the tools file is not found.
+* In the theme repository, `pages/documentation/resource_table.md` already contains `{% tool %}` examples. Load that page and click a tool to open its popover.
+
+## Releasing
+
+Releases are automated by [`.github/workflows/release.yml`](.github/workflows/release.yml).
+
+Consumers pin this gem to an exact version, so a new release also needs the version bumped in the theme's `Gemfile` and `elixir-toolkit-theme.gemspec`.

data/lib/elixir-toolkit-theme-plugins/tool_tag.rb

@@ -108,7 +108,7 @@ module Jekyll
                     data-bs-content="<h5>#{html_escape(tool["name"])}</h5><div class='mb-2'>#{html_escape(tool["description"])}</div><div class='d-flex flex-wrap gap-1'>#{tags}</div>"
                     data-bs-template="<div class='popover popover-tool' role='tooltip'><div class='popover-arrow'></div><h3 class='popover-header'></h3><div class='popover-body'></div></div>"
                     data-bs-html="true"
-                    ><i class="fa-solid fa-wrench fa-sm me-2"></i>#{ html_escape(tool["name"]) }</a>}
+                    ><i class="icon-wrench me-2"></i>#{ html_escape(tool["name"]) }</a>}
             end
 
             def find_tool(tool_id)
@@ -119,14 +119,13 @@ module Jekyll
 
             def create_tags(tool, site)
                 tags = ""
-                tags << create_tag("#{tool["url"]}", "fa-link", "Website")
+                tags << create_tag("#{tool["url"]}", "icon-link", "Website")
                 if tool["registry"]
                     registry = tool["registry"]
-                    tags << create_tag("https://bio.tools/#{registry["biotools"]}", "fa-info", "Tool info") if registry["biotools"] && registry["biotools"] != "NA"
-                    tags << create_tag("https://fairsharing.org/FAIRsharing.#{registry["fairsharing"]}", "fa-database", "Standards/Databases") if registry["fairsharing"] && registry["fairsharing"] != "NA"
-                    tags << create_tag("https://fairsharing.org/#{registry["fairsharing-coll"]}", "fa-database", "Standards/Databases") if registry["fairsharing-coll"] && registry["fairsharing-coll"] != "NA"
-                    tags << create_tag("https://tess.elixir-europe.org/search?q=#{registry["tess"]}", "fa-graduation-cap", "Training") if registry["tess"] && registry["tess"] != "NA"
-                    tags << create_tag("https://europepmc.org/article/MED/#{registry["europmc"]}", "fa-book", "Publication") if registry["europmc"] && registry["europmc"] != "NA"
+                    tags << create_tag("https://bio.tools/#{registry["biotools"]}", "icon-info", "Tool info") if registry["biotools"] && registry["biotools"] != "NA"
+                    tags << create_tag("https://fairsharing.org/FAIRsharing.#{registry["fairsharing"]}", "icon-database", "Standards/Databases") if registry["fairsharing"] && registry["fairsharing"] != "NA"
+                    tags << create_tag("https://tess.elixir-europe.org/search?q=#{registry["tess"]}", "icon-graduation-cap", "Training") if registry["tess"] && registry["tess"] != "NA"
+                    tags << create_tag("https://europepmc.org/article/MED/#{registry["europmc"]}", "icon-book-open", "Publication") if registry["europmc"] && registry["europmc"] != "NA"
                 end
 
                 instances = @instances_by_tool[tool["id"]]
@@ -135,7 +134,7 @@ module Jekyll
             end
 
             def create_tag(url, icon, label)
-                "<a href='#{html_attr(url)}' target='_blank' rel='noopener'><span class='badge bg-dark text-white hover-primary'><i class='fa-solid #{icon} me-2'></i>#{html_escape(label)}</span></a>"
+                "<a href='#{html_attr(url)}' target='_blank' rel='noopener'><span class='badge bg-dark text-white hover-primary'><i class='#{icon} me-2'></i>#{html_escape(label)}</span></a>"
             end
 
             def instances_dropdown(instances, site, tool_id)
@@ -143,7 +142,8 @@ module Jekyll
 
                 items = instances.map do |inst|
                     href = inst["url"] || resolve_page_url(inst["page_path"], site) || "#"
-                    flag = inst["country_code"].to_s.strip.empty? ? "" : "<span class='flag-icon ms-2 shadow-sm flag-icon-#{inst["country_code"].downcase}'></span>"
+                    country_code = inst["country_code"].to_s.strip.downcase
+                    flag = country_code.empty? ? "" : "<span class='fi fi-#{html_attr(country_code)} ms-2 shadow-sm'></span>"
                     name = html_escape(inst["name"])
                     url  = html_attr(href)
                     "<li><a class='dropdown-item' href='#{url}' target='_blank' rel='noopener'>#{name} #{flag}</a></li>"
@@ -156,7 +156,7 @@ module Jekyll
                             id='#{dd_id}'
                             data-bs-toggle='dropdown'
                             aria-expanded='false'>
-                    <i class='fa-solid fa-globe me-2'></i>Instances
+                    <i class='icon-globe me-2'></i>Instances
                     </button>
                     <ul class='dropdown-menu' aria-labelledby='#{dd_id}'>
                     #{items}

data/lib/elixir-toolkit-theme-plugins/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
     class Ett
-      VERSION = '1.1.0'
+      VERSION = '2.0.0'
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elixir-toolkit-theme-plugins
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - bedroesb
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-07 00:00:00.000000000 Z
+date: 2026-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll