state_machine 0.9.4 → 0.10.0

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

@@ -0,0 +1,4 @@
+filename = "#{File.dirname(__FILE__)}/../active_model/locale.rb"
+translations = eval(IO.read(filename), binding, filename)
+translations[:en][:mongo_mapper] = translations[:en].delete(:activemodel)
+translations

data/lib/state_machine/integrations/mongo_mapper/versions.rb

@@ -0,0 +1,102 @@
+module StateMachine
+  module Integrations #:nodoc:
+    module MongoMapper
+      version '0.5.x - 0.6.x' do
+        def self.active?
+          !defined?(::MongoMapper::Plugins)
+        end
+        
+        def initialize_state?(object, options)
+          attributes = options[:attributes] || {}
+          super unless attributes.stringify_keys.key?('_id')
+        end
+        
+        def filter_attributes(object, attributes)
+          attributes
+        end
+      end
+      
+      version '0.5.x - 0.7.x' do
+        def self.active?
+          !defined?(::MongoMapper::Version) || ::MongoMapper::Version < '0.8.0'
+        end
+        
+        def define_scope(name, scope)
+          lambda {|model, values| model.all(scope.call(values))}
+        end
+      end
+      
+      version '0.5.x - 0.8.x' do
+        def self.active?
+          !defined?(::MongoMapper::Version) || ::MongoMapper::Version < '0.9.0'
+        end
+        
+        def invalidate(object, attribute, message, values = [])
+          object.errors.add(self.attribute(attribute), generate_message(message, values))
+        end
+        
+        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
+        
+        def action_hook
+          action == :save ? :create_or_update : super
+        end
+        
+        def load_locale
+        end
+        
+        def supports_observers?
+          false
+        end
+        
+        def supports_validations?
+          true
+        end
+        
+        def supports_dirty_tracking?(object)
+          true
+        end
+        
+        def callback_terminator
+        end
+        
+        def translate(klass, key, value)
+          value.to_s.humanize.downcase
+        end
+      end
+      
+      version '0.5.x - 0.8.3' do
+        def self.active?
+          !defined?(::MongoMapper::Version) || ::MongoMapper::Version <= '0.8.3'
+        end
+        
+        def define_state_initializer
+          define_helper(:instance, :initialize) do |machine, object, _super, *args|
+            attrs, from_db = args
+            from_db ? _super.call : object.class.state_machines.initialize_states(object, :attributes => attrs) { _super.call }
+          end
+        end
+      end
+      
+      # Assumes MongoMapper 0.10+ uses ActiveModel 3.1+
+      version '0.9.x' do
+        def self.active?
+          !defined?(::MongoMapper::Version) || ::MongoMapper::Version =~ /^0\.9\./
+        end
+        
+        def define_action_hook
+          # +around+ callbacks don't have direct access to results until AS 3.1
+          owner_class.set_callback(:save, :after, 'value', :prepend => true) if action_hook == :save
+          super
+        end
+      end
+    end
+  end
+end

data/lib/state_machine/integrations/mongoid.rb

@@ -0,0 +1,297 @@
+module StateMachine
+  module Integrations #:nodoc:
+    # Adds support for integrating state machines with Mongoid models.
+    # 
+    # == Examples
+    # 
+    # Below is an example of a simple state machine defined within a
+    # Mongoid model:
+    # 
+    #   class Vehicle
+    #     include Mongoid::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: 4d70e028b876bb54d9000003, name: nil, state: "parked">
+    #   vehicle.name = 'Ford Explorer'
+    #   vehicle.ignite                    # => true
+    #   vehicle.reload                    # => #<Vehicle _id: 4d70e028b876bb54d9000003, 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 Mongoid, 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: 4d70e028b876bb54d9000003, 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: 4d70e028b876bb54d9000003, 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 Mongoid::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 Mongoid::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: 4d70e028b876bb54d9000003, 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 Mongoid::Document
+    #     
+    #     scope :with_states, lambda {|*states| where(:state => {'$in' => states})}
+    #     # with_states also aliased to with_state
+    #     
+    #     scope :without_states, lambda {|*states| where(:state => {'$nin' => states})}
+    #     # 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 Mongoid, they *cannot* be
+    # chained.
+    # 
+    # == Callbacks
+    # 
+    # All before/after transition callbacks defined for Mongoid models
+    # behave in the same way that other Mongoid callbacks behave.  The
+    # object involved in the transition is passed in as an argument.
+    # 
+    # For example,
+    # 
+    #   class Vehicle
+    #     include Mongoid::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 Mongoid
+      include Base
+      include ActiveModel
+      
+      require 'state_machine/integrations/mongoid/versions'
+      
+      # 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 Mongoid::Document will automatically use the
+      # Mongoid integration.
+      def self.matches?(klass)
+        defined?(::Mongoid::Document) && klass <= ::Mongoid::Document
+      end
+      
+      def self.extended(base) #:nodoc:
+        require 'mongoid/version'
+        super
+      end
+      
+      # Forces the change in state to be recognized regardless of whether the
+      # state value actually changed
+      def write(object, attribute, value, *args)
+        result = super
+        
+        if (attribute == :state || attribute == :event && value) && !object.send("#{self.attribute}_changed?")
+          current = read(object, :state)
+          object.changes[self.attribute.to_s] = [attribute == :event ? current : value, current]
+        end
+        
+        result
+      end
+      
+      protected
+        # The name of this integration
+        def integration
+          :mongoid
+        end
+        
+        # Mongoid uses its own implementation of dirty tracking instead of
+        # ActiveModel's and doesn't support the #{attribute}_will_change! APIs
+        def supports_dirty_tracking?(object)
+          false
+        end
+        
+        # Only runs validations on the action if using <tt>:save</tt>
+        def runs_validations_on_action?
+          action == :save
+        end
+        
+        # Only allows state initialization on new records that aren't being
+        # created with a set of attributes that includes this machine's
+        # attribute.
+        def initialize_state?(object, options)
+          if object.new_record? && !object.instance_variable_defined?('@initialized_state_machines')
+            object.instance_variable_set('@initialized_state_machines', true)
+            super
+          end
+        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
+          define_helper(:instance, :process) do |machine, object, _super, *args|
+            object.class.state_machines.initialize_states(object, :attributes => args.first) { _super.call }
+          end
+        end
+        
+        # Skips defining reader/writer methods since this is done automatically
+        def define_state_accessor
+          owner_class.field(attribute, :type => String) unless owner_class.fields.include?(attribute)
+          super
+        end
+        
+        # Uses around callbacks to run state events if using the :save hook
+        def define_action_hook
+          if action_hook == :save
+            owner_class.set_callback(:save, :around, self, :prepend => true)
+          else
+            super
+          end
+        end
+        
+        # Runs state events around the machine's :save action
+        def around_save(object)
+          object.class.state_machines.transitions(object, action).perform { yield }
+        end
+        
+        # Creates a scope for finding records *with* a particular state or
+        # states for the attribute
+        def create_with_scope(name)
+          define_scope(name, lambda {|values| {attribute => {'$in' => values}}})
+        end
+        
+        # Creates a scope for finding records *without* a particular state or
+        # states for the attribute
+        def create_without_scope(name)
+          define_scope(name, lambda {|values| {attribute => {'$nin' => values}}})
+        end
+        
+        # Defines a new scope with the given name
+        def define_scope(name, scope)
+          lambda {|model, values| model.criteria.where(scope.call(values))}
+        end
+        
+        # ActiveModel's use of method_missing / respond_to for attribute methods
+        # breaks both ancestor lookups and defined?(super).  Need to special-case
+        # the existence of query attribute methods.
+        def owner_class_ancestor_has_method?(method)
+          method == "#{name}?" || super
+        end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+filename = "#{File.dirname(__FILE__)}/../active_model/locale.rb"
+translations = eval(IO.read(filename), binding, filename)
+translations[:en][:mongoid] = translations[:en].delete(:activemodel)
+translations

data/lib/state_machine/integrations/mongoid/versions.rb

@@ -0,0 +1,18 @@
+module StateMachine
+  module Integrations #:nodoc:
+    module Mongoid
+      # Assumes Mongoid 2.1+ uses ActiveModel 3.1+
+      version '2.0.x' do
+        def self.active?
+          ::Mongoid::VERSION >= '2.0.0' && ::Mongoid::VERSION < '2.1.0'
+        end
+        
+        def define_action_hook
+          # +around+ callbacks don't have direct access to results until AS 3.1
+          owner_class.set_callback(:save, :after, 'value', :prepend => true) if action_hook == :save
+          super
+        end
+      end
+    end
+  end
+end

data/lib/state_machine/integrations/sequel.rb

@@ -216,6 +216,10 @@ module StateMachine
     # Note, also, that the transition can be accessed by simply defining
     # additional arguments in the callback block.
     module Sequel
+      include Base
+      
+      require 'state_machine/integrations/sequel/versions'
+      
       # The default options to use for state machines using this integration
       class << self; attr_reader :defaults; end
       @defaults = {:action => :save}
@@ -227,17 +231,16 @@ module StateMachine
         defined?(::Sequel::Model) && klass <= ::Sequel::Model
       end
       
-      # Loads additional files specific to Sequel
-      def self.extended(base) #:nodoc:
-        require 'sequel/extensions/inflector' if ::Sequel.const_defined?('VERSION') && ::Sequel::VERSION >= '2.12.0'
-      end
-      
       # Forces the change in state to be recognized regardless of whether the
       # state value actually changed
-      def write(object, attribute, value)
+      def write(object, attribute, value, *args)
         result = super
+        
         column = self.attribute.to_sym
-        object.changed_columns << column if attribute == :state && owner_class.columns.include?(column) && !object.changed_columns.include?(column)
+        if (attribute == :state || attribute == :event && value) && owner_class.columns.include?(column) && !object.changed_columns.include?(column)
+          object.changed_columns << column
+        end
+        
         result
       end
       
@@ -251,28 +254,40 @@ module StateMachine
         object.errors.clear
       end
       
+      # Pluralizes the name using the built-in inflector
+      def pluralize(word)
+        load_inflector
+        super
+      end
+      
       protected
+        # Loads the built-in inflector
+        def load_inflector
+          require 'sequel/extensions/inflector'
+        end
+        
+        # Only allows state initialization on new records that aren't being
+        # created with a set of attributes that includes this machine's
+        # attribute.
+        def initialize_state?(object, options)
+          if object.new? && !object.instance_variable_defined?('@initialized_state_machines')
+            object.instance_variable_set('@initialized_state_machines', true)
+            
+            attributes = options[:attributes] || {}
+            ignore = object.send(:setter_methods, nil, nil).map {|setter| setter.chop.to_sym} & attributes.keys.map {|key| key.to_sym}
+            !ignore.map {|attribute| attribute.to_sym}.include?(attribute) 
+          end
+        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__
-            # Hooks in to attribute initialization to set the states *prior*
-            # to the attributes being set
-            def set(hash, *args)
-              if new? && !@initialized_state_machines
-                @initialized_state_machines = true
-                
-                ignore = setter_methods(nil, nil).map {|setter| setter.chop.to_sym} & (hash ? hash.keys.map {|attribute| attribute.to_sym} : [])
-                initialize_state_machines(:dynamic => false, :ignore => ignore)
-                result = super
-                initialize_state_machines(:dynamic => true, :ignore => ignore)
-                result
-              else
-                super
-              end
-            end
-          end_eval
+          # Hooks in to attribute initialization to set the states *prior* to
+          # the attributes being set
+          define_helper(:instance, :set) do |machine, object, _super, *args|
+            object.class.state_machines.initialize_states(object, :attributes => args.first) { _super.call }
+          end
         end
         
         # Skips defining reader/writer methods since this is done automatically
@@ -286,45 +301,74 @@ module StateMachine
         
         # Adds hooks into validation for automatically firing events.  This is
         # a bit more complicated than other integrations since Sequel doesn't
-        # provide an easy way to hook around validation / save calls
-         def define_action_helpers
-           if action == :save
-             @instance_helper_module.class_eval do
-               define_method(:valid?) do |*args|
-                yielded = false
-                result = self.class.state_machines.transitions(self, :save, :after => false).perform do
-                  yielded = true
-                  super(*args)
-                end
-                
-                if defined?(::Sequel::MAJOR) && (::Sequel::MAJOR > 3 || ::Sequel::MAJOR == 3 && ::Sequel::MINOR > 13)
-                  raise_on_failure?(args.first || {}) && !yielded && !result ? raise_hook_failure(:validation) : result
-                else
-                  raise_on_save_failure && !yielded && !result ? save_failure(:validation) : result
-                end
+        # provide an easy way to hook around validation calls
+        def define_action_helpers
+          super
+          
+          if action == :save
+            handle_validation_failure = self.handle_validation_failure
+            define_helper(:instance, :valid?) do |machine, object, _super, *args|
+              yielded = false
+              result = object.class.state_machines.transitions(object, :save, :after => false).perform do
+                yielded = true
+                _super.call
               end
               
-              define_method(defined?(::Sequel::MAJOR) && (::Sequel::MAJOR >= 3 || ::Sequel::MAJOR == 2 && ::Sequel::MINOR == 12) ? :_save : :save) do |*args|
-                yielded = false
-                result = self.class.state_machines.transitions(self, :save).perform do
-                  yielded = true
-                  super(*args)
-                end
-                
-                if yielded || result
-                  result
-                elsif defined?(::Sequel::MAJOR) && (::Sequel::MAJOR > 3 || ::Sequel::MAJOR == 3 && ::Sequel::MINOR > 13)
-                  raise_hook_failure(:save)
-                else
-                  save_failure(:save)
-                end
+              !yielded && !result ? handle_validation_failure.call(object, args, yielded, result) : result
+            end
+          end
+        end
+        
+        # Uses custom hooks for :save actions in order to preserve failure
+        # behavior within Sequel.  This is a bit more complicated than other
+        # integrations since Sequel doesn't provide an easy way to hook around
+        # save calls.
+        def define_action_hook
+          if action == :save
+            action_hook = self.action_hook
+            handle_save_failure = self.handle_save_failure
+            
+            define_helper(:instance, action_hook) do |machine, object, _super, *|
+              yielded = false
+              result = object.class.state_machines.transitions(object, :save).perform do
+                yielded = true
+                _super.call
+              end
+              
+              if yielded || result
+                result
+              else
+                handle_save_failure.call(object)
               end
-            end unless owner_class.state_machines.any? {|name, machine| machine.action == :save && machine != self}
+            end
           else
             super
           end
         end
         
+        # Uses internal save hooks if using the :save action
+        def action_hook
+          action == :save ? :_save : super
+        end
+        
+        # Handles whether validation errors should be raised
+        def handle_validation_failure
+          lambda do |object, args, yielded, result|
+            object.instance_eval do
+              raise_on_failure?(args.first || {}) ? raise_hook_failure(:validation) : result
+            end
+          end
+        end
+        
+        # Handles how save failures are raised
+        def handle_save_failure
+          lambda do |object|
+            object.instance_eval do
+              raise_hook_failure(:save)
+            end
+          end
+        end
+        
         # Creates a scope for finding records *with* a particular state or
         # states for the attribute
         def create_with_scope(name)