Merge pull request #2 from pbauermeister/refactoring

Refactoring

Author: pbauermeister

CHANGES.md

@@ -0,0 +1,10 @@
+# Changes
+
+## Version 2.0.6
+- use more recent setuptools.
+- use Typing and mypy.
+- require Python 3.10 or upper.
+
+## Version 2.0.5 and below
+- Rewrite of https://github.com/pbauermeister/umlsequence in pure
+  Python (+ reportlab).

README.md

@@ -1,15 +1,26 @@
 umlsequence2
 ============
 
-UML Sequence Diagrams Generator - Commandline tool to generate
+UML Sequence Diagrams Generator, version 2<sup>[1]</sup> -
+Commandline tool to generate
 diagrams as images in various formats (SVG, PNG, JPG, PDF, etc.) from
 source text files.
 
-Source code: https://github.com/pbauermeister/umlsequence2
+- Source code: https://github.com/pbauermeister/umlsequence2
+- Package page: https://pypi.org/project/umlsequence2/
 
-(This is a pure-Python rewrite of the
+<sub>[1] This is a pure-Python rewrite of the
 https://github.com/pbauermeister/umlsequence project, which was itself
-based on umlgraph by Diomidis Spinellis.)
+based on umlgraph (in Java) by Diomidis Spinellis.</sub>
+
+## Scope
+
+"*A sequence diagram or system sequence diagram (SSD) shows process interactions
+arranged in time sequence in the field of software engineering. It depicts the
+processes involved and the sequence of messages exchanged between the processes
+needed to carry out the functionality.*"
+-- [Wikipedia](https://en.wikipedia.org/wiki/Sequence_diagram)
+## Summary
 
 Source text files are in the so-called "umlsequence" syntax.
 
@@ -20,21 +31,21 @@ Umlsequence syntax example:
     T : t:thread
     O : :Toolkit
     P :
-    
+
     # messages and activations
     E  -> T+ a1:run(3)
     T  -> O+ run()
     O        >callbackLoop()
-    
+
     # creation
     O+ :> P  p:Peer
-    
+
     # message with response
     O- => P  result=handleExpose()
-    
+
     # destruction
     O  #> P
-    
+
     # deactivation
     T- O-
 

TODO.md

@@ -0,0 +1,7 @@
+# TODO:
+
+- in uml_builder, move keywords to constants defined in model
+- in parser, move preprocess to own module
+- in parser, refactor regex and handling
+- in parser, refactor horrendous do_line() in smaller functions.
+

build-testpypi.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+. ./set-ex.sh
+
+banner2 "Cleaning up"
+./clean.sh
+
+banner2 "Linting"
+./lint.sh
+
+# TODO:
+#banner2 "Testing"
+#./test.sh
+
+banner2 "Making doc"
+./make-doc.sh

build.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -ex
+
+clean() {
+    $1 rm -rf build/ dist/ src/*.egg-info/ $(find -name __pycache__)
+}
+
+clean || clean sudo

clean.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+. ./set-ex.sh
+
+WHAT=umlsequence2
+
+./build.sh
+
+yes | pip3 uninstall $WHAT 2>/dev/null || true
+yes | sudo pip3 uninstall $WHAT
+
+python3 setup.py build
+
+sudo python3 setup.py install

examples/example.svg

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -ex
+
+MYPY_OPTS=""
+MYPY_OPTS+=" --warn-redundant-casts"
+MYPY_OPTS+=" --warn-return-any"
+#MYPY_OPTS+=" --warn-unreachable"
+MYPY_OPTS+=" --strict-equality"
+MYPY_OPTS+=" --strict --namespace-packages"
+
+#SRCS=$(find src tests -name "*.py")
+SRCS=$(find src -name "*.py")
+mypy --ignore-missing-imports --pretty $MYPY_OPTS --no-strict-optional $SRCS

install-locally.py

@@ -0,0 +1,28 @@
+#!/bin/bash
+. ./set-ex.sh
+
+WHAT=umlsequence2
+
+#OPTS=--debug
+OPTS=
+
+for dir in doc examples; do (
+    cd $dir
+
+    rm -f *.svg
+
+    if ls *.md; then
+	for doc in *.md; do
+	    ../$WHAT $OPTS $doc --markdown
+	done
+    fi
+
+    if ls *.umlsequence; then
+	for doc in *.umlsequence; do
+	    ../$WHAT $OPTS $doc
+	done
+    fi
+)
+done
+
+./$WHAT README.md --markdown