state_machine 0.7.4 → 0.7.5

data/CHANGELOG.rdoc

@@ -1,5 +1,13 @@
 == master
 
+== 0.7.5 / 2009-05-25
+
+* Add built-in caching for dynamic state values when the value only needs to be generated once
+* Fix flawed example for using record ids as state values
+* Don't evaluate state values until they're actually used in an object instance
+* Make it easier to use event attributes for actions defined in the same class as the state machine
+* Fix #save/save! running transitions in ActiveRecord integrations even when a machine's action is not :save
+
 == 0.7.4 / 2009-05-23
 
 * Fix #save! not firing event attributes properly in ActiveRecord integrations

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'state_machine'
-  s.version           = '0.7.4'
+  s.version           = '0.7.5'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Adds support for creating state machines for attributes on any Ruby class'
   s.description       = s.summary

data/lib/state_machine/integrations/active_record.rb

@@ -327,12 +327,16 @@ module StateMachine
         
         # Adds hooks into validation for automatically firing events
         def define_action_helpers
-          if super(:create_or_update) && action == :save
-            @instance_helper_module.class_eval do
-              define_method(:valid?) do |*args|
-                self.class.state_machines.fire_attribute_events(self, :save, false) { super(*args) }
+          if action == :save
+            if super(:create_or_update)
+              @instance_helper_module.class_eval do
+                define_method(:valid?) do |*args|
+                  self.class.state_machines.fire_event_attributes(self, :save, false) { super(*args) }
+                end
               end
             end
+          else
+            super
           end
         end
         

data/lib/state_machine/integrations/data_mapper.rb

@@ -287,7 +287,7 @@ module StateMachine
           if super && action == :save && supports_validations?
             @instance_helper_module.class_eval do
               define_method(:valid?) do |*args|
-                self.class.state_machines.fire_attribute_events(self, :save, false) { super(*args) }
+                self.class.state_machines.fire_event_attributes(self, :save, false) { super(*args) }
               end
             end
           end

data/lib/state_machine/integrations/sequel.rb

@@ -253,7 +253,7 @@ module StateMachine
           if super && action == :save
             @instance_helper_module.class_eval do
               define_method(:valid?) do |*args|
-                self.class.state_machines.fire_attribute_events(self, :save, false) { super(*args) }
+                self.class.state_machines.fire_event_attributes(self, :save, false) { super(*args) }
               end
             end
           end

data/lib/state_machine/machine.rb

@@ -69,6 +69,46 @@ module StateMachine
   # fails.  *Note* that this will also be the case if an exception is raised
   # while calling the action.
   # 
+  # === Indirect transitions
+  # 
+  # In addition to the action being run as the _result_ of an event, the action
+  # can also be used to run events itself.  For example, using the above as an
+  # example:
+  # 
+  #   vehicle = Vehicle.new           # => #<Vehicle:0xb7c27024 @state="parked">
+  #   
+  #   vehicle.state_event = 'ignite'
+  #   vehicle.save                    # => true
+  #   vehicle.state                   # => "idling"
+  #   vehicle.state_event             # => nil
+  # 
+  # As can be seen, the +save+ action automatically invokes the event stored in
+  # the +state_event+ attribute (<tt>:ignite</tt> in this case).
+  # 
+  # One important note about using this technique for running transitions is
+  # that if the class in which the state machine is defined *also* defines the
+  # action being invoked (and not a superclass), then it must manually run the
+  # StateMachine hook that checks for event attributes.
+  # 
+  # For example, in ActiveRecord, DataMapper, and Sequel, the default action
+  # (+save+) is already defined in a base class.  As a result, when a state
+  # machine is defined in a model / resource, StateMachine can automatically
+  # hook into the +save+ action.
+  # 
+  # On the other hand, the Vehicle class from above defined its own +save+
+  # method (and there is no +save+ method in its superclass).  As a result, it
+  # must be modified like so:
+  # 
+  #     def save
+  #       self.class.state_machines.fire_event_attributes(self, :save) do
+  #         @saving_state = state
+  #         fail != true
+  #       end
+  #     end
+  # 
+  # This will add in the functionality for firing the event stored in the
+  # +state_event+ attribute.
+  # 
   # == Callbacks
   # 
   # Callbacks are supported for hooking before and after every possible
@@ -527,6 +567,8 @@ module StateMachine
     # Configuration options:
     # * <tt>:value</tt> - The actual value to store when an object transitions
     #   to the state.  Default is the name (stringified).
+    # * <tt>:cache</tt> - If a dynamic value (via a lambda block) is being used,
+    #   then setting this to true will cache the evaluated result
     # * <tt>:if</tt> - Determines whether an object's value matches the state
     #   (e.g. :value => lambda {Time.now}, :if => lambda {|state| !state.nil?}).
     #   By default, the configured value is matched.
@@ -579,12 +621,31 @@ module StateMachine
     #         transition :parked => :idling
     #       end
     #       
-    #       states.each {|state| self.state(state.name, :value => VehicleState.find_by_name(state.name.to_s).id)}
+    #       states.each do |state|
+    #         self.state(state.name, :value => lambda { VehicleState.find_by_name(state.name.to_s).id }, :cache => true)
+    #       end
     #     end
     #   end
     # 
     # In the above example, each known state is configured to store it's
-    # associated database id in the +state_id+ attribute.
+    # associated database id in the +state_id+ attribute.  Also, notice that a
+    # lambda block is used to define the state's value.  This is required in
+    # situations (like testing) where the model is loaded without any existing
+    # data (i.e. no VehicleState records available).
+    # 
+    # One caveat to the above example is to keep performance in mind.  To avoid
+    # constant db hits for looking up the VehicleState ids, the value is cached
+    # by specifying the <tt>:cache</tt> option.  Alternatively, a custom
+    # caching strategy can be used like so:
+    # 
+    #   class VehicleState < ActiveRecord::Base
+    #     cattr_accessor :cache_store
+    #     self.cache_store = ActiveSupport::Cache::MemoryStore.new
+    #     
+    #     def self.find_by_name(name)
+    #       cache_store.fetch(name) { find(:first, :conditions => {:name => name}) }
+    #     end
+    #   end
     # 
     # === Dynamic values
     # 
@@ -745,7 +806,7 @@ module StateMachine
     # options hash which contains at least <tt>:if</tt> condition support.
     def state(*names, &block)
       options = names.last.is_a?(Hash) ? names.pop : {}
-      assert_valid_keys(options, :value, :if)
+      assert_valid_keys(options, :value, :cache, :if)
       
       states = add_states(names)
       states.each do |state|
@@ -754,6 +815,7 @@ module StateMachine
           self.states.update(state)
         end
         
+        state.cache = options[:cache] if options.include?(:cache)
         state.matcher = options[:if] if options.include?(:if)
         state.context(&block) if block_given?
       end
@@ -1277,9 +1339,7 @@ module StateMachine
           @instance_helper_module.class_eval do
             # Override the default action to invoke the before / after hooks
             define_method(action_hook) do |*args|
-              value = nil
-              result = self.class.state_machines.fire_attribute_events(self, action) { value = super(*args) }
-              value.nil? ? result : value
+              self.class.state_machines.fire_event_attributes(self, action) { super(*args) }
             end
             
             private action_hook if private_method

data/lib/state_machine/machine_collection.rb

@@ -44,12 +44,12 @@ module StateMachine
       end
     end
     
-    # Runs one or more attribute events in parallel during the invocation of
+    # Runs one or more event attributes in parallel during the invocation of
     # an action on the given object.  After transition callbacks can be
     # optionally disabled if the events are being only partially fired (for
     # example, when validating records in ORM integrations).
     # 
-    # The attribute events that will be fired are based on which machines
+    # The event attributes that will be fired are based on which machines
     # match the action that is being invoked.
     # 
     # == Examples
@@ -77,7 +77,7 @@ module StateMachine
     #   vehicle.state_event = 'ignite'
     #   vehicle.alarm_state_event = 'disable'
     #   
-    #   Vehicle.state_machines.fire_attribute_events(vehicle, :save) { true }
+    #   Vehicle.state_machines.fire_event_attributes(vehicle, :save) { true }
     #   vehicle.state                                 # => "idling"
     #   vehicle.state_event                           # => nil
     #   vehicle.alarm_state                           # => "off"
@@ -89,7 +89,7 @@ module StateMachine
     #   vehicle.state_event = 'park'
     #   vehicle.alarm_state_event = 'disable'
     #   
-    #   Vehicle.state_machines.fire_attribute_events(vehicle, :save) { true }
+    #   Vehicle.state_machines.fire_event_attributes(vehicle, :save) { true }
     #   vehicle.state                                 # => "parked"
     #   vehicle.state_event                           # => nil
     #   vehicle.alarm_state                           # => "active"
@@ -101,22 +101,25 @@ module StateMachine
     #   vehicle = Vehicle.create                      # => #<Vehicle id=1 state="parked" alarm_state="active">
     #   vehicle.state_event = 'ignite'
     #   
-    #   Vehicle.state_machines.fire_attribute_events(vehicle, :save, false) { true }
+    #   Vehicle.state_machines.fire_event_attributes(vehicle, :save, false) { true }
     #   vehicle.state                                 # => "idling"
     #   vehicle.state_event                           # => "ignite"
     #   vehicle.state_event_transition                # => #<StateMachine::Transition attribute=:state event=:ignite from="parked" from_name=:parked to="idling" to_name=:idling>
-    def fire_attribute_events(object, action, complete = true)
+    def fire_event_attributes(object, action, complete = true)
       # Get the transitions to fire for each applicable machine
       transitions = map {|attribute, machine| machine.action == action ? machine.events.attribute_transition_for(object, true) : nil}.compact
       return yield if transitions.empty?
       
+      # The value generated by the yielded block (the actual action)
+      action_value = nil
+      
       # Make sure all events were valid
       if result = transitions.all? {|transition| transition != false}
         begin
           result = Transition.perform(transitions, :after => complete) do
             # Prevent events from being evaluated multiple times if actions are nested
             transitions.each {|transition| object.send("#{transition.attribute}_event=", nil)}
-            yield
+            action_value = yield
           end
         rescue Exception
           # Revert attribute modifications
@@ -139,7 +142,7 @@ module StateMachine
         end
       end
       
-      result
+      action_value.nil? ? result : action_value
     end
   end
 end

data/lib/state_machine/node_collection.rb

@@ -58,7 +58,7 @@ module StateMachine
     # the configured indices.
     def <<(node)
       @nodes << node
-      @indices.each {|attribute, index| index[node.send(attribute)] = node}
+      @indices.each {|attribute, index| index[value(node, attribute)] = node}
       self
     end
     
@@ -68,7 +68,7 @@ module StateMachine
     def update(node)
       @indices.each do |attribute, index|
         old_key = RUBY_VERSION < '1.9' ? index.index(node) : index.key(node)
-        new_key = node.send(attribute)
+        new_key = value(node, attribute)
         
         # Only replace the key if it's changed
         if old_key != new_key
@@ -143,5 +143,10 @@ module StateMachine
         raise ArgumentError, 'No indices configured' unless @indices.any?
         @indices[name] || raise(ArgumentError, "Invalid index: #{name.inspect}")
       end
+      
+      # Gets the value for the given attribute on the node
+      def value(node, attribute)
+        node.send(attribute)
+      end
   end
 end

data/lib/state_machine/state.rb

@@ -27,6 +27,9 @@ module StateMachine
     # transitions into this state
     attr_writer :value
     
+    # Whether this state's value should be cached after being evaluated
+    attr_accessor :cache
+    
     # Whether or not this state is the initial state to use for new objects
     attr_accessor :initial
     alias_method :initial?, :initial
@@ -48,16 +51,19 @@ module StateMachine
     #   machine. Default is false.
     # * <tt>:value</tt> - The value to store when an object transitions to this
     #   state.  Default is the name (stringified).
+    # * <tt>:cache</tt> - If a dynamic value (via a lambda block) is being used,
+    #   then setting this to true will cache the evaluated result
     # * <tt>:if</tt> - Determines whether a value matches this state
     #   (e.g. :value => lambda {Time.now}, :if => lambda {|state| !state.nil?}).
     #   By default, the configured value is matched.
     def initialize(machine, name, options = {}) #:nodoc:
-      assert_valid_keys(options, :initial, :value, :if)
+      assert_valid_keys(options, :initial, :value, :cache, :if)
       
       @machine = machine
       @name = name
       @qualified_name = name && machine.namespace ? :"#{machine.namespace}_#{name}" : name
       @value = options.include?(:value) ? options[:value] : name && name.to_s
+      @cache = options[:cache]
       @matcher = options[:if]
       @methods = {}
       @initial = options[:initial] == true
@@ -101,16 +107,25 @@ module StateMachine
       description
     end
     
-    # The value that represents this state.  If the value is a lambda block,
-    # then it will be evaluated at this time.  Otherwise, the static value is
+    # The value that represents this state.  This will optionally evaluate the
+    # original block if it's a lambda block.  Otherwise, the static value is
     # returned.
     # 
     # For example,
     # 
-    #   State.new(machine, :parked, :value => 1).value                  # => 1
-    #   State.new(machine, :parked, :value => lambda {Time.now}).value  # => Tue Jan 01 00:00:00 UTC 2008
-    def value
-      @value.is_a?(Proc) ? @value.call : @value
+    #   State.new(machine, :parked, :value => 1).value                        # => 1
+    #   State.new(machine, :parked, :value => lambda {Time.now}).value        # => Tue Jan 01 00:00:00 UTC 2008
+    #   State.new(machine, :parked, :value => lambda {Time.now}).value(false) # => <Proc:0xb6ea7ca0@...>
+    def value(eval = true)
+      if @value.is_a?(Proc) && eval
+        if cache_value?
+          instance_variable_defined?('@cached_value') ? @cached_value : @cached_value = @value.call
+        else
+          @value.call
+        end
+      else
+        @value
+      end
     end
     
     # Determines whether this state matches the given value.  If no matcher is
@@ -213,6 +228,11 @@ module StateMachine
     end
     
     private
+      # Should the value be cached after it's evaluated for the first time?
+      def cache_value?
+        @cache
+      end
+      
       # Adds a predicate method to the owner class so long as a name has
       # actually been configured for the state
       def add_predicate

data/lib/state_machine/state_collection.rb

@@ -102,5 +102,11 @@ module StateMachine
       order.map! {|name| self[name]}
       order
     end
+    
+    private
+      # Gets the value for the given attribute on the node
+      def value(node, attribute)
+        attribute == :value ? node.value(false) : super
+      end
   end
 end

data/test/unit/integrations/active_record_test.rb

@@ -86,7 +86,8 @@ begin
       def setup
         @model = new_model
         @machine = StateMachine::Machine.new(@model)
-        @machine.state :parked, :idling, :first_gear
+        @machine.state :parked, :first_gear
+        @machine.state :idling, :value => lambda {'idling'}
       end
       
       def test_should_create_singular_with_scope
@@ -686,7 +687,7 @@ begin
       end
       
       def test_should_be_successful_if_event_has_transition
-        assert @record.save!
+        assert_equal true, @record.save!
       end
       
       def test_should_run_before_callbacks
@@ -711,6 +712,45 @@ begin
       end
     end
     
+    class MachineWithEventAttributesOnCustomActionTest < ActiveRecord::TestCase
+      def setup
+        @superclass = new_model do
+          def persist
+            create_or_update
+          end
+        end
+        @model = Class.new(@superclass)
+        @machine = StateMachine::Machine.new(@model, :action => :persist)
+        @machine.event :ignite do
+          transition :parked => :idling
+        end
+        
+        @record = @model.new
+        @record.state = 'parked'
+        @record.state_event = 'ignite'
+      end
+      
+      def test_should_not_transition_on_valid?
+        @record.valid?
+        assert_equal 'parked', @record.state
+      end
+      
+      def test_should_not_transition_on_save
+        @record.save
+        assert_equal 'parked', @record.state
+      end
+      
+      def test_should_not_transition_on_save!
+        @record.save!
+        assert_equal 'parked', @record.state
+      end
+      
+      def test_should_transition_on_custom_action
+        @record.persist
+        assert_equal 'idling', @record.state
+      end
+    end
+    
     class MachineWithObserversTest < ActiveRecord::TestCase
       def setup
         @model = new_model

data/test/unit/integrations/data_mapper_test.rb

@@ -74,7 +74,8 @@ begin
       def setup
         @resource = new_resource
         @machine = StateMachine::Machine.new(@resource)
-        @machine.state :parked, :idling, :first_gear
+        @machine.state :parked, :first_gear
+        @machine.state :idling, :value => lambda {'idling'}
       end
       
       def test_should_create_singular_with_scope
@@ -644,6 +645,40 @@ begin
           assert !ran_callback
         end
       end
+      
+      class MachineWithEventAttributesOnCustomActionTest < BaseTestCase
+        def setup
+          @superclass = new_resource do
+            def persist
+              save
+            end
+          end
+          @resource = Class.new(@superclass)
+          @machine = StateMachine::Machine.new(@resource, :action => :persist)
+          @machine.event :ignite do
+            transition :parked => :idling
+          end
+          
+          @record = @resource.new
+          @record.state = 'parked'
+          @record.state_event = 'ignite'
+        end
+        
+        def test_should_not_transition_on_valid?
+          @record.valid?
+          assert_equal 'parked', @record.state
+        end
+        
+        def test_should_not_transition_on_save
+          @record.save
+          assert_equal 'parked', @record.state
+        end
+        
+        def test_should_transition_on_custom_action
+          @record.persist
+          assert_equal 'idling', @record.state
+        end
+      end
     rescue LoadError
       $stderr.puts "Skipping DataMapper Validation tests. `gem install dm-validations#{" -v #{ENV['DM_VERSION']}" if ENV['DM_VERSION']}` and try again."
     end

data/test/unit/integrations/sequel_test.rb

@@ -63,7 +63,8 @@ begin
       def setup
         @model = new_model
         @machine = StateMachine::Machine.new(@model)
-        @machine.state :parked, :idling, :first_gear
+        @machine.state :parked, :first_gear
+        @machine.state :idling, :value => lambda {'idling'}
       end
       
       def test_should_create_singular_with_scope
@@ -438,6 +439,40 @@ begin
         assert !ran_callback
       end
     end
+    
+    class MachineWithEventAttributesOnCustomActionTest < BaseTestCase
+      def setup
+        @superclass = new_model do
+          def persist
+            save
+          end
+        end
+        @model = Class.new(@superclass)
+        @machine = StateMachine::Machine.new(@model, :action => :persist)
+        @machine.event :ignite do
+          transition :parked => :idling
+        end
+        
+        @record = @model.new
+        @record.state = 'parked'
+        @record.state_event = 'ignite'
+      end
+      
+      def test_should_not_transition_on_valid?
+        @record.valid?
+        assert_equal 'parked', @record.state
+      end
+      
+      def test_should_not_transition_on_save
+        @record.save
+        assert_equal 'parked', @record.state
+      end
+      
+      def test_should_transition_on_custom_action
+        @record.persist
+        assert_equal 'idling', @record.state
+      end
+    end
   end
 rescue LoadError
   $stderr.puts "Skipping Sequel tests. `gem install sequel#{" -v #{ENV['SEQUEL_VERSION']}" if ENV['SEQUEL_VERSION']}` and try again."

data/test/unit/machine_collection_test.rb

@@ -26,6 +26,7 @@ class MachineCollectionStateInitializationTest < Test::Unit::TestCase
     
     @machines[:state] = StateMachine::Machine.new(@klass, :state, :initial => :parked)
     @machines[:alarm_state] = StateMachine::Machine.new(@klass, :alarm_state, :initial => :active)
+    @machines[:alarm_state].state :active, :value => lambda {'active'}
   end
   
   def test_should_set_states_if_nil
@@ -251,7 +252,7 @@ class MachineCollectionFireImplicitWithoutEventTest < MachineCollectionFireImpli
     super
     
     @object.state_event = nil
-    @result = @machines.fire_attribute_events(@object, :save) { @saved = true }
+    @result = @machines.fire_event_attributes(@object, :save) { @saved = true }
   end
   
   def test_should_be_successful
@@ -276,7 +277,7 @@ class MachineCollectionFireImplicitWithBlankEventTest < MachineCollectionFireImp
     super
     
     @object.state_event = ''
-    @result = @machines.fire_attribute_events(@object, :save) { @saved = true }
+    @result = @machines.fire_event_attributes(@object, :save) { @saved = true }
   end
   
   def test_should_be_successful
@@ -301,7 +302,7 @@ class MachineCollectionFireImplicitWithInvalidEventTest < MachineCollectionFireI
     super
     
     @object.state_event = 'invalid'
-    @result = @machines.fire_attribute_events(@object, :save) { @saved = true }
+    @result = @machines.fire_event_attributes(@object, :save) { @saved = true }
   end
   
   def test_should_not_be_successful
@@ -327,7 +328,7 @@ class MachineCollectionFireImplicitWithoutTransitionTest < MachineCollectionFire
     
     @object.state = 'idling'
     @object.state_event = 'ignite'
-    @result = @machines.fire_attribute_events(@object, :save) { @saved = true }
+    @result = @machines.fire_event_attributes(@object, :save) { @saved = true }
   end
   
   def test_should_not_be_successful
@@ -354,7 +355,7 @@ class MachineCollectionFireImplicitWithTransitionTest < MachineCollectionFireImp
     @state_event = nil
     
     @object.state_event = 'ignite'
-    @result = @machines.fire_attribute_events(@object, :save) do
+    @result = @machines.fire_event_attributes(@object, :save) do
       @state_event = @object.state_event
       @saved = true
     end
@@ -382,7 +383,33 @@ class MachineCollectionFireImplicitWithTransitionTest < MachineCollectionFireImp
   
   def test_should_not_be_successful_if_fired_again
     @object.state_event = 'ignite'
-    assert !@machines.fire_attribute_events(@object, :save) { true }
+    assert !@machines.fire_event_attributes(@object, :save) { true }
+  end
+end
+
+class MachineCollectionFireImplicitWithNonBooleanResultTest < MachineCollectionFireImplicitTest
+  def setup
+    super
+    
+    @action_value = Object.new
+    
+    @object.state_event = 'ignite'
+    @result = @machines.fire_event_attributes(@object, :save) do
+      @saved = true
+      @action_value
+    end
+  end
+  
+  def test_should_be_successful
+    assert_equal @action_value, @result
+  end
+  
+  def test_should_run_action
+    assert @saved
+  end
+  
+  def test_should_transition_state
+    assert_equal 'idling', @object.state
   end
 end
 
@@ -391,7 +418,7 @@ class MachineCollectionFireImplicitWithActionFailureTest < MachineCollectionFire
     super
     
     @object.state_event = 'ignite'
-    @result = @machines.fire_attribute_events(@object, :save) { false }
+    @result = @machines.fire_event_attributes(@object, :save) { false }
   end
   
   def test_should_not_be_successful
@@ -412,7 +439,7 @@ class MachineCollectionFireImplicitWithActionErrorTest < MachineCollectionFireIm
     super
     
     @object.state_event = 'ignite'
-    assert_raise(ArgumentError) { @machines.fire_attribute_events(@object, :save) { raise ArgumentError } }
+    assert_raise(ArgumentError) { @machines.fire_event_attributes(@object, :save) { raise ArgumentError } }
   end
   
   def test_should_not_transition_state
@@ -436,7 +463,7 @@ class MachineCollectionFireImplicitPartialTest < MachineCollectionFireImplicitTe
     @state_event = nil
     
     @object.state_event = 'ignite'
-    @result = @machines.fire_attribute_events(@object, :save, false) do
+    @result = @machines.fire_event_attributes(@object, :save, false) do
       @state_event = @object.state_event
       true
     end
@@ -467,49 +494,49 @@ class MachineCollectionFireImplicitPartialTest < MachineCollectionFireImplicitTe
   end
   
   def test_should_reset_event_attributes_after_next_fire_on_success
-    assert @machines.fire_attribute_events(@object, :save) { true }
+    assert @machines.fire_event_attributes(@object, :save) { true }
     assert_equal 'idling', @object.state
     assert_nil @object.state_event
   end
   
   def test_should_guard_transition_after_next_fire_on_success
-    @machines.fire_attribute_events(@object, :save) { true }
+    @machines.fire_event_attributes(@object, :save) { true }
     
     @object.state = 'idling'
     @object.state_event = 'ignite'
-    assert !@machines.fire_attribute_events(@object, :save) { true }
+    assert !@machines.fire_event_attributes(@object, :save) { true }
   end
   
   def test_should_rollback_all_attributes_after_next_fire_on_failure
-    assert !@machines.fire_attribute_events(@object, :save) { false }
+    assert !@machines.fire_event_attributes(@object, :save) { false }
     assert_equal 'parked', @object.state
     assert_equal :ignite, @object.state_event
     
     @object.state = 'idling'
-    assert !@machines.fire_attribute_events(@object, :save) { false }
+    assert !@machines.fire_event_attributes(@object, :save) { false }
   end
   
   def test_should_guard_transition_after_next_fire_on_failure
-    @machines.fire_attribute_events(@object, :save) { false }
+    @machines.fire_event_attributes(@object, :save) { false }
     
     @object.state = 'idling'
-    assert !@machines.fire_attribute_events(@object, :save) { true }
+    assert !@machines.fire_event_attributes(@object, :save) { true }
   end
   
   def test_should_rollback_all_attributes_after_next_fire_on_error
-    assert_raise(ArgumentError) { @machines.fire_attribute_events(@object, :save) { raise ArgumentError } }
+    assert_raise(ArgumentError) { @machines.fire_event_attributes(@object, :save) { raise ArgumentError } }
     assert_equal 'parked', @object.state
     assert_equal :ignite, @object.state_event
   end
   
   def test_should_guard_transition_after_next_fire_on_error
     begin
-      @machines.fire_attribute_events(@object, :save) { raise ArgumentError }
+      @machines.fire_event_attributes(@object, :save) { raise ArgumentError }
     rescue ArgumentError
     end
     
     @object.state = 'idling'
-    assert !@machines.fire_attribute_events(@object, :save) { true }
+    assert !@machines.fire_event_attributes(@object, :save) { true }
   end
 end
 
@@ -520,8 +547,8 @@ class MachineCollectionFireImplicitNestedPartialTest < MachineCollectionFireImpl
     @partial_result = nil
     
     @object.state_event = 'ignite'
-    @result = @machines.fire_attribute_events(@object, :save) do
-      @partial_result = @machines.fire_attribute_events(@object, :save, false) { true }
+    @result = @machines.fire_event_attributes(@object, :save) do
+      @partial_result = @machines.fire_event_attributes(@object, :save, false) { true }
       true
     end
   end
@@ -557,7 +584,7 @@ class MachineCollectionFireImplicitWithDifferentActionsTest < MachineCollectionF
     @object.state_event = 'ignite'
     @object.alarm_state_event = 'disable'
     
-    @machines.fire_attribute_events(@object, :save) { true }
+    @machines.fire_event_attributes(@object, :save) { true }
   end
   
   def test_should_transition_states_for_action
@@ -591,7 +618,7 @@ class MachineCollectionFireImplicitWithSameActionsTest < MachineCollectionFireIm
     @object.state_event = 'ignite'
     @object.alarm_state_event = 'disable'
     
-    @machines.fire_attribute_events(@object, :save) { true }
+    @machines.fire_event_attributes(@object, :save) { true }
   end
   
   def test_should_transition_all_states_for_action
@@ -637,7 +664,7 @@ class MachineCollectionFireImplicitWithValidationsTest < Test::Unit::TestCase
   
   def test_should_invalidate_if_event_is_invalid
     @object.state_event = 'invalid'
-    @machines.fire_attribute_events(@object, :save) { true }
+    @machines.fire_event_attributes(@object, :save) { true }
     
     assert !@object.errors.empty?
   end
@@ -645,14 +672,14 @@ class MachineCollectionFireImplicitWithValidationsTest < Test::Unit::TestCase
   def test_should_invalidate_if_no_transition_exists
     @object.state = 'idling'
     @object.state_event = 'ignite'
-    @machines.fire_attribute_events(@object, :save) { true }
+    @machines.fire_event_attributes(@object, :save) { true }
     
     assert !@object.errors.empty?
   end
   
   def test_should_not_invalidate_if_transition_exists
     @object.state_event = 'ignite'
-    @machines.fire_attribute_events(@object, :save) { true }
+    @machines.fire_event_attributes(@object, :save) { true }
     
     assert @object.errors.empty?
   end

data/test/unit/machine_test.rb

@@ -1067,6 +1067,23 @@ class MachineWithStatesWithCustomValuesTest < Test::Unit::TestCase
   end
 end
 
+class MachineWithStatesWithRuntimeDependenciesTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new
+    @machine = StateMachine::Machine.new(@klass)
+    @machine.state :parked
+  end
+  
+  def test_should_not_evaluate_value_during_definition
+    assert_nothing_raised { @machine.state :parked, :value => lambda {raise ArgumentError} }
+  end
+  
+  def test_should_not_evaluate_if_not_initial_state
+    @machine.state :parked, :value => lambda {raise ArgumentError}
+    assert_nothing_raised { @klass.new }
+  end
+end
+
 class MachineWithStateWithMatchersTest < Test::Unit::TestCase
   def setup
     @klass = Class.new
@@ -1084,6 +1101,24 @@ class MachineWithStateWithMatchersTest < Test::Unit::TestCase
   end
 end
 
+class MachineWithCachedStateTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new
+    @machine = StateMachine::Machine.new(@klass, :initial => :parked)
+    @state = @machine.state :parked, :value => lambda {Object.new}, :cache => true
+    
+    @object = @klass.new
+  end
+  
+  def test_should_use_evaluated_value
+    assert_instance_of Object, @object.state
+  end
+  
+  def test_use_same_value_across_multiple_objects
+    assert_equal @object.state, @klass.new.state
+  end
+end
+
 class MachineWithStatesWithBehaviorsTest < Test::Unit::TestCase
   def setup
     @klass = Class.new

data/test/unit/state_test.rb

@@ -223,13 +223,18 @@ class StateWithLambdaValueTest < Test::Unit::TestCase
     @klass = Class.new
     @args = nil
     @machine = StateMachine::Machine.new(@klass)
-    @state = StateMachine::State.new(@machine, :parked, :value => lambda {|*args| @args = args; :parked})
+    @value = lambda {|*args| @args = args; :parked}
+    @state = StateMachine::State.new(@machine, :parked, :value => @value)
   end
   
-  def test_should_use_evaluated_value
+  def test_should_use_evaluated_value_by_default
     assert_equal :parked, @state.value
   end
   
+  def test_should_allow_access_to_original_value
+    assert_equal @value, @state.value(false)
+  end
+  
   def test_should_include_masked_value_in_description
     assert_equal 'parked (*)', @state.description
   end
@@ -243,6 +248,48 @@ class StateWithLambdaValueTest < Test::Unit::TestCase
     object = @klass.new
     assert object.respond_to?(:parked?)
   end
+  
+  def test_should_match_evaluated_value
+    assert @state.matches?(:parked)
+  end
+end
+
+class StateWithCachedLambdaValueTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new
+    @machine = StateMachine::Machine.new(@klass)
+    @state = StateMachine::State.new(@machine, :parked, :value => lambda {Object.new}, :cache => true)
+  end
+  
+  def test_should_be_caching
+    assert @state.cache
+  end
+  
+  def test_should_evaluate_value
+    assert_instance_of Object, @state.value
+  end
+  
+  def test_should_only_evaluate_value_once
+    value = @state.value
+    assert_same value, @state.value
+  end
+end
+
+class StateWithoutCachedLambdaValueTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new
+    @machine = StateMachine::Machine.new(@klass)
+    @state = StateMachine::State.new(@machine, :parked, :value => lambda {Object.new})
+  end
+  
+  def test_should_not_be_caching
+    assert !@state.cache
+  end
+  
+  def test_should_evaluate_value_each_time
+    value = @state.value
+    assert_not_same value, @state.value
+  end
 end
 
 class StateWithMatcherTest < Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: state_machine
 version: !ruby/object:Gem::Version 
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-23 00:00:00 -04:00
+date: 2009-05-25 00:00:00 -04:00
 default_executable: 
 dependencies: []