Ruby/yUML

Copyright © 2009 Gregoire Lejeune

• home : github.com/glejeune/ruby-yuml

• doc : rdoc.info/projects/glejeune/ruby-yuml

DESCRIPTION:

Ruby/yUML is a UML diagrams generator via yuml.me

FEATURES/PROBLEMS:

0.1.0

• Initial release

SYNOPSIS:

Use Case Diagram

Syntax Overview

• Use Case : _(:UseCase) or <b>useCase(:UseCase)</b>

• Actor : _[:Actor] or <b>actor(:Actor)</b>

• <<Extend>> : _(:UseCase) <b><</b> _(:OtherUseCase)

• <<Include>> : _(:UseCase) <b>></b> _(:OtherUseCase)

• Link : _[:Actor] <b>-</b> _(:UseCase)

• Actor Inheritance : _[:Actor] <b>^</b> _[:OtherActor]

• Notes : _(:UseCase) <b>- note('This is a note')</b>

Example

require 'yuml'

YUML::useCaseDiagram( :scruffy, :scale => 75 ) {
  _[:Admin] ^ _[:User]
  _[:Admin] - note( 'Most privilidged user' )
  _[:User] - _(:Login)
  _[:User] - _(:Logout) 
  _(:Login) < _(:Reminder) 
  _(:Login) > _(:Captcha)
}.to_png( "sample.png" )

This example generate this PNG :

Activity Diagram

Syntax Overview

• Start : _(:start) or <b>_start</b> or <b>activity(:start)</b>

• End : _(:end) or <b>_end</b> or <b>activity(:end)</b>

• Activity : <b>_(:Activity)</b> or <b>activity(:Activity)</b>

• Flow : _(:A) <b>></b> _(:B)

• Decision : <b>_{:Decision}</b> or <b>decision(:Decision)</b>

• Parallel : <b>_[:Parallel]</b> or <b>parallel(:Parallel)</b>

• Decision with label : _{:Decision} <b>-"label"></b> _(:Activity)

Example

require 'yuml'

YUML::activityDiagram( :scruffy, :scale => 100 ) {
  _(:start) > _{:d1}
  _{:d1} -"logged in"> _("Show Dashboard") 
  _("Show Dashboard") > _[:a]
  _[:a] > _(:end)
  _{:d1} -"not logged in"> _("Show Login") 
  _("Show Login") > _[:a]
}.to_png( "activity-diagram.png" )

This example generate this PNG :

Class Diagram

Syntax Overview

WIP

Example

require 'yuml'

x = YUML::classDiagram( :scruffy, :scale => 75 ) {
  _["Customer"|"Forename;Surname;Email"|"+new();-Save()"] - _[:User]
  _["Customer"] - note( 'I love this Klass' )
}.to_png( "class-diagram.png" )

This example generate this PNG :

REQUIREMENTS:

• An internet acces ;)

LICENSE:

Ruby/yUML is freely distributable according to the terms of the GNU General Public License.

This program is distributed without any warranty. See the file ‘COPYING’ for details.