metanorma-plugin-glossarist 0.2.8 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a311ce06912e8b9b57e5aa6993cda8a35f8ef887aaaf2aec8d1899e8c7e39cd4
-  data.tar.gz: 15c7a6268a0bd292105860a316fb747d8be26977d8223f3808f47c2db2a2d7b8
+  metadata.gz: c15949c9576065603f4a70e07d513df78d3042747d5506a4a80a0aaf23189b99
+  data.tar.gz: 7231ecb9af7c8dd43cc7ee9419d1a179ceaf468e6af248ac5ab183600afb6f27
 SHA512:
-  metadata.gz: 5a296bc7cdac4225dc07db3d11faa14a22188a65c6636ee8d31cebe63c039902074aa76ae8b754c21ecc1298ea0d36cb115c6ab637e2b36808bc9126e694ed46
-  data.tar.gz: a8eb548632a313635b2318a38ffca8e6c7254fe0e98aa03904b213287098e4828c83777b406fd288ff4df17ed345fd7c6d5ada38e8df0ee2121d22baa67c8efb
+  metadata.gz: d0d74131f0d39fe1c75893814730551db56f6471bacbd5c18f85a53fb07c440da28d1d7fb70ab8e7cf47db63f2a92b099f866269ad46e5acec944dff9fed9808
+  data.tar.gz: 999be7b8d32c5204e0c7b822b4ae2536e4b7f4b327986ab86d635bd60b6d210b2556f23b9e71d1f1c940e303fe8f57eb940a13872e8941636aa4d665d1372248

data/README.adoc

@@ -83,7 +83,7 @@ Syntax:
 
 [source,adoc]
 ------
-[glossarist,{dataset-path},{filters},{context}]
+[glossarist,{dataset-path},{filter=filters},{template=path/to/template},{context}]
 ----
 // Liquid template
 ----
@@ -96,9 +96,12 @@ Where,
 
 `{context}`:: The context in which the dataset is being used (e.g., `concepts`).
 
-`{filters}`:: (Optional) Filters to apply to the dataset prior to making the
+`{filter=filters}`:: (Optional) Filters to apply to the dataset prior to making the
 `context` available.
 
+`{template=path/to/template}`:: (Optional) The path to a Liquid template folder
+to use for rendering.
+
 [example]
 ======
 Given the following Glossarist block:
@@ -566,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`).
 
@@ -614,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,16 +6,18 @@ 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
-        GLOSSARIST_BLOCK_REGEX = /^\[glossarist,(.+?),(.+?)\]/.freeze
-        GLOSSARIST_FILTER_BLOCK_REGEX = /^\[glossarist,(.+?),(filter=.+?),(.+?)\]/.freeze # rubocop:disable Layout/LineLength
+        GLOSSARIST_BLOCK_REGEX = /^\[glossarist,(.+?),(.+?)\]$/m.freeze
         GLOSSARIST_BIBLIOGRAPHY_REGEX = /^glossarist::render_bibliography\[(.*?)\]$/m.freeze # rubocop:disable Layout/LineLength
         GLOSSARIST_BIBLIOGRAPHY_ENTRY_REGEX = /^glossarist::render_bibliography_entry\[(.*?)\]$/m.freeze # rubocop:disable Layout/LineLength
 
@@ -57,13 +59,7 @@ module Metanorma
 
         def process(document, reader)
           input_lines = reader.lines.to_enum
-
-          file_system = ::Liquid::LocalFileSystem.new(
-            relative_file_path(document, ""),
-          )
-
-          @config[:file_system] = file_system
-
+          @config[:file_system] = relative_file_path(document, "")
           processed_doc = prepare_document(document, input_lines)
           log(document, processed_doc.to_s) unless @seen_glossarist.empty?
           Asciidoctor::PreprocessorReader.new(document,
@@ -112,18 +108,14 @@ 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)
-          elsif match = current_line.match(GLOSSARIST_FILTER_BLOCK_REGEX)
-            process_glossarist_block(document, liquid_doc, input_lines, match)
-          elsif match = current_line.match(GLOSSARIST_BLOCK_REGEX) # rubocop:disable Lint/DuplicateBranch
+            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
             if /^==+ \S/.match?(current_line)
-              @title_depth[:value] =
-                current_line.sub(/ .*$/,
-                                 "").size
+              @title_depth[:value] = current_line.sub(/ .*$/, "").size
             end
             liquid_doc.add_content(current_line)
           end
@@ -146,9 +138,9 @@ module Metanorma
         def process_glossarist_block(document, liquid_doc, input_lines, match)
           @seen_glossarist << "x"
           end_mark = input_lines.next
-          # path = relative_file_path(document, match[1])
-          glossarist_params = prepare_glossarist_block_params(document, match)
 
+          glossarist_params, template =
+            prepare_glossarist_block_params(document, match)
           glossarist_section = <<~TEMPLATE.strip
             {% with_glossarist_context #{glossarist_params} %}
             #{prepare_document(
@@ -158,23 +150,38 @@ module Metanorma
             {% endwith_glossarist_context %}
           TEMPLATE
 
-          liquid_doc.add_content(
-            glossarist_section,
-            render: true,
-          )
+          options = { render: true }
+          options[:template] = template if template
+
+          liquid_doc.add_content(glossarist_section, options)
         end
 
-        def prepare_glossarist_block_params(document, match)
+        def prepare_glossarist_block_params(document, match) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
           path = get_context_path(document, match[1])
-
-          if match[2].strip.start_with?("filter")
-            filters = match[2].split("=")[1..-1].join("=").strip
-            context_name = match[3].strip
-            "#{context_name}=#{path};#{filters}"
-          else
-            context_name = match[2].strip
-            "#{context_name}=#{path}"
+          matched_arr = match[2].split(",").map(&:strip)
+          # get the last element as context name
+          context_name = matched_arr.last
+
+          glossarist_block_params = []
+          glossarist_block_params << "#{context_name}=#{path}"
+
+          template = nil
+          if matched_arr.size > 1
+            filters_or_template = matched_arr[0..-2]
+            filters_or_template.each do |item|
+              if item.start_with?("filter=")
+                filters = item.gsub(/^filter=/, "").strip
+                glossarist_block_params << filters
+              elsif item.start_with?("template=")
+                template = relative_file_path(
+                  document,
+                  item.gsub(/^template=/, "").strip,
+                )
+              end
+            end
           end
+
+          [glossarist_block_params.join(";"), template]
         end
 
         def get_context_path(document, key) # rubocop:disable Metrics/MethodLength
@@ -195,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)
@@ -228,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
@@ -257,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"] || ".",
@@ -275,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)}
@@ -290,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
@@ -307,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
@@ -333,7 +385,7 @@ module Metanorma
           examples.each do |example|
             content = <<~EXAMPLE
               [example]
-              #{example.content}
+              #{sanitize_references(example.content)}
 
             EXAMPLE
             result << content
@@ -351,7 +403,7 @@ module Metanorma
             content = <<~NOTE
               [NOTE]
               ====
-              #{note.content}
+              #{sanitize_references(note.content)}
               ====
 
             NOTE

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

@@ -2,6 +2,7 @@
 
 require_relative "liquid/custom_blocks/with_glossarist_context"
 require_relative "liquid/custom_filters/filters"
+require_relative "liquid/multiply_local_file_system"
 
 module Metanorma
   module Plugin
@@ -16,7 +17,7 @@ module Metanorma
 
         def add_content(content, options = {})
           @content << if options[:render]
-                        render_liquid(content)
+                        render_liquid(content, options)
                       else
                         content
                       end
@@ -26,11 +27,13 @@ module Metanorma
           @content.compact.join("\n")
         end
 
-        def render_liquid(file_content)
+        def render_liquid(file_content, options = {}) # rubocop:disable Metrics/AbcSize
+          include_paths = [file_system, options[:template]].compact
           template = ::Liquid::Template
             .parse(file_content, environment: create_liquid_environment)
-
-          template.registers[:file_system] = file_system
+          template.registers[:file_system] = ::Metanorma::Plugin::Glossarist::Liquid::LocalFileSystem.new(
+            include_paths, ["%s.liquid", "_%s.liquid", "_%s.adoc"]
+          )
           rendered_template = template.render(strict_variables: false,
                                               error_mode: :warn)
 

data/lib/metanorma/plugin/glossarist/liquid/custom_blocks/with_glossarist_context.rb

@@ -14,13 +14,12 @@ module Metanorma
               @contexts = []
               @filters = {}
 
-              contexts, filters = markup.split(";", 2)
+              contexts, filters = markup.strip.split(";", 2)
 
               if filters && !filters.empty?
-                filters.strip.gsub(/^['"]|['"]$/,
-                                   "").split(";").each do |filter|
+                filters = filters.strip.gsub(/^['"]|['"]$/, "").split(";")
+                filters.each do |filter|
                   property, value = filter.split("=")
-
                   @filters[property] = value
                 end
               end

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/liquid/multiply_local_file_system.rb

@@ -0,0 +1,74 @@
+module Metanorma
+  module Plugin
+    module Glossarist
+      module Liquid
+        class LocalFileSystem
+          attr_accessor :roots, :patterns
+
+          def initialize(roots, patterns = ["_%s.liquid"])
+            @roots    = roots
+            @patterns = patterns
+          end
+
+          def read_template_file(template_path)
+            full_path = full_path(template_path)
+
+            unless File.exist?(full_path)
+              raise FileSystemError, "No such template '#{template_path}'"
+            end
+
+            File.read(full_path)
+          end
+
+          def full_path(template_path) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+            unless %r{\A[^./][a-zA-Z0-9_/]+\z}.match?(template_path)
+              raise ::Liquid::FileSystemError,
+                    "Illegal template name '#{template_path}'"
+            end
+
+            result_path = if template_path.include?("/")
+                            roots
+                              .map do |root|
+                                patterns.map do |pattern|
+                                  File.join(
+                                    root,
+                                    File.dirname(template_path),
+                                    pattern % File.basename(template_path),
+                                  )
+                                end
+                              end
+                              .flatten
+                              .find { |path| File.file?(path) }
+                          else
+                            roots
+                              .map do |root|
+                                patterns.map do |pattern|
+                                  File.join(root, pattern % template_path)
+                                end
+                              end
+                              .flatten
+                              .find { |path| File.file?(path) }
+                          end
+
+            if result_path.nil?
+              raise ::Liquid::FileSystemError,
+                    "No documents in template path: " \
+                    " #{File.expand_path(template_path)}"
+            end
+
+            unless roots.any? do |root|
+                     File.expand_path(result_path).start_with?(
+                       File.expand_path(root),
+                     )
+                   end
+              raise ::Liquid::FileSystemError,
+                    "Illegal template path '#{File.expand_path(result_path)}'"
+            end
+
+            result_path
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Glossarist
-      VERSION = "0.2.8".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.8
+  version: 0.2.10
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-16 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
@@ -77,6 +91,7 @@ files:
 - lib/metanorma/plugin/glossarist/document.rb
 - lib/metanorma/plugin/glossarist/liquid/custom_blocks/with_glossarist_context.rb
 - lib/metanorma/plugin/glossarist/liquid/custom_filters/filters.rb
+- lib/metanorma/plugin/glossarist/liquid/multiply_local_file_system.rb
 - lib/metanorma/plugin/glossarist/version.rb
 - metanorma-plugin-glossarist.gemspec
 homepage: https://github.com/metanorma/metanorma-plugin-glossarist