statemachine 1.1.1 → 1.2.0

data/lib/statemachine/builder.rb

@@ -11,7 +11,7 @@ module Statemachine
   #     trans :unlocked, :pass, :locked, :lock
   #   end
   #   
-  # An optional statemachine paramter may be passed in to modify
+  # An optional statemachine parameter may be passed in to modify
   # an existing statemachine instance.
   #
   # Actions:
@@ -57,12 +57,13 @@ module Statemachine
   module StateBuilding
     attr_reader :subject
   
-    # Declares that the state responds to the spcified event.
-    # The +event+ paramter should be a Symbol.  
+    # Declares that the state responds to the specified event.
+    # The +event+ parameter should be a Symbol.  
     # The +destination_id+, which should also be a Symbol, is the id of the state 
     # that will event will transition into.
     # 
-    # The 3rd +action+ paramter is optional
+    # The 3rd +action+ parameter is optional. Note that the action runs *before*
+    # the transition to the state specified in the 2nd parameter.
     #   
     #   sm = Statemachine.build do
     #     state :locked do
@@ -277,4 +278,4 @@ module Statemachine
     end
   end
   
-end
+end

data/lib/statemachine/statemachine.rb

@@ -33,6 +33,11 @@ module Statemachine
     # is responsible for all the behavior.
     attr_accessor :context
 
+    # A statemachine can be named. This is most useful when a program is running
+    # multiple machines with a tracer. The name is prepended to the tracer notices
+    # so that they can be matched to the correct statemachine.
+    attr_accessor :name
+
     attr_reader :root #:nodoc:
 
     # Should not be called directly.  Instances of Statemachine::Statemachine are created
@@ -97,7 +102,10 @@ module Statemachine
     end
 
     def trace(message) #:nodoc:
-      @tracer.puts message if @tracer
+      if @tracer
+        prefix = @name ? "(#{@name}) " : ""
+        @tracer.puts("#{prefix}#{message}")
+      end
     end
 
     def get_state(id) #:nodoc:

data/lib/statemachine/version.rb

@@ -2,8 +2,8 @@ module Statemachine
   module VERSION #:nodoc:
     unless defined? MAJOR
       MAJOR  = 1
-      MINOR  = 1
-      TINY   = 1
+      MINOR  = 2
+      TINY   = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')
       TAG    = "REL_" + [MAJOR, MINOR, TINY].join('_')

data/spec/sm_odds_n_ends_spec.rb

@@ -61,6 +61,41 @@ describe "State Machine Odds And Ends" do
     @sm.state.should equal(:stuck)
   end
 
+  it "traces output with name" do
+    io = StringIO.new
+    @sm.name = "Switch"
+    @sm.tracer = io
+    @sm.toggle
+    @sm.toggle
+
+    expected = StringIO.new
+    expected.puts "(Switch) Event: toggle"
+    expected.puts "(Switch) \texiting 'off' state"
+    expected.puts "(Switch) \tentering 'on' state"
+    expected.puts "(Switch) Event: toggle"
+    expected.puts "(Switch) \texiting 'on' state"
+    expected.puts "(Switch) \tentering 'off' state"
+
+    io.string.should == expected.string
+  end
+
+  it "traces output without name" do
+    io = StringIO.new
+    @sm.tracer = io
+    @sm.toggle
+    @sm.toggle
+
+    expected = StringIO.new
+    expected.puts "Event: toggle"
+    expected.puts "\texiting 'off' state"
+    expected.puts "\tentering 'on' state"
+    expected.puts "Event: toggle"
+    expected.puts "\texiting 'on' state"
+    expected.puts "\tentering 'off' state"
+
+    io.string.should == expected.string
+  end
+
 end
 
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Micah Martin
@@ -14,7 +14,7 @@ autorequire: statemachine
 bindir: bin
 cert_chain: []
 
-date: 2010-09-29 00:00:00 -05:00
+date: 2011-06-17 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -90,7 +90,7 @@ rubyforge_project: statemachine
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Statemachine-1.1.1 - Statemachine Library for Ruby http://slagyr.github.com/statemachine
+summary: Statemachine-1.2.0 - Statemachine Library for Ruby http://slagyr.github.com/statemachine
 test_files: 
 - spec/action_invokation_spec.rb
 - spec/builder_spec.rb