metanorma-plugin-lutaml 0.4.5 → 0.4.9

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

@@ -0,0 +1,11 @@
+.{{ type }} used in {{ package.name }}
+[cols="2a,6a",options="header"]
+|===
+|Name |Description
+
+{% for klass in classes %}
+|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype | default: "Enumeration" }}»
+|{{ klass.definition }}
+
+{% endfor %}
+|===

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

@@ -3,8 +3,9 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-[[tab-P-{{ package_name }}-E-{{ klass_name }}]]
-.Elements of {{ package.name }}::{{ klass.name }}
+
+[[section-{{ klass.xmi_id }}]]
+.Elements of {{ package.name }}::{{ klass.name }}” (enum)
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 
@@ -24,14 +25,14 @@ h|Inheritance from: 7+| {{ inherited | map: 'member_end' | join: ", " }}
 h|Generalization of: 7+| {{ generalizations | map: 'member_end' | join: ", " }}
 {% endif %}
 
-h|Abstract: 7+| {{ klass.is_abstract }}
+h|Abstract: 7+| {% if klass.is_abstract %}True{% else %}False{% endif %}
 {% assign aggregations = klass.associations | where: "member_end_type", "aggregation" %}
 {% if aggregations.size > 0 %}
 .{{aggregations.size | plus: 1}}+h|Associations:
-4+|_Association with:_
-|_Obligation_
+4+| _Association with_
+| _Obligation_
 | _Maximum occurrence_
-|_Provides:_
+| _Provides_
 
 {% for assoc in aggregations %}
 4+| {{assoc.member_end}}
@@ -41,11 +42,11 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-
-.1+h|Associations: 7+| (none)
+h| Associations: 7+| (none)
 {% endif %}
+
 {% if klass.values.size > 0 %}
-.{{klass.values.size | plus: 1}}+h|Values:
+.{{klass.values.size | plus: 1}}+h| Values:
 | _Name_
 6+| _Definition_
 
@@ -55,7 +56,7 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-.1+h|Values:
+h| Values:
 7+| (none)
 {% endif %}
 

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_figure_inline_macro.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class LutamlFigureInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+        include LutamlDiagramBase
+
+        use_dsl
+        named :lutaml_figure
+
+        def process(parent, _target, attrs)
+          diagram_key = [attrs["package"], attrs["name"]].compact.join(":")
+          return if parent.document.attributes['lutaml_figure_id'].nil?
+          xmi_id = parent.document.attributes['lutaml_figure_id'][diagram_key]
+          return unless xmi_id
+
+          %Q(<xref target="figure-#{xmi_id}"></xref>)
+        end
+      end
+    end
+  end
+end

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(/^\[lutaml_express,([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
           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_datamodel_description_preprocessor.rb

@@ -20,6 +20,15 @@ module Metanorma
           Gem.loaded_specs["metanorma-plugin-lutaml"].full_gem_path,
           "lib", "metanorma", "plugin", "lutaml", "liquid_templates"
         )
+        DEFAULT_RENDER_INCLUDE = 'packages'.freeze
+        RENDER_STYLES_INCLUDES = {
+          'default' => 'packages',
+          'entity_list' => 'packages_entity_list',
+          'data_dictionary' => 'packages_data_dictionary'
+        }.freeze
+        RENDER_STYLE_ATTRIBUTE = 'render_style'.freeze
+        SUPPORTED_NESTED_MACRO = %w[
+          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
@@ -57,44 +66,102 @@ module Metanorma
           block_match = line.match(MARCO_REGEXP)
           return [line] if block_match.nil?
 
+          lutaml_document = lutaml_document_from_file(document, block_match[1])
+          fill_in_diagrams_attributes(document, lutaml_document)
           model_representation(
-            lutaml_document_from_file(document, block_match[1]),
+            lutaml_document,
             document,
             collect_additional_context(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|
+            pks.each_with_object({}) do |package, res|
+              package.diagrams.map { |diag| res["#{package.name}:#{diag.name}"] = diag.xmi_id }
+            end
+          end
+          children_pks_daigs = 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_daigs)
+        end
+
         def collect_additional_context(input_lines, end_mark)
-          additional_context = {}
+          additional_context = Hash.new { |hash, key| hash[key] = [] }
+          additional_context['all_macroses'] = []
           block_lines = []
           while (block_line = input_lines.next) != end_mark
             block_lines.push(block_line)
           end
           block_document = (Asciidoctor::Document.new(block_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(";")
-            additional_context[macro_keyword] = { 'text' => block.lines[1..-2].join("\n") }.merge(attrs)
+            block_text = block.lines.length > 0 ? block.lines.join("\n") : ''
+            additional_context[macro_keyword].push({ 'text' => block_text }.merge(attrs))
+            additional_context['all_macroses'].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)
-          if options.length.zero?
+          root_package = package_level(lutaml_document.to_liquid, options['package_root_level'] || 1)
+          if options.length.zero? || options['packages'].nil?
             return {
               'render_nested_packages' => true,
-              "packages" => lutaml_document.to_liquid['packages'].first['packages'].first['packages'],
-              "additional_context" => additional_context
+              "packages" => root_package['packages'],
+              "root_packages" => [root_package],
+              "additional_context" => additional_context,
+              "name" => root_package['name']
             }
           end
 
-          root_package = lutaml_document.to_liquid['packages'].first
           all_packages = [root_package, *root_package['children_packages']]
           {
             "packages" => sort_and_filter_out_packages(all_packages, options),
-            "additional_context" => additional_context
+            "additional_context" => additional_context,
+            "root_packages" => [root_package],
+            "name" => root_package['name']
           }
         end
 
@@ -132,8 +199,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,
+            template_string: table_template(options['section_depth'] || 2, options['render_style'], options['include_root']),
             context_items: create_context_object(lutaml_document,
                               additional_context,
                               options),
@@ -145,9 +213,16 @@ module Metanorma
           render_result.split("\n")
         end
 
-        def table_template
-          <<~LIQUID
-            {% include "packages", depth: 2, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
+        def table_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}", context: context.root_packages, additional_context: context.additional_context, render_nested_packages: false %}
+            LIQUID
+          end
+          result += <<~LIQUID
+            {% include "#{include_name}", depth: #{section_depth}, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
           LIQUID
         end
       end

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

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

data/lib/metanorma-plugin-lutaml.rb

@@ -4,6 +4,8 @@ require "metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor"
 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.5
+  version: 0.4.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -261,12 +261,20 @@ files:
 - lib/metanorma/plugin/lutaml/liquid_templates/_diagrams_block.liquid
 - 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_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