metanorma-plugin-lutaml 0.4.9 → 0.4.10

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

@@ -4,7 +4,7 @@
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
 [[section-{{ klass.xmi_id }}]]
-.Elements of “{{ package.name }}::{{ klass.name }}” (class)
+.Elements of “{{ package.name }}::{{ klass.name }}” ({{ klass.stereotype }})
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 
@@ -69,8 +69,8 @@ h| Public attributes:
 
 {% if klass.constraints.size > 0 %}
 .{{ klass.constraints.size }}+h| Constraints:
-{% for constr in klass.constraints %}
-7+| `{{ constr.body }}`
+{% for constraint in klass.constraints %}
+7+| `{{ constraint.body }}`: `{{ constraint.definition | replace: '|', '\|' }}`
 
 {% endfor %}
 {% else %}

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

@@ -1,158 +1,250 @@
 {% for package in context.packages %}
 {% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
+{% assign nested_depth = depth | plus: 1 %}
 {% if additional_context.before and additional_context.before.size > 0 %}
 {% for before in additional_context.before %}
+{% if before.text %}
+
+{% if before.liquid %}
+{{ before.text | interpolate }}
+{% else %}
 {{ before.text }}
+{% endif %}
+{% endif %}
+{% endfor %}
+{% endif %}
+
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
+{{equalsigns}} {{ package.name }}
+{%comment%}(package: depth is {{ depth }}, nested_depth is {{ nested_depth }}){%endcomment%}
+
+{% 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 %}
+{% 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 %}
-{% 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] %}
+{% if before.text %}
+
+{% if before.liquid %}
+{{ before.text | interpolate }}
+{% else %}
 {{ before.text }}
+{% endif %}
+{% endif %}
 {% endfor %}
 {% endif %}
 
+.Metadata of {{ package.name }} ({{ package.stereotype }})
 [cols="1a,4a"]
 |===
 
-h|Description:    | {{ package.definition }}
+h|Description:    | {{ package.definition | replace: '|', '\|' }}
 h|Parent package: | {{ context.name }}
 h|Stereotype:     | «{{ package.stereotype }}»
 
 |===
 
+{% assign inner_depth = depth | plus: 2 %}
 {% 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: ','%}
+{% assign not_classes_stereotypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
 {{equalsigns}}= Classes
+{%comment%}(class: depth is {{ depth }}, nested_depth is {{ nested_depth }}){%endcomment%}
 
 {% unless not_classes_length == package.classes.size %}
 
 {% for klass in package.classes %}
-{% unless not_classes_stereoptypes contains klass.stereotype  %}
-{% include "packages_data_dictionary_class" %}
+{% unless not_classes_stereotypes contains klass.stereotype  %}
+{% include "packages_data_dictionary_class", depth: inner_depth %}
 {% endunless %}
 {% endfor %}
 {% else %}
-None
+None.
 {% endunless %}
 
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
 {{equalsigns}}= Basic types
+{%comment%}(class: depth is {{ depth }}, inner_depth is {{ inner_depth }}){%endcomment%}
 
 {% if basic_types.size > 0 %}
-
-{% include "packages_data_dictionary_classes", classes: basic_types %}
+{% include "packages_data_dictionary_classes", classes: basic_types, depth: inner_depth %}
 {% else %}
-None
+None.
 {% endif %}
 
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
 {{equalsigns}}= Unions
+{%comment%}(class: depth is {{ depth }}, inner_depth is {{ inner_depth }}){%endcomment%}
 
 {% if unions.size > 0 %}
-
-{% include "packages_data_dictionary_classes", classes: unions %}
+{% include "packages_data_dictionary_classes", classes: unions, depth: inner_depth %}
 {% else %}
-None
+None.
 {% endif %}
 
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
 {{equalsigns}}= Code lists
+{%comment%}(class: depth is {{ depth }}, inner_depth is {{ inner_depth }}){%endcomment%}
 
 {% if code_lists.size > 0 %}
-
-{% include "packages_data_dictionary_classes", classes: code_lists %}
+{% include "packages_data_dictionary_classes", classes: code_lists, depth: inner_depth %}
 {% else %}
-None
+None.
 {% endif %}
 
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
 {{equalsigns}}= Data types
+{%comment%}(class: depth is {{ depth }}, inner_depth is {{ inner_depth }}){%endcomment%}
 
 {% 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 %}
+{% capture generalizations %}{% assign inheritance = klass.associations | where: "member_end_type", "inheritance" %}{% for assoc in inheritance %}<<{{ assoc.member_end }}-section,{{ assoc.member_end }}>>{% endfor %}{% endcapture %}
 [[{{ data_type.name }}-section]]
-[cols="1a"]
+{{equalsigns}}== {{ data_type.name }}
+
+.Metadata of {{ data_type.name }} ({{ data_type.stereotype }})
+[cols="1a,4a"]
 |===
-|*{{ data_type.name }}*
-|[cols="1,4"]
-!===
-!Definition:  ! {{ data_type.definition }}
-!Subclass of: ! {% if generalizations.size > 4 %}{{ generalizations }}{% else %}None{% endif %}
-!Stereotype:  !  «{{ data_type.stereotype }}»
-!===
+h|Definition:  | {{ data_type.definition | replace: '|', '\|' }}
+h|Subclass of: | {% if generalizations.size > 0 %}{{ generalizations }}{% else %}None{% endif %}
+h|Stereotype:  | «{{ data_type.stereotype }}»
+
+{% if data_type.constraints.size > 0 %}
+{% for constraint in data_type.constraints %}
+h| Constraint:
+| `{{ constraint.body }}`:
+
+[source,ocl,%unnumbered]
+------
+{{ constraint.definition | replace: '|', '\|' }}
+------
+{% endfor %}
+{% endif %}
+
+|===
+
 {% 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 }}
+{% 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 %}
-{% if rendered_associations.size > 100 %}
-|
-[cols="15,20,60",options="header"]
-!===
-! Role name !Target class and multiplicity !Definition
+
+{% assign associations_stripped = rendered_associations | strip_newlines | strip %}
+
+{% if associations_stripped.size > 0 %}
+.Associations of {{ data_type.name }} ({{ data_type.stereotype }})
+[cols="15a,20a,60a",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
+.Attributes of {{ data_type.name }} ({{ data_type.stereotype }})
+[cols="15a,20a,60a",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 }}
+{% 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: Unless otherwise specified, all attributes and role names have the stereotype «Property».
-{% endif %}
 |===
 
+[NOTE,keep-separate=true]
+====
+Unless otherwise specified, all attributes and role names have the stereotype
+«Property».
+====
+{% endif %}
+
 {% endfor %}
 {% else %}
-None
+None.
 {% endif %}
 
 {{equalsigns}}= Enumerations
 
 {% if package.enums.size > 0 %}
-
 {% for enum in package.enums %}
 [[{{ enum.name }}-section]]
-[cols="1a"]
+{{equalsigns}}== {{ enum.name }}
+
+.Metadata of {{ enum.name }} (Enumeration)
+[cols="1a,4a"]
+|===
+h|Definition: | {{ enum.definition | replace: '|', '\|' }}
+h|Stereotype: | «Enumeration»
 |===
-|*{{ enum.name }}*
-|
-[cols="1,4"]
-!===
-!Definition: ! {{ enum.definition }}
-!Stereotype: ! «Enumeration»
-!===
+
 {% if enum.values.size > 0 %}
-|
-[cols="1,4",options="header"]
-!===
-! Literal value !Definition
+.Values of {{ enum.name }} (Enumeration)
+[cols="1a,4a",options="header"]
+|===
+| Literal value | Definition
 
 {% for val in enum.values %}
-! {{ val.name }}  !{{ val.definition }}
+| {{ val.name }}
+| {{ val.definition | replace: '|', '\|' }}
+
 {% endfor %}
-!===
-{% endif %}
+
 |===
+{% endif %}
 
 {% endfor %}
 {% else %}
-None
+None.
 {% endif %}
 
 {% if additional_context.include_block and additional_context.include_block.size > 0 %}
@@ -175,27 +267,83 @@ None
 {% 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 %}
 
+{% 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.text %}
+
+{% if after.liquid %}
+{{ after.text | interpolate }}
+{% else %}
 {{ after.text }}
+{% endif %}
+{% endif %}
 {% 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 %}
+{% 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 %}
+{% if after.text %}
+
+{% if after.liquid %}
+{{ after.text | interpolate }}
+{% else %}
 {{ after.text }}
+{% endif %}
+{% endif %}
 {% endfor %}
 {% endif %}

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

@@ -1,67 +1,73 @@
-{% capture generalizations %}{% assign inheritance = klass.associations | where: "member_end_type", "inheritance" %}{% for assoc in inheritance %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
+{% 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]]
-[cols="1a"]
+{{equalsigns}} {{ klass.name }}
+{%comment%}(inside class: depth is {{ depth }}, equalsigns {{equalsigns}}){%endcomment%}
+
+.Metadata of {{ klass.name }} ({{klass.stereotype}})
+[cols="1a,4a"]
 |===
-|*{{ klass.name }}*
-|
-[cols="1,4"]
-!===
-! Definition:  ! {{ klass.definition }}
-! Subclass of: ! {% if generalizations.size > 4 %}{{ generalizations }}{% else %}None{% endif %}
-! Stereotype:  ! «{{ klass.stereotype }}»
+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 %}
-! Constraint:  ! {{ constraint.body }}: {{ constraint.definition | replace: '|', '\|' }}
+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 %}{% 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 }}
-
+{% 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
 
-{% if rendered_associations.size > 100 %}
-|
-[cols="15,20,60",options="header"]
-!===
-! *Role name*
-! *Target class and multiplicity*
-! *Definition*
 {{ rendered_associations }}
-!===
-{% endif %}
 
+|===
+{% 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 %}
+{% if klass.attributes.size > 0 %}
+.Attributes of {{ klass.name }} ({{klass.stereotype}})
+[cols="15a,20a,60a",options="header"]
+|===
+| Attribute | Value type and multiplicity | Definition
 
-! {{ attr.name }}
-!<<{{ attr.type }}-section,{{ attr.type }}>> {{ cardinality }}
-!{{ attr.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: Unless otherwise specified, all attributes and role names have the stereotype «Property».
+[NOTE,keep-separate=true]
+====
+Unless otherwise specified, all attributes and role names have the stereotype
+«Property».
+====
 {% endif %}
-|===