interlis2py 0.1.0__py3-none-any.whl

ili2py/writers/diagram/interlis/__init__.py

@@ -0,0 +1,115 @@
+import logging
+import os
+from dataclasses import dataclass
+from pathlib import Path
+from random import randint
+
+from jinja2 import Environment, FileSystemLoader
+
+from ili2py.mappers.helpers import Index
+from ili2py.writers.diagram.interlis.uml import Diagram, TopicGroup
+from ili2py.writers.helpers import create_file
+
+ns_map = {"ili": "http://www.interlis.ch/INTERLIS2.3"}
+
+
+@dataclass
+class FlavourSettings:
+    postfix: str
+    directions: list[str]
+    linetype: list[str]
+
+
+tool_settings: dict[str, FlavourSettings] = {
+    "mermaid": FlavourSettings(
+        postfix="md",
+        directions=["LR", "RL", "TB", "BT"],
+        # currently not supported on class diagrams
+        linetype=[],
+    ),
+    "plantuml": FlavourSettings(
+        postfix="puml",
+        directions=["top to bottom", "left to right"],
+        linetype=["polyline", "ortho", "spline"],
+    ),
+    "plantuml_role_members": FlavourSettings(
+        postfix="puml",
+        directions=["top to bottom", "left to right"],
+        linetype=["polyline", "ortho", "spline"],
+    ),
+    "dot": FlavourSettings(
+        postfix="dot",
+        directions=[],
+        # currently not supported on class diagrams
+        linetype=[],
+    ),
+}
+
+
+def uml_diagram(
+    diagram: Diagram,
+    index: Index,
+    model_names: list[str],
+    flavour: str,
+    file_name: str,
+    output_path: str,
+    direction: str | None = None,
+    linetype: str | None = None,
+    multiplier: int = 2,
+    depth: int | None = None,
+):
+    if flavour == "mermaid":
+        selected_direction = tool_settings[flavour].directions[0]
+        selected_linetype = None
+    elif flavour == "plantuml" or flavour == "plantuml_role_members":
+        selected_direction = tool_settings[flavour].directions[0]
+        selected_linetype = tool_settings[flavour].linetype[0]
+    elif flavour == "dot":
+        selected_direction = None
+        selected_linetype = None
+    else:
+        raise NotImplementedError
+    if direction is not None:
+        if direction not in tool_settings[flavour].directions:
+            raise NotImplementedError
+        else:
+            selected_direction = direction
+    if linetype is not None:
+        if linetype not in tool_settings[flavour].linetype:
+            raise NotImplementedError
+        else:
+            selected_linetype = linetype
+
+    tpl_dir = os.path.join(Path(__file__).parent.joinpath("templates"), flavour)
+    env = Environment(loader=FileSystemLoader(str(tpl_dir)), autoescape=False)  # nosec B701
+    if depth is None:
+        # all relevant models
+        inner_model_names = index.depth_tree[-1]
+    else:
+        try:
+            inner_model_names = index.depth_tree[depth]
+        except IndexError:
+            inner_model_names = index.depth_tree[-1]
+
+    if len(model_names) > 0:
+        if depth is not None:
+            inner_model_names = list(set(model_names) | set(inner_model_names))
+        else:
+            inner_model_names = model_names
+    logging.info(f"Drawing diagram for models: {inner_model_names}")
+    output = env.get_template(f"{flavour}.jinja2").render(
+        diagram=diagram,
+        index=index,
+        len=len,
+        randint=randint,
+        render_multiplicity=TopicGroup.render_multiplicity,
+        model_names=inner_model_names,
+        direction=selected_direction,
+        linetype=selected_linetype,
+        multiplier=multiplier,
+    )
+    src_code_encoded = output.encode()
+
+    diagram_file = create_file(output_path, flavour, file_name)
+    diagram_file.write_text(src_code_encoded.decode(), encoding="utf-8")
+    return str(diagram_file)

ili2py/writers/diagram/interlis/templates/dot/class.jinja2

@@ -0,0 +1,34 @@
+{{ class.save_oid }} [
+    shape=plain;
+    style=filled;
+    fillcolor=gray95;
+    label=<<table border="0" cellborder="1" cellspacing="0" cellpadding="4">
+            <tr>
+                <td colspan="3">
+                    <b>{{ class.name }}</b>
+                </td>
+            </tr>
+            {%- if class.attributes or class.association_attributes %}
+            {%- for attribute in class.attributes -%}
+            <tr>
+                <td align="left">+ {{ attribute.name }}</td>
+                <td align="left">{{ attribute.type_definition }}</td>
+                <td align="left">{{ attribute.mandatory }}</td>
+            </tr>
+            {%- endfor  -%}
+            {%- if class.association_attributes %}
+            {%- for attribute in class.association_attributes -%}
+            <tr>
+                <td align="left">+ {{ attribute.name }}</td>
+                <td align="left"></td>
+                <td align="left" port="{{ attribute.save_oid }}">[{{ attribute.mandatory }}]</td>
+            </tr>
+            {%- endfor  -%}
+            {%- endif %}
+            {%- endif %}
+        </table>>
+]
+{%- if class.inherits_from %}
+edge [dir=back arrowtail=empty style=""]
+{{ class.inherits_from.replace('.', '_') }} -> {{ class.save_oid }}
+{%- endif %}

ili2py/writers/diagram/interlis/templates/dot/classes.jinja2

@@ -0,0 +1,4 @@
+{% macro class_include(class) %}{% include "class.jinja2" %}{% endmacro %}
+{% for class in classes %}
+    {{ class_include(class)|indent|safe }}
+{% endfor %}

ili2py/writers/diagram/interlis/templates/dot/dot.jinja2

@@ -0,0 +1,48 @@
+{% macro classes_include(classes) %}{% include "classes.jinja2" %}{% endmacro %}
+digraph UML_Class_diagram {
+	graph [
+		label="UML Class diagram demo";
+		labelloc="t";
+		fontname="Helvetica,Arial,sans-serif";
+        layout="dot";
+        splines=spline;
+        dpi=96;
+        ranksep=1.5
+	]
+	node [
+		fontname="Helvetica,Arial,sans-serif";
+		shape=record;
+        margin=0.2;
+	]
+	edge [fontname="Helvetica,Arial,sans-serif"]
+	{% for model_group in diagram.model_groups %}
+    {%- if model_group.name in model_names %}
+    subgraph cluster_{{ model_group.save_oid }} {
+        style=filled;
+		color=lightgrey;
+        label="{{ model_group.name }}";
+        {{ classes_include(model_group.classes)|indent }}
+        {%- for association in model_group.associations %}
+        {%- if association[0][0].split('.')[0] in model_names and association[1][0].split('.')[0] in model_names %}
+        edge [dir=back style="" arrowhead="{% if association[1][2] == '' %}{{ "none" }}{% elif association[1][2] == '*' %}{{ "diamond" }}{% else %}{{ "odiamond" }}{% endif %}" arrowtail="{% if association[0][2] == '' %}{{ "none" }}{% elif association[0][2] == '*' %}{{ "diamond" }}{% else %}{{ "odiamond" }}{% endif %}"]
+        {{ association[0][0].replace('.', '_') }}:{{ association[1][3].replace('.', '_') }}:e -> {{ association[1][0].replace('.', '_') }}:{{ association[0][3].replace('.', '_') }}:e [constraint=false]
+        {%- endif %}
+        {%- endfor %}
+        {% for topic_group in model_group.topic_groups %}
+        subgraph cluster_{{ topic_group.save_oid }} {
+		    color=white
+            style=solid;
+            label="{{ topic_group.name }}";
+            {{ classes_include(topic_group.classes)|indent(8) }}
+            {%- for association in topic_group.associations %}
+            {%- if association[0][0].split('.')[0] in model_names and association[1][0].split('.')[0] in model_names %}
+            edge [dir=back style="" arrowhead="{% if association[1][2] == '' %}{{ "none" }}{% elif association[1][2] == '*' %}{{ "diamond" }}{% else %}{{ "odiamond" }}{% endif %}" arrowtail="{% if association[0][2] == '' %}{{ "none" }}{% elif association[0][2] == '*' %}{{ "diamond" }}{% else %}{{ "odiamond" }}{% endif %}"]
+            {{ association[0][0].replace('.', '_') }}:{{ association[1][3].replace('.', '_') }}:e -> {{ association[1][0].replace('.', '_') }}:{{ association[0][3].replace('.', '_') }}:e [constraint=false]
+            {%- endif %}
+            {%- endfor %}
+        }
+        {% endfor %}
+    }
+    {%- endif %}
+    {%- endfor %}
+}

ili2py/writers/diagram/interlis/templates/mermaid/mermaid.jinja2

@@ -0,0 +1,69 @@
+```mermaid
+---
+title: {{ ', '.join(model_names) }}
+---
+%%{
+    init: {
+        "layout": "elk",
+        "elk": {
+            "mergeEdges": false,
+            "nodePlacementStrategy": "SIMPLE",
+            "cycleBreakingStrategy": "GREEDY_MODEL_ORDER",
+            "forceNodeModelOrder": true,
+            "considerModelOrder": "NODES_AND_EDGES"
+        }
+    }
+}%%
+classDiagram
+direction {{ direction }}
+{%- for model_group in diagram.model_groups %}
+{%- if model_group.name in model_names %}
+{%- if model_group.classes %}
+namespace {{ model_group.oid.replace('.', '_') }} {
+    {%- for class_definition in model_group.classes  %}
+    class {{ class_definition.oid.replace('.', '_') }}["{{ class_definition.name }}"]{
+    {%- for attribute in class_definition.attributes %}
+    {{ attribute.name }}{{ attribute.mandatory }}: {{ attribute.type_definition }}
+    {%- endfor %}
+    }
+    {%- endfor %}
+}
+{% endif %}
+{%- for association in model_group.associations %}
+{{ association[0][0].replace('.', '_') }} "{{ association[0][1] }}" {{ association[0][2] }}--{{ association[1][2] }} "{{ association[1][1] }}" {{ association[1][0].replace('.', '_') }} : {{ association[2] }}
+{%- endfor %}
+{%- for class_definition in model_group.classes  %}
+{%- if class_definition.inherits_from %}
+{%- if class_definition.inherits_from.split('.')[0] in model_names  %}
+{{ class_definition.oid.replace('.', '_') }} --|> {{ class_definition.inherits_from.replace('.', '_') }}
+{%- endif %}
+{%- endif %}
+{% endfor %}
+{%- for topic_group in model_group.topic_groups  %}
+{%- if topic_group.classes %}
+namespace {{ topic_group.oid.replace('.', '_') }} {
+    {%- for class_definition in topic_group.classes  %}
+    class {{ class_definition.oid.replace('.', '_') }}["{{ class_definition.name }}"]{
+    {%- for attribute in class_definition.attributes %}
+    {{ attribute.name }}{{ attribute.mandatory }}: {{ attribute.type_definition }}
+    {%- endfor %}
+    }
+    {%- endfor %}
+}
+{%- endif %}
+{%- for association in topic_group.associations %}
+{%- if index.index[association[0][0]].element_in_package.ref.split('.')[0] in model_names and index.index[association[1][0]].element_in_package.ref.split('.')[0] in model_names %}
+{{ association[0][0].replace('.', '_') }} "{{ association[0][1] }}" {{ association[0][2] }}--{{ association[1][2] }} "{{ association[1][1] }}" {{ association[1][0].replace('.', '_') }} : {{ association[2] }}
+{%- endif %}
+{%- endfor %}
+{%- for class_definition in topic_group.classes  %}
+{%- if class_definition.inherits_from %}
+{%- if class_definition.inherits_from.split('.')[0] in model_names  %}
+{{ class_definition.oid.replace('.', '_') }} --|> {{ class_definition.inherits_from.replace('.', '_') }}
+{%- endif %}
+{%- endif %}
+{% endfor %}
+{%- endfor %}
+{%- endif %}
+{%- endfor %}
+```

ili2py/writers/diagram/interlis/templates/plantuml/plantuml.jinja2

@@ -0,0 +1,62 @@
+@startuml
+skinparam linetype {{ linetype }}
+{{ direction }} direction
+{%- for model_group in diagram.model_groups %}
+{%- if model_group.name in model_names %}
+{%- if model_group.classes %}
+namespace {{ model_group.oid }} {
+    {%- for class_definition in model_group.classes  %}
+    class {{ class_definition.oid }}{
+        {%- for attribute in class_definition.attributes %}
+        {{ attribute.name }}{{ attribute.mandatory }}: {{ attribute.type_definition }}
+        {%- endfor %}
+    }
+    {%- endfor %}
+}
+{% endif %}
+{%- for association in model_group.associations %}
+{%- if len(association) == 3 %}
+{{ association[0][0] }} "{{ association[0][1] }}" {{ association[0][2] }}{{ "-" * multiplier }}{{ association[1][2] }} "{{ association[1][1] }}" {{ association[1][0] }} : {{ association[0][3].split('.')[-1] }}\n{{ association[1][3].split('.')[-1] }}
+{%- else %}
+    note "Association <b>'{{ model_group.name }}.{{ association[-1] }}'</b>\n has more than 2 sides,\n this is currently not supported" as N{{ randint(1,10000) }}
+{%- endif %}
+{%- endfor %}
+{%- for class_definition in model_group.classes  %}
+{%- if class_definition.inherits_from %}
+{%- if class_definition.inherits_from.split('.')[0] in model_names  %}
+{{ class_definition.inherits_from }} <|{{ "-" * multiplier }} {{ class_definition.oid }}
+{%- endif %}
+{%- endif %}
+{% endfor %}
+{%- for topic_group in model_group.topic_groups  %}
+{%- if topic_group.classes %}
+namespace {{ topic_group.oid }} {
+    {%- for class_definition in topic_group.classes  %}
+    class {{ class_definition.oid }}{
+        {%- for attribute in class_definition.attributes %}
+        {{ attribute.name }}{{ attribute.mandatory }}: {{ attribute.type_definition }}
+        {%- endfor %}
+    }
+    {%- endfor %}
+}
+{%- endif %}
+{%- for association in topic_group.associations %}
+{%- if len(association) == 3 %}
+{%- if index.index[association[0][0]].element_in_package.ref.split('.')[0] in model_names and index.index[association[1][0]].element_in_package.ref.split('.')[0] in model_names %}
+{{ association[0][0] }} "{{ association[0][1] }}" {{ association[0][2] }}{{ "-" * multiplier }}{{ association[1][2] }} "{{ association[1][1] }}" {{ association[1][0] }} : {{ association[0][3].split('.')[-1] }}\n{{ association[1][3].split('.')[-1] }}
+{%- endif %}
+{%- else %}
+    note "Association <b>'{{ model_group.name }}.{{ topic_group.name }}.{{ association[-1] }}'</b>\n has more than 2 sides,\n this is currently not supported" as N{{ randint(1,10000) }}
+{%- endif %}
+{%- endfor %}
+{%- for class_definition in topic_group.classes  %}
+{%- if class_definition.inherits_from %}
+{%- if class_definition.inherits_from.split('.')[0] in model_names  %}
+{{ class_definition.inherits_from }} <|{{ "-" * multiplier }} {{ class_definition.oid }}
+{%- endif %}
+{%- endif %}
+{% endfor %}
+{%- endfor %}
+{%- endif %}
+{%- endfor %}
+@enduml

ili2py/writers/diagram/interlis/templates/plantuml_role_members/plantuml_role_members.jinja2

@@ -0,0 +1,78 @@
+@startuml
+skinparam linetype {{ linetype }}
+{{ direction }} direction
+{%- for model_group in diagram.model_groups %}
+{%- if model_group.name in model_names %}
+{%- if model_group.classes %}
+namespace {{ model_group.oid }} {
+    {%- for class_definition in model_group.classes  %}
+    class {{ class_definition.oid }}{
+        {%- for attribute in class_definition.attributes %}
+        {{ attribute.name }}{{ attribute.mandatory }}: {{ attribute.type_definition }}
+        {%- endfor %}
+        {%- if class_definition.oid in index.associated_classes %}
+        --Roles--
+        {%- for association_oid in index.associated_classes[class_definition.oid] %}
+        {% for role in index.association_bucket[association_oid] if role[1] != class_definition.oid -%}
+        +{{ role[0].split(".")[-1] }}[{{ render_multiplicity(role[-2], role[-1]) }}]
+        {%- endfor -%}
+        {%- endfor %}
+        {%- endif %}
+    }
+    {%- endfor %}
+}
+{% endif %}
+{%- for association in model_group.associations %}
+{%- if len(association) == 3 %}
+{{ association[0][0] }}::{{ association[1][3].split('.')[-1] }} {{ association[0][2] }}{{ "-" * multiplier }}{{ association[1][2] }} {{ association[1][0] }}::{{ association[0][3].split('.')[-1] }}
+{%- else %}
+    note "Association <b>'{{ model_group.name }}.{{ association[-1] }}'</b>\n has more than 2 sides,\n this is currently not supported" as N{{ randint(1,10000) }}
+{%- endif %}
+{%- endfor %}
+{%- for class_definition in model_group.classes  %}
+{%- if class_definition.inherits_from %}
+{%- if class_definition.inherits_from.split('.')[0] in model_names  %}
+{{ class_definition.inherits_from }} <|{{ "-" * multiplier }} {{ class_definition.oid }}
+{%- endif %}
+{%- endif %}
+{% endfor %}
+{%- for topic_group in model_group.topic_groups  %}
+{%- if topic_group.classes %}
+namespace {{ topic_group.oid }} {
+    {%- for class_definition in topic_group.classes  %}
+    class {{ class_definition.oid }}{
+        {%- for attribute in class_definition.attributes %}
+        {{ attribute.name }}{{ attribute.mandatory }}: {{ attribute.type_definition }}
+        {%- endfor %}
+        {%- if class_definition.oid in index.associated_classes %}
+        --Roles--
+        {%- for association_oid in index.associated_classes[class_definition.oid] %}
+        {% for role in index.association_bucket[association_oid] if role[1] != class_definition.oid -%}
+        +{{ role[0].split(".")[-1] }}[{{ render_multiplicity(role[-2], role[-1]) }}]
+        {%- endfor -%}
+        {%- endfor %}
+        {%- endif %}
+    }
+    {%- endfor %}
+}
+{%- endif %}
+{%- for association in topic_group.associations %}
+{%- if len(association) == 3 %}
+{%- if index.index[association[0][0]].element_in_package.ref.split('.')[0] in model_names and index.index[association[1][0]].element_in_package.ref.split('.')[0] in model_names %}
+{{ association[0][0] }}::{{ association[1][3].split('.')[-1] }} {{ association[0][2] }}{{ "-" * multiplier }}{{ association[1][2] }} {{ association[1][0] }}::{{ association[0][3].split('.')[-1] }}
+{%- endif %}
+{%- else %}
+    note "Association <b>'{{ model_group.name }}.{{ topic_group.name }}.{{ association[-1] }}'</b>\n has more than 2 sides,\n this is currently not supported" as N{{ randint(1,10000) }}
+{%- endif %}
+{%- endfor %}
+{%- for class_definition in topic_group.classes  %}
+{%- if class_definition.inherits_from %}
+{%- if class_definition.inherits_from.split('.')[0] in model_names  %}
+{{ class_definition.inherits_from }} <|{{ "-" * multiplier }} {{ class_definition.oid }}
+{%- endif %}
+{%- endif %}
+{% endfor %}
+{%- endfor %}
+{%- endif %}
+{%- endfor %}
+@enduml