Skip to content

Refactored the plantuml module

Alexander Schlemmer requested to merge f-refactor-plantuml into dev

Summary

Two main things were refactored:

  • The recordtypes to plantuml function allows for more customizations, e.g. leaving out the legend and others.
  • The to_graphics function uses a temporary directory for generating the files and furthermore is able to output customized formats.

Focus

The changes in recordtypes to plantuml are self-explanatory. The function to_graphics should be most intensively reviewed and tested (manually).

Test Environment

See the attached files which show an example script and example output for the demo instance that can be used for testing.

download_data_model.py

demo_data_model.svg

demo_data_model

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

  • All automated tests pass
  • Reference related issues
  • Up-to-date CHANGELOG.md (or not necessary)
  • Annotations in code (Gitlab comments)
    • Intent of new code
    • Problems with old code
    • Why this implementation?

Check List for the Reviewer

  • I understand the intent of this MR
  • All automated tests pass
  • Up-to-date CHANGELOG.md (or not necessary)
  • The test environment setup works and the intended behavior is reproducible in the test environment
  • In-code documentation and comments are up-to-date.
  • Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

Edited by Henrik tom Wörden

Merge request reports