mscgen 0.0.0 → 0.1.0

data/README.md

@@ -26,6 +26,7 @@ This gem generates a script for mscgen. This can generate sequence image(i.e. pn
 
 ### Create sequence scripts or images
 
+    require 'rubygems'
     require 'mscgen'
     
     # create chart
@@ -34,8 +35,12 @@ This gem generates a script for mscgen. This can generate sequence image(i.e. pn
     # add entities and messages
     a = chart.add_entity('a')
     b = chart.add_entity('b')
-    chart.add_message(Mscgen::Message.new(a,b, 'label'))
-    chart.add_message(Mscgen::Message.new(b,a, 'return', :type => :method_return ))
+    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)

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/mscgen/chart.rb

@@ -36,9 +36,17 @@ module Mscgen
     end
 
     # add messages to chart..
-    # _msg_ should respond to 'to_msc'
-    def add_message(msg)
-      raise ArgumentError unless msg.respond_to?(:to_msc)
+    # _from_or_msg_:: from entity or Message instance
+    # _to_:: to entity
+    # _label_:: message label string
+    # _param_:: message parameters
+    def add_message(from_or_msg, to=nil, label=nil, param=nil)
+      if to.nil? and label.nil? and param.nil?
+        msg = from_or_msg
+        raise ArgumentError unless msg.respond_to?(:to_msc)
+      else
+        msg = Mscgen::Message.new(from_or_msg, to, label, param)
+      end
       @messages << msg
       msg
     end

data/lib/mscgen/message.rb

@@ -1,5 +1,8 @@
 module Mscgen
   class Message
+    class UnknownAllowType < StandardError; end
+
+    # acceptable allow type definition
     ALLOW_TYPE = {
       :messege => "->",
       :method => "=>",
@@ -9,15 +12,20 @@ module Mscgen
       :lost_message => "-x",
     }
 
+
     attr_reader :label, :from, :to
 
-    # from
-    # option supports :type, :linecolor, :textcolor attributes
-    def initialize(from, to, label=nil, option={})
+    # _from_:: a entity which message from
+    # _to_:: a entity which message to 
+    # _label_:: message string
+    # _options_:: supports :type, :linecolor, :textcolor attributes
+    def initialize(from, to, label=nil, options={})
       @from = from
       @to = to
       @label = Mscgen.escape(label.to_s) unless label.nil?
-      @options = option
+      @options = (options or {})
+      raise ArgumentError unless @options.kind_of?(Hash)
+      raise UnknownAllowType unless ALLOW_TYPE.has_key?(@options.fetch(:type, :method))
     end
 
     # return mscgen format text
@@ -42,7 +50,7 @@ module Mscgen
 
     # determine allow shape
     def allow # :nodoc:
-      ALLOW_TYPE.fetch(@options[:type], "->")
+      ALLOW_TYPE.fetch(@options[:type], '->')
     end
     protected :allow
   end

data/mscgen.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mscgen"
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Masata NISHIDA"]
-  s.date = "2012-02-13"
+  s.date = "2012-02-17"
   s.description = "mscgen( http://www.mcternan.me.uk/mscgen/ ) is simple sequence chart generator. this gem generates a script for mscgen."
   s.email = "masatanish@gmail.com"
   s.extra_rdoc_files = [

data/spec/mscgen_chart_spec.rb

@@ -62,13 +62,20 @@ describe Mscgen::Chart do
         lambda {subject}.should change(@chart.messages, :size).by(1)
       end
     end
-
-    describe "#to_msc" do
+    context "with parameters to initialize Message object" do
+      it "should create new Message object" do
+        lambda { @chart.add_message(@ent1, @ent2, 'foobar') }.should change(@chart.messages, :size).by(1)
+      end
+      it "should create new Message object" do
+        lambda { @chart.add_message(@ent1, @ent2, 'foobar', :type => :method_return) }.should change(@chart.messages, :size).by(1)
+      end
     end
+  end
 
-    describe "#to_img" do
-    end
-    
+  describe "#to_msc" do
+  end
 
+  describe "#to_img" do
   end
+
 end

data/spec/mscgen_message_spec.rb

@@ -8,8 +8,26 @@ describe Mscgen::Message do
   end
 
   describe "#initialize" do
-  subject { Mscgen::Message.new(@ent1, @ent2, @label) }
+    before do
+      @param = nil
+    end
+    subject { Mscgen::Message.new(@ent1, @ent2, @label, @param) }
     it { should be_kind_of(Mscgen::Message) }
+
+    context "with known allow type parameter" do
+      before do
+        @param = {:type => :method}
+        it { should be_kind_of(Mscgen::Message) }
+      end
+    end
+    context "with unknown allow type parameter" do
+      before do
+        @param = {:type => :foo } # :foo is unknown type
+      end
+      it do
+        lambda {subject}.should raise_error(Mscgen::Message::UnknownAllowType)
+      end
+    end
   end
   describe "#from" do
     subject { Mscgen::Message.new(@ent1, @ent2, "abc").from }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mscgen
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-13 00:00:00.000000000Z
+date: 2012-02-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70098992503940 !ruby/object:Gem::Requirement
+  requirement: &70229594784180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70098992503940
+  version_requirements: *70229594784180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70098992503460 !ruby/object:Gem::Requirement
+  requirement: &70229594782680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70098992503460
+  version_requirements: *70229594782680
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70098992502980 !ruby/object:Gem::Requirement
+  requirement: &70229594781200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70098992502980
+  version_requirements: *70229594781200
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70098992539340 !ruby/object:Gem::Requirement
+  requirement: &70229594779220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70098992539340
+  version_requirements: *70229594779220
 description: mscgen( http://www.mcternan.me.uk/mscgen/ ) is simple sequence chart
   generator. this gem generates a script for mscgen.
 email: masatanish@gmail.com
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3737380167972180771
+      hash: 1357672505775249758
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: