metanorma-plugin-lutaml 0.4.6 → 0.4.10

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

@@ -0,0 +1,73 @@
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
+{% capture generalizations %}{% assign inheritance = klass.associations | where: "member_end_type", "inheritance" %}{% for assoc in inheritance %}<<{{ assoc.member_end }}-section,{{ assoc.member_end }}>>{% endfor %}{% endcapture %}
+[[{{ klass.name }}-section]]
+{{equalsigns}} {{ klass.name }}
+{%comment%}(inside class: depth is {{ depth }}, equalsigns {{equalsigns}}){%endcomment%}
+
+.Metadata of {{ klass.name }} ({{klass.stereotype}})
+[cols="1a,4a"]
+|===
+h| Definition:  | {{ klass.definition | replace: '|', '\|' }}
+h| Subclass of: | {% if generalizations.size > 0 %}{{ generalizations }}{% else %}None{% endif %}
+h| Stereotype:  | «{{ klass.stereotype }}»
+
+{% if klass.constraints.size > 0 %}
+{% for constraint in klass.constraints %}
+h| Constraint:
+| `{{ constraint.body }}`:
+
+[source,ocl,%unnumbered]
+------
+{{ constraint.definition | replace: '|', '\|' }}
+------
+{% endfor %}
+{% endif %}
+
+|===
+
+{% if klass.associations.size > 0 %}
+{% capture rendered_associations %}
+{% for assoc in klass.associations %}
+{% if assoc.member_end_attribute_name.size > 0 %}
+{% capture cardinality %}&#91;{% case assoc.member_end_cardinality.min %}{% when "C" %}0{% when "M" %}1{% else %}{{assoc.member_end_cardinality.min}}{% endcase %}..{{ assoc.member_end_cardinality.max }}&#93;{% endcapture %}
+| {{ assoc.member_end_attribute_name }}
+| <<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }}
+| {{ assoc.definition | replace: '|', '\|' }}
+{% endif %}
+{% endfor %}
+{% endcapture %}
+{% assign associations_stripped = rendered_associations | strip_newlines | strip %}
+
+{% if associations_stripped.size > 0 %}
+.Associations of {{ klass.name }} ({{ klass.stereotype }})
+[cols="15a,20a,60a",options="header"]
+|===
+| Role name | Target class and multiplicity | Definition
+
+{{ rendered_associations }}
+
+|===
+{% endif %}
+{% endif %}
+
+{% if klass.attributes.size > 0 %}
+.Attributes of {{ klass.name }} ({{klass.stereotype}})
+[cols="15a,20a,60a",options="header"]
+|===
+| Attribute | Value type and multiplicity | Definition
+
+{% for attr in klass.attributes %}
+{% capture cardinality %}&#91;{% case attr.cardinality.min %}{% when 'C' %}0{% when 'M' %}1{% else %}{{ attr.cardinality.min }}{% endcase %}..{{ attr.cardinality.max }}&#93;{% endcapture %}
+| {{ attr.name }}
+| <<{{ attr.type }}-section,{{ attr.type }}>> {{ cardinality }}
+| {{ attr.definition | replace: '|', '\|' }}
+
+{% endfor %}
+|===
+
+[NOTE,keep-separate=true]
+====
+Unless otherwise specified, all attributes and role names have the stereotype
+«Property».
+====
+{% endif %}

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

@@ -1,43 +1,3 @@
 {% 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 %}
-|===
-
+{% include "packages_data_dictionary_class", depth: depth %}
 {% endfor %}

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

@@ -3,8 +3,8 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-[[tab-P-{{ package_name }}-DT-{{ klass_name }}]]
-.Elements of {{ package.name }}::{{ klass.name }}
+[[section-{{ klass.xmi_id }}]]
+.Definition table of “{{ package.name }}::{{ klass.name }}” ({{ klass.stereotype }})
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 
@@ -24,14 +24,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,12 +41,11 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-
-.1+h|Associations: 7+| (none)
+h| Associations: 7+| (none)
 {% endif %}
 
 {% if klass.attributes.size > 0 %}
-.{{klass.attributes.size | plus: 1}}+h|Values:
+.{{klass.attributes.size | plus: 1}}+h| Values:
 | _Name_
 6+| _Definition_
 
@@ -56,7 +55,7 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-.1+h|Values:
+h| Values:
 7+| (none)
 {% endif %}
 

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

@@ -2,77 +2,133 @@
 {% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
 {% if additional_context.before and additional_context.before.size > 0 %}
 {% for before in additional_context.before %}
+{% if before.liquid %}
+{{ before.text | interpolate }}
+{% else %}
 {{ before.text }}
+{% endif %}
 {% 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 %}
+{% if additional_context[before_package_key] %}
 {% for before in additional_context[before_package_key] %}
+{% if before.liquid %}
+{{ before.text | interpolate }}
+{% else %}
 {{ 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 depth %}
+{% assign nested_depth = depth | plus: 1 %}
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
+[[rc_{{ package_name }}-model_section]]
+{{equalsigns}} {{ package.name }}
+{% endif %}
 
-{% if additional_context.include_block and additional_context.include_block.size > 0 %}
-{% for block in additional_context.include_block %}
+{% if additional_context.all_macros.size > 0 %}
+{% assign sorted_all_macros = additional_context.all_macros | where: "position", "before" | sort: 'index' %}
+{% for block in sorted_all_macros %}
+{% case block.type %}
+{% when 'include_block' %}
+{% unless block.package and block.package != package.name %}
 {% 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 %}
+
+{% if block.liquid %}
+{{ block.text | interpolate }}
+{% else %}
 {{ block.text }}
 {% endif %}
+{% endif %}
+
 {{ block_content }}
 {% endunless %}
-{% endfor %}
-{% endif %}
+{% endunless %}
+{% when 'package_text' %}
+{% unless block.package and block.package != package.name %}
 
-{% 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 %}
+{% if block.liquid %}
+{{ block.text | interpolate }}
+{% else %}
 {{ block.text }}
 {% endif %}
-{{ block_content }}
 {% endunless %}
+{% else %}
+{% endcase %}
+{% endfor %}
+{% endif %}
+
+{% comment %} // TODO: move to all_macros block {% endcomment %}
+{% 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 %}
 
-{{equalsigns}}= Class Definitions
 {% if package.classes.size > 0 %}
-.Classes used in {{ package.name }}
+{% unless package_skip_sections[package.name]['classes'] %}
+{{equalsigns}}= Class definitions
+
+{% endunless %}
+{% comment %} {% assign data_types = package.classes | where: "stereotype", "DataType" %} {% endcomment %}
+{% assign basic_types = package.classes | where: "stereotype", "BasicType" %}
+{% comment %} {% assign enumerations = package.classes | where: "stereotype", "Enumeration" %} {% endcomment %}
+{% assign code_lists = package.classes | where: "stereotype", "CodeList" %}
+{% assign unions = package.data_types | where: "stereotype", "Union" %}
+
+{% assign not_classes_length = plus: basic_types.size | plus: code_lists.size %}
+{% assign not_classes_stereotypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
+{% unless not_classes_length == package.classes.size or package_skip_sections[package.name]['classes'] %}
+.Classes defined in {{ package.name }} ({{ package.stereotype }})
 [cols="2a,6a",options="header"]
 |===
-|Class |Description
+|Name |Description
 
 {% for klass in package.classes %}
-|<<{{ klass.name }}-section,{{ klass.name }}>>
-«{{ klass.stereotype }}»
-|{{ klass.definition }}
+{% unless not_classes_stereotypes contains klass.stereotype %}
+| <<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
+| {{ klass.definition | replace: '|', '\|' }}
 
+{% endunless %}
 {% endfor %}
 |===
+{% endunless %}
+
+{% assign non_unions = package.data_types | where: "stereotype", "DataType"  %}
+{% if non_unions.size > 0 %}
+{% include "packages_entity_list_classes", classes: non_unions, type: "Data types", depth: nested_depth %}
 {% endif %}
 
-{% if package.data_types.size > 0 %}
-.Data Types used in {{ package.name }}
-[cols="2,6",options="header"]
+{% if basic_types.size > 0 %}
+{% include "packages_entity_list_classes", classes: basic_types, type: "Primitive data types", depth: nested_depth %}
+{% endif %}
+
+{% if package.enums.size > 0 %}
+{% include "packages_entity_list_classes", classes: package.enums, type: "Enumerated classes", depth: nested_depth %}
+{% endif %}
+
+{% if unions.size > 0 %}
+{% include "packages_entity_list_classes", classes: unions, type: "Union types", depth: nested_depth %}
+{% endif %}
+
+{% if code_lists.size > 0 %}
+{% include "packages_entity_list_classes", classes: code_lists, type: "Code list classes", depth: nested_depth %}
+{% endif %}
+
+{% endif %}
+
+{% comment %} {% if package.data_types.size > 0 %}
+.Data types used in {{ package.name }}
+[cols="2a,6a",options="header"]
 |===
 |Name |Description
 
 {% for klass in package.data_types %}
-|<<{{ klass.name }}-section,{{ klass.name }}>>
-|{{ klass.definition }}
+|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
+|{{ klass.definition | replace: '|', '\|' }}
 
 {% endfor %}
 
@@ -86,28 +142,70 @@
 |Name |Description
 
 {% for klass in package.enums %}
-|<<{{ klass.name }}-section,{{ klass.name }}>>
-|{{ klass.definition }}
+|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
+|{{ klass.definition | replace: '|', '\|' }}
 
 {% endfor %}
 
 |===
+{% endif %} {% endcomment %}
+
+{% if additional_context.all_macros.size > 0 %}
+{% assign sorted_all_macros = additional_context.all_macros | where: "position", "after" | sort: 'index' %}
+{% for block in sorted_all_macros %}
+{% case block.type %}
+{% when 'include_block' %}
+{% unless block.package and block.package != package.name %}
+{% 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 %}
+
+{% if block.liquid %}
+{{ block.text | interpolate }}
+{% else %}
+{{ block.text }}
+{% endif %}
+{% endif %}
+
+{{ block_content }}
+{% endunless %}
+{% endunless %}
+{% when 'package_text' %}
+{% unless block.package and block.package != package.name %}
+
+{% if block.liquid %}
+{{ block.text | interpolate }}
+{% else %}
+{{ block.text }}
+{% endif %}
+{% endunless %}
+{% else %}
+{% endcase %}
+{% 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] %}
+{% if after.liquid %}
+{{ after.text | interpolate }}
+{% else %}
 {{ after.text }}
+{% endif %}
 {% 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 %}
+{% 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 %}
+{% if after.liquid %}
+{{ after.text | interpolate }}
+{% else %}
 {{ after.text }}
+{% endif %}
 {% endfor %}
 {% endif %}

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

@@ -0,0 +1,19 @@
+{% for package in context.packages %}
+{% assign not_classes_stereotypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
+[cols="2a,6a",options="header"]
+|===
+|Class |Description
+
+{% for klass in package.classes %}
+{% assign klass_name = klass.name %}
+{% assign package_name = package.name %}
+{% unless package_entities and package_entities[package_name][klass_name] != true %}
+{% unless not_classes_stereotypes contains klass.stereotype %}
+| <<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
+| {{ klass.definition | replace: '|', '\|' }}
+
+{% endunless %}
+{% endunless %}
+{% endfor %}
+|===
+{% endfor %}

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

@@ -0,0 +1,11 @@
+.{{ type }} defined in {{ package.name }} ({{ package.stereotype }})
+[cols="2a,6a",options="header"]
+|===
+|Name |Description
+
+{% for klass in classes %}
+| <<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype | default: "Enumeration" }}»
+| {{ klass.definition | replace: '|', '\|' }}
+
+{% 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 }}]]
+.Definition table of “{{ package.name }}::{{ klass.name }}” ({{ klass.stereotype }})
 [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,9 +56,8 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-.1+h|Values:
+h| Values:
 7+| (none)
 {% endif %}
 
-
 |===