statemachine 1.0.0 → 1.1.1

data/CHANGES

@@ -1,5 +1,16 @@
 = Statemachine Changelog
 
+== Version 1.1.0
+
+DotGraph
+* DotGraph generator was added to generate graphs of statemachines using Omnigraffle.
+* Fixed bug in Java generator where Statenames where not formated correctly.
+
+== Version 1.0.0
+
+Generator
+* Java generator was added.  Statemachines defined in the Ruby DSL can generate Java code.
+
 == Version 0.4.2
 
 Simple Fixes

data/README.rdoc

@@ -21,7 +21,7 @@ at http://blog.8thlight.com/articles/2006/11/17/understanding-statemachines-part
 	
 == License
 
-Copyright (C) 2006  Micah Martin
+Copyright (C) 2006-2010  Micah Martin
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public

data/lib/statemachine/generate/dot_graph.rb

@@ -0,0 +1 @@
+require 'statemachine/generate/dot_graph/dot_graph_statemachine'

data/lib/statemachine/generate/dot_graph/dot_graph_statemachine.rb

@@ -0,0 +1,127 @@
+require 'statemachine/generate/util'
+require 'statemachine/generate/src_builder'
+
+module Statemachine
+  class Statemachine
+
+    attr_reader :states
+
+    def to_dot(options = {})
+      generator = Generate::DotGraph::DotGraphStatemachine.new(self, options)
+      generator.generate!
+    end
+
+  end
+
+  module Generate
+    module DotGraph
+
+      class DotGraphStatemachine
+
+        include Generate::Util
+
+        def initialize(sm, options)
+          @sm = sm
+          @output_dir = options[:output]
+          raise "Please specify an output directory. (:output => 'where/you/want/your/code')" if @output_dir.nil?
+          raise "Output dir '#{@output_dir}' doesn't exist." if !File.exist?(@output_dir)
+        end
+
+        def generate!
+          explore_sm
+          save_output(src_file("main"), build_full_graph)
+          @sm.states.values.each do |state|
+            save_output(src_file("#{state.id}"), build_state_graph(state))
+          end
+        end
+
+        private
+
+        def explore_sm
+          @nodes = []
+          @transitions = []
+          @sm.states.values.each { |state|
+            state.transitions.values.each { |transition|
+              @nodes << transition.origin_id
+              @nodes << transition.destination_id
+              @transitions << transition
+            }
+          }
+          @nodes = @nodes.uniq
+        end
+
+        def build_full_graph
+          builder = Generate::SrcBuilder.new
+
+          add_graph_header(builder, "main")
+
+          @nodes.each { |node| add_node(builder, node) }
+          builder << endl
+
+          @transitions.each do |transition|
+            add_transition(builder, transition)
+          end
+
+          add_graph_footer(builder)
+
+          return builder.to_s
+        end
+
+        def build_state_graph(state)
+          builder = Generate::SrcBuilder.new
+
+          add_graph_header(builder, state.id)
+
+          state.transitions.values.each do |transition|
+            add_transition(builder, transition)
+          end
+
+          add_graph_footer(builder)
+
+          return builder.to_s
+        end
+
+        def add_graph_header(builder, graph_name)
+          builder << "digraph #{graph_name} {" << endl
+          builder.indent!
+        end
+
+        def add_graph_footer(builder)
+          builder.undent!
+          builder << "}" << endl
+        end
+
+        def add_node(builder, node)
+          builder << node
+          builder << " [ href = \"#{node}.svg\"]"
+          builder << endl
+        end
+
+        def add_transition(builder, transition)
+          builder << transition.origin_id
+          builder << " -> "
+          builder << transition.destination_id
+          builder << " [ "
+          builder << "label = #{transition.event} "
+          builder << "]"
+          builder << endl
+        end
+
+        def src_file(name)
+          return name if @output_dir.nil?
+          path = @output_dir
+          answer = File.join(path, "#{name}.dot")
+          return answer
+        end
+
+        def save_output(filename, content)
+          if @output_dir.nil?
+            say "Writing to file: #{filename}"
+          else
+            create_file(filename, content)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/statemachine/generate/java/java_statemachine.rb

@@ -37,6 +37,7 @@ module Statemachine
           explore_sm
           create_file(src_file(@classname), build_statemachine_src)
           create_file(src_file(@context_classname), build_context_src)
+          say "Statemachine generated."
         end
 
         private ###########################################
@@ -88,8 +89,8 @@ module Statemachine
           src << "// Instance variables" << endl
           concrete_states = @sm.states.values.reject { |state| state.id.nil? || !state.concrete? }.sort { |a, b| a.id <=> b.id }
           concrete_states.each do |state|
-            name = state.id.to_s.camalized
-            src << "public final State #{name.upcase} = new #{name}State(this);" << endl
+            name = state.id.to_s
+            src << "public final State #{name.upcase} = new #{name.camalized}State(this);" << endl
           end
           superstates = @sm.states.values.reject { |state| state.concrete? }.sort { |a, b| a.id <=> b.id }
           superstates.each do |superstate|
@@ -193,7 +194,7 @@ module Statemachine
             src << "statemachine.getContext().#{transition.action.to_s.camalized(:lower)}();" << endl if transition.action
             src << "statemachine.setState(statemachine.#{transition.destination_id.to_s.upcase});" << endl
             entries.each do |entry|
-              src << "statemachine.getContext().#{entry.entry_action.to_s.camalized(:lower)}();" << endl if entry.entry_action              
+              src << "statemachine.getContext().#{entry.entry_action.to_s.camalized(:lower)}();" << endl if entry.entry_action
             end
           end
         end
@@ -244,6 +245,7 @@ module Statemachine
 
         def create_file(filename, content)
           establish_directory(File.dirname(filename))
+          say "Writing to file: #{filename}"
           File.open(filename, 'w') do |file|
             file.write(content)
           end
@@ -260,4 +262,4 @@ module Statemachine
       end
     end
   end
-end
+end

data/lib/statemachine/generate/util.rb

@@ -4,6 +4,13 @@ module Statemachine
   module Generate
     module Util
 
+      def create_file(filename, content)
+        establish_directory(File.dirname(filename))
+        File.open(filename, 'w') do |file|
+          file.write(content)
+        end
+      end
+
       def establish_directory(path)
         return if File.exist?(path)
         establish_directory(File.dirname(path))
@@ -18,6 +25,12 @@ module Statemachine
         return :endl
       end
 
+      def say(message)
+        if !defined?($IS_TEST)
+          puts message
+        end
+      end
+
     end
   end
 end
@@ -34,4 +47,4 @@ class Symbol
   def <=>(other)
     return to_s <=> other.to_s
   end
-end
+end

data/lib/statemachine/statemachine.rb

@@ -1,52 +1,52 @@
 module Statemachine
-  
+
   class StatemachineException < Exception
   end
-  
-  class TransitionMissingException < Exception 
+
+  class TransitionMissingException < Exception
   end
-  
+
   # Used at runtime to execute the behavior of the statemachine.
   # Should be created by using the Statemachine.build method.
-  # 
+  #
   #   sm = Statemachine.build do
   #     trans :locked, :coin, :unlocked
   #     trans :unlocked, :pass, :locked:
   #   end
-  #   
+  #
   #   sm.coin
   #   sm.state
-  #   
+  #
   # This class will accept any method that corresponds to an event.  If the
   # current state respons to the event, the appropriate transtion will be invoked.
   # Otherwise an exception will be raised.
   class Statemachine
     include ActionInvokation
-  
-    # The tracer is an IO object.  The statemachine will write run time execution 
+
+    # The tracer is an IO object.  The statemachine will write run time execution
     # information to the +tracer+. Can be helpful in debugging. Defaults to nil.
     attr_accessor :tracer
-    
+
     # Provides access to the +context+ of the statemachine.  The context is a object
     # where all actions will be invoked.  This provides a way to separate logic from
     # behavior.  The statemachine is responsible for all the logic and the context
-    # is responsible for all the behavior.  
+    # is responsible for all the behavior.
     attr_accessor :context
-    
+
     attr_reader :root #:nodoc:
-  
+
     # Should not be called directly.  Instances of Statemachine::Statemachine are created
     # through the Statemachine.build method.
     def initialize(root = Superstate.new(:root, nil, self))
       @root = root
       @states = {}
     end
-    
+
     # Returns the id of the startstate of the statemachine.
     def startstate
       return @root.startstate_id
     end
-  
+
     # Resets the statemachine back to its starting state.
     def reset
       @state = get_state(@root.startstate_id)
@@ -55,15 +55,15 @@ module Statemachine
       end
       raise StatemachineException.new("The state machine doesn't know where to start. Try setting the startstate.") if @state == nil
       @state.enter
-      
+
       @states.values.each { |state| state.reset }
     end
-    
+
     # Return the id of the current state of the statemachine.
     def state
       return @state.id
     end
-    
+
     # You may change the state of the statemachine by using this method.  The parameter should be
     # the id of the desired state.
     def state= value
@@ -75,10 +75,10 @@ module Statemachine
         @state = @states[value.to_sym]
       end
     end
-    
+
     # The key method to exercise the statemachine. Any extra arguments supplied will be passed into
     # any actions associated with the transition.
-    # 
+    #
     # Alternatively to this method, you may invoke methods, names the same as the event, on the statemachine.
     # The advantage of using +process_event+ is that errors messages are more informative.
     def process_event(event, *args)
@@ -95,11 +95,11 @@ module Statemachine
         raise StatemachineException.new("The state machine isn't in any state while processing the '#{event}' event.")
       end
     end
-    
+
     def trace(message) #:nodoc:
       @tracer.puts message if @tracer
     end
-    
+
     def get_state(id) #:nodoc:
       if @states.has_key? id
         return @states[id]
@@ -114,11 +114,11 @@ module Statemachine
         return state
       end
     end
-    
+
     def add_state(state) #:nodoc:
       @states[state.id] = state
     end
-    
+
     def has_state(id) #:nodoc:
       if(is_history_state_id?(id))
         return @states.has_key?(base_id(id))
@@ -126,13 +126,13 @@ module Statemachine
         return @states.has_key?(id)
       end
     end
-    
+
     def respond_to?(message)
       return true if super(message)
       return true if @state and @state.transition_for(message)
       return false
     end
-    
+
     def method_missing(message, *args) #:nodoc:
       if @state and @state.transition_for(message)
         process_event(message.to_sym, *args)
@@ -147,17 +147,17 @@ module Statemachine
         end
       end
     end
-    
-    private 
-    
+
+    private
+
     def is_history_state_id?(id)
       return id.to_s[-2..-1] == "_H"
     end
-    
+
     def base_id(history_id)
       return history_id.to_s[0...-2].to_sym
     end
-    
+
     def load_history(superstate)
       100.times do
         history = superstate.history_id ? get_state(superstate.history_id) : nil
@@ -170,6 +170,6 @@ module Statemachine
       end
       raise StatemachineException.new("No history found within 100 levels of nested superstates.")
     end
-    
+
   end
-end
+end

data/lib/statemachine/stub_context.rb

@@ -16,7 +16,9 @@ module Statemachine
     end
 
     def __generic_method(name, *args)
-      puts "action invoked: #{name}(#{args.join(", ")}) #{block_given? ? "with block" : ""}" if @verbose      
+      if !defined?($IS_TEST)
+        puts "action invoked: #{name}(#{args.join(", ")}) #{block_given? ? "with block" : ""}" if @verbose
+      end
     end
 
   end

data/lib/statemachine/version.rb

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

data/spec/generate/dot_graph/dot_graph_stagemachine_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'statemachine/generate/dot_graph/dot_graph_statemachine'
+
+describe Statemachine::Statemachine, "(Turn Stile)" do
+  include TurnstileStatemachine
+
+  before(:each) do
+    remove_test_dir("dot")
+    @output = test_dir("dot")
+    create_turnstile
+  end
+
+#  it "should output to console when no output dir provided" do
+#    # Note - this test doesn't verify output to the console, but it does
+#    # ensure that the to_dot call does not fail if not output is provided.
+#    @sm.to_dot
+#  end
+
+  it "should generate a basic graph declaration" do
+    @sm.to_dot(:output => @output)
+
+    dot = load_lines(@output, "main.dot")
+
+    dot.should_not equal(nil)
+    dot[0].include?("digraph").should == true
+  end
+end

data/spec/generate/java/java_statemachine_spec.rb

@@ -48,11 +48,11 @@ describe Statemachine::Statemachine, "(Java)" do
     @sm.to_java(:output => @output, :name => "JavaTurnstile", :package => "test.turnstile")
   end
 
-  def load_lines(*segs)
-    filename = File.join(*segs)
-    File.should exist( filename)
-    return IO.read(filename).split("\n")
-  end
+  # def load_lines(*segs)
+  #   filename = File.join(*segs)
+  #   File.should exist( filename)
+  #   return IO.read(filename).split("\n")
+  # end
 
   def empty_sm_lines
     @sm.to_java(:name => "JavaTest", :output => @output, :package => "test.blank")
@@ -345,4 +345,4 @@ describe Statemachine::Statemachine, "(Java)" do
     lines.shift.should == "  }"
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,8 @@ require 'rubygems'
 require 'spec'
 require 'statemachine'
 
+$IS_TEST = true
+
 def check_transition(transition, origin_id, destination_id, event, action)
   transition.should_not equal(nil)
   transition.event.should equal(event)
@@ -12,20 +14,20 @@ def check_transition(transition, origin_id, destination_id, event, action)
 end
 
 module SwitchStatemachine
-  
+
   def create_switch
     @status = "off"
     @sm = Statemachine.build do
-      trans :off, :toggle, :on, Proc.new { @status = "on" } 
+      trans :off, :toggle, :on, Proc.new { @status = "on" }
       trans :on, :toggle, :off, Proc.new { @status = "off" }
     end
     @sm.context = self
   end
-  
+
 end
 
 module TurnstileStatemachine
-  
+
   def create_turnstile
     @locked = true
     @alarm_status = false
@@ -34,7 +36,7 @@ module TurnstileStatemachine
     @unlock = "@locked = false"
     @alarm = "@alarm_status = true"
     @thankyou = "@thankyou_status = true"
-  
+
     @sm = Statemachine.build do
       trans :locked, :coin, :unlocked, "@locked = false"
       trans :unlocked, :pass, :locked, "@locked = true"
@@ -58,4 +60,10 @@ end
 
 def remove_test_dir(name)
   system "rm -rf #{test_dir(name)}" if File.exist?(test_dir(name))
-end
+end
+
+def load_lines(*segs)
+  filename = File.join(*segs)
+  File.should exist( filename)
+  return IO.read(filename).split("\n")
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 0
-  - 0
-  version: 1.0.0
+  - 1
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Micah Martin
@@ -14,7 +14,7 @@ autorequire: statemachine
 bindir: bin
 cert_chain: []
 
-date: 2010-03-25 00:00:00 -05:00
+date: 2010-09-29 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,8 @@ files:
 - TODO
 - lib/statemachine/action_invokation.rb
 - lib/statemachine/builder.rb
+- lib/statemachine/generate/dot_graph/dot_graph_statemachine.rb
+- lib/statemachine/generate/dot_graph.rb
 - lib/statemachine/generate/java/java_statemachine.rb
 - lib/statemachine/generate/java.rb
 - lib/statemachine/generate/src_builder.rb
@@ -48,6 +50,7 @@ files:
 - spec/action_invokation_spec.rb
 - spec/builder_spec.rb
 - spec/default_transition_spec.rb
+- spec/generate/dot_graph/dot_graph_stagemachine_spec.rb
 - spec/generate/java/java_statemachine_spec.rb
 - spec/history_spec.rb
 - spec/sm_action_parameterization_spec.rb
@@ -87,7 +90,7 @@ rubyforge_project: statemachine
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Statemachine-1.0.0 - Statemachine Library for Ruby http://slagyr.github.com/statemachine
+summary: Statemachine-1.1.1 - Statemachine Library for Ruby http://slagyr.github.com/statemachine
 test_files: 
 - spec/action_invokation_spec.rb
 - spec/builder_spec.rb