metanorma-plugin-lutaml 0.4.6 → 0.4.10

data/lib/metanorma/plugin/lutaml/liquid_templates/test.rb

@@ -0,0 +1 @@
+k = {"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_0BD8DEDF_F024_453d_AA7D_6EBC873FDBB6", "member_end"=>"AbstractFeatureWithLifespan", "member_end_type"=>"inheritance", "member_end_cardinality"=>{"min"=>nil, "max"=>""},"}, "member_end_attribute_name"=>nil, "owner_end"=>"AbstractCityObject", "definition"=>""}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_1C91D9CF_14CB_400c_A818_7C74428AE5B7", "member_end"=>"AbstractAppearance", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>" "member_end_attribute_name"=>"appearance", "owner_end"=>"AbstractCityObject", "definition"=>"Relates appearances to the city object."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_BDD0FCAB_72F7_499b_AC4D_2391D4DE7CAC", "member_end"=>"AbstractGenericAttribute", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>""},"}, "member_end_attribute_name"=>"genericAttribute", "owner_end"=>"AbstractCityObject", "definition"=>"Relates generic attributes to the city object."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_C22B8769_C2E7_4e9b_9C0D_138631E90002", "member_end"=>"AbstractCityObject", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>" "member_end_attribute_name"=>"generalizesTo", "owner_end"=>"AbstractCityObject", "definition"=>"Relates generalized representations of the same real-world object in different Levels of Detail to the city object. The direction of this relation is from the city object to the corresponding generalized city objects."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_CF0045E1_6BF1_40a7_B08D_9B7B30ECA025", "member_end"=>"ExternalReference", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>""},"}, "member_end_attribute_name"=>"externalReference", "owner_end"=>"AbstractCityObject", "definition"=>"References external objects in other information systems that have a relation to the city object."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_D45045CA_AAD6_418a_AF10_F4BC95DE923A", "member_end"=>"AbstractCityObject", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>" "member_end_attribute_name"=>"relatedTo", "owner_end"=>"AbstractCityObject", "definition"=>"Relates other city objects to the city object. It also describes how the city objects are related to each other."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_E3BB8700_143D_4dbd_A7EC_49D33C66D430", "member_end"=>"AbstractDynamizer", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>""},"}, "member_end_attribute_name"=>"dynamizer", "owner_end"=>"AbstractCityObject", "definition"=>"Relates Dynamizer objects to the city object. These allow timeseries data to override static attribute values of the city object."}{"visibility"=>"public", "name"=>nil, "owner_end"=>"AbstractCityObject"}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_BE026036_E811_494c_9776_D1A309393D6D", "member_end"=>"AbstractSpace", "member_end_type"=>"generalization", "member_end_cardinality"=>nil, "member_end_attribute_name"=>nil, "owner_end"=>"AbstractCityObject", "definition"=>""}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_C2189DFF_0F24_475b_AB55_070CD09A3186", "member_end"=>"AbstractSpaceBoundary", "member_end_type"=>"generalization", "member_end_cardinality"=>{"min"=>nil, "max"=>" "member_end_attribute_name"=>nil, "owner_end"=>"AbstractCityObject", "definition"=>""}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_C22B8769_C2E7_4e9b_9C0D_138631E90002", "member_end"=>"AbstractCityObject", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>""},"}, "member_end_attribute_name"=>"generalizesTo", "owner_end"=>"AbstractCityObject", "definition"=>"Relates generalized representations of the same real-world object in different Levels of Detail to the city object. The direction of this relation is from the city object to the corresponding generalized city objects."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_D45045CA_AAD6_418a_AF10_F4BC95DE923A", "member_end"=>"AbstractCityObject", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>" "member_end_attribute_name"=>"relatedTo", "owner_end"=>"AbstractCityObject", "definition"=>"Relates other city objects to the city object. It also describes how the city objects are related to each other."}{"visibility"=>"public", "name"=>nil, "owner_end"=>"AbstractCityObject"}{"visibility"=>"public", "name"=>nil, "owner_end"=>"AbstractCityObject"}

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

@@ -52,7 +52,7 @@ module Metanorma
 
         def process_text_blocks(document, input_lines, express_indexes)
           line = input_lines.next
-          block_match = line.match(/^\[lutaml,([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
+          block_match = line.match(/^\[(?:\blutaml\b|\blutaml_express\b),([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
           return [line] if block_match.nil?
 
           end_mark = input_lines.next

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class LutamlTableInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+        include LutamlDiagramBase
+        SUPPORTED_OPTIONS = %w[class enum data_type]
+
+        use_dsl
+        named :lutaml_table_class
+
+        def process(parent, _target, attrs)
+          keyword = SUPPORTED_OPTIONS.find { |n| attrs[n] }
+          entity_key = [keyword, attrs["package"], attrs[keyword]].compact.join(":")
+          return if parent.document.attributes['lutaml_entity_id'].nil?
+          xmi_id = parent.document.attributes['lutaml_entity_id'][entity_key]
+          return unless xmi_id
+
+          %Q(<xref target="section-#{xmi_id}"></xref>)
+        end
+      end
+    end
+  end
+end

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

@@ -87,7 +87,7 @@ module Metanorma
           {% else %}
           .{{ definition.name }} attributes
           |===
-          |Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
+          |Name |Definition |Mandatory / Optional / Conditional |Max Occur |Data Type
 
           {% for item in definition.attributes %}
           |{{ item.name }} |{% if item.definition %}{{ item.definition }}{% endif %} |{% if item.cardinality.min == "0" %}O{% else %}M{% endif %} |{% if item.cardinality.max == "*" %}N{% else %}1{% endif %} |{% if item.origin %}<<{{ item.origin }}>>{% endif %} `{{ item.type }}`

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

@@ -24,10 +24,12 @@ module Metanorma
         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'.freeze
         SUPPORTED_NESTED_MACRO = %w[
-          before diagram_include_block after include_block].freeze
+          before diagram_include_block after include_block package_text].freeze
         # search document for block `lutaml_uml_datamodel_description`
         #  read include derectives that goes after that in block and transform
         #  into yaml2text blocks
@@ -38,11 +40,19 @@ module Metanorma
 
         private
 
-        def lutaml_document_from_file(document, file_path)
-          ::Lutaml::Parser
-            .parse(File.new(Utils.relative_file_path(document, file_path),
-                            encoding: "UTF-8"))
-            .first
+        def lutaml_document_from_file_or_cache(document, file_path)
+          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
+          result_document = ::Lutaml::Parser.parse(File.new(full_path,
+                                encoding: "UTF-8"))
+                              .first
+                              result_document
+          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)
@@ -65,15 +75,44 @@ module Metanorma
           block_match = line.match(MARCO_REGEXP)
           return [line] if block_match.nil?
 
-          lutaml_document = lutaml_document_from_file(document, block_match[1])
+          lutaml_document = lutaml_document_from_file_or_cache(document, block_match[1])
           fill_in_diagrams_attributes(document, lutaml_document)
           model_representation(
             lutaml_document,
             document,
-            collect_additional_context(input_lines, input_lines.next),
+            collect_additional_context(document, input_lines, input_lines.next),
             parse_yaml_config_file(document, block_match[2]))
         end
 
+        def fill_in_entities_refs_attributes(document, lutaml_document_wrapper, options)
+          lutaml_document = lutaml_document_wrapper.original_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_daigs = package_flat.call(all_children_packages)
+              ref_dictionary = ref_dictionary
+                                .merge(package_flat.call(lutaml_document.packages)
+                                        .merge(children_pks_daigs))
+          end
+          document.attributes['lutaml_entity_id'] = ref_dictionary
+        end
+
         def fill_in_diagrams_attributes(document, lutaml_document_wrapper)
           lutaml_document = lutaml_document_wrapper.original_document
           package_flat_diagrams = lambda do |pks|
@@ -86,13 +125,17 @@ module Metanorma
                                                       .merge(children_pks_daigs)
         end
 
-        def collect_additional_context(input_lines, end_mark)
+        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
-          block_document = (Asciidoctor::Document.new(block_lines, {})).parse
+          processed_lines = self
+                              .process(document, Asciidoctor::Reader.new(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'])
 
@@ -100,8 +143,9 @@ module Metanorma
             name = attrs.delete('role')
             package = attrs.delete('package')
             macro_keyword = [name, package].compact.join(";")
-            block_text = block.lines.length > 0 ? block.lines[1..-2].join("\n") : ''
+            block_text = block.lines.length > 0 ? 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
@@ -118,17 +162,39 @@ module Metanorma
             return {
               'render_nested_packages' => true,
               "packages" => root_package['packages'],
-              "additional_context" => additional_context
+              "root_packages" => [root_package],
+              "additional_context" => additional_context,
+              "name" => root_package['name']
             }
           end
 
           all_packages = [root_package, *root_package['children_packages']]
           {
             "packages" => sort_and_filter_out_packages(all_packages, options),
-            "additional_context" => additional_context
+            "package_entities" => package_entities(options),
+            "package_skip_sections" => package_skip_sections(options),
+            "additional_context" => additional_context,
+            "root_packages" => [root_package],
+            "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 { |entity| [entity.keys.first, entity.values.first['render_entities'].map { |n| [n, true] }.to_h] }.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 { |entity| [entity.keys.first, entity.values.first['skip_tables'].map { |n| [n, true] }.to_h] }.to_h
+        end
+
         def sort_and_filter_out_packages(all_packages, options)
           return all_packages if options['packages'].nil?
 
@@ -143,8 +209,9 @@ module Metanorma
             end
           # Step two - select supplied packages by pattern
           options['packages']
-            .find_all { |entity| entity.is_a?(String) }
-            .each do |entity|
+            .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.with_index do |package|
                 if package['name'] =~ entity_regexp
@@ -163,8 +230,9 @@ module Metanorma
         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: table_template(options['section_depth'] || 2, options['render_style']),
+            template_string: table_template(options['section_depth'] || 2, options['render_style'], options['include_root']),
             context_items: create_context_object(lutaml_document,
                               additional_context,
                               options),
@@ -176,10 +244,16 @@ module Metanorma
           render_result.split("\n")
         end
 
-        def table_template(section_depth, render_style)
+        def table_template(section_depth, render_style, include_root)
           include_name = RENDER_STYLES_INCLUDES.fetch(render_style, DEFAULT_RENDER_INCLUDE)
-          <<~LIQUID
-            {% include "#{include_name}", depth: #{section_depth}, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
+          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

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

@@ -7,7 +7,7 @@ require "metanorma/plugin/lutaml/liquid/multiply_local_file_system"
 module Metanorma
   module Plugin
     module Lutaml
-      # Helpers for lutaml macroses
+      # Helpers for lutaml macros
       module Utils
         LUTAML_EXP_IDX_TAG = /^:lutaml-express-index:(?<index_name>.+?);(?<index_path>.+?);?(\s*cache=(?<cache_path>.+))?$/.freeze
 

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

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

data/lib/metanorma-plugin-lutaml.rb

@@ -5,6 +5,7 @@ require "metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_diagram_block"
 require "metanorma/plugin/lutaml/lutaml_diagram_block_macro"
 require "metanorma/plugin/lutaml/lutaml_figure_inline_macro"
+require "metanorma/plugin/lutaml/lutaml_table_inline_macro"
 
 module Metanorma
   module Plugin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.10
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -262,15 +262,20 @@ files:
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_class.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_dictionary.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_dictionary_class.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_dictionary_classes.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_type.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_entity_list.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/_packages_entity_list_class.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/_packages_entity_list_classes.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_enum.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/test.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_base.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_figure_inline_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb
+- lib/metanorma/plugin/lutaml/lutaml_table_inline_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor.rb
 - lib/metanorma/plugin/lutaml/utils.rb