state_machine 0.8.1 → 0.9.0

data/lib/state_machine/integrations/active_model/locale.rb

@@ -0,0 +1,11 @@
+{:en => {
+  :activemodel => {
+    :errors => {
+      :messages => {
+        :invalid => StateMachine::Machine.default_messages[:invalid],
+        :invalid_event => StateMachine::Machine.default_messages[:invalid_event] % ['{{state}}'],
+        :invalid_transition => StateMachine::Machine.default_messages[:invalid_transition] % ['{{event}}']
+      }
+    }
+  }
+}}

data/lib/state_machine/integrations/{active_record → active_model}/observer.rb

@@ -1,14 +1,14 @@
 module StateMachine
   module Integrations #:nodoc:
-    module ActiveRecord
-      # Adds support for invoking callbacks on ActiveRecord observers with more
+    module ActiveModel
+      # Adds support for invoking callbacks on ActiveModel observers with more
       # than one argument (e.g. the record *and* the state transition).  By
-      # default, ActiveRecord only supports passing the record into the
+      # default, ActiveModel only supports passing the record into the
       # callbacks.
       # 
       # For example:
       # 
-      #   class VehicleObserver < ActiveRecord::Observer
+      #   class VehicleObserver < ActiveModel::Observer
       #     # The default behavior: only pass in the record
       #     def after_save(vehicle)
       #     end
@@ -40,6 +40,6 @@ module StateMachine
   end
 end
 
-ActiveRecord::Observer.class_eval do
-  include StateMachine::Integrations::ActiveRecord::Observer
-end
+ActiveModel::Observer.class_eval do
+  include StateMachine::Integrations::ActiveModel::Observer
+end if defined?(ActiveModel::Observer)

data/lib/state_machine/integrations/active_record.rb

@@ -64,6 +64,9 @@ module StateMachine
     #   vehicle = Vehicle.create(:state_event => 'ignite')  # => #<Vehicle id: 1, name: nil, state: "idling">
     #   vehicle.state                                       # => "idling"
     # 
+    # This technique is always used for transitioning states when the +save+
+    # action (which is the default) is configured for the machine.
+    # 
     # === Security implications
     # 
     # Beware that public event attributes mean that events can be fired
@@ -131,6 +134,9 @@ module StateMachine
     #     end
     #   end
     # 
+    # If using the +save+ action for the machine, this option will be ignored as
+    # the transaction will be created by ActiveRecord within +save+.
+    # 
     # == Validation errors
     # 
     # If an event fails to successfully fire because there are no matching
@@ -304,8 +310,9 @@ module StateMachine
     #         events:
     #           park: 'estacionarse'
     module ActiveRecord
+      include ActiveModel
+      
       # The default options to use for state machines using this integration
-      class << self; attr_reader :defaults; end
       @defaults = {:action => :save}
       
       # Should this integration be used for state machines in the given class?
@@ -315,9 +322,12 @@ module StateMachine
         defined?(::ActiveRecord::Base) && klass <= ::ActiveRecord::Base
       end
       
-      # Loads additional files specific to ActiveRecord
       def self.extended(base) #:nodoc:
-        require 'state_machine/integrations/active_record/observer'
+        require 'state_machine/integrations/active_model/observer'
+        
+        ::ActiveRecord::Observer.class_eval do
+          include StateMachine::Integrations::ActiveModel::Observer
+        end unless ::ActiveRecord::Observer.included_modules.include?(StateMachine::Integrations::ActiveModel::Observer)
         
         if Object.const_defined?(:I18n)
           locale = "#{File.dirname(__FILE__)}/active_record/locale.rb"
@@ -325,57 +335,53 @@ module StateMachine
         end
       end
       
-      # Forces the change in state to be recognized regardless of whether the
-      # state value actually changed
-      def write(object, attribute, value)
-        result = super
-        if attribute == :state && object.respond_to?("#{self.attribute}_will_change!") && !object.send("#{self.attribute}_changed?")
-          object.send("#{self.attribute}_will_change!")
-        end
-        result
-      end
-      
       # Adds a validation error to the given object 
       def invalidate(object, attribute, message, values = [])
-        attribute = self.attribute(attribute)
-        
         if Object.const_defined?(:I18n)
-          klasses =
-            if ::ActiveRecord::VERSION::MAJOR >= 3
-              object.class.lookup_ancestors
-            elsif ::ActiveRecord::VERSION::MINOR == 3 && ::ActiveRecord::VERSION::TINY >= 2
-              object.class.self_and_descendants_from_active_record
-            else
-              object.class.self_and_descendents_from_active_record
-            end
-          
-          options = values.inject({}) do |options, (key, value)|
-            # Generate all possible translation keys
-            group = key.to_s.pluralize
-            translations = klasses.map {|klass| :"#{klass.model_name.underscore}.#{name}.#{group}.#{value}"}
-            translations.concat([:"#{name}.#{group}.#{value}", :"#{group}.#{value}", value.to_s])
-            
-            options[key] = I18n.translate(translations.shift, :default => translations, :scope => [:activerecord, :state_machines])
-            options
-          end
-          
-          object.errors.add(attribute, message, options.merge(:default => @messages[message]))
+          super
         else
-          object.errors.add(attribute, generate_message(message, values))
+          object.errors.add(self.attribute(attribute), generate_message(message, values))
         end
       end
       
-      # Resets any errors previously added when invalidating the given object
-      def reset(object)
-        object.errors.clear
-      end
-      
       protected
-        # Adds the default callbacks for notifying ActiveRecord observers
-        # before/after a transition has been performed.
-        def after_initialize
-          callbacks[:before] << Callback.new {|object, transition| notify(:before, object, transition)}
-          callbacks[:after] << Callback.new {|object, transition| notify(:after, object, transition)}
+        # Always adds observer support
+        def supports_observers?
+          true
+        end
+        
+        # Always adds validation support
+        def supports_validations?
+          true
+        end
+        
+        # Only runs validations on the action if using <tt>:save</tt>
+        def runs_validations_on_action?
+          action == :save
+        end
+        
+        # Only adds dirty tracking support if ActiveRecord supports it
+        def supports_dirty_tracking?(object)
+          defined?(::ActiveRecord::Dirty) && object.respond_to?("#{self.attribute}_changed?") || super
+        end
+        
+        # Always uses the <tt>:activerecord</tt> translation scope
+        def i18n_scope
+          :activerecord
+        end
+        
+        # Attempts to look up a class's ancestors via:
+        # * #lookup_ancestors
+        # * #self_and_descendants_from_active_record
+        # * #self_and_descendents_from_active_record
+        def ancestors_for(klass)
+          if ::ActiveRecord::VERSION::MAJOR >= 3
+            super
+          elsif ::ActiveRecord::VERSION::MINOR == 3 && ::ActiveRecord::VERSION::TINY >= 2
+            klass.self_and_descendants_from_active_record
+          else
+            klass.self_and_descendents_from_active_record
+          end
         end
         
         # Defines an initialization hook into the owner class for setting the
@@ -414,16 +420,6 @@ module StateMachine
           end_eval
         end
         
-        # Skips defining reader/writer methods since this is done automatically
-        def define_state_accessor
-          name = self.name
-          
-          owner_class.validates_each(attribute) do |record, attr, value|
-            machine = record.class.state_machine(name)
-            machine.invalidate(record, :state, :invalid) unless machine.states.match(record)
-          end
-        end
-        
         # Adds support for defining the attribute predicate, while providing
         # compatibility with the default predicate which determines whether
         # *anything* is set for the attribute's value
@@ -441,17 +437,7 @@ module StateMachine
         
         # Adds hooks into validation for automatically firing events
         def define_action_helpers
-          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
+          super(action == :save ? :create_or_update : action)
         end
         
         # Creates a scope for finding records *with* a particular state or
@@ -476,83 +462,33 @@ module StateMachine
           object.class.transaction {raise ::ActiveRecord::Rollback unless yield}
         end
         
-        # Creates a new callback in the callback chain, always inserting it
-        # before the default Observer callbacks that were created after
-        # initialization.
-        def add_callback(type, options, &block)
-          options[:terminator] = @terminator ||= lambda {|result| result == false}
-          @callbacks[type].insert(-2, callback = Callback.new(options, &block))
-          add_states(callback.known_states)
-          
-          callback
-        end
-        
       private
-        # Defines a new named scope with the given name.  Since ActiveRecord
-        # does not allow direct access to the model being used within the
-        # evaluation of a dynamic named scope, the scope must be generated
-        # manually.  It's necessary to have access to the model so that the
-        # state names can be translated to their associated values and so that
-        # inheritance is respected properly.
+        # Defines a new named scope with the given name
         def define_scope(name, scope)
-          if ::ActiveRecord::VERSION::MAJOR <= 2
+          if ::ActiveRecord::VERSION::MAJOR >= 3
+            lambda {|model, values| model.where(scope.call(values)[:conditions])}
+          else
             if owner_class.respond_to?(:named_scope)
               name = name.to_sym
               machine_name = self.name
               
-              # Create the scope and then override it with state translation
+              # Since ActiveRecord does not allow direct access to the model
+              # being used within the evaluation of a dynamic named scope, the
+              # scope must be generated manually.  It's necessary to have access
+              # to the model so that the state names can be translated to their
+              # associated values and so that inheritance is respected properly.
               owner_class.named_scope(name)
-              owner_class.scopes[name] = lambda do |klass, *states|
-                machine_states = klass.state_machine(machine_name).states
+              owner_class.scopes[name] = lambda do |model, *states|
+                machine_states = model.state_machine(machine_name).states
                 values = states.flatten.map {|state| machine_states.fetch(state).value}
                 
-                ::ActiveRecord::NamedScope::Scope.new(klass, scope.call(values))
+                ::ActiveRecord::NamedScope::Scope.new(model, scope.call(values))
               end
             end
             
             # Prevent the Machine class from wrapping the scope
             false
-          else
-            lambda {|klass, values| klass.where(scope.call(values)[:conditions])}
-          end
-        end
-        
-        # Notifies observers on the given object that a callback occurred
-        # involving the given transition.  This will attempt to call the
-        # following methods on observers:
-        # * #{type}_#{qualified_event}_from_#{from}_to_#{to}
-        # * #{type}_#{qualified_event}_from_#{from}
-        # * #{type}_#{qualified_event}_to_#{to}
-        # * #{type}_#{qualified_event}
-        # * #{type}_transition_#{machine_name}_from_#{from}_to_#{to}
-        # * #{type}_transition_#{machine_name}_from_#{from}
-        # * #{type}_transition_#{machine_name}_to_#{to}
-        # * #{type}_transition_#{machine_name}
-        # * #{type}_transition
-        # 
-        # This will always return true regardless of the results of the
-        # callbacks.
-        def notify(type, object, transition)
-          name = self.name
-          event = transition.qualified_event
-          from = transition.from_name
-          to = transition.to_name
-          
-          # Machine-specific updates
-          ["#{type}_#{event}", "#{type}_transition_#{name}"].each do |event_segment|
-            ["_from_#{from}", nil].each do |from_segment|
-              ["_to_#{to}", nil].each do |to_segment|
-                object.class.changed
-                object.class.notify_observers([event_segment, from_segment, to_segment].join, object, transition)
-              end
-            end
           end
-          
-          # Generic updates
-          object.class.changed
-          object.class.notify_observers("#{type}_transition", object, transition)
-          
-          true
         end
     end
   end

data/lib/state_machine/integrations/active_record/locale.rb

@@ -1,11 +1,4 @@
-{:en => {
-  :activerecord => {
-    :errors => {
-      :messages => {
-        :invalid => StateMachine::Machine.default_messages[:invalid],
-        :invalid_event => StateMachine::Machine.default_messages[:invalid_event] % ['{{state}}'],
-        :invalid_transition => StateMachine::Machine.default_messages[:invalid_transition] % ['{{event}}']
-      }
-    }
-  }
-}}
+filename = "#{File.dirname(__FILE__)}/../active_model/locale.rb"
+translations = eval(IO.read(filename), binding, filename)
+translations[:en][:activerecord] = translations[:en].delete(:activemodel)
+translations

data/lib/state_machine/integrations/data_mapper.rb

@@ -70,6 +70,9 @@ module StateMachine
     #   vehicle = Vehicle.create(:state_event => 'ignite')  # => #<Vehicle id=1 name=nil state="idling">
     #   vehicle.state                                       # => "idling"
     # 
+    # This technique is always used for transitioning states when the +save+
+    # action (which is the default) is configured for the machine.
+    # 
     # === Security implications
     # 
     # Beware that public event attributes mean that events can be fired
@@ -140,6 +143,10 @@ module StateMachine
     #     end
     #   end
     # 
+    # If using the +save+ action for the machine, this option will be ignored as
+    # the transaction behavior will depend on the +save+ implementation within
+    # DataMapper.
+    # 
     # == Validation errors
     # 
     # If an event fails to successfully fire because there are no matching
@@ -256,9 +263,12 @@ module StateMachine
       def write(object, attribute, value)
         result = super
         if attribute == :state && owner_class.properties.detect {|property| property.name == self.attribute}
-          if ::DataMapper::VERSION =~ /^(0\.\d\.)/ # Match anything < 0.10
+          if ::DataMapper::VERSION =~ /^0\.\d\./ # Match anything < 0.10
             object.original_values[self.attribute] = "#{value}-ignored" if object.original_values[self.attribute] == value
           else
+            # Force the resource's state to Dirty for 0.10.13+
+            object.persisted_state = ::DataMapper::Resource::State::Dirty.new(object) unless ::DataMapper::VERSION =~ /^0\.10\.[0-2]$/ || object.persisted_state.respond_to?(:original_attributes)
+            
             property = owner_class.properties[self.attribute]
             object.original_attributes[property] = "#{value}-ignored" unless object.original_attributes.include?(property)
           end
@@ -284,7 +294,7 @@ module StateMachine
         
         # Pluralizes the name using the built-in inflector
         def pluralize(word)
-          Extlib::Inflection.pluralize(word.to_s)
+          defined?(Extlib::Inflection) ? Extlib::Inflection.pluralize(word.to_s) : super
         end
         
         # Defines an initialization hook into the owner class for setting the
@@ -316,12 +326,20 @@ module StateMachine
         
         # Adds hooks into validation for automatically firing events
         def define_action_helpers
-          if super && action == :save && supports_validations?
-            @instance_helper_module.class_eval do
-              define_method(:valid?) do |*args|
-                self.class.state_machines.fire_event_attributes(self, :save, false) { super(*args) }
+          # 0.9.4 - 0.9.6 fails to run after callbacks when validations are
+          # enabled because of the way dm-validations integrates
+          return if ::DataMapper::VERSION =~ /^0\.9\.[4-6]/ && supports_validations?
+          
+          if action == :save
+            if super(::DataMapper::VERSION =~ /^0\.\d\./ ? :save : :save_self) && supports_validations?
+              @instance_helper_module.class_eval do
+                define_method(:valid?) do |*args|
+                  self.class.state_machines.transitions(self, :save, :after => false).perform { super(*args) }
+                end
               end
             end
+          else
+            super
           end
         end
         

data/lib/state_machine/integrations/data_mapper/observer.rb

@@ -104,6 +104,42 @@ module StateMachine
           add_transition_callback(:after, *args, &block)
         end
         
+        # Creates a callback that will be invoked *around* a transition so long
+        # as the given requirements match the transition.
+        # 
+        # == Examples
+        # 
+        #   class Vehicle
+        #     include DataMapper::Resource
+        #     
+        #     property :id, Serial
+        #     property :state, :String
+        #     
+        #     state_machine :initial => :parked do
+        #       event :ignite do
+        #         transition :parked => :idling
+        #       end
+        #     end
+        #   end
+        #   
+        #   class VehicleObserver
+        #     include DataMapper::Observer
+        #     
+        #     observe Vehicle
+        #     
+        #     around_transition do |transition, block|
+        #       # track start time
+        #       block.call
+        #       # track end time
+        #     end
+        #   end
+        # 
+        # See +before_transition+ for a description of the possible configurations
+        # for defining callbacks.
+        def around_transition(*args, &block)
+          add_transition_callback(:around, *args, &block)
+        end
+        
         private
           # Adds the transition callback to a specific machine or all of the
           # state machines for each observed class.

data/lib/state_machine/integrations/mongo_mapper.rb

@@ -0,0 +1,295 @@
+module StateMachine
+  module Integrations #:nodoc:
+    # Adds support for integrating state machines with MongoMapper models.
+    # 
+    # == Examples
+    # 
+    # Below is an example of a simple state machine defined within a
+    # MongoMapper model:
+    # 
+    #   class Vehicle
+    #     include MongoMapper::Document
+    #     
+    #     state_machine :initial => :parked do
+    #       event :ignite do
+    #         transition :parked => :idling
+    #       end
+    #     end
+    #   end
+    # 
+    # The examples in the sections below will use the above class as a
+    # reference.
+    # 
+    # == Actions
+    # 
+    # By default, the action that will be invoked when a state is transitioned
+    # is the +save+ action.  This will cause the record to save the changes
+    # made to the state machine's attribute.  *Note* that if any other changes
+    # were made to the record prior to transition, then those changes will
+    # be saved as well.
+    # 
+    # For example,
+    # 
+    #   vehicle = Vehicle.create          # => #<Vehicle id: 1, name: nil, state: "parked">
+    #   vehicle.name = 'Ford Explorer'
+    #   vehicle.ignite                    # => true
+    #   vehicle.reload                    # => #<Vehicle id: 1, name: "Ford Explorer", state: "idling">
+    # 
+    # == Events
+    # 
+    # As described in StateMachine::InstanceMethods#state_machine, event
+    # attributes are created for every machine that allow transitions to be
+    # performed automatically when the object's action (in this case, :save)
+    # is called.
+    # 
+    # In MongoMapper, these automated events are run in the following order:
+    # * before validation - Run before callbacks and persist new states, then validate
+    # * before save - If validation was skipped, run before callbacks and persist new states, then save
+    # * after save - Run after callbacks
+    # 
+    # For example,
+    # 
+    #   vehicle = Vehicle.create          # => #<Vehicle id: 1, name: nil, state: "parked">
+    #   vehicle.state_event               # => nil
+    #   vehicle.state_event = 'invalid'
+    #   vehicle.valid?                    # => false
+    #   vehicle.errors.full_messages      # => ["State event is invalid"]
+    #   
+    #   vehicle.state_event = 'ignite'
+    #   vehicle.valid?                    # => true
+    #   vehicle.save                      # => true
+    #   vehicle.state                     # => "idling"
+    #   vehicle.state_event               # => nil
+    # 
+    # Note that this can also be done on a mass-assignment basis:
+    # 
+    #   vehicle = Vehicle.create(:state_event => 'ignite')  # => #<Vehicle id: 1, name: nil, state: "idling">
+    #   vehicle.state                                       # => "idling"
+    # 
+    # This technique is always used for transitioning states when the +save+
+    # action (which is the default) is configured for the machine.
+    # 
+    # === Security implications
+    # 
+    # Beware that public event attributes mean that events can be fired
+    # whenever mass-assignment is being used.  If you want to prevent malicious
+    # users from tampering with events through URLs / forms, the attribute
+    # should be protected like so:
+    # 
+    #   class Vehicle
+    #     include MongoMapper::Document
+    #     
+    #     attr_protected :state_event
+    #     # attr_accessible ... # Alternative technique
+    #     
+    #     state_machine do
+    #       ...
+    #     end
+    #   end
+    # 
+    # If you want to only have *some* events be able to fire via mass-assignment,
+    # you can build two state machines (one public and one protected) like so:
+    # 
+    #   class Vehicle
+    #     include MongoMapper::Document
+    #     
+    #     attr_protected :state_event # Prevent access to events in the first machine
+    #     
+    #     state_machine do
+    #       # Define private events here
+    #     end
+    #     
+    #     # Public machine targets the same state as the private machine
+    #     state_machine :public_state, :attribute => :state do
+    #       # Define public events here
+    #     end
+    #   end
+    # 
+    # == Validation errors
+    # 
+    # If an event fails to successfully fire because there are no matching
+    # transitions for the current record, a validation error is added to the
+    # record's state attribute to help in determining why it failed and for
+    # reporting via the UI.
+    # 
+    # For example,
+    # 
+    #   vehicle = Vehicle.create(:state => 'idling')  # => #<Vehicle id: 1, name: nil, state: "idling">
+    #   vehicle.ignite                                # => false
+    #   vehicle.errors.full_messages                  # => ["State cannot transition via \"ignite\""]
+    # 
+    # If an event fails to fire because of a validation error on the record and
+    # *not* because a matching transition was not available, no error messages
+    # will be added to the state attribute.
+    # 
+    # == Scopes
+    # 
+    # To assist in filtering models with specific states, a series of basic
+    # scopes are defined on the model for finding records with or without a
+    # particular set of states.
+    # 
+    # These scopes are essentially the functional equivalent of the following
+    # definitions:
+    # 
+    #   class Vehicle
+    #     include MongoMapper::Document
+    #     
+    #     def self.with_states(*states)
+    #       all(:conditions => {:state => {'$in' => states}})
+    #     end
+    #     # with_states also aliased to with_state
+    #     
+    #     def self.without_states(*states)
+    #       all(:conditions => {:state => {'$nin' => states}})
+    #     end
+    #     # without_states also aliased to without_state
+    #   end
+    # 
+    # *Note*, however, that the states are converted to their stored values
+    # before being passed into the query.
+    # 
+    # Because of the way named scopes work in MongoMapper, they *cannot* be
+    # chained.
+    # 
+    # == Callbacks
+    # 
+    # All before/after transition callbacks defined for MongoMapper models
+    # behave in the same way that other MongoMapper callbacks behave.  The
+    # object involved in the transition is passed in as an argument.
+    # 
+    # For example,
+    # 
+    #   class Vehicle
+    #     include MongoMapper::Document
+    #     
+    #     state_machine :initial => :parked do
+    #       before_transition any => :idling do |vehicle|
+    #         vehicle.put_on_seatbelt
+    #       end
+    #       
+    #       before_transition do |vehicle, transition|
+    #         # log message
+    #       end
+    #       
+    #       event :ignite do
+    #         transition :parked => :idling
+    #       end
+    #     end
+    #     
+    #     def put_on_seatbelt
+    #       ...
+    #     end
+    #   end
+    # 
+    # Note, also, that the transition can be accessed by simply defining
+    # additional arguments in the callback block.
+    module MongoMapper
+      include ActiveModel
+      
+      # The default options to use for state machines using this integration
+      @defaults = {:action => :save}
+      
+      # Should this integration be used for state machines in the given class?
+      # Classes that include MongoMapper::Document will automatically use the
+      # MongoMapper integration.
+      def self.matches?(klass)
+        defined?(::MongoMapper::Document) && klass <= ::MongoMapper::Document
+      end
+      
+      # Adds a validation error to the given object (no i18n support)
+      def invalidate(object, attribute, message, values = [])
+        object.errors.add(self.attribute(attribute), generate_message(message, values))
+      end
+      
+      protected
+        # Does not support observers
+        def supports_observers?
+          false
+        end
+        
+        # Always adds validation support
+        def supports_validations?
+          true
+        end
+        
+        # Only runs validations on the action if using <tt>:save</tt>
+        def runs_validations_on_action?
+          action == :save
+        end
+        
+        # Always adds dirty tracking support
+        def supports_dirty_tracking?(object)
+          true
+        end
+        
+        # Don't allow callback terminators
+        def callback_terminator
+        end
+        
+        # Defines an initialization hook into the owner class for setting the
+        # initial state of the machine *before* any attributes are set on the
+        # object
+        def define_state_initializer
+          @instance_helper_module.class_eval <<-end_eval, __FILE__, __LINE__
+            def initialize(attrs = {}, *args)
+              from_database = args.first
+              
+              if !from_database && (!attrs || !attrs.stringify_keys.key?('_id'))
+                filtered = respond_to?(:filter_protected_attrs) ? filter_protected_attrs(attrs) : attrs 
+                ignore = filtered ? filtered.keys : []
+                
+                initialize_state_machines(:dynamic => false, :ignore => ignore)
+                super
+                initialize_state_machines(:dynamic => true, :ignore => ignore)
+              else
+                super
+              end
+            end
+          end_eval
+        end
+        
+        # Skips defining reader/writer methods since this is done automatically
+        def define_state_accessor
+          owner_class.key(attribute, String) unless owner_class.keys.include?(attribute)
+          
+          name = self.name
+          owner_class.validates_each(attribute, :logic => lambda {
+            machine = self.class.state_machine(name)
+            machine.invalidate(self, :state, :invalid) unless machine.states.match(self)
+          })
+        end
+        
+        # Adds support for defining the attribute predicate, while providing
+        # compatibility with the default predicate which determines whether
+        # *anything* is set for the attribute's value
+        def define_state_predicate
+          name = self.name
+          
+          # Still use class_eval here instance of define_instance_method since
+          # we need to be able to call +super+
+          @instance_helper_module.class_eval do
+            define_method("#{name}?") do |*args|
+              args.empty? ? super(*args) : self.class.state_machine(name).states.matches?(self, *args)
+            end
+          end
+        end
+        
+        # Adds hooks into validation for automatically firing events
+        def define_action_helpers
+          super(action == :save ? :create_or_update : action)
+        end
+        
+        # Creates a scope for finding records *with* a particular state or
+        # states for the attribute
+        def create_with_scope(name)
+          lambda {|model, values| model.all(:conditions => {attribute => {'$in' => values}})}
+        end
+        
+        # Creates a scope for finding records *without* a particular state or
+        # states for the attribute
+        def create_without_scope(name)
+          lambda {|model, values| model.all(:conditions => {attribute => {'$nin' => values}})}
+        end
+    end
+  end
+end