metanorma-plugin-lutaml 0.7.9 → 0.7.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29510e3dd02119b47d1d179c94d0a954b596dc0255410091d8c0db366e6a4dd3
-  data.tar.gz: b2502ffd6bea597bc56c8882712c58d13e72799eca5387c76329a9ef813d62eb
+  metadata.gz: c0601a4c6b35e5d1fd1c58d24240e3a5dea1b87bae62cbf9ce17ac904c21d5bf
+  data.tar.gz: 60d05d99810e378da5df64b8ec603fbf522a3e66c10ef9ef776c0c616dd2a9e0
 SHA512:
-  metadata.gz: b06a2f0d8be8e9073c3f631b260d8e88525353afb8e4e6cdf11bd6db9d78994543eb6a9acda9a2602212943ff972a700efa7c7d3dc870951cd3f2c6e5a219ff2
-  data.tar.gz: c80c2d456bec408dccb3c621397bc9313e2cc6a53cf7c5671d504737087ebb597b446d2fc043e3deaaf809a0941f0f3b732837bf4b5aee404685d70cd6ab0d27
+  metadata.gz: 1a6e74aa665b6b3917ce08bc0a8aa7464dd3acb3fa6e1664f0a4e9951c3a204769299d8fbe3ff3be3f9b700b9d3cf28def826844cb0fa6de94fc6158827eb011
+  data.tar.gz: e772698bfc26cbb86bf58e171dcd2e531c91b834f67b7241939ee9db2cf51516d8531c46ae69eae14148c46575c85fe94e02502b73b0d78e2c3ff8bc2546d6fa

data/.gitignore

@@ -4,3 +4,5 @@ spec/assets/lutaml
 test.err
 
 .rubocop-https--*
+.DS_Store
+.vscode

data/README.adoc

@@ -315,7 +315,7 @@ lutaml_gml_dictionary::/path/to/dictionary.xml[template="/path/to/template.liqui
 
 The command accepts the options listed below:
 
-* `"/path/to/dictionary.xml` specifies the path of xml file of the
+* `/path/to/dictionary.xml` specifies the path of xml file of the
 GML Dictionary.
 
 * `template="/path/to/template.liquid"` specifies the liquid template.
@@ -364,6 +364,36 @@ h| Help | Description
 --
 -----
 
+=== Rendering a LutaML table of a class: `lutaml_klass_table`
+
+This command allows to render a LutaML table of a class by using Liquid Drop.
+
+The table will show:
+
+* Class Name
+* Class Definition
+* Inherited Properties
+* Self-defined Properties
+* Properties Inherited from Association
+* Properties Defined in Association
+
+[source,adoc]
+-----
+lutaml_klass_table::/path/to/example.xmi[name="NameOfClass",template="/path/to/templates/_my_klass_table.liquid"]
+-----
+
+The command accepts the options listed below:
+
+* `/path/to/example.xmi` specifies the path of xmi file.
+
+* `name="NameOfClass"` specifies the name of the Class.
+
+* `template="/path/to/templates/_my_klass_table.liquid"` specifies the path of
+  the liquid template. (Optional)
+  By default, it will look for the template `_klass_table.liquid` defined in
+  `lib/metanorma/plugin/lutaml/templates`.  This template can be customized by
+  changing the template path in the `template` option.
+
 === Generating UML class and attributes: `lutaml_uml_class`
 
 This command allows rendering a definition clause for a UML class.
@@ -796,6 +826,33 @@ and iterate through packages according to the order supplied in the file. All
 packages that matches `skip` in the YAML config file will be skipped during
 render.
 
+=== Usage of `lutaml_ea_xmi` macro
+
+This command is a replacement for `lutaml_uml_datamodel_description` to perform
+the same functionalities of `lutaml_uml_datamodel_description`, which is to
+render data model packages and its dependent objects for supplied XMI file, by
+using Liquid Drop.  The performance of `lutaml_ea_xmi` can be improved by
+10~20 times. (Tested with a 10.6MB XMI file with 120000+ lines)
+
+To use this macro, you only need to replace `lutaml_uml_datamodel_description`
+by `lutaml_ea_xmi`.
+
+Replace:
+
+[source,adoc]
+-----
+[lutaml_uml_datamodel_description, path/to/example.xmi]
+...
+-----
+
+By:
+
+[source,adoc]
+-----
+[lutaml_ea_xmi, path/to/example.xmi]
+...
+-----
+
 == Documentation
 
 Please refer to https://www.metanorma.org.

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

@@ -1,23 +1,65 @@
+{% assign root = klass.generalization %}
 [cols="1a,1a,2a"]
 |===
-| 型の定義
+| Definition of Type
 2+| {{ root.definition }}
 
-h| 上位の型 2+| {{ root.general.upper_klass }}:{{ root.general.name }}
-h| ステレオタイプ 2+| << {{ root.stereotype }} >>
+h| Upper Type 2+| {{ root.general.upper_klass }}:{{ root.general.name }}
+h| Stereotype 2+| << {{ root.stereotype }} >>
 
-3+h| 継承する属性
-h| 属性名 h| 属性の型及び多重度 h| 定義
-{{ content.inherited_props }}
+3+h| Inherited Properties
+h| Property Name h| Property Type and Multiplicity h| Definition
+{% for attr in root.inherited_props %}
+  {%- if attr.has_association? == false -%}
+    {%- capture name_col -%}
+      {{ attr.name_ns }}:{{ attr.name }}
+      ({{ attr.gen_name }})
+    {%- endcapture -%}
+    | {{ name_col | newline_to_br }}
+    | {{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.definition }}
+  {%- endif -%}
+{% endfor %}
 
-3+h| 自身に定義された属性
-{{ content.owned_props }}
+3+h| Self-defined Properties
+h| Property Name h| Property Type and Multiplicity h| Definition
+{% for attr in root.owned_props %}
+  {%- if attr.has_association? == false -%}
+    {%- capture name_col -%}
+      {{ attr.name_ns }}:{{ attr.name }}
+      ({{ attr.gen_name }})
+    {%- endcapture -%}
+    | {{ name_col | newline_to_br }}
+    | {{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.definition }}
+  {%- endif -%}
+{% endfor %}
 
-3+h| 継承する関連役割
-h| 関連役割名 h| 関連役割の型及び多重度 h| 定義
-{{ content.inherited_assoc_props }}
+3+h| Properties Inherited from Association
+h| Property Name h| Property Type and Multiplicity h| Definition
+{% for attr in root.inherited_assoc_props %}
+  {%- if attr.has_association? == true -%}
+    {%- capture name_col -%}
+      {{ attr.name_ns }}:{{ attr.name }}
+      ({{ attr.gen_name }})
+    {%- endcapture -%}
+    | {{ name_col | newline_to_br }}
+    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.definition }}
+  {%- endif -%}
+{% endfor %}
 
-3+h| 自身に定義された関連役割
-h| 関連役割名 h| 関連役割の型及び多重度 h| 定義
-{{ content.assoc_props }}
+3+h| Properties Defined in Association
+h| Property Name h| Property Type and Multiplicity h| Definition
+{% for attr in root.assoc_props %}
+  {%- if attr.has_association? == true -%}
+    {%- capture name_col -%}
+      {{ attr.name_ns }}:{{ attr.name }}
+      ({{ attr.gen_name }})
+    {%- endcapture -%}
+    | {{ name_col | newline_to_br }}
+    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.definition }}
+  {%- endif -%}
+{% endfor %}
 |===

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

@@ -12,8 +12,7 @@ module Metanorma
         named :lutaml_ea_diagram
 
         def process(parent, _target, attrs)
-          orig_doc = parent.document.attributes["lutaml_xmi_cache"]
-            .values.first.original_document
+          orig_doc = get_original_document(parent)
           diagram = fetch_diagram_by_name(orig_doc, attrs["name"])
           return if diagram.nil?
 
@@ -27,6 +26,13 @@ module Metanorma
 
         private
 
+        def get_original_document(parent)
+          doc = parent.document.attributes["lutaml_xmi_cache"].values.first
+          return doc if doc.instance_of?(::Lutaml::XMI::RootDrop)
+
+          doc.original_document
+        end
+
         def img_src_path(document, attrs, diagram)
           base_path = attrs["base_path"]
           format = attrs["format"] || "png"

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

@@ -0,0 +1,345 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "asciidoctor"
+require "asciidoctor/reader"
+require "lutaml"
+require "lutaml/uml"
+require "lutaml/formatter"
+require "metanorma/plugin/lutaml/utils"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      module LutamlEaXmiBase
+        LIQUID_INCLUDE_PATH = File.join(
+          Gem.loaded_specs["metanorma-plugin-lutaml"].full_gem_path,
+          "lib", "metanorma", "plugin", "lutaml", "liquid_templates"
+        )
+        DEFAULT_RENDER_INCLUDE = "packages"
+        RENDER_STYLES_INCLUDES = {
+          "default" => "packages",
+          "entity_list" => "packages_entity_list",
+          "entity_list_class" => "packages_entity_list_class",
+          "data_dictionary" => "packages_data_dictionary",
+        }.freeze
+        RENDER_STYLE_ATTRIBUTE = "render_style"
+        SUPPORTED_NESTED_MACRO = %w[
+          before diagram_include_block after include_block package_text
+        ].freeze
+
+        # search document for block `lutaml_ea_xmi`
+        # or `lutaml_uml_datamodel_description`
+        # read include derectives that goes after that in block and transform
+        # into yaml2text blocks
+        def process(document, reader)
+          r = Asciidoctor::PreprocessorNoIfdefsReader.new document, reader.lines
+          input_lines = r.readlines.to_enum
+          Asciidoctor::PreprocessorNoIfdefsReader
+            .new(document, processed_lines(document, input_lines))
+        end
+
+        private
+
+        def lutaml_document_from_file_or_cache(document, file_path, yaml_config) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          full_path = Utils.relative_file_path(document, file_path)
+          if document.attributes["lutaml_xmi_cache"] &&
+              document.attributes["lutaml_xmi_cache"][full_path]
+            return document.attributes["lutaml_xmi_cache"][full_path]
+          end
+
+          yaml_config["ea_extension"]&.each do |ea_extension_path|
+            ea_extension_full_path = File.expand_path(
+              ea_extension_path, File.dirname(file_path)
+            )
+            Xmi::EaRoot.load_extension(ea_extension_full_path)
+          end
+
+          result_document = parse_result_document(full_path)
+          document.attributes["lutaml_xmi_cache"] ||= {}
+          document.attributes["lutaml_xmi_cache"][full_path] = result_document
+          result_document
+        end
+
+        def parse_yaml_config_file(document, file_path)
+          return {} if file_path.nil?
+
+          relative_file_path = Utils.relative_file_path(document, file_path)
+          YAML.safe_load(File.read(relative_file_path, encoding: "UTF-8"))
+        end
+
+        def processed_lines(document, input_lines)
+          result = []
+          loop do
+            result.push(*process_text_blocks(document, input_lines))
+          end
+          result
+        end
+
+        def get_macro_regexp
+          self.class.const_get(:MACRO_REGEXP)
+        end
+
+        def process_text_blocks(document, input_lines) # rubocop:disable Metrics/MethodLength
+          line = input_lines.next
+          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)
+          fill_in_diagrams_attributes(document, lutaml_document)
+          model_representation(
+            lutaml_document, document,
+            collect_additional_context(document, input_lines, input_lines.next),
+            yaml_config
+          )
+        end
+
+        def get_original_document(wrapper)
+          doc = wrapper
+          return doc if doc.instance_of?(::Lutaml::XMI::RootDrop)
+
+          doc.original_document
+        end
+
+        def fill_in_entities_refs_attributes(document, # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
+          lutaml_document, _options)
+          lutaml_document = get_original_document(lutaml_document)
+          # render_style = options.fetch(RENDER_STYLE_ATTRIBUTE, "default")
+          all_children_packages = lutaml_document.packages
+            .map(&:children_packages).flatten
+          package_flat_packages = lambda do |pks|
+            pks.each_with_object({}) do |package, res|
+              res[package.name] = package.xmi_id
+            end
+          end
+          children_pks = package_flat_packages.call(all_children_packages)
+          ref_dictionary = package_flat_packages.call(lutaml_document.packages)
+            .merge(children_pks)
+          %w[class enum data_type].each do |type|
+            package_flat = lambda do |pks|
+              pks.each_with_object({}) do |package, res|
+                plural = type == "class" ? "classes" : "#{type}s"
+                package.send(plural).map do |entity|
+                  res["#{type}:#{package.name}:#{entity.name}"] = entity.xmi_id
+                end
+              end
+            end
+            children_pks_diags = package_flat.call(all_children_packages)
+            ref_dictionary = ref_dictionary
+              .merge(package_flat.call(lutaml_document.packages)
+                                      .merge(children_pks_diags))
+          end
+          document.attributes["lutaml_entity_id"] = ref_dictionary
+        end
+
+        def fill_in_diagrams_attributes(document, lutaml_document) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          lutaml_document = get_original_document(lutaml_document)
+          package_flat_diagrams = lambda do |pks|
+            pks.each_with_object({}) do |package, res|
+              package.diagrams.map do |diag|
+                res["#{package.name}:#{diag.name}"] = diag.xmi_id
+              end
+            end
+          end
+          children_pks_diags = package_flat_diagrams.call(
+            lutaml_document.packages.map(&:children_packages).flatten,
+          )
+
+          document.attributes["lutaml_figure_id"] = package_flat_diagrams
+            .call(lutaml_document.packages)
+            .merge(children_pks_diags)
+        end
+
+        def collect_additional_context(document, input_lines, end_mark) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          additional_context = Hash.new { |hash, key| hash[key] = [] }
+          additional_context["all_macros"] = []
+          block_lines = []
+
+          while (block_line = input_lines.next) != end_mark
+            block_lines.push(block_line)
+          end
+
+          processed_lines = process(
+            document,
+            ::Asciidoctor::PreprocessorReader.new(document, block_lines),
+          ).read_lines
+
+          block_document = ::Asciidoctor::Document
+            .new(processed_lines, {}).parse
+          block_document.blocks.each do |block|
+            next unless SUPPORTED_NESTED_MACRO.include?(
+              block.attributes["role"],
+            )
+
+            attrs = block.attributes
+            name = attrs.delete("role")
+            package = attrs.delete("package")
+            macro_keyword = [name, package].compact.join(";")
+            block_text = if block.lines.length.positive?
+                           block.lines.join("\n")
+                         else
+                           ""
+                         end
+            additional_context[macro_keyword]
+              .push({ "text" => block_text }.merge(attrs))
+            additional_context["all_macros"]
+              .push({ "text" => block_text,
+                      "type" => name, "package" => package }.merge(attrs))
+          end
+          additional_context
+        end
+
+        def package_level(lutaml_document, level)
+          return lutaml_document if level <= 0
+
+          package_level(lutaml_document["packages"].first, level - 1)
+        end
+
+        def create_context_object(lutaml_document, additional_context, options) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          root_package = package_level(lutaml_document.to_liquid,
+                                       options["package_root_level"] || 1)
+          if options.empty? || options["packages"].nil?
+            return {
+              "render_nested_packages" => true,
+              "packages" => root_package["packages"],
+              "root_packages" => [root_package],
+              "additional_context" => additional_context
+                  .merge("external_classes" => options["external_classes"]),
+              "name" => root_package["name"],
+            }
+          end
+
+          all_packages = [root_package, *root_package["children_packages"]]
+          {
+            "packages" => sort_and_filter_out_packages(all_packages, options),
+            "package_entities" => package_entities(options),
+            "package_skip_sections" => package_skip_sections(options),
+            "additional_context" => additional_context
+              .merge("external_classes" => options["external_classes"]),
+            "root_packages" => [root_package],
+            "render_nested_packages" => options["render_nested_packages"] ||
+              false,
+            "name" => root_package["name"],
+          }
+        end
+
+        def package_entities(options) # rubocop:disable Metrics/AbcSize
+          return {} unless options["packages"]
+
+          options["packages"].find_all do |entity|
+            entity.is_a?(Hash) && entity.values.first["render_entities"]
+          end.map do |entity|
+            [entity.keys.first,
+             entity.values.first["render_entities"].map { |n| [n, true] }.to_h]
+          end.to_h
+        end
+
+        def package_skip_sections(options) # rubocop:disable Metrics/AbcSize
+          return {} unless options["packages"]
+
+          options["packages"].find_all do |entity|
+            entity.is_a?(Hash) && entity.values.first["skip_tables"]
+          end.map do |entity|
+            [entity.keys.first,
+             entity.values.first["skip_tables"].map { |n| [n, true] }.to_h]
+          end.to_h
+        end
+
+        def sort_and_filter_out_packages(all_packages, options) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+          return all_packages if options["packages"].nil?
+
+          result = []
+          # Step one - filter out all skipped packages
+          all_packages =
+            filter_out_all_skipped_packages(options, all_packages)
+
+          # Step two - select supplied packages by pattern
+          select_supplied_packages_by_pattern(options, all_packages,
+                                              result)
+        end
+
+        def filter_out_all_skipped_packages(options, all_packages)
+          options["packages"].find_all do |entity|
+            entity.is_a?(Hash) && entity["skip"]
+          end.each do |entity|
+            entity_regexp = config_entity_regexp(entity["skip"])
+            all_packages.delete_if do |package|
+              package["name"] =~ entity_regexp
+            end
+          end
+
+          all_packages
+        end
+
+        def select_supplied_packages_by_pattern(options, all_packages, result) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+          options["packages"].find_all do |entity|
+            entity.is_a?(String) || (entity.is_a?(Hash) && !entity["skip"])
+          end.each do |entity_obj|
+            entity = if entity_obj.is_a?(String)
+                       entity_obj
+                     else
+                       entity_obj.keys.first
+                     end
+            entity_regexp = config_entity_regexp(entity)
+            all_packages.each do |package|
+              if package["name"]&.match?(entity_regexp)
+                result.push(package)
+                all_packages.delete_if do |nest_package|
+                  nest_package["name"] == package["name"]
+                end
+              end
+            end
+          end
+
+          result
+        end
+
+        def config_entity_regexp(entity)
+          additional_sym = ".*" if /\*$/.match?(entity)
+          %r{^#{Regexp.escape(entity.delete('*'))}#{additional_sym}$}
+        end
+
+        def model_representation(lutaml_doc, document, add_context, options) # rubocop:disable Metrics/MethodLength
+          fill_in_entities_refs_attributes(document, lutaml_doc, options)
+          render_result, errors = Utils.render_liquid_string(
+            template_string: template(options["section_depth"] || 2,
+                                      options["render_style"],
+                                      options["include_root"]),
+            context_items: create_context_object(lutaml_doc,
+                                                 add_context,
+                                                 options),
+            context_name: "context",
+            document: document,
+            include_path: template_path(document, options["template_path"]),
+          )
+          Utils.notify_render_errors(document, errors)
+          render_result.split("\n")
+        end
+
+        def template_path(document, template_path)
+          return LIQUID_INCLUDE_PATH if template_path.nil?
+
+          Utils.relative_file_path(document, template_path)
+        end
+
+        def template(section_depth, render_style, include_root)
+          include_name = RENDER_STYLES_INCLUDES.fetch(render_style,
+                                                      DEFAULT_RENDER_INCLUDE)
+          result = ""
+          if include_root
+            result += <<~LIQUID
+              {% include "#{include_name}", package_skip_sections: context.package_skip_sections, package_entities: context.package_entities, context: context.root_packages, additional_context: context.additional_context, render_nested_packages: false %}
+            LIQUID
+          end
+          result + <<~LIQUID
+            {% include "#{include_name}", depth: #{section_depth}, package_skip_sections: context.package_skip_sections, package_entities: context.package_entities, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
+          LIQUID
+        end
+      end
+    end
+  end
+end