pluginaweek-state_machine 0.7.6

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

@@ -0,0 +1,10 @@
+{:en => {
+  :activerecord => {
+    :errors => {
+      :messages => {
+        :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/observer.rb

@@ -0,0 +1,41 @@
+module StateMachine
+  module Integrations #:nodoc:
+    module ActiveRecord
+      # Adds support for invoking callbacks on ActiveRecord observers with more
+      # than one argument (e.g. the record *and* the state transition).  By
+      # default, ActiveRecord only supports passing the record into the
+      # callbacks.
+      # 
+      # For example:
+      # 
+      #   class VehicleObserver < ActiveRecord::Observer
+      #     # The default behavior: only pass in the record
+      #     def after_save(vehicle)
+      #     end
+      #     
+      #     # Custom behavior: allow the transition to be passed in as well
+      #     def after_transition(vehicle, transition)
+      #       Audit.log(vehicle, transition)
+      #     end
+      #   end
+      module Observer
+        def self.included(base) #:nodoc:
+          base.class_eval do
+            alias_method :update_without_multiple_args, :update
+            alias_method :update, :update_with_multiple_args
+          end
+        end
+        
+        # Allows additional arguments other than the object to be passed to the
+        # observed methods
+        def update_with_multiple_args(observed_method, object, *args) #:nodoc:
+          send(observed_method, object, *args) if respond_to?(observed_method)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Observer.class_eval do
+  include StateMachine::Integrations::ActiveRecord::Observer
+end

data/lib/state_machine/integrations/data_mapper.rb

@@ -0,0 +1,325 @@
+module StateMachine
+  module Integrations #:nodoc:
+    # Adds support for integrating state machines with DataMapper resources.
+    # 
+    # == Examples
+    # 
+    # Below is an example of a simple state machine defined within a
+    # DataMapper resource:
+    # 
+    #   class Vehicle
+    #     include DataMapper::Resource
+    #     
+    #     property :id, Serial
+    #     property :name, String
+    #     property :state, String
+    #     
+    #     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 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 DataMapper, these automated events are run in the following order:
+    # * before validation - If validation feature loaded, run before callbacks and persist new states, then validate
+    # * before save - If validation feature was skipped/not loaded, 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                    # => #<DataMapper::Validate::ValidationErrors:0xb7a48b54 @errors={"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"
+    # 
+    # === 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 DataMapper::Resource
+    #     ...
+    #     
+    #     state_machine do
+    #       ...
+    #     end
+    #     protected :state_event
+    #   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 DataMapper::Resource
+    #     ...
+    #     
+    #     # Allow both machines to share the same state
+    #     alias_method :public_state, :state
+    #     alias_method :public_state=, :state=
+    #     
+    #     state_machine do
+    #       # Define private events here
+    #     end
+    #     protected :state_event= # Prevent access to events in the first machine
+    #     
+    #     state_machine :public_state do
+    #       # Define public events here
+    #     end
+    #   end
+    # 
+    # == Transactions
+    # 
+    # By default, the use of transactions during an event transition is
+    # turned off to be consistent with DataMapper.  This means that if
+    # changes are made to the database during a before callback, but the the
+    # transition fails to complete, those changes will *not* be rolled back.
+    # 
+    # For example,
+    # 
+    #   class Message
+    #     include DataMapper::Resource
+    #     
+    #     property :id, Serial
+    #     property :content, String
+    #   end
+    #   
+    #   Vehicle.state_machine do
+    #     before_transition do |transition|
+    #       Message.create(:content => transition.inspect)
+    #       throw :halt
+    #     end
+    #   end
+    #   
+    #   vehicle = Vehicle.create      # => #<Vehicle id=1 name=nil state="parked">
+    #   vehicle.ignite                # => false
+    #   Message.all.count             # => 1
+    # 
+    # To turn on transactions:
+    # 
+    #   class Vehicle < ActiveRecord::Base
+    #     state_machine :initial => :parked, :use_transactions => true do
+    #       ...
+    #     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                  # => ["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
+    #     include DataMapper::Resource
+    #     
+    #     property :id, Serial
+    #     property :state, String
+    #     
+    #     class << self
+    #       def with_states(*states)
+    #         all(:state => states.flatten)
+    #       end
+    #       alias_method :with_state, :with_states
+    #       
+    #       def without_states(*states)
+    #         all(:state.not => states.flatten)
+    #       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 DataMapper, they can be chained like
+    # so:
+    # 
+    #   Vehicle.with_state(:parked).all(:order => [:id.desc])
+    # 
+    # == Callbacks / Observers
+    # 
+    # All before/after transition callbacks defined for DataMapper resources
+    # behave in the same way that other DataMapper 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
+    #     include DataMapper::Resource
+    #     
+    #     property :id, Serial
+    #     property :state, String
+    #     
+    #     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.
+    # 
+    # In addition to support for DataMapper-like hooks, there is additional
+    # support for DataMapper observers.  See StateMachine::Integrations::DataMapper::Observer
+    # for more information.
+    module DataMapper
+      # The default options to use for state machines using this integration
+      class << self; attr_reader :defaults; end
+      @defaults = {:action => :save, :use_transactions => false}
+        
+      # Should this integration be used for state machines in the given class?
+      # Classes that include DataMapper::Resource will automatically use the
+      # DataMapper integration.
+      def self.matches?(klass)
+        defined?(::DataMapper::Resource) && klass <= ::DataMapper::Resource
+      end
+      
+      # Loads additional files specific to DataMapper
+      def self.extended(base) #:nodoc:
+        require 'state_machine/integrations/data_mapper/observer' if ::DataMapper.const_defined?('Observer')
+      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)) if supports_validations?
+      end
+      
+      # Resets any errors previously added when invalidating the given object
+      def reset(object)
+        object.errors.clear if object.respond_to?(:errors)
+      end
+      
+      protected
+        # Is validation support currently loaded?
+        def supports_validations?
+          @supports_validations ||= ::DataMapper.const_defined?('Validate')
+        end
+        
+        # Skips defining reader/writer methods since this is done automatically
+        def define_state_accessor
+          owner_class.property(attribute, String) unless owner_class.properties.has_property?(attribute)
+          
+          if supports_validations?
+            attribute = self.attribute
+            owner_class.validates_with_block(attribute) do
+              machine = self.class.state_machine(attribute)
+              machine.states.match(self) ? true : [false, machine.generate_message(:invalid)]
+            end
+          end
+        end
+        
+        # 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) }
+              end
+            end
+          end
+        end
+        
+        # Creates a scope for finding records *with* a particular state or
+        # states for the attribute
+        def create_with_scope(name)
+          attribute = self.attribute
+          lambda {|resource, values| resource.all(attribute => values)}
+        end
+        
+        # Creates a scope for finding records *without* a particular state or
+        # states for the attribute
+        def create_without_scope(name)
+          attribute = self.attribute
+          lambda {|resource, values| resource.all(attribute.to_sym.not => values)}
+        end
+        
+        # Runs a new database transaction, rolling back any changes if the
+        # yielded block fails (i.e. returns false).
+        def transaction(object)
+          object.class.transaction {|t| t.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
+        # DataMapper/Extlib callbacks
+        def add_callback(type, options, &block)
+          options[:bind_to_object] = true
+          super
+        end
+    end
+  end
+end

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

@@ -0,0 +1,139 @@
+module StateMachine
+  module Integrations #:nodoc:
+    module DataMapper
+      # Adds support for creating before/after transition callbacks within a
+      # DataMapper observer.  These callbacks behave very similar to
+      # before/after hooks during save/update/destroy/etc., but with the
+      # following modifications:
+      # * Each callback can define a set of transition conditions (i.e. guards)
+      # that must be met in order for the callback to get invoked.
+      # * An additional transition parameter is available that provides
+      # contextual information about the event (see StateMachine::Transition
+      # for more information)
+      # 
+      # To define a single observer for multiple state machines:
+      # 
+      #   class StateMachineObserver
+      #     include DataMapper::Observer
+      #     
+      #     observe Vehicle, Switch, Project
+      #     
+      #     after_transition do |transition|
+      #       Audit.log(self, transition)
+      #     end
+      #   end
+      # 
+      # == Requirements
+      # 
+      # To use this feature of the DataMapper integration, the dm-observer library
+      # must be available.  This can be installed either directly or indirectly
+      # through dm-more.  When loading DataMapper, be sure to load the dm-observer
+      # library as well like so:
+      # 
+      #   require 'rubygems'
+      #   require 'dm-core'
+      #   require 'dm-observer'
+      # 
+      # If dm-observer is not available, then this feature will be skipped.
+      module Observer
+        include MatcherHelpers
+        
+        # Creates a callback that will be invoked *before* a transition is
+        # performed, so long as the given configuration options match the
+        # transition.  Each part of the transition (event, to state, from state)
+        # must match in order for the callback to get invoked.
+        # 
+        # See StateMachine::Machine#before_transition for more
+        # information about the various configuration options available.
+        # 
+        # == 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
+        #     
+        #     before :save do
+        #       # log message
+        #     end
+        #     
+        #     # Target all state machines
+        #     before_transition :parked => :idling, :on => :ignite do
+        #       # put on seatbelt
+        #     end
+        #     
+        #     # Target a specific state machine
+        #     before_transition :state, any => :idling do
+        #       # put on seatbelt
+        #     end
+        #     
+        #     # Target all state machines without requirements
+        #     before_transition do |transition|
+        #       # log message
+        #     end
+        #   end
+        # 
+        # *Note* that in each of the above +before_transition+ callbacks, the
+        # callback is executed within the context of the object (i.e. the
+        # Vehicle instance being transition).  This means that +self+ refers
+        # to the vehicle record within each callback block.
+        def before_transition(*args, &block)
+          add_transition_callback(:before, *args, &block)
+        end
+        
+        # Creates a callback that will be invoked *after* a transition is
+        # performed so long as the given configuration options match the
+        # transition.
+        # 
+        # See +before_transition+ for a description of the possible configurations
+        # for defining callbacks.
+        def after_transition(*args, &block)
+          add_transition_callback(:after, *args, &block)
+        end
+        
+        private
+          # Adds the transition callback to a specific machine or all of the
+          # state machines for each observed class.
+          def add_transition_callback(type, *args, &block)
+            if args.any? && !args.first.is_a?(Hash)
+              # Specific attribute(s) being targeted
+              attributes = args
+              args = args.last.is_a?(Hash) ? [args.pop] : []
+            else
+              # Target all state machines
+              attributes = nil
+            end
+            
+            # Add the transition callback to each class being observed
+            observing.each do |klass|
+              state_machines =
+                if attributes
+                  attributes.map {|attribute| klass.state_machines.fetch(attribute)}
+                else
+                  klass.state_machines.values
+                end
+              
+              state_machines.each {|machine| machine.send("#{type}_transition", *args, &block)}
+            end if observing
+          end
+      end
+    end
+  end
+end
+
+DataMapper::Observer::ClassMethods.class_eval do
+  include StateMachine::Integrations::DataMapper::Observer
+end