mscgen for ruby

Mscgen is simple sequence chart generator. This gem generates a script for mscgen. This can generate sequence image(i.e. png, svg…) if you set mscgen path.

Requirements

install mscgen

 $ yum install mscgen # Linux(CentOS, Fedora..)
 $ brew isntall mscgen # MacOS X

Install

$ gem install mscgen

Usage

Setting Mscgen Path

Mscgen.path = '/usr/local/bin/mscgen'

Create sequence scripts or images

require 'rubygems'
require 'mscgen'

# create chart
chart = Mscgen::Chart.new

# add entities and messages
a = chart.add_entity('a')
b = chart.add_entity('b')
c = chart.add_entity('ccc')

# create messages
chart.add_message(a,b, 'hoge', :type => :method)
chart.add_message(b,a, 'return', :type => :method_return)
chart.add_message(b,c, 'hoge')

# create image file
chart.to_img('seq.png', :png)

# or create a script for mscgen
script = chart.to_msc
File.open('seq.txt', 'w') {|f| f.write script }

Support Image Format

refer mscgen --help.

Contributing to mscgen

Copyright

Copyright © 2012 Masata NISHIDA. See LICENSE.txt for further details.