metanorma-plugin-lutaml 0.7.8 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '091036d68a92b76cdfb383ae829bd65182a26ddc1146cce1d844a5646c27ca83'
-  data.tar.gz: 39bfe3ec5d4b57985902f5ab17f6d097db903f3151efee95068cefe4d2861f5e
+  metadata.gz: 29510e3dd02119b47d1d179c94d0a954b596dc0255410091d8c0db366e6a4dd3
+  data.tar.gz: b2502ffd6bea597bc56c8882712c58d13e72799eca5387c76329a9ef813d62eb
 SHA512:
-  metadata.gz: 4276c20cae2b83cc37b562217429e00b951a2e0a73bf384f931b47bd94b71774db3b42d62cfc1c380bf3b64bf9b6d5c6b8d98fbe18b5b2d9426558ba8aa40a1e
-  data.tar.gz: 4323e58139487b3192af2da916a8142f1bd56b7cf8d2df3dae2882172ea7cf22c10e0cfd4d31278cbd3e731f2a689ab871e6a5baa1d89d462a95df90ab389500
+  metadata.gz: b06a2f0d8be8e9073c3f631b260d8e88525353afb8e4e6cdf11bd6db9d78994543eb6a9acda9a2602212943ff972a700efa7c7d3dc870951cd3f2c6e5a219ff2
+  data.tar.gz: c80c2d456bec408dccb3c621397bc9313e2cc6a53cf7c5671d504737087ebb597b446d2fc043e3deaaf809a0941f0f3b732837bf4b5aee404685d70cd6ab0d27

data/Gemfile

@@ -11,7 +11,3 @@ begin
 rescue StandardError
   nil
 end
-
-# gem "lutaml", path: "../../lutaml/lutaml"
-
-gem "ogc-gml", github: "lutaml/ogc-gml"

data/lib/metanorma/plugin/lutaml/liquid/custom_filters.rb

@@ -1,5 +1,4 @@
 require "coradoc"
-require "coradoc/input/html"
 
 module Metanorma
   module Plugin
@@ -7,6 +6,7 @@ module Metanorma
       module Liquid
         module CustomFilters
           def html2adoc(input)
+            # Coradoc::ReverseAdoc.convert(input)
             Coradoc::Input::HTML.convert(input)
           end
 

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

@@ -0,0 +1,310 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "asciidoctor"
+require "asciidoctor/reader"
+require "lutaml"
+# require "lutaml/uml"
+require "xmi"
+require "lutaml/xmi"
+require "metanorma/plugin/lutaml/utils"
+require "metanorma/plugin/lutaml/asciidoctor/preprocessor"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      #  Macro for quick rendering of datamodel attributes/values tables
+      #  from liquid drop object
+      class LutamlEaXmiPreprocessor <
+          ::Asciidoctor::Extensions::Preprocessor
+        MACRO_REGEXP =
+          /\[lutaml_ea_xmi,([^,]+),?(.+)?\]/.freeze
+        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`
+        #  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)
+          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 = ::Lutaml::XMI::Parsers::XML.serialize_xmi_to_liquid(
+            File.new(
+              full_path, encoding: "UTF-8"
+            ),
+          )
+
+          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 process_text_blocks(document, input_lines)
+          line = input_lines.next
+          block_match = line.match(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 fill_in_entities_refs_attributes(document,
+          lutaml_document, options)
+          # 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)
+          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)
+          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 = block.lines.length.positive? ? block.lines.join("\n") : ""
+            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)
+          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)
+          return {} unless options["packages"]
+
+          options["packages"]
+            .find_all { |entity| entity.is_a?(Hash) && entity.values.first["render_entities"] }
+            .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)
+          return {} unless options["packages"]
+
+          options["packages"]
+            .find_all { |entity| entity.is_a?(Hash) && entity.values.first["skip_tables"] }
+            .map do |entity|
+            [entity.keys.first, entity.values.first["skip_tables"].map do |n|
+                                  [n, true]
+                                end.to_h]
+          end.to_h
+        end
+
+        def sort_and_filter_out_packages(all_packages, options)
+          return all_packages if options["packages"].nil?
+
+          result = []
+          # Step one - filter out all skipped packages
+          options["packages"]
+            .find_all { |entity| entity.is_a?(Hash) && entity["skip"] }
+            .each do |entity|
+              entity_regexp = config_entity_regexp(entity["skip"])
+              all_packages
+                .delete_if { |package| package["name"] =~ entity_regexp }
+            end
+          # Step two - select supplied packages by pattern
+          options["packages"]
+            .find_all { |entity| entity.is_a?(String) || (entity.is_a?(Hash) && !entity["skip"]) }
+            .each do |entity_obj|
+              entity = entity_obj.is_a?(String) ? entity_obj : entity_obj.keys.first
+              entity_regexp = config_entity_regexp(entity)
+              all_packages.each do |package|
+                if package["name"]&.match?(entity_regexp)
+                  result.push(package)
+                  all_packages
+                    .delete_if { |nest_package| nest_package["name"] == package["name"] }
+                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_document, document, additional_context,
+options)
+          fill_in_entities_refs_attributes(document, lutaml_document, 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_document,
+                                                 additional_context,
+                                                 options),
+            context_name: "context",
+            document: document,
+            include_path: LIQUID_INCLUDE_PATH,
+          )
+          Utils.notify_render_errors(document, errors)
+          render_result.split("\n")
+        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

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

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

data/lib/metanorma-plugin-lutaml.rb

@@ -3,6 +3,7 @@ require "metanorma/plugin/lutaml/lutaml_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_uml_class_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor"
+require "metanorma/plugin/lutaml/lutaml_ea_xmi_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_diagram_block"
 require "metanorma/plugin/lutaml/lutaml_diagram_block_macro"
 require "metanorma/plugin/lutaml/lutaml_figure_inline_macro"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
 platform: ruby
 authors:
 - Ribose Inc.
@@ -355,6 +355,7 @@ files:
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_ea_diagram_block_macro.rb
+- lib/metanorma/plugin/lutaml/lutaml_ea_xmi_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_figure_inline_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_gml_dictionary_base.rb
 - lib/metanorma/plugin/lutaml/lutaml_gml_dictionary_block.rb