state_machine 0.1.0

data/test/unit/transition_test.rb

@@ -0,0 +1,298 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class TransitionTest < Test::Unit::TestCase
+  def setup
+    @machine = PluginAWeek::StateMachine::Machine.new(Switch, 'state', :initial => 'off')
+    @event = PluginAWeek::StateMachine::Event.new(@machine, 'turn_on')
+    @transition = PluginAWeek::StateMachine::Transition.new(@event, 'off', 'on')
+  end
+  
+  def test_should_have_a_from_state
+    assert_equal 'off', @transition.from_state
+  end
+  
+  def test_should_have_a_to_state
+    assert_equal 'on', @transition.to_state
+  end
+  
+  def test_should_not_be_a_loopback
+    assert !@transition.loopback?
+  end
+  
+  def test_should_not_be_able_to_perform_if_record_state_is_not_from_state
+    record = new_switch(:state => 'on')
+    assert !@transition.can_perform_on?(record)
+  end
+  
+  def test_should_be_able_to_perform_if_record_state_is_from_state
+    record = new_switch(:state => 'off')
+    assert @transition.can_perform_on?(record)
+  end
+end
+
+class TransitionWithoutFromStateTest < Test::Unit::TestCase
+  def setup
+    @machine = PluginAWeek::StateMachine::Machine.new(Switch, 'state', :initial => 'off')
+    @event = PluginAWeek::StateMachine::Event.new(@machine, 'turn_on')
+    @transition = PluginAWeek::StateMachine::Transition.new(@event, nil, 'on')
+  end
+  
+  def test_should_not_have_a_from_state
+    assert_nil @transition.from_state
+  end
+  
+  def test_should_be_able_to_perform_on_all_states
+    record = new_switch(:state => 'off')
+    assert @transition.can_perform_on?(record)
+    
+    record = new_switch(:state => 'on')
+    assert @transition.can_perform_on?(record)
+  end
+end
+
+class TransitionWithLoopbackTest < Test::Unit::TestCase
+  def setup
+    @machine = PluginAWeek::StateMachine::Machine.new(Switch, 'state', :initial => 'off')
+    @event = PluginAWeek::StateMachine::Event.new(@machine, 'turn_on')
+    @transition = PluginAWeek::StateMachine::Transition.new(@event, 'on', 'on')
+  end
+  
+  def test_should_have_a_from_state
+    assert_equal 'on', @transition.from_state
+  end
+  
+  def test_should_have_a_to_state
+    assert_equal 'on', @transition.to_state
+  end
+  
+  def test_should_be_a_loopback
+    assert @transition.loopback?
+  end
+  
+  def test_should_be_able_to_perform_if_record_is_in_from_state
+    record = new_switch(:state => 'on')
+    assert @transition.can_perform_on?(record)
+  end
+end
+
+class TransitionAfterBeingPerformedTest < Test::Unit::TestCase
+  def setup
+    @machine = PluginAWeek::StateMachine::Machine.new(Switch, 'state', :initial => 'off')
+    @event = PluginAWeek::StateMachine::Event.new(@machine, 'turn_on')
+    @transition = PluginAWeek::StateMachine::Transition.new(@event, 'off', 'on')
+    
+    @record = create_switch(:state => 'off')
+    @transition.perform(@record)
+    @record.reload
+  end
+  
+  def test_should_update_the_state_to_the_to_state
+    assert_equal 'on', @record.state
+  end
+  
+  def test_should_no_longer_be_able_to_perform_on_the_record
+    assert !@transition.can_perform_on?(@record)
+  end
+end
+
+class TransitionWithLoopbackAfterBeingPerformedTest < Test::Unit::TestCase
+  def setup
+    @machine = PluginAWeek::StateMachine::Machine.new(Switch, 'state', :initial => 'off')
+    @event = PluginAWeek::StateMachine::Event.new(@machine, 'turn_on')
+    @transition = PluginAWeek::StateMachine::Transition.new(@event, 'on', 'on')
+    
+    @record = create_switch(:state => 'on')
+    @transition.perform(@record)
+    @record.reload
+  end
+  
+  def test_should_not_update_the_attribute
+    assert_equal 'on', @record.state
+  end
+  
+  def test_should_still_be_able_to_perform_on_the_record
+    assert @transition.can_perform_on?(@record)
+  end
+end
+
+class TransitionWithCallbacksTest < Test::Unit::TestCase
+  def setup
+    @machine = PluginAWeek::StateMachine::Machine.new(Switch, 'state', :initial => 'off')
+    @event = PluginAWeek::StateMachine::Event.new(@machine, 'turn_on')
+    @transition = PluginAWeek::StateMachine::Transition.new(@event, 'off', 'on')
+    @record = create_switch(:state => 'off')
+    
+    Switch.define_callbacks :before_exit_state_off, :before_enter_state_on, :after_exit_state_off, :after_enter_state_on
+  end
+  
+  def test_should_not_perform_if_before_exit_callback_fails
+    Switch.before_exit_state_off Proc.new {|record| false}
+    Switch.before_enter_state_on Proc.new {|record| record.callbacks << 'before_enter'; true}
+    Switch.after_exit_state_off Proc.new {|record| record.callbacks << 'after_exit'; true}
+    Switch.after_enter_state_on Proc.new {|record| record.callbacks << 'after_enter'; true}
+    
+    assert !@transition.perform(@record)
+    assert_equal %w(), @record.callbacks
+  end
+  
+  def test_should_not_perform_if_before_enter_callback_fails
+    Switch.before_exit_state_off Proc.new {|record| record.callbacks << 'before_exit'; true}
+    Switch.before_enter_state_on Proc.new {|record| false}
+    Switch.after_exit_state_off Proc.new {|record| record.callbacks << 'after_exit'; true}
+    Switch.after_enter_state_on Proc.new {|record| record.callbacks << 'after_enter'; true}
+    
+    assert !@transition.perform(@record)
+    assert_equal %w(before_exit), @record.callbacks
+  end
+  
+  def test_should_not_perform_if_after_exit_callback_fails
+    Switch.before_exit_state_off Proc.new {|record| record.callbacks << 'before_exit'; true}
+    Switch.before_enter_state_on Proc.new {|record| record.callbacks << 'before_enter'; true}
+    Switch.after_exit_state_off Proc.new {|record| false}
+    Switch.after_enter_state_on Proc.new {|record| record.callbacks << 'after_enter'; true}
+    
+    assert !@transition.perform(@record)
+    assert_equal %w(before_exit before_enter), @record.callbacks
+  end
+  
+  def test_should_not_perform_if_after_enter_callback_fails
+    Switch.before_exit_state_off Proc.new {|record| record.callbacks << 'before_exit'; true}
+    Switch.before_enter_state_on Proc.new {|record| record.callbacks << 'before_enter'; true}
+    Switch.after_exit_state_off Proc.new {|record| record.callbacks << 'after_exit'; true}
+    Switch.after_enter_state_on Proc.new {|record| false}
+    
+    assert !@transition.perform(@record)
+    assert_equal %w(before_exit before_enter after_exit), @record.callbacks
+  end
+  
+  def test_should_perform_if_all_callbacks_are_successful
+    Switch.before_exit_state_off Proc.new {|record| record.callbacks << 'before_exit'; true}
+    Switch.before_enter_state_on Proc.new {|record| record.callbacks << 'before_enter'; true}
+    Switch.after_exit_state_off Proc.new {|record| record.callbacks << 'after_exit'; true}
+    Switch.after_enter_state_on Proc.new {|record| record.callbacks << 'after_enter'; true}
+    
+    assert @transition.perform(@record)
+    assert_equal %w(before_exit before_enter after_exit after_enter), @record.callbacks
+  end
+  
+  def teardown
+    Switch.class_eval do
+      @before_exit_state_off_callbacks = nil
+      @before_enter_state_on_callbacks = nil
+      @after_exit_state_off_callbacks = nil
+      @after_enter_state_on_callbacks = nil
+    end
+  end
+end
+
+class TransitionWithoutFromStateAndCallbacksTest < Test::Unit::TestCase
+  def setup
+    @machine = PluginAWeek::StateMachine::Machine.new(Switch, 'state', :initial => 'off')
+    @event = PluginAWeek::StateMachine::Event.new(@machine, 'turn_on')
+    @transition = PluginAWeek::StateMachine::Transition.new(@event, nil, 'on')
+    @record = create_switch(:state => 'off')
+    
+    Switch.define_callbacks :before_exit_state_off, :before_enter_state_on, :after_exit_state_off, :after_enter_state_on
+  end
+  
+  def test_should_not_perform_if_before_exit_callback_fails
+    Switch.before_exit_state_off Proc.new {|record| false}
+    Switch.before_enter_state_on Proc.new {|record| record.callbacks << 'before_enter'; true}
+    Switch.after_exit_state_off Proc.new {|record| record.callbacks << 'after_exit'; true}
+    Switch.after_enter_state_on Proc.new {|record| record.callbacks << 'after_enter'; true}
+    
+    assert !@transition.perform(@record)
+    assert_equal %w(), @record.callbacks
+  end
+  
+  def test_should_not_perform_if_before_enter_callback_fails
+    Switch.before_exit_state_off Proc.new {|record| record.callbacks << 'before_exit'; true}
+    Switch.before_enter_state_on Proc.new {|record| false}
+    Switch.after_exit_state_off Proc.new {|record| record.callbacks << 'after_exit'; true}
+    Switch.after_enter_state_on Proc.new {|record| record.callbacks << 'after_enter'; true}
+    
+    assert !@transition.perform(@record)
+    assert_equal %w(before_exit), @record.callbacks
+  end
+  
+  def test_should_not_perform_if_after_exit_callback_fails
+    Switch.before_exit_state_off Proc.new {|record| record.callbacks << 'before_exit'; true}
+    Switch.before_enter_state_on Proc.new {|record| record.callbacks << 'before_enter'; true}
+    Switch.after_exit_state_off Proc.new {|record| false}
+    Switch.after_enter_state_on Proc.new {|record| record.callbacks << 'after_enter'; true}
+    
+    assert !@transition.perform(@record)
+    assert_equal %w(before_exit before_enter), @record.callbacks
+  end
+  
+  def test_should_not_perform_if_after_enter_callback_fails
+    Switch.before_exit_state_off Proc.new {|record| record.callbacks << 'before_exit'; true}
+    Switch.before_enter_state_on Proc.new {|record| record.callbacks << 'before_enter'; true}
+    Switch.after_exit_state_off Proc.new {|record| record.callbacks << 'after_exit'; true}
+    Switch.after_enter_state_on Proc.new {|record| false}
+    
+    assert !@transition.perform(@record)
+    assert_equal %w(before_exit before_enter after_exit), @record.callbacks
+  end
+  
+  def test_should_perform_if_all_callbacks_are_successful
+    Switch.before_exit_state_off Proc.new {|record| record.callbacks << 'before_exit'; true}
+    Switch.before_enter_state_on Proc.new {|record| record.callbacks << 'before_enter'; true}
+    Switch.after_exit_state_off Proc.new {|record| record.callbacks << 'after_exit'; true}
+    Switch.after_enter_state_on Proc.new {|record| record.callbacks << 'after_enter'; true}
+    
+    assert @transition.perform(@record)
+    assert_equal %w(before_exit before_enter after_exit after_enter), @record.callbacks
+  end
+  
+  def teardown
+    Switch.class_eval do
+      @before_exit_state_off_callbacks = nil
+      @before_enter_state_on_callbacks = nil
+      @after_exit_state_off_callbacks = nil
+      @after_enter_state_on_callbacks = nil
+    end
+  end
+end
+
+class TransitionWithLoopbackAndCallbacksTest < Test::Unit::TestCase
+  def setup
+    @machine = PluginAWeek::StateMachine::Machine.new(Switch, 'state', :initial => 'off')
+    @event = PluginAWeek::StateMachine::Event.new(@machine, 'turn_on')
+    @transition = PluginAWeek::StateMachine::Transition.new(@event, 'on', 'on')
+    @record = create_switch(:state => 'on')
+    
+    Switch.define_callbacks :before_exit_state_off, :before_enter_state_on, :after_exit_state_off, :after_enter_state_on
+    Switch.before_exit_state_off Proc.new {|record| record.callbacks << 'before_exit'; true}
+    Switch.before_enter_state_on Proc.new {|record| record.callbacks << 'before_enter'; true}
+    Switch.after_exit_state_off Proc.new {|record| record.callbacks << 'after_exit'; true}
+    Switch.after_enter_state_on Proc.new {|record| record.callbacks << 'after_enter'; true}
+    
+    assert @transition.perform(@record)
+  end
+  
+  def test_should_not_run_before_exit_callbacks
+    assert !@record.callbacks.include?('before_exit')
+  end
+  
+  def test_should_not_run_before_enter_callbacks
+    assert !@record.callbacks.include?('before_enter')
+  end
+  
+  def test_should_not_run_after_exit_callbacks
+    assert !@record.callbacks.include?('after_exit')
+  end
+  
+  def test_should_not_run_after_enter_callbacks
+    assert !@record.callbacks.include?('after_enter')
+  end
+  
+  def teardown
+    Switch.class_eval do
+      @before_exit_state_off_callbacks = nil
+      @before_enter_state_on_callbacks = nil
+      @after_exit_state_off_callbacks = nil
+      @after_enter_state_on_callbacks = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: state_machine
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Pfeifer
+autorequire: state_machine
+bindir: bin
+cert_chain: []
+
+date: 2008-05-05 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: aaron@pluginaweek.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/state_machine.rb
+- lib/state_machine
+- lib/state_machine/machine.rb
+- lib/state_machine/event.rb
+- lib/state_machine/transition.rb
+- test/factory.rb
+- test/app_root
+- test/app_root/db
+- test/app_root/db/migrate
+- test/app_root/db/migrate/004_create_vehicles.rb
+- test/app_root/db/migrate/003_create_highways.rb
+- test/app_root/db/migrate/002_create_auto_shops.rb
+- test/app_root/db/migrate/001_create_switches.rb
+- test/app_root/app
+- test/app_root/app/models
+- test/app_root/app/models/auto_shop.rb
+- test/app_root/app/models/switch.rb
+- test/app_root/app/models/vehicle.rb
+- test/app_root/app/models/motorcycle.rb
+- test/app_root/app/models/toggle_switch.rb
+- test/app_root/app/models/car.rb
+- test/app_root/app/models/highway.rb
+- test/functional
+- test/functional/state_machine_test.rb
+- test/test_helper.rb
+- test/unit
+- test/unit/event_test.rb
+- test/unit/machine_test.rb
+- test/unit/transition_test.rb
+- test/unit/state_machine_test.rb
+- CHANGELOG
+- init.rb
+- MIT-LICENSE
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://www.pluginaweek.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: Adds support for creating state machines for attributes within a model
+test_files: 
+- test/functional/state_machine_test.rb
+- test/unit/event_test.rb
+- test/unit/machine_test.rb
+- test/unit/transition_test.rb
+- test/unit/state_machine_test.rb