metanorma-plugin-glossarist 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a311ce06912e8b9b57e5aa6993cda8a35f8ef887aaaf2aec8d1899e8c7e39cd4
-  data.tar.gz: 15c7a6268a0bd292105860a316fb747d8be26977d8223f3808f47c2db2a2d7b8
+  metadata.gz: b06eede0539ad9fda202136bb7d97aded91a6e925536234e822bdff0a067996e
+  data.tar.gz: 96981f754d34698da5288b12df8fe54719e9e40e15f96413a1cbad9f63962e4e
 SHA512:
-  metadata.gz: 5a296bc7cdac4225dc07db3d11faa14a22188a65c6636ee8d31cebe63c039902074aa76ae8b754c21ecc1298ea0d36cb115c6ab637e2b36808bc9126e694ed46
-  data.tar.gz: a8eb548632a313635b2318a38ffca8e6c7254fe0e98aa03904b213287098e4828c83777b406fd288ff4df17ed345fd7c6d5ada38e8df0ee2121d22baa67c8efb
+  metadata.gz: 9dd3c3ec6cd75a5aeb4f718e567374820ed074de9dd428919b7e3c9d038f95b116d61d2f29478c25e624aa35f593da0ca9e31fd280be43c9ea46e75cfdfce824
+  data.tar.gz: 1ea5f7d523beecdb2a1c67f9282064b5791f537ca6f6743d17329aefab4492421b758ee4f3728332653f567cb92f1c0c4977010ecbce86c4f92d79328adb5701

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:

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

@@ -14,8 +14,7 @@ module Metanorma
         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 +56,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,
@@ -115,15 +108,11 @@ module Metanorma
             process_bibliography(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
+          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 +135,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 +147,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

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/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.9".freeze
     end
   end
 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.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-16 00:00:00.000000000 Z
+date: 2025-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -77,6 +77,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