MINT-statemachine 1.2.2

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

@@ -0,0 +1,349 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+require 'statemachine/generate/java/java_statemachine'
+
+describe Statemachine::Statemachine, "(Java)" do
+
+  before(:each) do
+    remove_test_dir("java")
+    @output = test_dir("java")
+    @sm = Statemachine.build {}
+  end
+
+  def generate_turnstile_sm
+    @sm = Statemachine.build do
+      trans :locked, :coin, :unlocked, :unlock
+      trans :unlocked, :pass, :locked, :lock
+      trans :locked, :pass, :locked, :alarm
+      trans :unlocked, :coin, :locked, :thanks
+    end
+
+    @sm.to_java(:output => @output, :name => "JavaTurnstile", :package => "test.turnstile")
+  end
+
+  def generate_complex_turnstile_sm
+    @sm = Statemachine.build do
+      superstate :operational do
+        on_entry :operate
+        on_exit :beep
+        state :locked do
+          on_entry :lock
+          event :coin, :unlocked
+          event :pass, :locked, :alarm
+        end
+        state :unlocked do
+          on_entry :unlock
+          event :coin, :unlocked, :thanks
+          event :pass, :locked
+        end
+        event :diagnose, :diagnostics
+      end
+      state :diagnostics do
+        on_entry :disable
+        on_exit :beep
+        event :operate, :operational
+      end
+      stub_context :verbose => true
+    end
+
+    @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 empty_sm_lines
+    @sm.to_java(:name => "JavaTest", :output => @output, :package => "test.blank")
+    return load_lines(@output, "test", "blank", "JavaTest.java")
+  end
+
+  def turnstile_lines
+    generate_turnstile_sm
+    return load_lines(@output, "test", "turnstile", "JavaTurnstile.java")
+  end
+
+  def turnstile_context_lines
+    generate_turnstile_sm
+    return load_lines(@output, "test", "turnstile", "JavaTurnstileContext.java")
+  end
+
+  def complex_turnstile_lines
+    generate_complex_turnstile_sm
+    return load_lines(@output, "test", "turnstile", "JavaTurnstile.java")
+  end
+
+  def find_lines_after(lines, goose)
+    while !lines.empty?
+      return lines if lines.shift.strip == goose
+    end
+    raise "Can't find desired line: #{goose}"
+  end
+
+  it "should error if no output dir is specified" do
+    lambda { @sm.to_java }.should raise_error("Please specify an output directory. (:output => 'where/you/want/your/code')")
+  end
+
+  it "should error if output dir doesn't exist" do
+    lambda { @sm.to_java(:output => "/blah") }.should raise_error("Output dir '/blah' doesn't exist.")
+  end
+
+  it "should error if no class name is specified" do
+    lambda { @sm.to_java(:output => @output) }.should raise_error("Please specify a name for the statemachine. (:name => 'SomeName')")
+  end
+
+  it "should generate a class" do
+    @sm.to_java(:name => "JavaTest", :output => @output)
+    File.should exist(File.join(@output, "JavaTest.java"))
+  end
+
+  it "should generate a class in a package" do
+    lines = empty_sm_lines
+
+    lines.shift.should == "// This file was generated by the Ruby Statemachine Library (http://slagyr.github.com/statemachine)."
+    lines.shift.include?("// Generated at ").should == true
+    lines.shift.should == "package test.blank;"
+    lines.shift.should == ""
+    lines.shift.should == "public class JavaTest"
+    lines.shift.should == "{"
+    lines.last.should == "}"
+  end
+
+  it "should generate the constructor" do
+    lines = find_lines_after(empty_sm_lines, "// Statemachine constructor")
+
+    lines.shift.should == "  public JavaTest(JavaTestContext context)"
+    lines.shift.should == "  {"
+    lines.shift.should == "    this.context = context;"
+    lines.shift.should == "  }"
+    lines.shift.should == ""
+  end
+
+  it "should generate sm boilerplate code" do
+    lines = find_lines_after(empty_sm_lines, "// The following is boiler plate code standard to all statemachines")
+
+    lines.shift.should == "  public JavaTestContext getContext()"
+    lines.shift.should == "  {"
+    lines.shift.should == "    return context;"
+    lines.shift.should == "  }"
+    lines.shift.should == ""
+    lines.shift.should == "  public State getState()"
+    lines.shift.should == "  {"
+    lines.shift.should == "    return state;"
+    lines.shift.should == "  }"
+    lines.shift.should == ""
+    lines.shift.should == "  public void setState(State newState)"
+    lines.shift.should == "  {"
+    lines.shift.should == "    state = newState;"
+    lines.shift.should == "  }"
+  end
+
+  it "should generate the sm exception" do
+    lines = empty_sm_lines
+    lines = find_lines_after(lines, "// Standard exception class added to all statemachines.")
+
+    lines.shift.should == "  public static class StatemachineException extends RuntimeException"
+    lines.shift.should == "  {"
+    lines.shift.should == "    public StatemachineException(State state, String event)"
+    lines.shift.should == "    {"
+    lines.shift.should == "      super(\"Missing transition from '\" + state.getClass().getSimpleName() + \"' with the '\" + event + \"' event.\");"
+    lines.shift.should == "    }"
+    lines.shift.should == "  }"
+  end
+
+  it "should generate base state" do
+    lines = empty_sm_lines
+    lines = find_lines_after(lines, "// The base state")
+
+    lines.shift.should == "  public static abstract class State"
+    lines.shift.should == "  {"
+    lines.shift.should == "    protected JavaTest statemachine;"
+    lines.shift.should == ""
+    lines.shift.should == "    public State(JavaTest statemachine)"
+    lines.shift.should == "    {"
+    lines.shift.should == "      this.statemachine = statemachine;"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "  }"
+  end
+
+  it "should generate the context" do
+    @sm.to_java(:name => "JavaTest", :output => @output, :package => "com.blah")
+
+    filename = File.join(@output, "com", "blah", "JavaTestContext.java")
+    File.should exist(filename)
+    lines = IO.read(filename).split("\n")
+
+    lines.shift.should == "// This file was generated by the Ruby Statemachine Library (http://slagyr.github.com/statemachine)."
+    lines.shift.include?("// Generated at ").should == true
+    lines.shift.should == "package com.blah;"
+    lines.shift.should == ""
+    lines.shift.should == "public interface JavaTestContext"
+    lines.shift.should == "{"
+    lines.shift.should == "  // Actions"
+    lines.shift.should == "}"
+    lines.should be_empty
+  end
+
+  it "should generate the state instance variables" do
+    lines = find_lines_after(turnstile_lines, "// Instance variables")
+
+    lines.shift.should == "  public final State LOCKED = new LockedState(this);"
+    lines.shift.should == "  public final State UNLOCKED = new UnlockedState(this);"
+    lines.shift.should == "  private State state = LOCKED;"
+    lines.shift.should == ""
+    lines.shift.should == "  private JavaTurnstileContext context;"
+  end
+
+  it "should generate all the sm event handlers" do
+    lines = find_lines_after(turnstile_lines, "// Event delegation")
+
+    lines.shift.should == "  public void coin()"
+    lines.shift.should == "  {"
+    lines.shift.should == "    state.coin();"
+    lines.shift.should == "  }"
+    lines.shift.should == ""
+    lines.shift.should == "  public void pass()"
+    lines.shift.should == "  {"
+    lines.shift.should == "    state.pass();"
+    lines.shift.should == "  }"
+    lines.shift.should == ""
+  end
+
+  it "should generate all the default event handlers" do
+    lines = find_lines_after(turnstile_lines, "// The base state")
+
+    lines.shift.should == "  public static abstract class State"
+    lines.shift.should == "  {"
+    lines.shift.should == "    protected JavaTurnstile statemachine;"
+    lines.shift.should == ""
+    lines.shift.should == "    public State(JavaTurnstile statemachine)"
+    lines.shift.should == "    {"
+    lines.shift.should == "      this.statemachine = statemachine;"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "    public void coin()"
+    lines.shift.should == "    {"
+    lines.shift.should == "      throw new StatemachineException(this, \"coin\");"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "    public void pass()"
+    lines.shift.should == "    {"
+    lines.shift.should == "      throw new StatemachineException(this, \"pass\");"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "  }"
+  end
+
+  it "should generate state classes" do
+    lines = find_lines_after(turnstile_lines, "// State implementations")
+
+    lines.shift.should == "  public static class LockedState extends State"
+    lines.shift.should == "  {"
+    lines.shift.should == "    public LockedState(JavaTurnstile statemachine)"
+    lines.shift.should == "    {"
+    lines.shift.should == "      super(statemachine);"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "    public void coin()"
+    lines.shift.should == "    {"
+    lines.shift.should == "      statemachine.getContext().unlock();"
+    lines.shift.should == "      statemachine.setState(statemachine.UNLOCKED);"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "    public void pass()"
+    lines.shift.should == "    {"
+    lines.shift.should == "      statemachine.getContext().alarm();"
+    lines.shift.should == "      statemachine.setState(statemachine.LOCKED);"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "  }"
+    lines.shift.should == ""
+    lines.shift.should == "  public static class UnlockedState extends State"
+    lines.shift.should == "  {"
+    lines.shift.should == "    public UnlockedState(JavaTurnstile statemachine)"
+    lines.shift.should == "    {"
+    lines.shift.should == "      super(statemachine);"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "    public void coin()"
+    lines.shift.should == "    {"
+    lines.shift.should == "      statemachine.getContext().thanks();"
+    lines.shift.should == "      statemachine.setState(statemachine.LOCKED);"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "    public void pass()"
+    lines.shift.should == "    {"
+    lines.shift.should == "      statemachine.getContext().lock();"
+    lines.shift.should == "      statemachine.setState(statemachine.LOCKED);"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "  }"
+    lines.shift.should == ""
+  end
+
+  it "should generate all the context methods" do
+    lines = find_lines_after(turnstile_context_lines, "// Actions")
+
+    lines.shift.should == "  void alarm();"
+    lines.shift.should == "  void lock();"
+    lines.shift.should == "  void thanks();"
+    lines.shift.should == "  void unlock();"
+  end
+
+  it "should generate complext state instances" do
+    lines = find_lines_after(complex_turnstile_lines, "// Instance variables")
+
+    lines.shift.should == "  public final State DIAGNOSTICS = new DiagnosticsState(this);"
+    lines.shift.should == "  public final State LOCKED = new LockedState(this);"
+    lines.shift.should == "  public final State UNLOCKED = new UnlockedState(this);"
+    lines.shift.should == "  public final State OPERATIONAL = LOCKED;"
+    lines.shift.should == "  private State state = LOCKED;"
+  end
+
+  it "should generate entry actions on startup" do
+    lines = find_lines_after(complex_turnstile_lines, "// Statemachine constructor")
+
+    lines.shift.should == "  public JavaTurnstile(JavaTurnstileContext context)"
+    lines.shift.should == "  {"
+    lines.shift.should == "    this.context = context;"
+    lines.shift.should == "    context.operate();"
+    lines.shift.should == "    context.lock();"
+    lines.shift.should == "  }"
+    lines.shift.should == ""
+  end
+
+  it "should add entry/exit actions to each transition" do
+    lines = find_lines_after(complex_turnstile_lines, "public static class LockedState extends State")
+
+    lines.shift.should == "  {"
+    lines.shift.should == "    public LockedState(JavaTurnstile statemachine)"
+    lines.shift.should == "    {"
+    lines.shift.should == "      super(statemachine);"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "    public void coin()"
+    lines.shift.should == "    {"
+    lines.shift.should == "      statemachine.setState(statemachine.UNLOCKED);"
+    lines.shift.should == "      statemachine.getContext().unlock();"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "    public void diagnose()"
+    lines.shift.should == "    {"
+    lines.shift.should == "      statemachine.getContext().beep();"
+    lines.shift.should == "      statemachine.setState(statemachine.DIAGNOSTICS);"
+    lines.shift.should == "      statemachine.getContext().disable();"
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "    public void pass()"
+    lines.shift.should == "    {"
+    lines.shift.should == "      statemachine.getContext().alarm();"
+    lines.shift.should == "      statemachine.setState(statemachine.LOCKED);"
+    lines.shift.should == "      statemachine.getContext().lock();"    # this has been added since my modifications don't know why'
+    lines.shift.should == "    }"
+    lines.shift.should == ""
+    lines.shift.should == "  }"
+  end
+
+end

data/spec/history_spec.rb

@@ -0,0 +1,107 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "History States" do
+
+  before(:each) do
+    @sm = Statemachine.build do
+      superstate :operate do
+        trans :on, :toggle, :off
+        trans :off, :toggle, :on
+        event :fiddle, :middle
+      end
+      trans :middle, :fiddle, :operate_H
+      trans :middle, :dream, :on_H
+      trans :middle, :faddle, :on
+      startstate :middle
+    end
+  end
+  
+  it "no history allowed for concrete states" do
+    lambda {
+        @sm.dream
+      }.should raise_error(Statemachine::StatemachineException, "No history exists for 'on' state since it is not a super state.")
+  end
+
+  it "error when trying to use history that doesn't exist yet" do
+    lambda {
+      @sm.fiddle
+      }.should raise_error(Statemachine::StatemachineException, "'operate' superstate doesn't have any history yet.")
+  end
+  
+  it "reseting the statemachine resets history" do
+    @sm.faddle
+    @sm.fiddle
+    @sm.get_state(:operate).history_id.should eql(:on)
+    
+    @sm.reset
+    @sm.get_state(:operate).history_id.should eql(nil)
+  end
+  
+end
+
+describe "History Default" do
+  
+  before(:each) do    
+    @sm = Statemachine.build do
+      superstate :operate do
+        trans :on, :toggle, :off
+        trans :off, :toggle, :on
+        event :fiddle, :middle
+        default_history :on
+      end
+      trans :middle, :fiddle, :operate_H
+      startstate :middle
+      trans :middle, :faddle, :on
+    end
+  end
+  
+  it "default history" do
+    @sm.fiddle
+    @sm.state.should eql(:on)
+  end
+  
+  it "reseting the statemachine resets history" do
+    @sm.faddle
+    @sm.toggle
+    @sm.fiddle
+    @sm.get_state(:operate).history_id.should eql(:off)
+    
+    @sm.reset
+    @sm.get_state(:operate).history_id.should eql(:on)
+  end
+
+end
+
+describe "Nested Superstates" do
+
+  before(:each) do
+    @sm = Statemachine.build do
+      
+      superstate :grandpa do
+        trans :start, :go, :daughter
+        event :sister, :great_auntie
+        
+        superstate :papa do
+          state :son
+          state :daughter
+        end
+      end
+      
+      state :great_auntie do
+        event :foo, :grandpa_H
+      end
+    
+    end
+  end
+  
+  it "should use history of sub superstates when transitioning itto it's own history" do
+    @sm.go
+    @sm.sister
+    @sm.foo
+    
+    @sm.state.should eql(:daughter)
+  end
+
+end
+
+