🔖 0.2.0 handle inheritance and enums

Author: lucsorel

README.md

@@ -1,3 +1,14 @@
+<div align="center">
+  <a href="https://www.python.org/psf-landing/" target="_blank">
+    <img width="350px" alt="Python logo"
+      src="https://www.python.org/static/community_logos/python-logo-generic.svg" />
+  </a>
+  <a href="http://plantuml.com/" target="_blank">
+    <img width="116px" height="112px" alt="PlantUML logo" src="http://s.plantuml.com/logoc.png" style="margin-bottom: 40px" vspace="40px" />
+  </a>
+  <h1>Python to PlantUML</h1>
+</div>
+
 Generate Plantuml diagrams to document your python code
 
 # How it works
@@ -32,20 +43,19 @@ Install from the github repository:
 * with `pip`:
 
 ```sh
-pip3 install git+https://github.com/lucsorel/py2puml.git
+pip install py2puml
 ```
 
 * with [poetry](https://pipenv.readthedocs.io/en/latest/):
 
 ```sh
-poetry add git+https://github.com/lucsorel/py2puml.git
+poetry add py2puml
 ```
 
 * with [pipenv](https://pipenv.readthedocs.io/en/latest/):
 
 ```sh
-# should be installed in editable mode to ensure an up-to-date copy of the repository and that it includes all known dependencies -> '-e'
-pipenv install -e git+https://github.com/lucsorel/py2puml.git#egg=py2puml
+pipenv install py2puml
 ```
 
 # Usage
@@ -69,33 +79,56 @@ with open('py2puml/domain.puml', 'w') as puml_file:
 
 ```plantuml
 @startuml
-class py2puml.domain.umlattribute.UmlAttribute {
+class py2puml.domain.umlclass.UmlAttribute {
   name: str
   type: str
 }
 class py2puml.domain.umlclass.UmlClass {
+  attributes: List[UmlAttribute]
+}
+class py2puml.domain.umlitem.UmlItem {
   name: str
   fqdn: str
-  attributes: List[UmlAttribute]
 }
-class py2puml.domain.umlcomposition.UmlComposition {
-  compound_fqdn: str
-  component_fqdn: str
+class py2puml.domain.umlenum.Member {
+  name: str
+  value: str
+}
+class py2puml.domain.umlenum.UmlEnum {
+  members: List[Member]
+}
+enum py2puml.domain.umlrelation.RelType {
+  COMPOSITION: *
+  INHERITANCE: <|
+}
+class py2puml.domain.umlrelation.UmlRelation {
+  source_fqdn: str
+  target_fqdn: str
+  type: RelType
 }
-py2puml.domain.umlclass.UmlClass *-- py2puml.domain.umlattribute.UmlAttribute
+py2puml.domain.umlclass.UmlClass *-- py2puml.domain.umlclass.UmlAttribute
+py2puml.domain.umlitem.UmlItem <|-- py2puml.domain.umlclass.UmlClass
+py2puml.domain.umlenum.UmlEnum *-- py2puml.domain.umlenum.Member
+py2puml.domain.umlitem.UmlItem <|-- py2puml.domain.umlenum.UmlEnum
+py2puml.domain.umlrelation.UmlRelation *-- py2puml.domain.umlrelation.RelType
 @enduml
 ```
 
 Which renders like this:
 
-![](https://www.plantuml.com/plantuml/png/ZP0_2y8m4CNtV8gRXNPmx5HnTNKIaMWY199Bp5s68ltkfi7KWlXd-xrty7uXFR6Cd9mL5ok980pha5Ehl9C6suoIEPfpOjtkdTtK07S1WDBf3eXZPXx2ayUFKwMVPhOJl4rSRmehprRgO6U83qlvyPl3k-39iF5OJAzOVEMSK9rcMIrH8o_QKVny_wff_lulqMjK-Ve0)
+![](https://www.plantuml.com/plantuml/png/ZP91IyGm48Nl-HKvBsmF7iiUTbaA1jnMQZs9I7OxIY19Qp8H5jV_xZIse5GsFULrQBvvCozRZz9XC9gTjFIUz-URdhwojZDIsOnah6UFHkyGdJe61Fx9EBVIGCuzEj9uxaVzbSRi1n4HSWBwdDyfZq-_cpnVOIa4Cw04dJCph--jJPa16qns07C4Dxl_8NM0HG1oKD0P2IR2fa5-qCC8mu__t7UW9QhEPZNeXhON6VlgS5yzY4PKPSvNL13bRL6BPbVkYvnlBdC_SnvvgaSTcRuBxWGlSIbJMjAz0SRItm17BzGc6TzglLxqL5WYlCs5GAbkBB5_CdCzuoKk4Y6pPJkFNj9niotObkhi6m00)
 
 # Tests
 
 ```sh
-poetry run python3 -W ignore::DeprecationWarning -m pytest -v
+python3 -m pytest -v
 ```
 
+# Changelog
+
+* `0.2.0`: handle inheritance relationships and enums. Unit tested
+* `0.1.3`: first release, handle all module of a folder and compositions of domain classes
+
 # Licence
 
 Unless stated otherwise all works are licensed under the [MIT license](http://spdx.org/licenses/MIT.html), a copy of which is included [here](LICENSE).
@@ -109,7 +142,7 @@ Pull-requests are welcome and will be processed on a best-effort basis.
 
 # Alternatives
 
-If `py2uml` does not meet your needs (suggestions and pull-requests are welcome), you can have a look at these projects which follow other approaches (AST, linting, modeling):
+If `py2puml` does not meet your needs (suggestions and pull-requests are welcome), you can have a look at these projects which follow other approaches (AST, linting, modeling):
 
 * [cb109/pyplantuml](https://github.com/cb109/pyplantuml)
 * [deadbok/py-puml-tools](https://github.com/deadbok/py-puml-tools)

py2puml/__init__.py

@@ -1 +1,17 @@
-__version__ = '0.1.3'
+from os.path import dirname, realpath, join
+from re import compile, Match
+
+# exports the version read from the pyproject.toml file
+try:
+    PARENT_DIR = dirname(dirname(realpath(__file__)))
+    VERSION_PATTERN = compile('^version = "([^"]+)"$')
+    with open(join(PARENT_DIR, 'pyproject.toml')) as pyproject:
+        version_match: Match = next((
+            match for match in (VERSION_PATTERN.search(line) for line in pyproject.readlines())
+            if match is not None
+        ), None)
+
+        __version__ = version_match.group(1)
+except:
+    __version__ = None
+

py2puml/domain/umlclass.py

@@ -1,10 +1,13 @@
 from typing import List
 from dataclasses import dataclass
 
-from py2puml.domain.umlattribute import UmlAttribute
+from py2puml.domain.umlitem import UmlItem
 
 @dataclass
-class UmlClass(object):
+class UmlAttribute(object):
     name: str
-    fqdn: str
+    type: str
+
+@dataclass
+class UmlClass(UmlItem):
     attributes: List[UmlAttribute]

py2puml/domain/umlcomposition.py

@@ -0,0 +1,13 @@
+from typing import List
+from dataclasses import dataclass
+
+from py2puml.domain.umlitem import UmlItem
+
+@dataclass
+class Member(object):
+    name: str
+    value: str
+
+@dataclass
+class UmlEnum(UmlItem):
+    members: List[Member]

py2puml/domain/umlenum.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 
 @dataclass
-class UmlAttribute(object):
+class UmlItem(object):
     name: str
-    type: str
+    fqdn: str

py2puml/domain/umlattribute.py renamed to py2puml/domain/umlitem.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+from enum import Enum
+
+class RelType(Enum):
+    COMPOSITION = '*'
+    INHERITANCE = '<|'
+
+@dataclass
+class UmlRelation(object):
+    source_fqdn: str
+    target_fqdn: str
+    type: RelType

py2puml/domain/umlrelation.py

@@ -1,23 +1,44 @@
 from typing import List, Iterable
 
+from py2puml.domain.umlitem import UmlItem
 from py2puml.domain.umlclass import UmlClass
-from py2puml.domain.umlcomposition import UmlComposition
+from py2puml.domain.umlenum import UmlEnum
+from py2puml.domain.umlrelation import UmlRelation
 
 PUML_FILE_START = '@startuml\n'
 PUML_FILE_END = '@enduml\n'
-PUML_CLASS_START_TPL = 'class {class_fqdn} {{\n'
+PUML_ITEM_START_TPL = '{item_type} {item_fqdn} {{\n'
 PUML_ATTR_TPL = '  {attr_name}: {attr_type}\n'
-PUML_CLASS_END = '}\n'
-PUML_COMPOSITION_TPL = '{compound_fqdn} *-- {component_fqdn}\n'
+PUML_ITEM_END = '}\n'
+PUML_COMPOSITION_TPL = '{source_fqdn} {rel_type}-- {target_fqdn}\n'
 
 
-def to_puml_content(uml_classes: List[UmlClass], uml_compositions: List[UmlComposition]) -> Iterable[str]:
+def to_puml_content(uml_items: List[UmlItem], uml_relations: List[UmlRelation]) -> Iterable[str]:
     yield PUML_FILE_START
-    for uml_class in uml_classes:
-        yield PUML_CLASS_START_TPL.format(class_fqdn=uml_class.fqdn)
-        for uml_attr in uml_class.attributes:
-            yield PUML_ATTR_TPL.format(attr_type=uml_attr.type, attr_name=uml_attr.name)
-        yield PUML_CLASS_END
-    for uml_composition in uml_compositions:
-        yield PUML_COMPOSITION_TPL.format(compound_fqdn=uml_composition.compound_fqdn, component_fqdn=uml_composition.component_fqdn)
+
+    # exports the domain classes and enums
+    for uml_item in uml_items:
+        if isinstance(uml_item, UmlEnum):
+            uml_enum: UmlEnum = uml_item
+            yield PUML_ITEM_START_TPL.format(item_type='enum', item_fqdn=uml_enum.fqdn)
+            for member in uml_enum.members:
+                yield PUML_ATTR_TPL.format(attr_name=member.name, attr_type=member.value)
+            yield PUML_ITEM_END
+        elif isinstance(uml_item, UmlClass):
+            uml_class: UmlClass = uml_item
+            yield PUML_ITEM_START_TPL.format(item_type='class', item_fqdn=uml_class.fqdn)
+            for uml_attr in uml_class.attributes:
+                yield PUML_ATTR_TPL.format(attr_name=uml_attr.name, attr_type=uml_attr.type)
+            yield PUML_ITEM_END
+        else:
+            raise TypeError(f'cannot process uml_item of type {uml_item.__class__}')
+
+    # exports the domain relationships between classes and enums
+    for uml_relation in uml_relations:
+        yield PUML_COMPOSITION_TPL.format(
+            source_fqdn=uml_relation.source_fqdn,
+            rel_type=uml_relation.type.value,
+            target_fqdn=uml_relation.target_fqdn
+        )
+
     yield PUML_FILE_END