metanorma-plugin-lutaml 0.7.16 → 0.7.18

data/lib/metanorma/plugin/lutaml/liquid_templates/_klass_table.liquid

@@ -28,7 +28,7 @@ h| Property Name h| Property Type and Multiplicity h| Definition
       ({{ attr.gen_name }})
     {%- endcapture -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
+    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}]
     | {{ attr.definition }}
   {%- endif -%}
 {% endfor %}
@@ -42,7 +42,7 @@ h| Property Name h| Property Type and Multiplicity h| Definition
       ({{ attr.gen_name }})
     {%- endcapture -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
+    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}]
     | {{ attr.definition }}
   {%- endif -%}
 {% endfor %}
@@ -56,7 +56,7 @@ h| Property Name h| Property Type and Multiplicity h| Definition
       ({{ attr.gen_name }})
     {%- endcapture -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
+    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}]
     | {{ attr.definition }}
   {%- endif -%}
 {% endfor %}
@@ -70,7 +70,7 @@ h| Property Name h| Property Type and Multiplicity h| Definition
       ({{ attr.gen_name }})
     {%- endcapture -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
+    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}]
     | {{ attr.definition }}
   {%- endif -%}
 {% endfor %}

data/lib/metanorma/plugin/lutaml/lutaml_ea_diagram_block_macro.rb

@@ -7,13 +7,14 @@ module Metanorma
     module Lutaml
       class LutamlEaDiagramBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
         include LutamlDiagramBase
+        include LutamlEaXmiBase
 
         use_dsl
         named :lutaml_ea_diagram
 
         def process(parent, _target, attrs)
-          orig_doc = get_original_document(parent)
-          diagram = fetch_diagram_by_name(orig_doc, attrs["name"])
+          orig_doc = get_original_document(parent, attrs["index"])
+          diagram = fetch_diagram_by_name(orig_doc, attrs)
           return if diagram.nil?
 
           through_attrs = generate_attrs(attrs)
@@ -26,13 +27,43 @@ module Metanorma
 
         private
 
-        def get_original_document(parent)
-          doc = parent.document.attributes["lutaml_xmi_cache"].values.first
+        def parse_result_document(full_path, guidance = nil)
+          ::Lutaml::XMI::Parsers::XML.serialize_xmi_to_liquid(
+            File.new(full_path, encoding: "UTF-8"),
+            guidance,
+          )
+        end
+
+        def get_original_document(parent, index = nil)
+          path = get_path_from_index(parent, index) if index
+
+          if index && path
+            doc = lutaml_document_from_file_or_cache(parent.document, path, {})
+          end
+
+          doc ||= parent.document.attributes["lutaml_xmi_cache"].values.first
           return doc if doc.instance_of?(::Lutaml::XMI::RootDrop)
 
           doc.original_document
         end
 
+        def get_path_from_index(parent, index_name) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          lutaml_xmi_index = parent.document
+            .attributes["lutaml_xmi_index"][index_name]
+
+          if lutaml_xmi_index.nil? || lutaml_xmi_index[:path].nil?
+            ::Metanorma::Util.log(
+              "[metanorma-plugin-lutaml] lutaml_xmi_index error: " \
+              "XMI index #{index_name} path not found!",
+              :error,
+            )
+
+            return nil
+          end
+
+          lutaml_xmi_index[:path]
+        end
+
         def img_src_path(document, attrs, diagram)
           base_path = attrs["base_path"]
           format = attrs["format"] || "png"
@@ -41,19 +72,30 @@ module Metanorma
           "#{img_path}/#{diagram.xmi_id}.#{format}"
         end
 
-        def fetch_diagram_by_name(orig_doc, name)
+        def fetch_diagram_by_name(orig_doc, attrs)
+          name = attrs["name"]
+          package_name = attrs["package"]
           found_diagrams = []
-          loop_sub_packages(orig_doc.packages.first, name, found_diagrams)
+
+          loop_sub_packages(
+            orig_doc.packages.first, name, found_diagrams, package_name
+          )
+
           found_diagrams.first
         end
 
-        def loop_sub_packages(package, name, found_diagrams)
+        def loop_sub_packages(package, name, found_diagrams, package_name) # rubocop:disable Metrics/CyclomaticComplexity
           found_diagram = package.diagrams.find { |diag| diag.name == name }
 
+          if found_diagram && package_name &&
+              found_diagram.package_name != package_name
+            found_diagram = nil
+          end
+
           found_diagrams << found_diagram if found_diagram
 
           package.packages.each do |sub_package|
-            loop_sub_packages(sub_package, name, found_diagrams)
+            loop_sub_packages(sub_package, name, found_diagrams, package_name)
           end
         end
       end

data/lib/metanorma/plugin/lutaml/lutaml_ea_xmi_base.rb

@@ -27,6 +27,7 @@ module Metanorma
         SUPPORTED_NESTED_MACRO = %w[
           before diagram_include_block after include_block package_text
         ].freeze
+        XMI_INDEX_REGEXP = /^:lutaml-xmi-index:(?<index_name>.+?);(?<index_path>.+?);?(\s*config=(?<config_path>.+))?$/.freeze # rubocop:disable Lint/MixedRegexpCaptureTypes,Layout/LineLength
 
         # search document for block `lutaml_ea_xmi`
         # or `lutaml_uml_datamodel_description`
@@ -92,16 +93,38 @@ module Metanorma
           self.class.const_get(:MACRO_REGEXP)
         end
 
-        def process_text_blocks(document, input_lines) # rubocop:disable Metrics/MethodLength
+        def process_xmi_index_lines(document, line)
+          block_match = line.match(XMI_INDEX_REGEXP)
+
+          return if block_match.nil?
+
+          name = block_match[:index_name]&.strip
+          path = block_match[:index_path]&.strip
+          config = block_match[:config_path]&.strip
+
+          document.attributes["lutaml_xmi_index"] ||= {}
+          document.attributes["lutaml_xmi_index"][name] = {
+            path: path,
+            config: config,
+          }
+        end
+
+        def process_text_blocks(document, input_lines) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
           line = input_lines.next
+          process_xmi_index_lines(document, line)
           block_match = line.match(get_macro_regexp)
 
           return [line] if block_match.nil?
 
-          yaml_config = parse_yaml_config_file(document, block_match[2])
-          lutaml_document = lutaml_document_from_file_or_cache(document,
-                                                               block_match[1],
-                                                               yaml_config)
+          config_yaml_path = block_match[2]&.strip
+          xmi_or_index = block_match[1]&.strip
+
+          lutaml_document, yaml_config = load_lutaml_doc_and_config(
+            document,
+            xmi_or_index,
+            config_yaml_path,
+          )
+
           fill_in_diagrams_attributes(document, lutaml_document)
           model_representation(
             lutaml_document, document,
@@ -110,6 +133,35 @@ module Metanorma
           )
         end
 
+        def load_lutaml_doc_and_config(document, xmi_or_index, config_yaml_path)
+          index = xmi_or_index.match(/index=(.*)/)
+
+          if index
+            # load lutaml index
+            index_name = index[1]
+
+            if document.attributes["lutaml_xmi_index"][index_name].nil? ||
+                document.attributes["lutaml_xmi_index"][index_name][:path].nil?
+              ::Metanorma::Util.log(
+                "[metanorma-plugin-lutaml] lutaml_xmi_index error: " \
+                "XMI index #{index_name} path not found!",
+                :error,
+              )
+            end
+
+            xmi_or_index = document
+              .attributes["lutaml_xmi_index"][index_name][:path]
+            config_yaml_path = document
+              .attributes["lutaml_xmi_index"][index_name][:config]
+          end
+
+          yaml_config = parse_yaml_config_file(document, config_yaml_path)
+          lutaml_document = lutaml_document_from_file_or_cache(document,
+                                                               xmi_or_index,
+                                                               yaml_config)
+          [lutaml_document, yaml_config]
+        end
+
         def get_original_document(wrapper)
           doc = wrapper
           return doc if doc.instance_of?(::Lutaml::XMI::RootDrop)

data/lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb

@@ -5,7 +5,6 @@ require "asciidoctor"
 require "asciidoctor/reader"
 require "lutaml"
 require "metanorma/plugin/lutaml/utils"
-require "metanorma/plugin/lutaml/express_remarks_decorator"
 require "metanorma/plugin/lutaml/asciidoctor/preprocessor"
 
 module Metanorma
@@ -15,12 +14,12 @@ module Metanorma
       class LutamlPreprocessor < ::Asciidoctor::Extensions::Preprocessor
         REMARKS_ATTRIBUTE = "remarks"
 
-        def process(document, reader)
+        def process(document, reader) # rubocop:disable Metrics/MethodLength
           r = Asciidoctor::PreprocessorNoIfdefsReader.new(document,
                                                           reader.lines)
           input_lines = r.readlines.to_enum
 
-          has_lutaml = input_lines.any? { |line| lutaml?(line) }
+          has_lutaml_liquid = input_lines.any? { |line| lutaml_liquid?(line) }
 
           express_indexes = Utils.parse_document_express_indexes(
             document,
@@ -33,7 +32,7 @@ module Metanorma
             express_indexes: express_indexes,
           )
 
-          log(document, result_content) if has_lutaml
+          log(document, result_content) if has_lutaml_liquid
 
           Asciidoctor::PreprocessorNoIfdefsReader.new(document, result_content)
         end
@@ -46,8 +45,8 @@ module Metanorma
           end
         end
 
-        def lutaml?(line)
-          line.match(/^\[(?:\blutaml\b|\blutaml_express\b),(?<index_names>[^,]+)?,?(?<context_name>[^,]+)?(?<options>,.*)?\]/)
+        def lutaml_liquid?(line)
+          line.match(/^\[(?:\blutaml\b|\blutaml_express\b|\blutaml_express_liquid\b),(?<index_names>[^,]+)?,?(?<context_name>[^,]+)?(?<options>,.*)?\]/) # rubocop:disable Layout/LineLength
         end
 
         def load_lutaml_file(document, file_path)
@@ -61,28 +60,19 @@ module Metanorma
 
         private
 
-        def process_input_lines(
-          document:,
-            input_lines:,
-            express_indexes:
-        )
-
+        def process_input_lines(document:, input_lines:, express_indexes:)
           result = []
           loop do
             result.push(
-              *process_text_blocks(
-                document,
-                input_lines,
-                express_indexes,
-              ),
+              *process_text_blocks(document, input_lines, express_indexes),
             )
           end
           result
         end
 
-        def process_text_blocks(document, input_lines, express_indexes)
+        def process_text_blocks(document, input_lines, express_indexes) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
           line = input_lines.next
-          block_header_match = lutaml?(line)
+          block_header_match = lutaml_liquid?(line)
 
           return [line] if block_header_match.nil?
 
@@ -94,7 +84,7 @@ module Metanorma
 
           end_mark = input_lines.next
 
-          render_template(
+          render_liquid_template(
             document: document,
             lines: extract_block_lines(input_lines, end_mark),
             index_names: index_names,
@@ -112,19 +102,16 @@ module Metanorma
           block
         end
 
-        def gather_context_items(index_names:, document:, indexes:)
+        def gather_context_liquid_items(index_names:, document:, indexes:, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+selected_schemas:, options:)
           index_names.map do |path|
-            # TODO: Rephrase of the below TODO message.
-            # ::Lutaml::Parser.parse(file_list) can return an Array or just one.
-            # TODO: decide how to handle expressir multiply file parse as one
-            # object and lutaml
-
-            # Does this condition ever happen? That is only if the
-            # `lutaml-express-index` condition is not set
             if indexes[path]
-              indexes[path][:serialized_hash] ||= indexes[path][:wrapper].to_liquid
+              indexes[path][:liquid_drop] ||=
+                indexes[path][:wrapper].original_document.to_liquid(
+                  selected_schemas: selected_schemas,
+                  options: options,
+                )
             else
-
               full_path = Utils.relative_file_path(document, path)
               unless File.file?(full_path)
                 raise StandardError.new(
@@ -135,8 +122,10 @@ module Metanorma
               end
               wrapper = load_lutaml_file(document, path)
               indexes[path] = {
-                wrapper: wrapper,
-                serialized_hash: wrapper.to_liquid,
+                liquid_drop: wrapper.original_document.to_liquid(
+                  selected_schemas: selected_schemas,
+                  options: options,
+                ),
               }
             end
 
@@ -144,7 +133,7 @@ module Metanorma
           end
         end
 
-        def read_config_yaml_file(document, file_path)
+        def read_config_yaml_file(document, file_path) # rubocop:disable Metrics/MethodLength
           return {} if file_path.nil?
 
           relative_file_path = Utils.relative_file_path(document, file_path)
@@ -156,8 +145,8 @@ module Metanorma
           if config_yaml["schemas"]
             unless config_yaml["schemas"].is_a?(Hash)
               raise StandardError.new(
-                "[lutaml_express] attribute `config_yaml` must point to a YAML " \
-                "file that has the `schema` key containing a hash.",
+                "[lutaml_express_liquid] attribute `config_yaml` must point " \
+                "to a YAML file that has the `schema` key containing a hash.",
               )
             end
 
@@ -167,35 +156,6 @@ module Metanorma
           options
         end
 
-        def decorate_schema_object(schema:, document:, indexes:, index_names:, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/ParameterLists
-selected:, options:)
-          # Mark a schema as "selected" with `.selected`
-          schema["selected"] = true if selected
-
-          # Provide pretty-formatted code under `.formatted`
-          _index_found_key, index_found_value = indexes.detect do |k, v|
-            _found = get_original_document(v[:wrapper]).schemas.detect do |s|
-              s.id == schema["id"]
-            end
-          end
-
-          schema["formatted"] = get_original_document(
-            index_found_value[:wrapper],
-          ).schemas.detect do |s|
-            s.id == schema["id"]
-          end.to_s(no_remarks: true)
-
-          # Decorate the remaining things
-          decorate_context_items(
-            schema,
-            options.merge(
-              "relative_path_prefix" =>
-                Utils.relative_file_path(document,
-                                         File.dirname(schema["file"])),
-            ),
-          ) || {}
-        end
-
         def get_original_document(wrapper)
           doc = wrapper
           return doc if doc.instance_of?(::Lutaml::XMI::RootDrop)
@@ -203,38 +163,26 @@ selected:, options:)
           doc.original_document
         end
 
-        def render_template(document:, lines:, context_name:, index_names:, # rubocop:disable Metrics/ParameterLists,Metrics/AbcSize,Metrics/MethodLength
-options:, indexes:)
+        def render_liquid_template(document:, lines:, context_name:, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/ParameterLists
+index_names:, options:, indexes:)
           config_yaml_path = options.delete("config_yaml")
           config = read_config_yaml_file(document, config_yaml_path)
           selected_schemas = config["selected_schemas"]
 
-          gather_context_items(
+          all_items = gather_context_liquid_items(
             index_names: index_names,
             document: document,
             indexes: indexes,
-          ).map do |items|
-            serialized_hash = items[:serialized_hash]
-
-            serialized_hash["schemas"]&.map! do |schema|
-              decorate_schema_object(
-                schema: schema,
-                document: document,
-                index_names: index_names,
-                indexes: indexes,
-                selected: selected_schemas && selected_schemas.include?(
-                  schema["id"],
-                ),
-                options: options,
-              )
-            end
+            selected_schemas: selected_schemas,
+            options: options.merge("document" => document),
+          )
 
-            render_block(
-              document: document,
-              block_lines: lines,
-              context_items: serialized_hash,
-              context_name: context_name,
-            )
+          all_items.map do |item|
+            repo_drop = item[:liquid_drop]
+            template = ::Liquid::Template.parse(lines.join("\n"))
+            template.assigns[context_name] = repo_drop
+            template.assigns["selected_schemas"] = selected_schemas
+            template.render
           end.flatten
         rescue StandardError => e
           ::Metanorma::Util.log(
@@ -252,48 +200,6 @@ options:, indexes:)
             .map { |elem| elem.map(&:strip) }
             .to_h
         end
-
-        def decorate_context_item(key, val, options)
-          if key == REMARKS_ATTRIBUTE
-            return [
-              key,
-              val&.map do |remark|
-                Metanorma::Plugin::Lutaml::ExpressRemarksDecorator
-                    .call(remark, options)
-              end,
-            ]
-          end
-
-          case val
-          when Hash
-            [key, decorate_context_items(val, options)]
-          when Array
-            [key, val.map { |n| decorate_context_items(n, options) }]
-          else
-            [key, val]
-          end
-        end
-
-        def decorate_context_items(item, options)
-          return item unless item.is_a?(Hash)
-
-          item.map do |(key, val)|
-            decorate_context_item(key, val, options)
-          end.to_h
-        end
-
-        def render_block(block_lines:, context_items:, context_name:, document:)
-          render_result, errors = Utils.render_liquid_string(
-            template_string: block_lines.join("\n"),
-            context_items: context_items,
-            context_name: context_name,
-            document: document,
-          )
-
-          Utils.notify_render_errors(document, errors)
-
-          render_result.split("\n")
-        end
       end
     end
   end

data/lib/metanorma/plugin/lutaml/utils.rb

@@ -4,7 +4,12 @@ require "expressir/express/cache"
 require "metanorma/plugin/lutaml/liquid/custom_filters"
 require "metanorma/plugin/lutaml/liquid/multiply_local_file_system"
 
-::Liquid::Template.register_filter(Metanorma::Plugin::Lutaml::Liquid::CustomFilters)
+liquid_klass = if Object.const_defined?("Liquid::Environment")
+                 Object.const_get("Liquid::Environment").default
+               else
+                 Object.const_get("Liquid::Template")
+               end
+liquid_klass.register_filter(Metanorma::Plugin::Lutaml::Liquid::CustomFilters)
 
 module Metanorma
   module Plugin

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

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      VERSION = "0.7.16".freeze
+      VERSION = "0.7.18".freeze
     end
   end
 end

data/metanorma-plugin-lutaml.gemspec

@@ -27,9 +27,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor"
   spec.add_dependency "coradoc", "~> 1.1.1"
-  spec.add_dependency "expressir", "~> 2.1.0"
+  spec.add_dependency "expressir", "~> 2.1.6"
   spec.add_dependency "liquid"
-  spec.add_dependency "lutaml", ">= 0.9.18"
+  spec.add_dependency "lutaml", "~> 0.9.25"
   spec.add_dependency "ogc-gml", "1.0.0"
   spec.add_dependency "relaton-cli"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.16
+  version: 0.7.18
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2025-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.1.6
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: lutaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.25
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.25
 - !ruby/object:Gem::Dependency
   name: ogc-gml
   requirement: !ruby/object:Gem::Requirement
@@ -313,7 +313,6 @@ files:
 - bin/setup
 - lib/metanorma-plugin-lutaml.rb
 - lib/metanorma/plugin/lutaml/asciidoctor/preprocessor.rb
-- lib/metanorma/plugin/lutaml/express_remarks_decorator.rb
 - lib/metanorma/plugin/lutaml/liquid/custom_filters.rb
 - lib/metanorma/plugin/lutaml/liquid/multiply_local_file_system.rb
 - lib/metanorma/plugin/lutaml/liquid_drops/gml_dictionary_drop.rb
@@ -354,7 +353,7 @@ homepage: https://github.com/metanorma/metanorma-plugin-lutaml
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -370,7 +369,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Metanorma plugin for LutaML
 test_files: []