state_machine 1.0.1 → 1.0.2

data/test/unit/state_context_test.rb

@@ -0,0 +1,421 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class Validateable
+  class << self
+    def validate(*args, &block)
+      args << block if block_given?
+      args
+    end
+  end
+end
+
+class StateContextTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(Validateable)
+    @machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    @state = @machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(@state)
+  end
+  
+  def test_should_have_a_machine
+    assert_equal @machine, @state_context.machine
+  end
+  
+  def test_should_have_a_state
+    assert_equal @state, @state_context.state
+  end
+end
+
+class StateContextTransitionTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new
+    @machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    @state = @machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(@state)
+  end
+  
+  def test_should_not_allow_except_to
+    exception = assert_raise(ArgumentError) { @state_context.transition(:except_to => :idling) }
+    assert_equal 'Invalid key(s): except_to', exception.message
+  end
+  
+  def test_should_not_allow_from
+    exception = assert_raise(ArgumentError) { @state_context.transition(:from => :idling) }
+    assert_equal 'Invalid key(s): from', exception.message
+  end
+  
+  def test_should_not_allow_except_from
+    exception = assert_raise(ArgumentError) { @state_context.transition(:except_from => :idling) }
+    assert_equal 'Invalid key(s): except_from', exception.message
+  end
+  
+  def test_should_not_allow_implicit_transitions
+    exception = assert_raise(ArgumentError) { @state_context.transition(:parked => :idling) }
+    assert_equal 'Invalid key(s): parked', exception.message
+  end
+  
+  def test_should_not_allow_except_on
+    exception = assert_raise(ArgumentError) { @state_context.transition(:except_on => :park) }
+    assert_equal 'Invalid key(s): except_on', exception.message
+  end
+  
+  def test_should_require_on_event
+    exception = assert_raise(ArgumentError) { @state_context.transition(:to => :idling) }
+    assert_equal 'Must specify :to state and :on event', exception.message
+  end
+  
+  def test_should_require_to_state
+    exception = assert_raise(ArgumentError) { @state_context.transition(:on => :ignite) }
+    assert_equal 'Must specify :to state and :on event', exception.message
+  end
+  
+  def test_should_automatically_set_from_option
+    branch = @state_context.transition(:to => :idling, :on => :ignite)
+    assert_instance_of StateMachine::Branch, branch
+    
+    state_requirements = branch.state_requirements
+    assert_equal 1, state_requirements.length
+    
+    from_requirement = state_requirements[0][:from]
+    assert_instance_of StateMachine::WhitelistMatcher, from_requirement
+    assert_equal [:parked], from_requirement.values
+  end
+  
+  def test_should_allow_if_condition
+    assert_nothing_raised {@state_context.transition(:to => :idling, :on => :park, :if => :seatbelt_on?)}
+  end
+  
+  def test_should_allow_unless_condition
+    assert_nothing_raised {@state_context.transition(:to => :idling, :on => :park, :unless => :seatbelt_off?)}
+  end
+  
+  def test_should_include_all_transition_states_in_machine_states
+    @state_context.transition(:to => :idling, :on => :ignite)
+    
+    assert_equal [:parked, :idling], @machine.states.map {|state| state.name}
+  end
+  
+  def test_should_include_all_transition_events_in_machine_events
+    @state_context.transition(:to => :idling, :on => :ignite)
+    
+    assert_equal [:ignite], @machine.events.map {|event| event.name}
+  end
+  
+  def test_should_allow_multiple_events
+    @state_context.transition(:to => :idling, :on => [:ignite, :shift_up])
+    
+    assert_equal [:ignite, :shift_up], @machine.events.map {|event| event.name}
+  end
+end
+
+class StateContextWithMatchingTransitionTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new
+    @machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    @state = @machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(@state)
+    @state_context.transition(:to => :idling, :on => :ignite)
+    
+    @event = @machine.event(:ignite)
+    @object = @klass.new
+  end
+  
+  def test_should_be_able_to_fire
+    assert @event.can_fire?(@object)
+  end
+  
+  def test_should_have_a_transition
+    transition = @event.transition_for(@object)
+    assert_not_nil transition
+    assert_equal 'parked', transition.from
+    assert_equal 'idling', transition.to
+    assert_equal :ignite, transition.event
+  end
+end
+
+class StateContextProxyTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(Validateable)
+    machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    state = machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(state)
+  end
+  
+  def test_should_call_class_with_same_arguments
+    options = {}
+    validation = @state_context.validate(:name, options)
+    
+    assert_equal [:name, options], validation
+  end
+  
+  def test_should_pass_block_through_to_class
+    options = {}
+    proxy_block = lambda {}
+    validation = @state_context.validate(:name, options, &proxy_block)
+    
+    assert_equal [:name, options, proxy_block], validation
+  end
+end
+
+class StateContextProxyWithoutConditionsTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(Validateable)
+    machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    state = machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(state)
+    @object = @klass.new
+    
+    @options = @state_context.validate[0]
+  end
+  
+  def test_should_have_options_configuration
+    assert_instance_of Hash, @options
+  end
+  
+  def test_should_have_if_option
+    assert_not_nil @options[:if]
+  end
+  
+  def test_should_be_false_if_state_is_different
+    @object.state = nil
+    assert !@options[:if].call(@object)
+  end
+  
+  def test_should_be_true_if_state_matches
+    assert @options[:if].call(@object)
+  end
+end
+
+class StateContextProxyWithIfConditionTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(Validateable)
+    machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    state = machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(state)
+    @object = @klass.new
+    
+    @condition_result = nil
+    @options = @state_context.validate(:if => lambda {@condition_result})[0]
+  end
+  
+  def test_should_have_if_option
+    assert_not_nil @options[:if]
+  end
+  
+  def test_should_be_false_if_state_is_different
+    @object.state = nil
+    assert !@options[:if].call(@object)
+  end
+  
+  def test_should_be_false_if_original_condition_is_false
+    @condition_result = false
+    assert !@options[:if].call(@object)
+  end
+  
+  def test_should_be_true_if_state_matches_and_original_condition_is_true
+    @condition_result = true
+    assert @options[:if].call(@object)
+  end
+  
+  def test_should_evaluate_symbol_condition
+    @klass.class_eval do
+      attr_accessor :callback
+    end
+    
+    options = @state_context.validate(:if => :callback)[0]
+    
+    object = @klass.new
+    object.callback = false
+    assert !options[:if].call(object)
+    
+    object.callback = true
+    assert options[:if].call(object)
+  end
+  
+  def test_should_evaluate_string_condition
+    @klass.class_eval do
+      attr_accessor :callback
+    end
+    
+    options = @state_context.validate(:if => '@callback')[0]
+    
+    object = @klass.new
+    object.callback = false
+    assert !options[:if].call(object)
+    
+    object.callback = true
+    assert options[:if].call(object)
+  end
+end
+
+class StateContextProxyWithMultipleIfConditionsTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(Validateable)
+    machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    state = machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(state)
+    @object = @klass.new
+    
+    @first_condition_result = nil
+    @second_condition_result = nil
+    @options = @state_context.validate(:if => [lambda {@first_condition_result}, lambda {@second_condition_result}])[0]
+  end
+  
+  def test_should_be_true_if_all_conditions_are_true
+    @first_condition_result = true
+    @second_condition_result = true
+    assert @options[:if].call(@object)
+  end
+  
+  def test_should_be_false_if_any_condition_is_false
+    @first_condition_result = true
+    @second_condition_result = false
+    assert !@options[:if].call(@object)
+    
+    @first_condition_result = false
+    @second_condition_result = true
+    assert !@options[:if].call(@object)
+  end
+end
+
+class StateContextProxyWithUnlessConditionTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(Validateable)
+    machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    state = machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(state)
+    @object = @klass.new
+    
+    @condition_result = nil
+    @options = @state_context.validate(:unless => lambda {@condition_result})[0]
+  end
+  
+  def test_should_have_if_option
+    assert_not_nil @options[:if]
+  end
+  
+  def test_should_be_false_if_state_is_different
+    @object.state = nil
+    assert !@options[:if].call(@object)
+  end
+  
+  def test_should_be_false_if_original_condition_is_true
+    @condition_result = true
+    assert !@options[:if].call(@object)
+  end
+  
+  def test_should_be_true_if_state_matches_and_original_condition_is_false
+    @condition_result = false
+    assert @options[:if].call(@object)
+  end
+  
+  def test_should_evaluate_symbol_condition
+    @klass.class_eval do
+      attr_accessor :callback
+    end
+    
+    options = @state_context.validate(:unless => :callback)[0]
+    
+    object = @klass.new
+    object.callback = true
+    assert !options[:if].call(object)
+    
+    object.callback = false
+    assert options[:if].call(object)
+  end
+  
+  def test_should_evaluate_string_condition
+    @klass.class_eval do
+      attr_accessor :callback
+    end
+    
+    options = @state_context.validate(:unless => '@callback')[0]
+    
+    object = @klass.new
+    object.callback = true
+    assert !options[:if].call(object)
+    
+    object.callback = false
+    assert options[:if].call(object)
+  end
+end
+
+class StateContextProxyWithMultipleUnlessConditionsTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(Validateable)
+    machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    state = machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(state)
+    @object = @klass.new
+    
+    @first_condition_result = nil
+    @second_condition_result = nil
+    @options = @state_context.validate(:unless => [lambda {@first_condition_result}, lambda {@second_condition_result}])[0]
+  end
+  
+  def test_should_be_true_if_all_conditions_are_false
+    @first_condition_result = false
+    @second_condition_result = false
+    assert @options[:if].call(@object)
+  end
+  
+  def test_should_be_false_if_any_condition_is_true
+    @first_condition_result = true
+    @second_condition_result = false
+    assert !@options[:if].call(@object)
+    
+    @first_condition_result = false
+    @second_condition_result = true
+    assert !@options[:if].call(@object)
+  end
+end
+
+class StateContextProxyWithIfAndUnlessConditionsTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(Validateable)
+    machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    state = machine.state :parked
+    
+    @state_context = StateMachine::StateContext.new(state)
+    @object = @klass.new
+    
+    @if_condition_result = nil
+    @unless_condition_result = nil
+    @options = @state_context.validate(:if => lambda {@if_condition_result}, :unless => lambda {@unless_condition_result})[0]
+  end
+  
+  def test_should_be_false_if_if_condition_is_false
+    @if_condition_result = false
+    @unless_condition_result = false
+    assert !@options[:if].call(@object)
+    
+    @if_condition_result = false
+    @unless_condition_result = true
+    assert !@options[:if].call(@object)
+  end
+  
+  def test_should_be_false_if_unless_condition_is_true
+    @if_condition_result = false
+    @unless_condition_result = true
+    assert !@options[:if].call(@object)
+    
+    @if_condition_result = true
+    @unless_condition_result = true
+    assert !@options[:if].call(@object)
+  end
+  
+  def test_should_be_true_if_if_condition_is_true_and_unless_condition_is_false
+    @if_condition_result = true
+    @unless_condition_result = false
+    assert @options[:if].call(@object)
+  end
+end

data/test/unit/state_test.rb

@@ -561,6 +561,25 @@ class StateWithConflictingMachineTest < Test::Unit::TestCase
   end
 end
 
+class StateWithConflictingMachineNameTest < Test::Unit::TestCase
+  def setup
+    require 'stringio'
+    @original_stderr, $stderr = $stderr, StringIO.new
+    
+    @klass = Class.new
+    @state_machine = StateMachine::Machine.new(@klass, :state)
+  end
+  
+  def test_should_output_warning_if_name_conflicts
+    StateMachine::State.new(@state_machine, :state)
+    assert_equal "Instance method \"state?\" is already defined in #{@klass} :state instance helpers, use generic helper instead.\n", $stderr.string
+  end
+  
+  def teardown
+    $stderr = @original_stderr
+  end
+end
+
 class StateWithNamespaceTest < Test::Unit::TestCase
   def setup
     @klass = Class.new
@@ -794,8 +813,6 @@ end
 
 begin
   # Load library
-  require 'rubygems'
-  gem 'ruby-graphviz', '>=0.9.0'
   require 'graphviz'
   
   class StateDrawingTest < Test::Unit::TestCase
@@ -921,4 +938,4 @@ begin
   end
 rescue LoadError
   $stderr.puts 'Skipping GraphViz StateMachine::State tests. `gem install ruby-graphviz` >= v0.9.0 and try again.'
-end
+end unless ENV['TRAVIS']