metanorma-plugin-lutaml 0.4.3 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a594ac058de2a8fc661fa9354e32c3e53cbba9ba831eb2241866c3fe50fef39e
-  data.tar.gz: c9ccd2ad0f3d8bcb39da897b733f0c84a8aebf2b434f0c05e4229700e96b1042
+  metadata.gz: 6975d55ed93f086ff54367a880fe6cd997da1040dd5266d3c5c2f5c984370801
+  data.tar.gz: fa336cbe86550862521a4fe051a69dfdd8e809cc3ba652c07482ab6f9d5bb7ac
 SHA512:
-  metadata.gz: 2761bf514acf0b0861a18c7d9182834868d3061e8720373e2e57bf5f31216e7a5c66e08fee6069f93c59074c352b8f4fb6f416cbd5a1644df0d55dc6db59860e
-  data.tar.gz: 86489b0e1915b61997af3f55388ea4b788fe505188caca2efd40589b67c1ba4e9a0acba591d111c0af7c4943dbad1a3bd69dc0c0dd737663e93b1ada5436d046
+  metadata.gz: bf4817cf9ec3c41195ae30425bf4462f58dffce5773f4f07e146915a13fc7c1f9e46be8285c5f4814a673a7558aacb937b7e0dfb3939c644ad9b8cb438c1a580
+  data.tar.gz: e987082dd620fcf4b455204e86607df45632c5ce9bdca7dfd30815c1c720a6facab339a436d90cc8b78809c608c2271a8f7cb3e32dbad66205a25e3f11c525a7

data/README.adoc

@@ -285,31 +285,45 @@ 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/", format="emf"]
+....
+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
----
+....
 --
 --
 -----
@@ -318,102 +332,118 @@ 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
 
 * `[.after, package="Another"]` - macro with text to be inserted before(after in case of `.before` name) the package
 
-
-Will produce this output:
-
+* `[.diagram_include_block]` - macro to automatically include diagram images. Attribute `base_path` is a required attribute to supply path prefix where to look for a digram image. `format` is an optional attribute that tells what file extention to use when including diagram file. The logic is as follows:
 [source,adoc]
 -----
-= preface
-my text
-
-text before Another package
-
-=== Another
+{% for diagram in package.diagrams %}
+[[figure-{{ diagram.xmi_id }}]]
+.{{ diagram.name }}
+image::{{ image_base_path }}/{{ diagram.xmi_id }}.{{ format | default: 'png' }}[]
+
+{% if diagram.definition %}
+{{ diagram.definition | html2adoc }}
+{% endif %}
+{% endfor %}
+-----
+Eg: script will take package diagrams supplied in xmi file and will try to include `image` with the name equal to diagram' xmi_id attribute plus `.png`. Also one can add any text to the macro text, it will be added as paragraph before each image include.
 
-[[rc_another-model_section]]
-==== Another
+* `[.diagram_include_block, package="Another"]` - same as above, but diagram will be included only for supplied package name
 
-==== Requirements
+* `[.include_block, base_path="spec/fixtures"]` - macro to inlude files(adoc/liquid) for each package name. Attribute `base_path` is a required attribute to supply path prefix where to look for file to include. Macro will look for a file called `base_path` + `/` `_package_name`(downcase, replace : -> '', ' ' -> '_') + `.adoc`[`.liquid`], eg for package 'My Package name' and `base_path` eq to `my/path`, macro will look for the following file path: `my/path/_my_package_name.adoc`.
 
-==== Class Definitions
+* `[.include_block, package="Another", base_path="spec/fixtures"]` - same as above, but include block will be included only for supplied package name
 
-.Classes used in Another
-[cols="2a,6a",options="header"]
-|===
-|Class |Description
+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
+-----
 
-|<<AbstractAtomicTimeseries-section,AbstractAtomicTimeseries>>
-«»
-|
+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:
 
-|<<AbstractTimeseries-section,AbstractTimeseries>>
-«»
-|
+[source,adoc]
+-----
+my text
+== CityGML package
+=== CityGML overview
 
-....
-|===
+Diagram text
 
+[[figure-EAID_ACBB5EE3_3428_40f5_9C7C_E41923419F29]]
+.CityGML Package Diagram
+image::requirements//EAID_ACBB5EE3_3428_40f5_9C7C_E41923419F29.png[]
 
+BuildingFurnitureFunctionValue is a code list that enumerates the different purposes of a BuildingFurniture.
 
-.Data Types used in Another
-[cols="2,6",options="header"]
-|===
-|Name |Description
+[[figure-EAID_938AE961_1C57_4052_B964_997D1894A58D]]
+.Use of ISO and OASIS standards in CityGML
+image::requirements//EAID_938AE961_1C57_4052_B964_997D1894A58D.png[]
 
+The CityGML package is organized into
+2 packages with 1 modules:
 
-|<<ADEOfAbstractAtomicTimeseries-section,ADEOfAbstractAtomicTimeseries>>
-|
+[arabic]
+. Another package
+. CityTML package
 
+my text
 
-|<<ADEOfAbstractTimeseries-section,ADEOfAbstractTimeseries>>
-|
+Content for CityGML package
 
-....
-|===
+==== Defining tables
 
+[arabic]
+.<<tab-P-another-C-abstractatomictimeseries>> -- Elements of Another::AbstractAtomicTimeseries
 
-
-.Enumerated Classes used in Another
-[cols="2a,6a",options="header"]
+[[tab-P-another-C-abstractatomictimeseries]]
+.Elements of Another::AbstractAtomicTimeseries
+[width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
-|Name |Description
-
-|<<TimeseriesTypeValue-section,TimeseriesTypeValue>>
+h|Name: 7+| AbstractAtomicTimeseries
+h|Definition: 7+|
+h|Stereotype: 7+| interface
+h|Abstract: 7+|
+.1+h|Associations: 7+| (none)
+.4+h|Public attributes:
+| _Name_
+2+| _Definition_
+| _Derived_
+| _Obligation_
+| _Maximum occurrence_
+| _Data type_
+| adeOfAbstractAtomicTimeseries
+2+|
 |
-
+| C
+| *
+| ADEOfAbstractAtomicTimeseries
+| observationProperty
+2+|
+|
+| M
+| 1
+| CharacterString
+| uom
+2+|
+|
+| C
+| 1
+| CharacterString
+h|Constraints: 7+| (none)
 |===
 
-
-==== Additional Information
-
-text after Another package
-
-
-=== CityGML
-
-[[rc_citygml-model_section]]
-==== CityGML
-
-==== Requirements
-
-==== Class Definitions
-
-==== Additional Information
+=== Additional Information
 
 text after CityGML package
-
-
-= footer
-footer text
-
 -----
 
 In addition to just supplying XMI file, this macro also supports YAML
@@ -431,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/multiply_local_file_system.rb

@@ -0,0 +1,53 @@
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Liquid
+        class LocalFileSystem
+          attr_accessor :roots, :patterns
+
+          def initialize(roots, patterns = ["_%s.liquid"])
+            @roots    = roots
+            @patterns = patterns
+          end
+
+          def read_template_file(template_path)
+            full_path = full_path(template_path)
+            raise FileSystemError, "No such template '#{template_path}'" unless File.exist?(full_path)
+
+            File.read(full_path)
+          end
+
+          def full_path(template_path)
+            raise ::Liquid::FileSystemError, "Illegal template name '#{template_path}'" unless %r{\A[^./][a-zA-Z0-9_/]+\z}.match?(template_path)
+
+            result_path = if template_path.include?('/')
+              roots
+                .map do |root|
+                  patterns.map do |pattern|
+                    File.join(root, File.dirname(template_path), pattern % File.basename(template_path))
+                  end
+                end
+                .flatten
+                .find { |path| File.file?(path) }
+            else
+              roots
+                .map do |root|
+                  patterns.map do |pattern|
+                    File.join(root, pattern % template_path)
+                  end
+                end
+                .flatten
+                .find { |path| File.file?(path) }
+            end
+
+            unless roots.any? { |root| File.expand_path(result_path).start_with?(File.expand_path(root)) }
+              raise ::Liquid::FileSystemError, "Illegal template path '#{File.expand_path(result_path)}'"
+            end
+
+            result_path
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+{{ text }}
+
+{% for diagram in package.diagrams %}
+[[figure-{{ diagram.xmi_id }}]]
+.{{ diagram.name }}
+image::{{ image_base_path }}/{{ diagram.xmi_id }}.{{ format | default: 'png' }}[]
+
+{% if diagram.definition %}
+{{ diagram.definition | html2adoc }}
+{% endif %}
+{% endfor %}

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

@@ -1,27 +1,29 @@
 {% for package in context.packages %}
-{% assign before_package_key = 'before;' | append: package.name %}
-{% if additional_context[before_package_key] %}
-{{ additional_context[before_package_key] }}
+{% 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 %}
 {% assign is_package_spare = package.name | slice: 0,5 %}
 {% if is_package_spare == 'old: ' %}{% continue %}
 {% elsif is_package_spare == 'Spare' %}{% continue %}
 {% endif %}
-{% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
 
 {% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }} package
 {{equalsigns}}= {{ package.name }} overview
 
-// TODO: include blocks by base path
-//{% for diagram in package.diagrams %}
-//[[figure-{{ diagram.xmi_id }}]]
-//.{{ diagram.name }}
-//image::../../xmi-19170-only/Images/{{ diagram.xmi_id }}.png[]
-//
-//{% if diagram.definition %}
-//{{ diagram.definition | html2adoc }}
-//{% endif %}
-//{% endfor %}
+{% 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, format: diagram_include_block.format %}
+{% endfor %}
+{% endif %}
 
 {% if package.packages.size > 0 %}The {{ package.name }} package is organized into
 {{ package.packages.size }} packages{% assign modules_nested_size = 0 %}{% for module in package.packages %}{% assign modules_nested_size = modules_nested_size | plus: module.packages.size %}{% endfor %}{% if modules_nested_size > 0 %} with {{modules_nested_size}} modules{% endif %}:
@@ -38,7 +40,7 @@
 {% endif %}
 {% endfor %}
 
-{% if package.classes.size > 0 %}
+{% if package.classes.size > 0 or package.enums.size > 0 or package.data_types.size > 0 %}
 
 {{equalsigns}}= Defining tables
 
@@ -83,26 +85,49 @@
 {% include "packages_data_type" %}
 {% endfor %}
 
-// TODO: include blocks by base path
-// {% capture requirement_filename %}requirements/REQ_{{ package_name }}{% endcapture %}
-// {% capture requirement_content %}{% include requirement_filename %}{% endcapture %}
-// {% unless requirement_content contains "Liquid error" %}
-// The following requirements apply:
-// {{ requirement_content }}
-//
-// {% for num in (1..5) %}
-// {% capture nested_requirement_filename %}requirements/REQ_{{ package_name }}_{{num}}{% endcapture %}
-// {% capture nested_requirement_content %}{% include nested_requirement_filename %}{% endcapture %}
-// {% unless nested_requirement_content contains "Liquid error" %}
-// {{ nested_requirement_content }}
-// {% endunless %}
-// {% endfor %}
-// {% endunless %}
+{% 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 %}
-{{equalsigns}}= Additional Information
 {% if additional_context[after_package_key] %}
-{{ 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", 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.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_diagram_base.rb

@@ -5,6 +5,7 @@ require "asciidoctor"
 require "asciidoctor/reader"
 require "lutaml"
 require "lutaml/uml"
+require "lutaml/formatter"
 require "metanorma/plugin/lutaml/utils"
 
 module Metanorma
@@ -41,7 +42,7 @@ module Metanorma
 
         # if no :imagesdir: leave image file in lutaml
         def generate_file(parent, _reader, uml_document)
-          formatter = ::Lutaml::Uml::Formatter::Graphviz.new
+          formatter = ::Lutaml::Formatter::Graphviz.new
           formatter.type = :png
 
           imagesdir = if parent.document.attr("imagesdir")

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

@@ -14,7 +14,7 @@ module Metanorma
       #  @example [lutaml_uml_attributes_table,path/to/lutaml,EntityName]
       class LutamlUmlAttributesTablePreprocessor < Asciidoctor::Extensions::Preprocessor
         MARCO_REGEXP =
-          /\[lutaml_uml_attributes_table,([^,]+),?(.+)?,([^,]+),?(.+)?\]/
+          /\[lutaml_uml_attributes_table,([^,]+),?([^,]+),?(.+?)?\]/
         # search document for block `datamodel_attributes_table`
         #  read include derectives that goes after that in block and transform
         #  into yaml2text blocks
@@ -36,15 +36,16 @@ module Metanorma
           input_lines.each_with_object([]) do |line, result|
             if match = line.match(MARCO_REGEXP)
               lutaml_path = match[1]
-              entity_name = match[3]
-              result.push(*parse_marco(lutaml_path, entity_name, document))
+              entity_name = match[2]
+              skip_headers = match[3]
+              result.push(*parse_marco(lutaml_path, entity_name, document, skip_headers))
             else
               result.push(line)
             end
           end
         end
 
-        def parse_marco(lutaml_path, entity_name, document)
+        def parse_marco(lutaml_path, entity_name, document, skip_headers)
           lutaml_document = lutaml_document_from_file(document, lutaml_path)
             .serialized_document
           entities = [lutaml_document["classes"], lutaml_document["enums"]]
@@ -53,12 +54,12 @@ module Metanorma
           entity_definition = entities.detect do |klass|
             klass["name"] == entity_name.strip
           end
-          model_representation(entity_definition, document)
+          model_representation(entity_definition, document, skip_headers)
         end
 
-        def model_representation(entity_definition, document)
+        def model_representation(entity_definition, document, skip_headers)
           render_result, errors = Utils.render_liquid_string(
-            template_string: table_template,
+            template_string: table_template(skip_headers),
             context_items: entity_definition,
             context_name: "definition",
             document: document
@@ -68,9 +69,9 @@ module Metanorma
         end
 
         # rubocop:disable Layout/IndentHeredoc
-        def table_template
+        def table_template(skip_headers)
           <<~TEMPLATE
-          === {{ definition.name }}
+          #{"=== {{ definition.name }}" unless skip_headers}
           {{ definition.definition }}
 
           {% if definition.attributes %}

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

@@ -16,11 +16,18 @@ module Metanorma
           Asciidoctor::Extensions::Preprocessor
         MARCO_REGEXP =
           /\[lutaml_uml_datamodel_description,([^,]+),?(.+)?\]/
-        SUPPORTED_NESTED_MACROSES = %w[before after].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'.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
@@ -58,35 +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
-            nested_match = SUPPORTED_NESTED_MACROSES
-              .map { |macro| [macro, block_line.match(/\[.#{macro}(,\s*package=("|')(?<package>.+?)("|'))?\]/)] }
-              .detect { |n| !n.last.nil? }
-            nested_context_value = []
-            if nested_match
-              macro_keyword = [nested_match.first, nested_match.last['package']].compact.join(";")
-              nested_end_mark = input_lines.next
-              while (block_line = input_lines.next) != nested_end_mark
-                nested_context_value.push(block_line)
-              end
-              additional_context[macro_keyword] = nested_context_value
-                .join("\n")
-            end
+            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(";")
+            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)
-          root_package = lutaml_document.to_liquid['packages'].first
+          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" => root_package['packages'],
+              "additional_context" => additional_context
+            }
+          end
+
           all_packages = [root_package, *root_package['children_packages']]
           {
             "packages" => sort_and_filter_out_packages(all_packages, options),
@@ -129,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),
@@ -141,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 %}
+            {% 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/utils.rb

@@ -1,5 +1,6 @@
 require "expressir/express/cache"
 require "metanorma/plugin/lutaml/liquid/custom_filters"
+require "metanorma/plugin/lutaml/liquid/multiply_local_file_system"
 
 ::Liquid::Template.register_filter(Metanorma::Plugin::Lutaml::Liquid::CustomFilters)
 
@@ -25,8 +26,8 @@ module Metanorma
                                  context_name:, document:, include_path: nil)
           liquid_template = ::Liquid::Template.parse(template_string)
           # Allow includes for the template
-          include_path ||= Utils.relative_file_path(document, "")
-          liquid_template.registers[:file_system] = ::Liquid::LocalFileSystem.new(include_path)
+          include_paths = [Utils.relative_file_path(document, ""), include_path].compact
+          liquid_template.registers[:file_system] = ::Metanorma::Plugin::Lutaml::Liquid::LocalFileSystem.new(include_paths, ["_%s.liquid", "_%s.adoc"])
           rendered_string = liquid_template
             .render(context_name => context_items,
                     strict_variables: true,

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

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      VERSION = "0.4.3".freeze
+      VERSION = "0.4.7".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.3
+  version: 0.4.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -257,13 +257,19 @@ files:
 - lib/metanorma-plugin-lutaml.rb
 - lib/metanorma/plugin/lutaml/express_remarks_decorator.rb
 - lib/metanorma/plugin/lutaml/liquid/custom_filters.rb
+- lib/metanorma/plugin/lutaml/liquid/multiply_local_file_system.rb
+- 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