metanorma-plugin-lutaml 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a510a5a23684dee91557fb6047267ca6ac87be25cbe11e0bcad8e4c0d0812b9
-  data.tar.gz: 5d6e5cfc99c66b42ed50b7f6c6b1346fd2887ee9bba4436cacd5fbc56121dde6
+  metadata.gz: 636e4bec2488f6e9044ab15915f37485cf08ddcec31e2e852c9d381188b2d99e
+  data.tar.gz: c9c0e74be3a5d5856336f5202c7cb18e442d18548e1a29f476b72694d767eac5
 SHA512:
-  metadata.gz: ea2e863ee349fb9bc5e60c43802569b0592b3437f2aad58f5bdb5591ecd430388566aff7ad8ff6d6c187e64868df9f1f303917afa94e73396e5c6d6564d0571a
-  data.tar.gz: dc8d9a72fbea070f7aec02fa576c59859ce34abf6375e307ef18685cdbd70130edcc3958839e7b82e9e7155befc8b51657c685d5f42cef96e900de0fd4a50532
+  metadata.gz: 0e15f9f636f56f0f110baaec844dde2691aefbc882d3be878abe4ccd57e917472847ceb7dcca32f41c1d713d202f4e5caed0530171aad7d368fdde16431fdaee
+  data.tar.gz: 623fb7a37ad8be5e2aac50bbb32be6f366c75abeb47226800af1ae3ec88e24e6c024b7f57016862791f3fa89f4e8181a5c55710f71ab557d25f13480e88e53d9

data/README.adoc

@@ -286,44 +286,44 @@ The `lutaml_uml_datamodel_description` macro can be used:
 [lutaml_uml_datamodel_description, path/to/example.xmi]
 --
 [.before]
-...
+....
 my text
-...
+....
 
 [.diagram_include_block, base_path="requirements/"]
-...
+....
 Diagram text
-...
+....
 
 [.include_block, package="Another", base_path="spec/fixtures"]
-...
+....
 my text
-...
+....
 
 [.include_block, base_path="spec/fixtures"]
-...
+....
 my text
-...
+....
 
 [.before, package="Another"]
-...
+....
 text before Another package
-...
+....
 
 [.after, package="Another"]
-...
+....
 text after Another package
-...
+....
 
 [.after, package="CityGML"]
-...
+....
 text after CityGML package
-...
+....
 
 [.after]
-...
+....
 footer text
-...
+....
 --
 --
 -----
@@ -332,7 +332,7 @@ Where:
 
 * `path/to/example.xmi` - required, path to the XMI file to render
 
-* `[.before]` - macro to add additional text before the rendered output, can be used only once, additional occurrences of macro will overwrite text
+* `[.before]` - macro to add additional text before the rendered output, can be used only once, additional occurrences of macro will overwrite text, not that `literal` block style must be used in there(eg `....`)
 
 * `[.after]` - macro to add additional text after the rendered output, can be used only once, additional occurrences of macro will overwrite text
 
@@ -359,6 +359,14 @@ Eg: script will take package diagrams supplied in xmi file and will try to inclu
 
 * `[.include_block, package="Another", base_path="spec/fixtures"]` - same as above, but include block will be included only for supplied package name
 
+In addition to macroses listed above that can be used only inside `lutaml_uml_datamodel_description` macro there is another macro called `lutaml_figure`. `lutaml_figure` is used to lookup and reference xmi package diagrams. The syntax is as follows:
+
+[source,adoc]
+-----
+This is lutaml_figure::[package="Wrapper root package", name="Fig B1 Full model"] figure
+-----
+
+This code will be transformed into `<<figure-{diagram.xmi_id}>>` and will point to diagram figure. One can only use this macro when document rendered `lutaml_uml_datamodel_description` macro as it needs diagram lookup table in order to refernce package diagram.
 
 Will produce this output:
 
@@ -453,18 +461,21 @@ packages:
   - three
   # skips these packages
   - skip: four
+render_style: entity_list|data_dictionary|default
+section_depth: 2
 -----
 
 Where:
 
 * `packages` - required, root element with the list of strings or objects
-
 * `Package *` - pattern matching, specifies lookup condition for packages to
 render.
 +
 NOTE: In this example, it is equal to the following regular expression: `/^Package.*$/`
 
 * `skip: four` - object with package name to skip
+* `render_style` - what template to use to render packages, can be: entity_list, data_dictionary or default
+* `section_depth` - what package to use as root package for render, eg `section_depth` equal to 2 tells processor to use first nested package of the first root packages in xmi file. Example: if xmi file has this package structure: [{ name: 'One', packages: [{ name: 'one-1' }, { name: 'one-2' }] }, { name: 'Two', packages: [{ name: 'two-1' }, { name: 'two-2' }] }] and we have `section_depth` equal to 2, root package will be `one-1`
 
 Usage with macro:
 

data/lib/metanorma-plugin-lutaml.rb

@@ -4,6 +4,7 @@ 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"
 
 module Metanorma
   module Plugin

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

@@ -1,11 +1,9 @@
 {% for package in context.packages %}
 {% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
-{% if additional_context.before %}
-{{ additional_context.before.text }}
-{% endif %}
-{% assign before_package_key = 'before;' | append: package.name %}
-{% if additional_context[before_package_key] %}
-{{ additional_context[before_package_key].text }}
+{% if additional_context.before and additional_context.before.size > 0 %}
+{% for before in additional_context.before %}
+{{ before.text }}
+{% endfor %}
 {% endif %}
 {% assign is_package_spare = package.name | slice: 0,5 %}
 {% if is_package_spare == 'old: ' %}{% continue %}
@@ -15,8 +13,16 @@
 {% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }} package
 {{equalsigns}}= {{ package.name }} overview
 
+{% assign before_package_key = 'before;' | append: package.name %}
+{% if additional_context[before_package_key] and additional_context[before_package_key].size > 0 %}
+{% for before in additional_context[before_package_key] %}
+{{ before.text }}
+{% endfor %}
+{% endif %}
 {% if additional_context.diagram_include_block %}
-{% include "diagrams_block", package_name: package_name, image_base_path: additional_context.diagram_include_block.base_path, text: additional_context.diagram_include_block.text %}
+{% for diagram_include_block in additional_context.diagram_include_block %}
+{% include "diagrams_block", package_name: package_name, image_base_path: diagram_include_block.base_path, text: diagram_include_block.text %}
+{% endfor %}
 {% endif %}
 
 {% if package.packages.size > 0 %}The {{ package.name }} package is organized into
@@ -81,9 +87,9 @@
 
 {% endif %}
 
-{% if additional_context.include_block %}
-{% assign block = additional_context.include_block %}
-{% capture block_filename %}{{ block.base_path }}/{{ package_name }}{% endcapture %}
+{% if additional_context.include_block and additional_context.include_block.size > 0 %}
+{% for block in additional_context.include_block %}
+{% capture block_filename %}{{ block.base_path }}{{ package_name }}{% endcapture %}
 {% capture block_content %}{% include block_filename %}{% endcapture %}
 {% unless block_content contains "Liquid error" %}
 {% if block.text %}
@@ -91,12 +97,13 @@
 {% endif %}
 {{ block_content }}
 {% endunless %}
+{% endfor %}
 {% endif %}
 
 {% assign include_block_package_key = 'include_block;' | append: package.name %}
-{% assign block = additional_context[include_block_package_key] %}
-{% if block %}
-{% capture block_filename %}{{ block.base_path }}/{{ package_name }}{% endcapture %}
+{% if additional_context[include_block_package_key] and additional_context[include_block_package_key].size > 0 %}
+{% for block in additional_context[include_block_package_key] %}
+{% capture block_filename %}{{ block.base_path }}{{ package_name }}{% endcapture %}
 {% capture block_content %}{% include block_filename %}{% endcapture %}
 {% unless block_content contains "Liquid error" %}
 {% if block.text %}
@@ -104,16 +111,23 @@
 {% endif %}
 {{ block_content }}
 {% endunless %}
+{% endfor %}
 {% endif %}
 
 {% assign after_package_key = 'after;' | append: package.name %}
-{{equalsigns}}= Additional Information
 {% if additional_context[after_package_key] %}
-{{ additional_context[after_package_key].text }}
+{{equalsigns}}= Additional Information
+{% for after in additional_context[after_package_key] %}
+{{ after.text }}
+{% endfor %}
+{% endif %}
+{% if package.packages.size > 0 and render_nested_packages %}
+{% assign nested_depth = depth | plus: 1 %}{% include "packages", depth: nested_depth, context: package %}
 {% endif %}
-{% if package.packages.size > 0 and render_nested_packages %}{% assign nested_depth = depth | plus: 1 %}{% include "packages", depth: nested_depth, context: package %}{% endif %}
 {% endfor %}
 
-{% if additional_context.after %}
-{{ additional_context.after.text }}
+{% if additional_context.after and additional_context.after.size > 0 %}
+{% for after in additional_context.after %}
+{{ after.text }}
+{% endfor %}
 {% endif %}

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

@@ -0,0 +1,177 @@
+{% for package in context.packages %}
+{% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
+{% if additional_context.before and additional_context.before.size > 0 %}
+{% for before in additional_context.before %}
+{{ before.text }}
+{% endfor %}
+{% endif %}
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }}
+{{equalsigns}}= {{ package.name }}
+
+{% assign before_package_key = 'before;' | append: package.name %}
+{% if additional_context[before_package_key] and additional_context[before_package_key].size > 0 %}
+{% for before in additional_context[before_package_key] %}
+{{ before.text }}
+{% endfor %}
+{% endif %}
+
+[cols="1a,4a"]
+|===
+
+h|Description:    | {{ package.definition }}
+h|Parent Package: | {{ context.name }}
+h|Stereotype:     | «{{ package.stereotype }}»
+
+|===
+
+{% assign feature_types = package.classes | where: "stereotype", "FeatureType" %}
+{% assign object_types = package.classes | where: "stereotype", "ObjectType" %}
+{% assign basic_types = package.classes | where: "stereotype", "BasicType" %}
+{% assign unions = package.classes | where: "stereotype", "Union" %}
+{% assign code_lists = package.classes | where: "stereotype", "CodeList" %}
+{% if feature_types.size > 0 or object_types.size > 0 %}
+{{equalsigns}}= Classes
+
+{% include "packages_data_dictionary_classes", classes: feature_types %}
+{% include "packages_data_dictionary_classes", classes: object_types %}
+{% endif %}
+
+{% if basic_types.size > 0 %}
+{{equalsigns}}= Basic Types
+
+{% include "packages_data_dictionary_classes", classes: basic_types %}
+{% endif %}
+
+{% if unions.size > 0 %}
+{{equalsigns}}= Unions
+
+{% include "packages_data_dictionary_classes", classes: unions %}
+{% endif %}
+
+{% if code_lists.size > 0 %}
+{{equalsigns}}= Code Lists
+
+{% include "packages_data_dictionary_classes", classes: code_lists %}
+{% endif %}
+
+{% if package.data_types.size > 0 %}
+{{equalsigns}}= Data Types
+
+{% for data_type in package.data_types %}
+{% capture generalizations %}{% for assoc in data_type.associations | where: "member_end_type", "generalization" %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
+[[{{ data_type.name }}-section]]
+[cols="1a"]
+|===
+|*{{ data_type.name }}*
+|[cols="1,4",frame=none,grid=none]
+!===
+!{nbsp}{nbsp}{nbsp}{nbsp}Definition: ! {{ data_type.definition }}
+!{nbsp}{nbsp}{nbsp}{nbsp}Subclass of: ! {{ generalizations }}
+!{nbsp}{nbsp}{nbsp}{nbsp}Stereotype: !  «DataType»
+!===
+{% if data_type.associations.size > 0 %}
+{% capture rendered_associations %}
+{% for assoc in data_type.associations %}
+{% if assoc.member_end_attribute_name.size > 0 %}
+{% capture cardinality %}{% if assoc.member_end_cardinality.min == 'C' %}[0..{{ assoc.member_end_cardinality.max }}]{% elsif assoc.member_end_cardinality.min == 'M' and assoc.member_end_cardinality.max == '1' %}[1..1]{% else %}[{{ assoc.member_end_cardinality.max }}]{% endif %}{% endcapture %}
+!{set:cellbgcolor:#FFFFFF} {{ assoc.member_end_attribute_name }}  !<<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }} ! {{ assoc.definition }}
+{% endif %}
+{% endfor %}
+{% endcapture %}
+{% if rendered_associations.size > 0 %}
+|[cols="15,20,60",frame=none,grid=none,options="header"]
+!===
+!{set:cellbgcolor:#DDDDDD} *Role name* !*Target class and multiplicity*  !*Definition*
+{{ rendered_associations }}
+!===
+{% endif %}
+{% endif %}
+{% if data_type.attributes.size > 0 %}
+|[cols="15,20,60",frame=none,grid=none,options="header"]
+!===
+!{set:cellbgcolor:#DDDDDD} *Attribute* !*Value type and multiplicity* !*Definition*
+{% for attr in data_type.attributes %}
+{% capture cardinality %}{% if attr.cardinality.min == 'C' %}[0..{{ attr.cardinality.max }}]{% elsif assoc.member_end_cardinality.min == 'M' and assoc.member_end_cardinality.max == '1' %}[1..1]{% else %}[{{ attr.cardinality.max }}]{% endif %}{% endcapture %}
+!{set:cellbgcolor:#FFFFFF} {{ attr.name }}  !<<{{ attr.type }}-section,{{ attr.name }}>>  {{ cardinality }} !{{ attr.definition }}
+{% endfor %}
+!===
+|{set:cellbgcolor:#FFFFFF} Note: Unless otherwise specified, all attributes and role names have the stereotype «Property».
+{% endif %}
+|===
+
+{% endfor %}
+{% endif %}
+
+{% if package.enums.size > 0 %}
+{{equalsigns}}= Enumerations
+
+{% for enum in package.enums %}
+{% capture generalizations %}{% for assoc in enum.associations | where: "member_end_type", "generalization" %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
+[[{{ enum.name }}-section]]
+[cols="1a"]
+|===
+|*{{ enum.name }}*
+|[cols="1,4",frame=none,grid=none]
+!===
+!{nbsp}{nbsp}{nbsp}{nbsp}Definition: ! {{ enum.definition }}
+!{nbsp}{nbsp}{nbsp}{nbsp}Stereotype: ! «Enumeration»
+!===
+{% if enum.values.size > 0 %}
+|[cols="1,4",frame=none,grid=none,options="header"]
+!===
+^!{set:cellbgcolor:#DDDDDD} *Literal value* !*Definition*
+
+{% for val in enum.values %}
+^!{set:cellbgcolor:#FFFFFF} {{ val.name }}  !{{ val.definition }}
+{% endfor %}
+!===
+{% endif %}
+|===
+
+{% endfor %}
+{% endif %}
+
+{% if additional_context.include_block and additional_context.include_block.size > 0 %}
+{% for block in additional_context.include_block %}
+{% capture block_filename %}{{ block.base_path }}{{ package_name }}{% endcapture %}
+{% capture block_content %}{% include block_filename %}{% endcapture %}
+{% unless block_content contains "Liquid error" %}
+{% if block.text %}
+{{ block.text }}
+{% endif %}
+{{ block_content }}
+{% endunless %}
+{% endfor %}
+{% endif %}
+
+{% assign include_block_package_key = 'include_block;' | append: package.name %}
+{% if additional_context[include_block_package_key] and additional_context[include_block_package_key].size > 0 %}
+{% for block in additional_context[include_block_package_key] %}
+{% capture block_filename %}{{ block.base_path }}{{ package_name }}{% endcapture %}
+{% capture block_content %}{% include block_filename %}{% endcapture %}
+{% unless block_content contains "Liquid error" %}
+{% if block.text %}
+{{ block.text }}
+{% endif %}
+{{ block_content }}
+{% endunless %}
+{% endfor %}
+{% endif %}
+
+{% assign after_package_key = 'after;' | append: package.name %}
+{% if additional_context[after_package_key] %}
+{{equalsigns}}= Additional Information
+{% for after in additional_context[after_package_key] %}
+{{ after.text }}
+{% endfor %}
+{% endif %}
+{% if package.packages.size > 0 and render_nested_packages %}
+{% assign nested_depth = depth | plus: 1 %}{% include "packages_data_dictionary", depth: nested_depth, context: package %}
+{% endif %}
+{% endfor %}
+
+{% if additional_context.after and additional_context.after.size > 0 %}
+{% for after in additional_context.after %}
+{{ after.text }}
+{% endfor %}
+{% endif %}

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

@@ -0,0 +1,43 @@
+{% for klass in classes %}
+{% capture generalizations %}{% for assoc in klass.associations | where: "member_end_type", "generalization" %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
+[[{{ klass.name }}-section]]
+[cols="1a"]
+|===
+|*{{ klass.name }}*
+|[cols="1,4",frame=none,grid=none]
+!===
+!{nbsp}{nbsp}{nbsp}{nbsp}Definition: ! {{ klass.definition }}
+!{nbsp}{nbsp}{nbsp}{nbsp}Subclass of: ! {{ generalizations }}
+!{nbsp}{nbsp}{nbsp}{nbsp}Stereotype: !  «{{ klass.stereotype }}»
+!===
+{% if klass.associations.size > 0 %}
+{% capture rendered_associations %}
+{% for assoc in klass.associations %}
+{% if assoc.member_end_attribute_name.size > 0 %}
+{% capture cardinality %}{% if assoc.member_end_cardinality.min == 'C' %}[0..{{ assoc.member_end_cardinality.max }}]{% elsif assoc.member_end_cardinality.min == 'M' and assoc.member_end_cardinality.max == '1' %}[1..1]{% else %}[{{ assoc.member_end_cardinality.max }}]{% endif %}{% endcapture %}
+!{set:cellbgcolor:#FFFFFF} {{ assoc.member_end_attribute_name }}  !<<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }} ! {{ assoc.definition }}
+{% endif %}
+{% endfor %}
+{% endcapture %}
+{% if rendered_associations.size > 0 %}
+|[cols="15,20,60",frame=none,grid=none,options="header"]
+!===
+!{set:cellbgcolor:#DDDDDD} *Role name* !*Target class and multiplicity*  !*Definition*
+{{ rendered_associations }}
+!===
+{% endif %}
+{% endif %}
+{% if klass.attributes.size > 0 %}
+|[cols="15,20,60",frame=none,grid=none,options="header"]
+!===
+!{set:cellbgcolor:#DDDDDD} *Attribute* !*Value type and multiplicity* !*Definition*
+{% for attr in klass.attributes %}
+{% capture cardinality %}{% if attr.cardinality.min == 'C' %}[0..{{ attr.cardinality.max }}]{% elsif assoc.member_end_cardinality.min == 'M' and assoc.member_end_cardinality.max == '1' %}[1..1]{% else %}[{{ attr.cardinality.max }}]{% endif %}{% endcapture %}
+!{set:cellbgcolor:#FFFFFF} {{ attr.name }}  !<<{{ attr.type }}-section,{{ attr.name }}>>  {{ cardinality }} !{{ attr.definition }}
+{% endfor %}
+!===
+|{set:cellbgcolor:#FFFFFF} Note: Unless otherwise specified, all attributes and role names have the stereotype «Property».
+{% endif %}
+|===
+
+{% endfor %}

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

@@ -0,0 +1,113 @@
+{% for package in context.packages %}
+{% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
+{% if additional_context.before and additional_context.before.size > 0 %}
+{% for before in additional_context.before %}
+{{ before.text }}
+{% endfor %}
+{% endif %}
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }}
+[[rc_{{ package_name }}-model_section]]
+{{equalsigns}}= {{ package.name }}
+
+{% assign before_package_key = 'before;' | append: package.name %}
+{% if additional_context[before_package_key] and additional_context[before_package_key].size > 0 %}
+{% for before in additional_context[before_package_key] %}
+{{ before.text }}
+{% endfor %}
+{% endif %}
+{% if additional_context.diagram_include_block %}
+{% for diagram_include_block in additional_context.diagram_include_block %}
+{% include "diagrams_block", package_name: package_name, image_base_path: diagram_include_block.base_path, text: diagram_include_block.text %}
+{% endfor %}
+{% endif %}
+
+{% if additional_context.include_block and additional_context.include_block.size > 0 %}
+{% for block in additional_context.include_block %}
+{% capture block_filename %}{{ block.base_path }}{{ package_name }}{% endcapture %}
+{% capture block_content %}{% include block_filename %}{% endcapture %}
+{% unless block_content contains "Liquid error" %}
+{% if block.text %}
+{{ block.text }}
+{% endif %}
+{{ block_content }}
+{% endunless %}
+{% endfor %}
+{% endif %}
+
+{% assign include_block_package_key = 'include_block;' | append: package.name %}
+{% if additional_context[include_block_package_key] and additional_context[include_block_package_key].size > 0 %}
+{% for block in additional_context[include_block_package_key] %}
+{% capture block_filename %}{{ block.base_path }}{{ package_name }}{% endcapture %}
+{% capture block_content %}{% include block_filename %}{% endcapture %}
+{% unless block_content contains "Liquid error" %}
+{% if block.text %}
+{{ block.text }}
+{% endif %}
+{{ block_content }}
+{% endunless %}
+{% endfor %}
+{% endif %}
+
+{{equalsigns}}= Class Definitions
+{% if package.classes.size > 0 %}
+.Classes used in {{ package.name }}
+[cols="2a,6a",options="header"]
+|===
+|Class |Description
+
+{% for klass in package.classes %}
+|<<{{ klass.name }}-section,{{ klass.name }}>>
+«{{ klass.stereotype }}»
+|{{ klass.definition }}
+
+{% endfor %}
+|===
+{% endif %}
+
+{% if package.data_types.size > 0 %}
+.Data Types used in {{ package.name }}
+[cols="2,6",options="header"]
+|===
+|Name |Description
+
+{% for klass in package.data_types %}
+|<<{{ klass.name }}-section,{{ klass.name }}>>
+|{{ klass.definition }}
+
+{% endfor %}
+
+|===
+{% endif %}
+
+{% if package.enums.size > 0 %}
+.Enumerated Classes used in {{ package.name }}
+[cols="2a,6a",options="header"]
+|===
+|Name |Description
+
+{% for klass in package.enums %}
+|<<{{ klass.name }}-section,{{ klass.name }}>>
+|{{ klass.definition }}
+
+{% endfor %}
+
+|===
+{% endif %}
+
+{% assign after_package_key = 'after;' | append: package.name %}
+{% if additional_context[after_package_key] %}
+{{equalsigns}}= Additional Information
+{% for after in additional_context[after_package_key] %}
+{{ after.text }}
+{% endfor %}
+{% endif %}
+{% if package.packages.size > 0 and render_nested_packages %}
+{% assign nested_depth = depth | plus: 1 %}{% include "packages_entity_list", depth: nested_depth, context: package %}
+{% endif %}
+{% endfor %}
+
+{% if additional_context.after and additional_context.after.size > 0 %}
+{% for after in additional_context.after %}
+{{ after.text }}
+{% endfor %}
+{% endif %}

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

@@ -20,6 +20,14 @@ 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
+        SUPPORTED_NESTED_MACRO = %w[
+          before diagram_include_block after include_block].freeze
         # search document for block `lutaml_uml_datamodel_description`
         #  read include derectives that goes after that in block and transform
         #  into yaml2text blocks
@@ -57,40 +65,63 @@ 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_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] = [] }
           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[1..-2].join("\n") : ''
+            additional_context[macro_keyword].push({ 'text' => block_text }.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'],
+              "packages" => root_package['packages'],
               "additional_context" => additional_context
             }
           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),
@@ -133,7 +164,7 @@ module Metanorma
 
         def model_representation(lutaml_document, document, additional_context, options)
           render_result, errors = Utils.render_liquid_string(
-            template_string: table_template,
+            template_string: table_template(options['section_depth'] || 2, options['render_style']),
             context_items: create_context_object(lutaml_document,
                               additional_context,
                               options),
@@ -145,9 +176,10 @@ module Metanorma
           render_result.split("\n")
         end
 
-        def table_template
+        def table_template(section_depth, render_style)
+          include_name = RENDER_STYLES_INCLUDES.fetch(render_style, DEFAULT_RENDER_INCLUDE)
           <<~LIQUID
-            {% include "packages", depth: 2, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
+            {% 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.6".freeze
     end
   end
 end

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.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -261,11 +261,15 @@ 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_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_enum.liquid
 - 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_uml_attributes_table_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor.rb