verborghs-state_machine 0.9.4

data/lib/state_machine/integrations/sequel.rb

@@ -0,0 +1,356 @@
+module StateMachine
+  module Integrations #:nodoc:
+    # Adds support for integrating state machines with Sequel models.
+    # 
+    # == Examples
+    # 
+    # Below is an example of a simple state machine defined within a
+    # Sequel model:
+    # 
+    #   class Vehicle < Sequel::Model
+    #     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 resource to save the changes
+    # made to the state machine's attribute.  *Note* that if any other changes
+    # were made to the resource prior to transition, then those changes will
+    # be made as well.
+    # 
+    # For example,
+    # 
+    #   vehicle = Vehicle.create          # => #<Vehicle @values={:state=>"parked", :name=>nil, :id=>1}>
+    #   vehicle.name = 'Ford Explorer'
+    #   vehicle.ignite                    # => true
+    #   vehicle.refresh                   # => #<Vehicle @values={:state=>"idling", :name=>"Ford Explorer", :id=>1}>
+    # 
+    # == 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 Sequel, 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 @values={:state=>"parked", :name=>nil, :id=>1}>
+    #   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                      # => #<Vehicle @values={:state=>"idling", :name=>nil, :id=>1}>
+    #   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 @values={:state=>"idling", :name=>nil, :id=>1}>
+    #   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 < Sequel::Model
+    #     set_restricted_columns :state_event
+    #     # set_allowed_columns ... # 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 < Sequel::Model
+    #     set_restricted_columns :state_event # Prevent access to events in the first machine
+    #     
+    #     state_machine do
+    #       # Define private events here
+    #     end
+    #     
+    #     # Allow both machines to share the same state
+    #     state_machine :public_state, :attribute => :state do
+    #       # Define public events here
+    #     end
+    #   end
+    # 
+    # == Transactions
+    # 
+    # In order to ensure that any changes made during transition callbacks
+    # are rolled back during a failed attempt, every transition is wrapped
+    # within a transaction.
+    # 
+    # For example,
+    # 
+    #   class Message < Sequel::Model
+    #   end
+    #   
+    #   Vehicle.state_machine do
+    #     before_transition do |transition|
+    #       Message.create(:content => transition.inspect)
+    #       false
+    #     end
+    #   end
+    #   
+    #   vehicle = Vehicle.create      # => #<Vehicle @values={:state=>"parked", :name=>nil, :id=>1}>
+    #   vehicle.ignite                # => false
+    #   Message.count                 # => 0
+    # 
+    # *Note* that only before callbacks that halt the callback chain and
+    # failed attempts to save the record will result in the transaction being
+    # rolled back.  If an after callback halts the chain, the previous result
+    # still applies and the transaction is *not* rolled back.
+    # 
+    # To turn off transactions:
+    # 
+    #   class Vehicle < Sequel::Model
+    #     state_machine :initial => :parked, :use_transactions => false do
+    #       ...
+    #     end
+    #   end
+    # 
+    # If using the +save+ action for the machine, this option will be ignored as
+    # the transaction will be created by Sequel within +save+.
+    # 
+    # == 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 @values={:state=>"parked", :name=>nil, :id=>1}>
+    #   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 class
+    # methods are defined on the model for finding records with or without a
+    # particular set of states.
+    # 
+    # These named scopes are the functional equivalent of the following
+    # definitions:
+    # 
+    #   class Vehicle < Sequel::Model
+    #     class << self
+    #       def with_states(*states)
+    #         filter(:state => states)
+    #       end
+    #       alias_method :with_state, :with_states
+    #       
+    #       def without_states(*states)
+    #         filter(~{:state => states})
+    #       end
+    #       alias_method :without_state, :without_states
+    #     end
+    #   end
+    # 
+    # *Note*, however, that the states are converted to their stored values
+    # before being passed into the query.
+    # 
+    # Because of the way scopes work in Sequel, they can be chained like so:
+    # 
+    #   Vehicle.with_state(:parked).order(:id.desc)
+    # 
+    # == Callbacks
+    # 
+    # All before/after transition callbacks defined for Sequel resources
+    # behave in the same way that other Sequel hooks behave.  Rather than
+    # passing in the record as an argument to the callback, the callback is
+    # instead bound to the object and evaluated within its context.
+    # 
+    # For example,
+    # 
+    #   class Vehicle < Sequel::Model
+    #     state_machine :initial => :parked do
+    #       before_transition any => :idling do
+    #         put_on_seatbelt
+    #       end
+    #       
+    #       before_transition do |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 Sequel
+      # 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?
+      # Classes that include Sequel::Model will automatically use the Sequel
+      # integration.
+      def self.matches?(klass)
+        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)
+        result = super
+        column = self.attribute.to_sym
+        object.changed_columns << column if attribute == :state && owner_class.columns.include?(column) && !object.changed_columns.include?(column)
+        result
+      end
+      
+      # Adds a validation error to the given object
+      def invalidate(object, attribute, message, values = [])
+        object.errors.add(self.attribute(attribute), generate_message(message, values))
+      end
+      
+      # Resets any errors previously added when invalidating the given object
+      def reset(object)
+        object.errors.clear
+      end
+      
+      protected
+        # 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
+        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 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
+              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
+              end
+            end unless owner_class.state_machines.any? {|name, machine| machine.action == :save && machine != self}
+          else
+            super
+          end
+        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.filter(:"#{owner_class.table_name}__#{attribute}" => 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.filter(~{:"#{owner_class.table_name}__#{attribute}" => values})}
+        end
+        
+        # Runs a new database transaction, rolling back any changes if the
+        # yielded block fails (i.e. returns false).
+        def transaction(object)
+          object.db.transaction {raise ::Sequel::Error::Rollback unless yield}
+        end
+        
+        # Creates a new callback in the callback chain, always ensuring that
+        # it's configured to bind to the object as this is the convention for
+        # Sequel callbacks
+        def add_callback(type, options, &block)
+          options[:bind_to_object] = true
+          options[:terminator] = @terminator ||= lambda {|result| result == false}
+          super
+        end
+    end
+  end
+end

data/lib/state_machine/integrations.rb

@@ -0,0 +1,83 @@
+# Load each available integration
+Dir["#{File.dirname(__FILE__)}/integrations/*.rb"].sort.each do |path|
+  require "state_machine/integrations/#{File.basename(path)}"
+end
+
+module StateMachine
+  # Integrations allow state machines to take advantage of features within the
+  # context of a particular library.  This is currently most useful with
+  # database libraries.  For example, the various database integrations allow
+  # state machines to hook into features like:
+  # * Saving
+  # * Transactions
+  # * Observers
+  # * Scopes
+  # * Callbacks
+  # * Validation errors
+  # 
+  # This type of integration allows the user to work with state machines in a
+  # fashion similar to other object models in their application.
+  # 
+  # The integration interface is loosely defined by various unimplemented
+  # methods in the StateMachine::Machine class.  See that class or the various
+  # built-in integrations for more information about how to define additional
+  # integrations.
+  module Integrations
+    # Attempts to find an integration that matches the given class.  This will
+    # look through all of the built-in integrations under the StateMachine::Integrations
+    # namespace and find one that successfully matches the class.
+    # 
+    # == Examples
+    # 
+    #   class Vehicle
+    #   end
+    #   
+    #   class ActiveModelVehicle
+    #     include ActiveModel::Dirty
+    #     include ActiveModel::Observing
+    #     include ActiveModel::Validations
+    #   end
+    #   
+    #   class ActiveRecordVehicle < ActiveRecord::Base
+    #   end
+    #   
+    #   class DataMapperVehicle
+    #     include DataMapper::Resource
+    #   end
+    #   
+    #   class MongoMapperVehicle
+    #     include MongoMapper::Document
+    #   end
+    #   
+    #   class SequelVehicle < Sequel::Model
+    #   end
+    #   
+    #   StateMachine::Integrations.match(Vehicle)             # => nil
+    #   StateMachine::Integrations.match(ActiveModelVehicle)  # => StateMachine::Integrations::ActiveModel
+    #   StateMachine::Integrations.match(ActiveRecordVehicle) # => StateMachine::Integrations::ActiveRecord
+    #   StateMachine::Integrations.match(DataMapperVehicle)   # => StateMachine::Integrations::DataMapper
+    #   StateMachine::Integrations.match(MongoMapperVehicle)  # => StateMachine::Integrations::MongoMapper
+    #   StateMachine::Integrations.match(SequelVehicle)       # => StateMachine::Integrations::Sequel
+    def self.match(klass)
+      constants = self.constants.map {|c| c.to_s}.select {|c| c != 'ActiveModel'}.sort << 'ActiveModel'
+      if integration = constants.find {|name| const_get(name).matches?(klass)}
+        find(integration)
+      end
+    end
+    
+    # Finds an integration with the given name.  If the integration cannot be
+    # found, then a NameError exception will be raised.
+    # 
+    # == Examples
+    # 
+    #   StateMachine::Integrations.find(:active_record)   # => StateMachine::Integrations::ActiveRecord
+    #   StateMachine::Integrations.find(:active_model)    # => StateMachine::Integrations::ActiveModel
+    #   StateMachine::Integrations.find(:data_mapper)     # => StateMachine::Integrations::DataMapper
+    #   StateMachine::Integrations.find(:mongo_mapper)    # => StateMachine::Integrations::MongoMapper
+    #   StateMachine::Integrations.find(:sequel)          # => StateMachine::Integrations::Sequel
+    #   StateMachine::Integrations.find(:invalid)         # => NameError: wrong constant name Invalid
+    def self.find(name)
+      const_get(name.to_s.gsub(/(?:^|_)(.)/) {$1.upcase})
+    end
+  end
+end