Skip to content

Generates a UML class diagram from any Ruby repository

License

Notifications You must be signed in to change notification settings

iulspop/ruby_to_uml

Repository files navigation

🖼️ Ruby To UML Class Diagram

Ruby To UML creates a UML class diagram from Ruby source code.

Installation

gem install ruby_to_uml

How to use

  1. Go to your Ruby project directory

  2. Run ruby_to_uml

    • To create diagram for a whole project: ruby_to_uml lib/
    • To create diagram for one file: ruby_to_uml lib/thing.rb
  3. Open uml_class_diagram.html in a browser

Diagram Features

  • Shows classes with instance variables, instance methods and singleton methods
  • Shows modules with instance emthods and singleton methods
  • Instance methods are marked public, private or protected
  • Show relationships between different classes or classes and modules in particular inheritence, includes, extends and prepends

Release Notes

Have a look at our CHANGELOG to get the details of all changes between versions.

Licence

MIT