Add minimal support fot abstract classes (#27)

jonykalavera · lucsorel · web-flow · commit 4787c5dab634 · 2022-04-15T13:48:46.000+02:00
* add support for abstract classes

* update pytest version

* undo changes

* requested changes

* implement pr changes

* remove extra line break

* tests(py2puml) fixed encodings

* doc(CONTRIBUTING) contributors list and version number upgrade

Co-authored-by: Luc Sorel-Giffo &lt;luc.sorel@gmail.com&gt;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -23,6 +23,42 @@ Corresponding unit tests must be added or adapted according to what was discusse
 
 All text files are expected to be encoded in UTF-8.
 
+## Contributions and version update
+
+Add yourself at the bottom of the [contributions section of the README.md](README.md#contributions) file:
+
+```text
+# Contributions
+
+* [Luc Sorel-Giffo](https://github.com/lucsorel)
+* ...
+* [Your Full Name](https://github.com/yourgithubname)
+```
+
+Discuss the new version number in the pull request and add a changelog line at the top of the [Changelog section of the README.md](README.md#changelog) file:
+
+```text
+# Changelog
+
+* `major.minor.patch`: the feature you added
+* ...
+```
+
+The version number is carried by the [pyproject.toml](pyproject.toml) file, which is not installed along the production code.
+Some manual changes thus need to be made to update it in the CLI; please, update the version number:
+
+- in the [version attribute of the pyproject.toml](pyproject.toml#L3) file
+
+```toml
+[tool.poetry]
+name = "py2puml"
+version = "major.minor.patch"
+```
+
+- in the [cli.py module](py2puml/cli.py#L12) (the string value associated to the `version` parameter)
+- in the [test__init__.py](tests/py2puml/test__init__.py#L5) file
+
+
 # Code practices
 
 It takes time to write comprehensive guidelines.
diff --git a/README.md b/README.md
@@ -134,7 +134,7 @@ Pipe the result of the CLI with a PlantUML server for instantaneous documentatio
 
 ```sh
 # runs a local PlantUML server from a docker container:
-docker run -d --rm -p 1234:8080 --name plantumlserver plantuml/plantuml-server:jetty 
+docker run -d --rm -p 1234:8080 --name plantumlserver plantuml/plantuml-server:jetty
 
 py2puml py2puml/domain py2puml.domain | curl -X POST --data-binary @- http://localhost:1234/svg/ --output - | display
 
@@ -181,6 +181,7 @@ poetry run python -m pytest -v --cov=py2puml --cov-branch --cov-report term-miss
 
 # Changelog
 
+* `0.6.0`: handle abstract classes
 * `0.5.4`: fixed the packaging so that the contribution guide is included in the published package
 * `0.5.3`: handle constructors decorated by wrapping decorators (decorators making uses of `functools.wrap`)
 * `0.5.2`: specify in pyproject.toml that py2puml requires python 3.8+ (`ast.get_source_segment` was introduced in 3.8)
@@ -201,6 +202,7 @@ Unless stated otherwise all works are licensed under the [MIT license](http://sp
 * [Luc Sorel-Giffo](https://github.com/lucsorel)
 * [Doyou Jung](https://github.com/doyou89)
 * [Julien Jerphanion](https://github.com/jjerphan)
+* [Luis Fernando Villanueva Pérez](https://github.com/jonykalavera)
 
 Pull-requests are welcome and will be processed on a best-effort basis.
 Follow the [contributing guide](CONTRIBUTING.md).
diff --git a/poetry.lock b/poetry.lock
diff --git a/py2puml/cli.py b/py2puml/cli.py
@@ -9,7 +9,7 @@
 def run():
     argparser = ArgumentParser(description='Generate PlantUML class diagrams to document your Python application.')
 
-    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.5.4')
+    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.6.0')
     argparser.add_argument('path', metavar='path', type=str, help='the path of the domain')
     argparser.add_argument('module', metavar='module', type=str, help='the module of the domain', default=None)
 
diff --git a/py2puml/domain/umlclass.py b/py2puml/domain/umlclass.py
@@ -12,3 +12,4 @@ class UmlAttribute(object):
 @dataclass
 class UmlClass(UmlItem):
     attributes: List[UmlAttribute]
+    is_abstract: bool = False
diff --git a/py2puml/example.py b/py2puml/example.py
@@ -6,5 +6,5 @@
 ))
 
 # writes the PlantUML content in a file
-with open('py2puml/py2puml.domain.puml', 'w') as puml_file:
+with open('py2puml/py2puml.domain.puml', 'w', encoding='utf8') as puml_file:
     puml_file.writelines(py2puml('py2puml/domain', 'py2puml.domain'))
diff --git a/py2puml/exportpuml.py b/py2puml/exportpuml.py
@@ -28,7 +28,7 @@ def to_puml_content(uml_items: List[UmlItem], uml_relations: List[UmlRelation])
             yield PUML_ITEM_END
         elif isinstance(uml_item, UmlClass):
             uml_class: UmlClass = uml_item
-            yield PUML_ITEM_START_TPL.format(item_type='class', item_fqn=uml_class.fqn)
+            yield PUML_ITEM_START_TPL.format(item_type='abstract class' if uml_item.is_abstract else 'class', item_fqn=uml_class.fqn)
             for uml_attr in uml_class.attributes:
                 yield PUML_ATTR_TPL.format(attr_name=uml_attr.name, attr_type=uml_attr.type, staticity=FEATURE_STATIC if uml_attr.static else FEATURE_INSTANCE)
             yield PUML_ITEM_END
diff --git a/py2puml/inspection/inspectclass.py b/py2puml/inspection/inspectclass.py
@@ -1,4 +1,5 @@
 
+from inspect import isabstract
 from typing import Type, List, Dict
 
 from re import compile
@@ -42,7 +43,8 @@ def inspect_static_attributes(
     uml_class = UmlClass(
         name=class_type.__name__,
         fqn=class_type_fqn,
-        attributes=definition_attrs
+        attributes=definition_attrs,
+        is_abstract=isabstract(class_type)
     )
     domain_items_by_fqn[class_type_fqn] = uml_class
     # inspect_domain_definition(class_type)
diff --git a/py2puml/py2puml.domain.puml b/py2puml/py2puml.domain.puml
@@ -6,6 +6,7 @@ class py2puml.domain.umlclass.UmlAttribute {
 }
 class py2puml.domain.umlclass.UmlClass {
   attributes: List[UmlAttribute]
+  is_abstract: bool
 }
 class py2puml.domain.umlitem.UmlItem {
   name: str
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "py2puml"
-version = "0.5.4"
+version = "0.6.0"
 description = "Generate PlantUML class diagrams to document your Python application."
 keywords = ["class diagram", "PlantUML", "documentation", "inspection", "AST"]
 readme = "README.md"
@@ -20,7 +20,7 @@ python = "^3.8"
 
 [tool.poetry.dev-dependencies]
 pylint = "2.12.2"
-pytest = "6.2.2"
+pytest = "6.2.5"
 pytest-cov = "2.12.1"
 
 [tool.pytest.ini_options]
diff --git a/tests/modules/withabstract.py b/tests/modules/withabstract.py
@@ -0,0 +1,11 @@
+from abc import ABC, abstractmethod
+
+
+class ClassTemplate(ABC):
+    @abstractmethod
+    def must_be_implemented(self):
+        """ Docstring."""
+
+class ConcreteClass(ClassTemplate):
+    def must_be_implemented(self):
+        pass
diff --git a/tests/py2puml/inspection/test_inspectclass.py b/tests/py2puml/inspection/test_inspectclass.py
@@ -70,6 +70,27 @@ def test_inspect_module_should_find_static_and_instance_attributes():
         RelType.COMPOSITION
     )
 
+def test_inspect_module_should_find_abstract_class():
+    domain_items_by_fqn: Dict[str, UmlItem] = {}
+    domain_relations: List[UmlRelation] = []
+    inspect_module(
+        import_module('tests.modules.withabstract'),
+        'tests.modules.withabstract',
+        domain_items_by_fqn, domain_relations
+    )
+
+    assert len(domain_items_by_fqn) == 2, 'two classes must be inspected'
+
+    class_template_umlitem: UmlClass = domain_items_by_fqn['tests.modules.withabstract.ClassTemplate']
+    assert class_template_umlitem.is_abstract
+
+    concrete_class_umlitem: UmlClass = domain_items_by_fqn['tests.modules.withabstract.ConcreteClass']
+    assert not concrete_class_umlitem.is_abstract
+
+    assert len(domain_relations) == 1, 'one inheritance relationship between the two must be inspected'
+    assert domain_relations[0].source_fqn == 'tests.modules.withabstract.ClassTemplate'
+    assert domain_relations[0].target_fqn == 'tests.modules.withabstract.ConcreteClass'
+
 def test_inspect_module_parse_class_constructor_should_not_process_inherited_constructor():
     domain_items_by_fqn: Dict[str, UmlItem] = {}
     domain_relations: List[UmlRelation] = []
diff --git a/tests/py2puml/test__init__.py b/tests/py2puml/test__init__.py
@@ -2,7 +2,7 @@
 
 # Ensures the library version is modified in the pyproject.toml file when upgrading it (pull request)
 def test_version():
-    assert __version__ == '0.5.4'
+    assert __version__ == '0.6.0'
 
 # Description also output in the CLI
 def test_description():
diff --git a/tests/py2puml/test_py2puml.py b/tests/py2puml/test_py2puml.py
@@ -11,7 +11,7 @@ def test_py2puml_model_on_py2uml_domain():
     domain_diagram_file_path = CURRENT_DIR.parent.parent / 'py2puml' / 'py2puml.domain.puml'
 
     # reads the existing class diagram (update it with `python -m py2puml.example`)
-    with open(domain_diagram_file_path, 'r') as expected_puml_file:
+    with open(domain_diagram_file_path, 'r', encoding='utf8') as expected_puml_file:
         puml_content = list(py2puml.py2puml('py2puml/domain', 'py2puml.domain'))
         for line_index, (actual_line, expected_line) in enumerate(zip(puml_content, expected_puml_file)):
             assert actual_line == expected_line, f'updated and versionned content {domain_diagram_file_path} in line {line_index} has changed'

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ class py2puml.domain.umlclass.UmlAttribute {`
`6`	`6`	`}`
`7`	`7`	`class py2puml.domain.umlclass.UmlClass {`
`8`	`8`	`attributes: List[UmlAttribute]`
	`9`	`+ is_abstract: bool`
`9`	`10`	`}`
`10`	`11`	`class py2puml.domain.umlitem.UmlItem {`
`11`	`12`	`name: str`