metanorma-plugin-glossarist 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b06eede0539ad9fda202136bb7d97aded91a6e925536234e822bdff0a067996e
-  data.tar.gz: 96981f754d34698da5288b12df8fe54719e9e40e15f96413a1cbad9f63962e4e
+  metadata.gz: c15949c9576065603f4a70e07d513df78d3042747d5506a4a80a0aaf23189b99
+  data.tar.gz: 7231ecb9af7c8dd43cc7ee9419d1a179ceaf468e6af248ac5ab183600afb6f27
 SHA512:
-  metadata.gz: 9dd3c3ec6cd75a5aeb4f718e567374820ed074de9dd428919b7e3c9d038f95b116d61d2f29478c25e624aa35f593da0ca9e31fd280be43c9ea46e75cfdfce824
-  data.tar.gz: 1ea5f7d523beecdb2a1c67f9282064b5791f537ca6f6743d17329aefab4492421b758ee4f3728332653f567cb92f1c0c4977010ecbce86c4f92d79328adb5701
+  metadata.gz: d0d74131f0d39fe1c75893814730551db56f6471bacbd5c18f85a53fb07c440da28d1d7fb70ab8e7cf47db63f2a92b099f866269ad46e5acec944dff9fed9808
+  data.tar.gz: 999be7b8d32c5204e0c7b822b4ae2536e4b7f4b327986ab86d635bd60b6d210b2556f23b9e71d1f1c940e303fe8f57eb940a13872e8941636aa4d665d1372248

data/README.adoc

@@ -569,7 +569,9 @@ glossarist::render_bibliography_entry[{dataset-name}, {term}]
 
 Where,
 
-`{dataset-name}`:: The name of the dataset (e.g., `dataset`).
+`{dataset-name}`:: The name of the dataset (e.g., `dataset`) or the path to the
+Glossarist dataset relative to the master document
+(e.g., `./path/to/glossarist-dataset`).
 
 `{term}`:: The term to render the bibliography for (e.g., `foo`).
 
@@ -617,7 +619,9 @@ glossarist::render_bibliography[{dataset-name}]
 
 Where,
 
-`{dataset-name}`:: The name of the dataset (e.g., `dataset`).
+`{dataset-name}`:: The name of the dataset (e.g., `dataset`) or the path to the
+Glossarist dataset relative to the master document
+(e.g., `./path/to/glossarist-dataset`).
 
 [example]
 ====

data/lib/metanorma/plugin/glossarist/dataset_preprocessor.rb

@@ -6,11 +6,14 @@ require "liquid"
 require "asciidoctor/reader"
 require "glossarist"
 require "metanorma/plugin/glossarist/document"
+require "metanorma/plugin/glossarist/liquid/custom_filters/filters"
 
 module Metanorma
   module Plugin
     module Glossarist
       class DatasetPreprocessor < Asciidoctor::Extensions::Preprocessor
+        include Metanorma::Plugin::Glossarist::Liquid::CustomFilters::Filters
+
         GLOSSARIST_DATASET_REGEX = /^:glossarist-dataset:\s*(.*?)$/m.freeze
         GLOSSARIST_IMPORT_REGEX = /^glossarist::import\[(.*?)\]$/m.freeze
         GLOSSARIST_RENDER_REGEX = /^glossarist::render\[(.*?)\]$/m.freeze
@@ -105,9 +108,9 @@ module Metanorma
           elsif match = current_line.match(GLOSSARIST_IMPORT_REGEX)
             process_import_tag(liquid_doc, match)
           elsif match = current_line.match(GLOSSARIST_BIBLIOGRAPHY_REGEX)
-            process_bibliography(liquid_doc, match)
+            process_bibliography(document, liquid_doc, match)
           elsif match = current_line.match(GLOSSARIST_BIBLIOGRAPHY_ENTRY_REGEX)
-            process_bibliography_entry(liquid_doc, match)
+            process_bibliography_entry(document, liquid_doc, match)
           elsif match = current_line.match(GLOSSARIST_BLOCK_REGEX)
             process_glossarist_block(document, liquid_doc, input_lines, match)
           else
@@ -199,32 +202,44 @@ module Metanorma
 
         def process_render_tag(liquid_doc, match)
           @seen_glossarist << "x"
-          context_name, concept_name = match[1].split(",")
+          matches = match[1].split(",").map(&:strip)
+
+          context_name = matches[0]
+          concept_name = matches[1]
+          render_options = matches[2..-1]
 
           liquid_doc.add_content(
-            concept_template(context_name.strip, concept_name.strip),
+            concept_template(context_name.strip, concept_name.strip,
+                             render_options),
           )
         end
 
-        def process_import_tag(liquid_doc, match) # rubocop:disable Metrics/AbcSize
+        def process_import_tag(liquid_doc, match) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
           @seen_glossarist << "x"
-          context_name = match[1].strip
-          dataset = @datasets[context_name]
+          matches = match[1].split(",").map(&:strip)
+          context_name = matches[0]
+          render_options = matches[1..-1]
+          dataset = @datasets[context_name.strip]
 
           liquid_doc.add_content(
             dataset.map do |concept|
               concept_name = concept.data.localizations["eng"].data
                 .terms[0].designation
-              concept_template(context_name, concept_name)
+              concept_template(context_name, concept_name, render_options)
             end.join("\n"),
           )
         end
 
-        def process_bibliography(liquid_doc, match)
+        def process_bibliography(document, liquid_doc, match) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
           @seen_glossarist << "x"
           dataset_name = match[1].strip
           dataset = @datasets[dataset_name]
 
+          if dataset.nil? || @datasets.empty?
+            path = relative_file_path(document, dataset_name)
+            dataset = load_dataset_from_path(path)
+          end
+
           liquid_doc.add_content(
             dataset.map do |concept|
               concept_bibliography(concept)
@@ -232,11 +247,12 @@ module Metanorma
           )
         end
 
-        def process_bibliography_entry(liquid_doc, match)
+        def process_bibliography_entry(document, liquid_doc, match)
           @seen_glossarist << "x"
           dataset_name, concept_name = match[1].split(",").map(&:strip)
-          concept = get_concept(dataset_name, concept_name)
+          concept = get_concept(dataset_name, concept_name, document)
           bibliography = concept_bibliography(concept)
+
           if bibliography
             liquid_doc.add_content(bibliography)
           end
@@ -261,15 +277,19 @@ module Metanorma
           contexts.split(";").map do |context|
             context_name, file_path = context.split(":").map(&:strip)
             path = relative_file_path(document, file_path)
-
-            dataset = ::Glossarist::ManagedConceptCollection.new
-            dataset.load_from_files(path)
+            dataset = load_dataset_from_path(path)
             @datasets[context_name] = dataset.map(&:to_liquid)
 
             "#{context_name}=#{path}"
           end
         end
 
+        def load_dataset_from_path(path)
+          dataset = ::Glossarist::ManagedConceptCollection.new
+          dataset.load_from_files(path)
+          dataset
+        end
+
         def relative_file_path(document, file_path)
           docfile_directory = File.dirname(
             document.attributes["docfile"] || ".",
@@ -279,9 +299,13 @@ module Metanorma
             .system_path(file_path, docfile_directory)
         end
 
-        def concept_template(dataset_name, concept_name)
+        def concept_template(dataset_name, concept_name, options = [])
+          options = options_to_hash(options)
+
           <<~CONCEPT_TEMPLATE
+            [[#{identifier(dataset_name, concept_name, options)}]]
             #{'=' * (@title_depth[:value] + 1)} #{concept_title(dataset_name, concept_name)}
+
             #{alt_terms(dataset_name, concept_name)}
 
             #{concept_definition(dataset_name, concept_name)}
@@ -294,14 +318,38 @@ module Metanorma
           CONCEPT_TEMPLATE
         end
 
-        def get_concept(dataset_name, concept_name)
-          @datasets[dataset_name].find do |c|
+        def get_concept(dataset_name, concept_name, document = nil)
+          dataset = @datasets[dataset_name]
+
+          if document && dataset.nil?
+            path = relative_file_path(document, dataset_name)
+            dataset = load_dataset_from_path(path)
+          end
+
+          dataset.find do |c|
             c.data.localizations["eng"]
               .data.terms[0]
               .designation == concept_name
           end
         end
 
+        def identifier(dataset_name, concept_name, options = {})
+          prefix = options["anchor-prefix"].to_s if options["anchor-prefix"]
+          concept = get_concept(dataset_name, concept_name)
+
+          id = "#{prefix}#{concept.data.id}"
+          # id starts with digits 0-9
+          return id if id.start_with?(/[0-9]/)
+
+          Metanorma::Utils.to_ncname(id.gsub(":", "_"))
+        end
+
+        def options_to_hash(options_arr)
+          return {} if !options_arr || options_arr.empty?
+
+          options_arr.map { |option| option.split("=") }.to_h
+        end
+
         def concept_title(dataset_name, concept_name)
           concept = get_concept(dataset_name, concept_name)
           concept.data.localizations["eng"].data.terms[0].designation
@@ -311,7 +359,7 @@ module Metanorma
           concept = get_concept(dataset_name, concept_name)
           definition = concept.data.localizations["eng"].data
             .definition[0].content
-          definition.to_s
+          sanitize_references(definition.to_s)
         end
 
         def alt_terms(dataset_name, concept_name) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
@@ -337,7 +385,7 @@ module Metanorma
           examples.each do |example|
             content = <<~EXAMPLE
               [example]
-              #{example.content}
+              #{sanitize_references(example.content)}
 
             EXAMPLE
             result << content
@@ -355,7 +403,7 @@ module Metanorma
             content = <<~NOTE
               [NOTE]
               ====
-              #{note.content}
+              #{sanitize_references(note.content)}
               ====
 
             NOTE

data/lib/metanorma/plugin/glossarist/liquid/custom_filters/filters.rb

@@ -6,10 +6,21 @@ module Metanorma
       module Liquid
         module CustomFilters
           module Filters
+            REF_REGEX = /{{([^,]{1,500}),([^\}]{1,500})}}(.*?)$/s.freeze
+
             def values(list)
               list.values
             end
 
+            def sanitize_references(str)
+              return str unless str.match?(REF_REGEX)
+
+              matched_str = str.match(REF_REGEX)
+              urn = Metanorma::Utils.to_ncname(matched_str[1]).gsub(":", "_")
+
+              "{{#{urn},#{matched_str[2]}}}#{matched_str[3]}"
+            end
+
             def terminological_data(term)
               result = []
 

data/lib/metanorma/plugin/glossarist/version.rb

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Glossarist
-      VERSION = "0.2.9".freeze
+      VERSION = "0.2.10".freeze
     end
   end
 end

data/lib/metanorma-plugin-glossarist.rb

@@ -1,6 +1,7 @@
 require "metanorma/plugin/glossarist/version"
 require "metanorma/plugin/glossarist/document"
 require "metanorma/plugin/glossarist/dataset_preprocessor"
+require "metanorma-utils"
 
 module Metanorma
   module Plugin

data/metanorma-plugin-glossarist.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "asciidoctor"
   spec.add_dependency "glossarist", "~> 2.3.7"
   spec.add_dependency "liquid"
+  spec.add_dependency "metanorma-utils", "~> 1.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-glossarist
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-17 00:00:00.000000000 Z
+date: 2025-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: metanorma-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 description: Metanorma plugin for glossarist
 email:
 - open.source@ribose.com