metanorma-plugin-lutaml 0.4.5 → 0.4.9

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

@@ -3,8 +3,8 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-[[tab-P-{{ package_name }}-C-{{ klass_name }}]]
-.Elements of {{ package.name }}::{{ klass.name }}
+[[section-{{ klass.xmi_id }}]]
+.Elements of “{{ package.name }}::{{ klass.name }}” (class)
 [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,9 +41,9 @@ 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|Public attributes:
 | _Name_
@@ -63,12 +63,12 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-.1+h|Public attributes:
+h| Public attributes:
 7+| (none)
 {% endif %}
 
 {% if klass.constraints.size > 0 %}
-.{{ klass.constraints.size }}+|*Constraints:*
+.{{ klass.constraints.size }}+h| Constraints:
 {% for constr in klass.constraints %}
 7+| `{{ constr.body }}`
 

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

@@ -0,0 +1,201 @@
+{% 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 }}
+
+{% 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 basic_types = package.classes | where: "stereotype", "BasicType" %}
+{% assign unions = package.data_types | where: "stereotype", "Union" %}
+{% assign code_lists = package.classes | where: "stereotype", "CodeList" %}
+{% assign not_classes_length = basic_types.size | plus: code_lists.size %}
+{% assign not_classes_stereoptypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
+{{equalsigns}}= Classes
+
+{% unless not_classes_length == package.classes.size %}
+
+{% for klass in package.classes %}
+{% unless not_classes_stereoptypes contains klass.stereotype  %}
+{% include "packages_data_dictionary_class" %}
+{% endunless %}
+{% endfor %}
+{% else %}
+None
+{% endunless %}
+
+{{equalsigns}}= Basic types
+
+{% if basic_types.size > 0 %}
+
+{% include "packages_data_dictionary_classes", classes: basic_types %}
+{% else %}
+None
+{% endif %}
+
+{{equalsigns}}= Unions
+
+{% if unions.size > 0 %}
+
+{% include "packages_data_dictionary_classes", classes: unions %}
+{% else %}
+None
+{% endif %}
+
+{{equalsigns}}= Code lists
+
+{% if code_lists.size > 0 %}
+
+{% include "packages_data_dictionary_classes", classes: code_lists %}
+{% else %}
+None
+{% endif %}
+
+{{equalsigns}}= Data types
+
+{% assign non_unions = package.data_types | where: "stereotype", "DataType"  %}
+{% if non_unions.size > 0 %}
+
+{% for data_type in non_unions %}
+{% capture generalizations %}{% assign inheritance = data_type.associations | where: "member_end_type", "inheritance" %}{% for assoc in inheritance %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
+[[{{ data_type.name }}-section]]
+[cols="1a"]
+|===
+|*{{ data_type.name }}*
+|[cols="1,4"]
+!===
+!Definition:  ! {{ data_type.definition }}
+!Subclass of: ! {% if generalizations.size > 4 %}{{ generalizations }}{% else %}None{% endif %}
+!Stereotype:  !  «{{ data_type.stereotype }}»
+!===
+{% 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 %}
+! {{ assoc.member_end_attribute_name }}  !<<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }} ! {{ assoc.definition }}
+{% endif %}
+{% endfor %}
+{% endcapture %}
+{% if rendered_associations.size > 100 %}
+|
+[cols="15,20,60",options="header"]
+!===
+! Role name !Target class and multiplicity !Definition
+{{ rendered_associations }}
+!===
+{% endif %}
+{% endif %}
+{% if data_type.attributes.size > 0 %}
+|
+[cols="15,20,60",options="header"]
+!===
+! 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 %}
+! {{ attr.name }}  !<<{{ attr.type }}-section,{{ attr.type }}>>  {{ cardinality }} !{{ attr.definition }}
+{% endfor %}
+!===
+| NOTE: Unless otherwise specified, all attributes and role names have the stereotype «Property».
+{% endif %}
+|===
+
+{% endfor %}
+{% else %}
+None
+{% endif %}
+
+{{equalsigns}}= Enumerations
+
+{% if package.enums.size > 0 %}
+
+{% for enum in package.enums %}
+[[{{ enum.name }}-section]]
+[cols="1a"]
+|===
+|*{{ enum.name }}*
+|
+[cols="1,4"]
+!===
+!Definition: ! {{ enum.definition }}
+!Stereotype: ! «Enumeration»
+!===
+{% if enum.values.size > 0 %}
+|
+[cols="1,4",options="header"]
+!===
+! Literal value !Definition
+
+{% for val in enum.values %}
+! {{ val.name }}  !{{ val.definition }}
+{% endfor %}
+!===
+{% endif %}
+|===
+
+{% endfor %}
+{% else %}
+None
+{% 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_class.liquid

@@ -0,0 +1,67 @@
+{% capture generalizations %}{% assign inheritance = klass.associations | where: "member_end_type", "inheritance" %}{% for assoc in inheritance %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
+[[{{ klass.name }}-section]]
+[cols="1a"]
+|===
+|*{{ klass.name }}*
+|
+[cols="1,4"]
+!===
+! Definition:  ! {{ klass.definition }}
+! Subclass of: ! {% if generalizations.size > 4 %}{{ generalizations }}{% else %}None{% endif %}
+! Stereotype:  ! «{{ klass.stereotype }}»
+{% if klass.constraints.size > 0 %}
+{% for constraint in klass.constraints %}
+! Constraint:  ! {{ constraint.body }}: {{ 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 %}{% 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 %}
+
+! {{ assoc.member_end_attribute_name }}
+! <<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }}
+! {{ assoc.definition }}
+
+{% endif %}
+{% endfor %}
+{% endcapture %}
+
+{% if rendered_associations.size > 100 %}
+|
+[cols="15,20,60",options="header"]
+!===
+! *Role name*
+! *Target class and multiplicity*
+! *Definition*
+{{ rendered_associations }}
+!===
+{% endif %}
+
+{% endif %}
+{% if klass.attributes.size > 0 %}
+|
+[cols="15,20,60",options="header"]
+!===
+! *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 %}
+
+! {{ attr.name }}
+!<<{{ attr.type }}-section,{{ attr.type }}>> {{ cardinality }}
+!{{ attr.definition }}
+
+{% endfor %}
+!===
+
+| NOTE: 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

@@ -0,0 +1,3 @@
+{% for klass in classes %}
+{% include "packages_data_dictionary_class" %}
+{% 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 }}]]
+.Elements of {{ package.name }}::{{ klass.name }}” (data_type)
 [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

@@ -0,0 +1,136 @@
+{% 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 %}
+{% if depth %}
+[[rc_{{ package_name }}-model_section]]
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }}
+{% endif %}
+
+{% if additional_context.all_macroses.size > 0 %}
+{% assign sorted_all_macroses = additional_context.all_macroses | where: "position", "before" | sort: 'index' %}
+{% for block in sorted_all_macroses %}
+{% 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 %}
+
+{{ block.text }}
+{% endif %}
+
+{{ block_content }}
+{% endunless %}
+{% endunless %}
+{% when 'package_text' %}
+{% unless block.package and block.package != package.name %}
+
+{{ block.text }}
+{% endunless %}
+{% else %}
+{% endcase %}
+{% endfor %}
+{% endif %}
+
+// TODO: move to all_macroses block
+{% 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 package.classes.size > 0 %}
+{{equalsigns}}= Class definitions
+
+{% 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 not_classes_length = plus: basic_types.size | plus: code_lists.size %}
+{% assign not_classes_stereoptypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
+{% unless not_classes_length == package.classes.size %}
+.Classes used in {{ package.name }}
+[cols="2a,6a",options="header"]
+|===
+|Name |Description
+{% for klass in package.classes %}
+{% unless not_classes_stereoptypes contains klass.stereotype  %}
+|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
+|{{ klass.definition }}
+
+{% endunless %}
+{% endfor %}
+|===
+{% endunless %}
+
+{% if package.data_types.size > 0 %}
+{% include "packages_entity_list_classes", classes: package.data_types, type: "Data Types" %}
+{% endif %}
+
+{% if basic_types.size > 0 %}
+{% include "packages_entity_list_classes", classes: basic_types, type: "Primitive Data Types" %}
+{% endif %}
+
+{% if package.enums.size > 0 %}
+{% include "packages_entity_list_classes", classes: package.enums, type: "Enumerated Classes" %}
+{% endif %}
+
+{% if code_lists.size > 0 %}
+{% include "packages_entity_list_classes", classes: code_lists, type: "CodeList Classes" %}
+{% endif %}
+
+{% endif %}
+
+{% comment %} {% 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.stereotype }}»
+|{{ 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.stereotype }}»
+|{{ klass.definition }}
+
+{% endfor %}
+
+|===
+{% endif %} {% endcomment %}
+
+{% 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 %}