metanorma-plugin-lutaml 0.4.2 → 0.4.6

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

@@ -0,0 +1,133 @@
+{% 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 %}
+{% assign is_package_spare = package.name | slice: 0,5 %}
+{% if is_package_spare == 'old: ' %}{% continue %}
+{% elsif is_package_spare == 'Spare' %}{% continue %}
+{% endif %}
+
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }} package
+{{equalsigns}}= {{ package.name }} overview
+
+{% assign before_package_key = 'before;' | append: package.name %}
+{% if additional_context[before_package_key] and additional_context[before_package_key].size > 0 %}
+{% for before in additional_context[before_package_key] %}
+{{ before.text }}
+{% endfor %}
+{% endif %}
+{% if additional_context.diagram_include_block %}
+{% for diagram_include_block in additional_context.diagram_include_block %}
+{% include "diagrams_block", package_name: package_name, image_base_path: diagram_include_block.base_path, text: diagram_include_block.text %}
+{% endfor %}
+{% endif %}
+
+{% if package.packages.size > 0 %}The {{ package.name }} package is organized into
+{{ 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 %}:
+{% endif %}
+[arabic]
+{% for module in package.packages %}
+{% if module.packages.length > 0 %}
+. {{ module.name }} package comprises:
+{% for nested_module in module.packages %}
+.. {{nested_module.name}} module
+{% endfor %}
+{% else %}
+. {{ module.name }} package
+{% endif %}
+{% endfor %}
+
+{% if package.classes.size > 0 or package.enums.size > 0 or package.data_types.size > 0 %}
+
+{{equalsigns}}= Defining tables
+
+[arabic]
+{% for klass in package.classes %}
+{% assign is_klass_spare = klass.name | slice: 0,5 %}
+{% if is_klass_spare == 'old: ' %}{% continue %}
+{% 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 }}
+
+{% endfor %}
+{% for enum in package.enums %}
+{% assign is_enum_spare = enum.name | slice: 0,5 %}
+{% if is_enum_spare == 'old: ' %}{% continue %}
+{% elsif is_enum_spare == 'Spare' %}{% continue %}
+{% endif %}
+{% assign enum_name = enum.name | downcase | replace: ':', '' | replace: ' ', '_' %}
+.<<tab-P-{{ package_name }}-E-{{ enum_name }}>> -- Elements of {{ package.name }}::{{ enum.name }}
+
+{% endfor %}
+{% for data_type in package.data_types %}
+{% assign is_data_type_spare = data_type.name | slice: 0,5 %}
+{% if is_data_type_spare == 'old: ' %}{% continue %}
+{% elsif is_data_type_spare == 'Spare' %}{% continue %}
+{% endif %}
+{% assign data_type_name = data_type.name | downcase | replace: ':', '' | replace: ' ', '_' %}
+.<<tab-P-{{ package_name }}-DT-{{ data_type_name }}>> -- Elements of {{ package.name }}::{{ data_type.name }}
+
+{% endfor %}
+
+{% for klass in package.classes %}
+{% include "packages_class" %}
+{% endfor %}
+
+{% for klass in package.enums %}
+{% include "packages_enum" %}
+{% endfor %}
+
+{% for klass in package.data_types %}
+{% include "packages_data_type" %}
+{% 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", 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_class.liquid

@@ -0,0 +1,81 @@
+{% assign is_klass_spare = klass.name | slice: 0,5 %}
+{% if is_klass_spare == 'old: ' %}{% continue %}
+{% 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 }}
+[width="100%",cols="a,a,a,a,a,a,a,a"]
+|===
+
+h|Name: 7+| {{ klass.name }}
+
+h|Definition: 7+| {{ klass.definition | html2adoc }}
+
+h|Stereotype: 7+| {{ klass.stereotype | default: 'interface' }}
+
+{% assign inherited = klass.associations | where: "member_end_type", "inheritance" %}
+{% if inherited.size > 0 %}
+h|Inheritance from: 7+| {{ inherited | map: 'member_end' | join: ", " }}
+{% endif %}
+
+{% assign generalizations = klass.associations | where: "member_end_type", "generalization" %}
+{% if generalizations.size > 0 %}
+h|Generalization of: 7+| {{ generalizations | map: 'member_end' | join: ", " }}
+{% endif %}
+
+h|Abstract: 7+| {{ klass.is_abstract }}
+{% assign aggregations = klass.associations | where: "member_end_type", "aggregation" %}
+{% if aggregations.size > 0 %}
+.{{aggregations.size | plus: 1}}+h|Associations:
+4+|_Association with:_
+|_Obligation_
+| _Maximum occurrence_
+|_Provides:_
+
+{% for assoc in aggregations %}
+4+| {{assoc.member_end}}
+| {% if assoc.member_end_cardinality %}{{ assoc.member_end_cardinality.min }}{% endif %}
+| {% if assoc.member_end_cardinality %}{{ assoc.member_end_cardinality.max }}{% endif %}
+| {{ assoc.member_end_attribute_name }}
+
+{% endfor %}
+{% else %}
+
+.1+h|Associations: 7+| (none)
+{% endif %}
+{% if klass.attributes.size > 0 %}
+.{{klass.attributes.size | plus: 1}}+h|Public attributes:
+| _Name_
+2+| _Definition_
+| _Derived_
+| _Obligation_
+| _Maximum occurrence_
+| _Data type_
+
+{% for attr in klass.attributes %}
+| {{attr.name}}
+2+| {{ attr.definition | html2adoc }}
+| {{ attr.is_derived }}
+| {{attr.cardinality.min}}
+| {{attr.cardinality.max}}
+| {{attr.type}}
+
+{% endfor %}
+{% else %}
+.1+h|Public attributes:
+7+| (none)
+{% endif %}
+
+{% if klass.constraints.size > 0 %}
+.{{ klass.constraints.size }}+|*Constraints:*
+{% for constr in klass.constraints %}
+7+| `{{ constr.body }}`
+
+{% endfor %}
+{% else %}
+
+h|Constraints: 7+| (none)
+{% 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_data_type.liquid

@@ -0,0 +1,63 @@
+{% assign is_klass_spare = klass.name | slice: 0,5 %}
+{% if is_klass_spare == 'old: ' %}{% continue %}
+{% 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 }}
+[width="100%",cols="a,a,a,a,a,a,a,a"]
+|===
+
+h|Name: 7+| {{ klass.name }}
+
+h|Definition: 7+| {{ klass.definition | html2adoc }}
+
+h|Stereotype: 7+| {{ klass.stereotype | default: 'interface' }}
+
+{% assign inherited = klass.associations | where: "member_end_type", "inheritance" %}
+{% if inherited.size > 0 %}
+h|Inheritance from: 7+| {{ inherited | map: 'member_end' | join: ", " }}
+{% endif %}
+
+{% assign generalizations = klass.associations | where: "member_end_type", "generalization" %}
+{% if generalizations.size > 0 %}
+h|Generalization of: 7+| {{ generalizations | map: 'member_end' | join: ", " }}
+{% endif %}
+
+h|Abstract: 7+| {{ klass.is_abstract }}
+{% assign aggregations = klass.associations | where: "member_end_type", "aggregation" %}
+{% if aggregations.size > 0 %}
+.{{aggregations.size | plus: 1}}+h|Associations:
+4+|_Association with:_
+|_Obligation_
+| _Maximum occurrence_
+|_Provides:_
+
+{% for assoc in aggregations %}
+4+| {{assoc.member_end}}
+| {% if assoc.member_end_cardinality %}{{ assoc.member_end_cardinality.min }}{% endif %}
+| {% if assoc.member_end_cardinality %}{{ assoc.member_end_cardinality.max }}{% endif %}
+| {{ assoc.member_end_attribute_name }}
+
+{% endfor %}
+{% else %}
+
+.1+h|Associations: 7+| (none)
+{% endif %}
+
+{% if klass.attributes.size > 0 %}
+.{{klass.attributes.size | plus: 1}}+h|Values:
+| _Name_
+6+| _Definition_
+
+{% for value in klass.attributes %}
+| {{value.name}}
+6+| {{ value.definition | html2adoc }}
+
+{% endfor %}
+{% else %}
+.1+h|Values:
+7+| (none)
+{% endif %}
+
+|===