elixir-toolkit-theme-plugins 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5431866052192d991faafb26e51d098141d161b58138d7ac87aa1107d79766ba
+  data.tar.gz: 735ca9af6a810b9e2d040097546c0d3fbffc2aec1611e0af7af1137c4fb0d664
+SHA512:
+  metadata.gz: 484d25bb4f6579f4edbd1b633f20bf77a51d34959bb26b109270ab3fa1cd591183e9dd25c93fd837758920ffd64fb911f1884d3e7ac03ecdef07909c3da1fd48
+  data.tar.gz: b1dd4b53bb2bbc763a771da90c1ef599f52eb6c31bc33dae4241bf554fde852ab2b94ee5c4571feb876c5c03c031a1abc435b7695e18d23ab9e5e0a5a65f7555

data/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Releasing Ruby Gem
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1.127.0
+      with:
+        ruby-version: '3.1'
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1 @@
+elixir-toolkit-theme-plugins*

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ELIXIR Belgium
+
+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 @@
+# elixir-toolkit-theme-plugins

data/elixir-toolkit-theme-plugins.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'elixir-toolkit-theme-plugins/version'
+require 'rake'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elixir-toolkit-theme-plugins"
+  spec.version       =  Jekyll::Ett::VERSION.dup
+  spec.authors       = ["bedroesb","janslifka"]
+  spec.email         = ["bedro@psb.vib-ugent.be\n"]
+
+  spec.summary       = "Plugins to work together with ELIXIR Toolkit theme"
+  spec.homepage      = "https://elixir-belgium.github.io/elixir-toolkit-theme-plugins/"
+  spec.license       = "MIT"
+
+  spec.date        = Time.now
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "jekyll", '~> 4.3', ">= 4.3.1"
+  spec.add_development_dependency "rake", "~> 12.0"
+end

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

@@ -0,0 +1,40 @@
+require "jekyll"
+
+
+module Jekyll
+    class Ett
+        module ToolTableFilter
+            def add_related_pages(data)
+                load_page_data
+
+                for tool in data
+                    if tool['id'] && @related_pages[tool['id']]
+                        tool['related_pages'] = @related_pages[tool['id']].to_a
+                    end
+                end
+
+                data
+            end
+
+            private
+
+            def load_page_data
+                @related_pages = {}
+                pages_path = File.join(Dir.pwd, "pages", "**", "*.md")
+                Dir.glob(pages_path).each do |f|
+                    file = File.read(f)
+                    page_id_matches = file.match(/page_id:\s*(\w+)/)
+                    
+                    if page_id_matches
+                        page_id = page_id_matches[1]
+                        file.scan(/\{% tool "([^"]+)" %}/).flatten.each do |m|
+                            @related_pages[m] = Set[] unless @related_pages[m]
+                            @related_pages[m].add(page_id)
+                        end
+                    end
+                end
+            end
+        end
+    end
+    Liquid::Template.register_filter(Jekyll::Ett::ToolTableFilter)
+end

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

@@ -0,0 +1,70 @@
+require "jekyll"
+
+
+module Jekyll
+    class Ett
+        class ToolTag < Liquid::Tag
+            def initialize(tagName, content, tokens)
+                super
+                @content = content
+                load_tools
+            end
+
+            def load_tools
+                tools_path = File.join(Dir.pwd, "_data", "tool_and_resource_list.yml")
+                @tools = YAML.load(File.read(tools_path))
+            end
+
+            def render(context)
+                tool = find_tool(context[@content.strip])
+                tags = create_tags(tool["registry"])
+
+                %Q{<a
+                    tabindex="0"
+                    class="tool"
+                    aria-description="#{tool["description"]}"
+                    data-bs-toggle="popover"
+                    data-bs-placement="bottom"
+                    data-bs-trigger="focus"
+                    data-bs-content="<h5><a href='#{tool["url"]}' target='_blank'>#{tool["name"]}</a></h5><div class='mb-2'>#{tool["description"]}</div>#{tags}"
+                    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 me-2"></i>#{ tool["name"] }</a>}
+            end
+
+            def find_tool(tool_id)
+                tool = @tools.find { |t| t["id"] == tool_id }
+                return tool if tool
+                
+                raise Exception.new "Undefined tool ID: #{tool_id}"
+            end
+
+            def create_tags(registry)
+                tags = ""
+
+                if registry["biotools"]
+                    tags << create_tag("https://bio.tools/#{registry["biotools"]}", "fa-info", "Tool info")
+                end
+
+                if registry["fairsharing"]
+                    tags << create_tag("https://fairsharing.org/FAIRsharing.#{registry["fairsharing"]}", "fa-database", "Standards/Databases")
+                end
+
+                if registry["fairsharing-coll"]
+                    tags << create_tag("https://fairsharing.org/#{registry["fairsharing-coll"]}", "fa-database", "Standards/Databases")
+                end
+
+                if registry["tess"]
+                    tags << create_tag("https://tess.elixir-europe.org/search?q=#{registry["tess"]}", "fa-graduation-cap", "Training")
+                end
+
+                tags
+            end
+
+            def create_tag(url, icon, label)
+                "<a href='#{url}' class='mt-2 me-2'><span class='badge bg-dark text-white hover-primary'><i class='fa-solid #{icon} me-2'></i>#{label}</span></a>"
+            end
+        end
+    end
+    Liquid::Template.register_tag("tool", Jekyll::Ett::ToolTag)
+end

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

@@ -0,0 +1,5 @@
+module Jekyll
+    class Ett
+      VERSION = '0.1.0'
+    end
+  end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+
+require "elixir-toolkit-theme-plugins/version"
+require "elixir-toolkit-theme-plugins/tool_table_filter"
+require "elixir-toolkit-theme-plugins/tool_tag"

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: elixir-toolkit-theme-plugins
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bedroesb
+- janslifka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: 
+email:
+- 'bedro@psb.vib-ugent.be
+
+  '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".gitignore"
+- LICENSE
+- README.md
+- elixir-toolkit-theme-plugins.gemspec
+- lib/elixir-toolkit-theme-plugins.rb
+- lib/elixir-toolkit-theme-plugins/tool_table_filter.rb
+- lib/elixir-toolkit-theme-plugins/tool_tag.rb
+- lib/elixir-toolkit-theme-plugins/version.rb
+homepage: https://elixir-belgium.github.io/elixir-toolkit-theme-plugins/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Plugins to work together with ELIXIR Toolkit theme
+test_files: []