Goal
ruby-uml tries to trace different aspects of an existing application, which is intended to provide support for refactorisations by generating UML-graphs.
ruby-uml is able to generate textual representations of the gathered informations.
These representations include pic- or dot-code that can be converted to images by their corresponding applications.
At this time ruby-uml is able to generate sequence- and class-diagrams.
As you won’t get that much information out of the trace, the resulting dot- or pic-files are intended to be as readable as possible, so that manual corrections/additions are made as easy as possible.
Dependencies
Gem dependencies:
- diff-lcs
-
>= 1.1.2
Other dependencies:
- ruby
-
ruby-uml is tested with 1.8.5
- aspectr
-
There are three aspectr projects known to me:
- 0.3.5
- 0.3.6
- 0.4.0
-
None of them seem to be maintained anymore.
-
Everyone provides the functionality needed for ruby-uml.
-
Everyone seems to have issues on ruby 1.8.5.
In the additional folder i provide a patch for 0.4.0 which resolved all issues for me on linux and cygwin.
- UMLGraph
-
ruby-uml uses the sequence.pic file from the UMLGraph Project for generating sequence-diagrams out of pic files.
ruby-uml is tested with 4.6.
- GNU Plotutils
-
www.gnu.org/software/plotutils/
Plotutils ‘pic2plot’ is used for generating sequence-diagram-images out of pic files.
ruby-uml is tested with 2.4.1.
- Graphviz
-
Grapphviz ‘dot’ command is used to generate class-diagram-images out of dot files.
ruby-uml is tested with 2.12.