telvue_state_machine 1.2.1

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

@@ -0,0 +1,210 @@
+module StateMachine
+  module Integrations #:nodoc:
+    module DataMapper
+      # Adds support for creating before/after/around/failure transition
+      # callbacks within a DataMapper observer.  These callbacks behave very
+      # similar to hooks during save/update/destroy/etc., but with the following
+      # modifications:
+      # * Each callback can define a set of transition requirements 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_transition, *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_transition, *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_transition, *args, &block)
+        end
+        
+        # Creates a callback that will be invoked *after* a transition failures to
+        # be performed so long as the given requirements match the transition.
+        # 
+        # == Example
+        # 
+        #   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
+        #     after_transition_failure do |transition|
+        #       # log failure
+        #     end
+        #     
+        #     after_transition_failure :on => :ignite do
+        #       # log failure
+        #     end
+        #   end
+        # 
+        # See +before_transition+ for a description of the possible configurations
+        # for defining callbacks.  *Note* however that you cannot define the state
+        # requirements in these callbacks.  You may only define event requirements.
+        def after_transition_failure(*args, &block)
+          add_transition_callback(:after_failure, *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 machine(s) being targeted
+              names = args
+              args = args.last.is_a?(Hash) ? [args.pop] : []
+            else
+              # Target all state machines
+              names = nil
+            end
+            
+            # Add the transition callback to each class being observed
+            observing.each do |klass|
+              state_machines =
+                if names
+                  names.map {|name| klass.state_machines.fetch(name)}
+                else
+                  klass.state_machines.values
+                end
+              
+              state_machines.each {|machine| machine.send(type, *args, &block)}
+            end if observing
+          end
+      end
+    end
+  end
+end
+
+DataMapper::Observer::ClassMethods.class_eval do
+  include StateMachine::Integrations::DataMapper::Observer
+end

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

@@ -0,0 +1,85 @@
+module StateMachine
+  module Integrations #:nodoc:
+    module DataMapper
+      version '0.9.x - 0.10.x' do
+        def self.active?
+          ::DataMapper::VERSION =~ /^0\.\d\./ || ::DataMapper::VERSION =~ /^0\.10\./
+        end
+        
+        def pluralize(word)
+          ::Extlib::Inflection.pluralize(word.to_s)
+        end
+      end
+      
+      version '0.9.x' do
+        def self.active?
+          ::DataMapper::VERSION =~ /^0\.9\./
+        end
+        
+        def define_action_helpers
+          if action_hook == :save
+            define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+              def save(*)
+                self.class.state_machines.transitions(self, :save).perform { super }
+              end
+            end_eval
+            
+            define_validation_hook
+          else
+            super
+          end
+        end
+      end
+      
+      version '0.9.4 - 0.9.6' do
+        def self.active?
+          ::DataMapper::VERSION =~ /^0\.9\.[4-6]/
+        end
+        
+        # 0.9.4 - 0.9.6 fails to run after callbacks when validations are
+        # enabled because of the way dm-validations integrates
+        def define_action_helpers?
+          super if action != :save || !supports_validations?
+        end
+      end
+      
+      version '0.10.x' do
+        def self.active?
+          ::DataMapper::VERSION =~ /^0\.10\./
+        end
+        
+        def define_action_helpers
+          if action_hook == :save
+            define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+              def save(*)
+                self.class.state_machines.transitions(self, :save).perform { super }
+              end
+              
+              def save!(*)
+                self.class.state_machines.transitions(self, :save).perform { super }
+              end
+              
+              def save_self(*)
+                self.class.state_machines.transitions(self, :save).perform { super }
+              end
+            end_eval
+            
+            define_validation_hook
+          else
+            super
+          end
+        end
+      end
+      
+      version '1.0.0' do
+        def self.active?
+          ::DataMapper::VERSION == '1.0.0'
+        end
+        
+        def pluralize(word)
+          (defined?(::ActiveSupport::Inflector) ? ::ActiveSupport::Inflector : ::Extlib::Inflection).pluralize(word.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/state_machine/integrations/mongo_mapper.rb

@@ -0,0 +1,389 @@
+require 'state_machine/integrations/active_model'
+
+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
+    # 
+    # == Validations
+    # 
+    # As mentioned in StateMachine::Machine#state, you can define behaviors,
+    # like validations, that only execute for certain states. One *important*
+    # caveat here is that, due to a constraint in MongoMapper's validation
+    # framework, custom validators will not work as expected when defined to run
+    # in multiple states.  For example:
+    # 
+    #   class Vehicle
+    #     include MongoMapper::Document
+    #     
+    #     state_machine do
+    #       ...
+    #       state :first_gear, :second_gear do
+    #         validate :speed_is_legal
+    #       end
+    #     end
+    #   end
+    # 
+    # In this case, the <tt>:speed_is_legal</tt> validation will only get run
+    # for the <tt>:second_gear</tt> state.  To avoid this, you can define your
+    # custom validation like so:
+    # 
+    #   class Vehicle
+    #     include MongoMapper::Document
+    #     
+    #     state_machine do
+    #       ...
+    #       state :first_gear, :second_gear do
+    #         validate {|vehicle| vehicle.speed_is_legal}
+    #       end
+    #     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.
+    # 
+    # In addition, if you're using the <tt>ignite!</tt> version of the event,
+    # then the failure reason (such as the current validation errors) will be
+    # included in the exception that gets raised when the event fails.  For
+    # example, assuming there's a validation on a field called +name+ on the class:
+    # 
+    #   vehicle = Vehicle.new
+    #   vehicle.ignite!       # => StateMachine::InvalidTransition: Cannot transition state via :ignite from :parked (Reason(s): Name cannot be blank)
+    # 
+    # == 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.
+    # 
+    # Note that states can also be referenced by the string version of their
+    # name:
+    # 
+    #   Vehicle.with_state('parked')
+    # 
+    # == 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.
+    # 
+    # === Callback Order
+    # 
+    # Callbacks occur in the following order.  Callbacks specific to state_machine
+    # are bolded.  The remaining callbacks are part of MongoMapper.
+    # 
+    # * (-) save
+    # * (1) *before_transition*
+    # * (-) valid
+    # * (2) before_validation
+    # * (3) after_validation
+    # * (4) before_save
+    # * (5) before_create
+    # * (6) after_create
+    # * (7) after_save
+    # * (8) *after_transition*
+    # 
+    # == Internationalization
+    # 
+    # Any error message that is generated from performing invalid transitions
+    # can be localized.  The following default translations are used:
+    # 
+    #   en:
+    #     mongo_mapper:
+    #       errors:
+    #         messages:
+    #           invalid: "is invalid"
+    #           # %{value} = attribute value, %{state} = Human state name
+    #           invalid_event: "cannot transition when %{state}"
+    #           # %{value} = attribute value, %{event} = Human event name, %{state} = Human current state name
+    #           invalid_transition: "cannot transition via %{event}"
+    # 
+    # You can override these for a specific model like so:
+    # 
+    #   en:
+    #     mongo_mapper:
+    #       errors:
+    #         models:
+    #           user:
+    #             invalid: "is not valid"
+    # 
+    # In addition to the above, you can also provide translations for the
+    # various states / events in each state machine.  Using the Vehicle example,
+    # state translations will be looked for using the following keys, where
+    # +model_name+ = "vehicle", +machine_name+ = "state" and +state_name+ = "parked":
+    # * <tt>mongo_mapper.state_machines.#{model_name}.#{machine_name}.states.#{state_name}</tt>
+    # * <tt>mongo_mapper.state_machines.#{model_name}.states.#{state_name}</tt>
+    # * <tt>mongo_mapper.state_machines.#{machine_name}.states.#{state_name}</tt>
+    # * <tt>mongo_mapper.state_machines.states.#{state_name}</tt>
+    # 
+    # Event translations will be looked for using the following keys, where
+    # +model_name+ = "vehicle", +machine_name+ = "state" and +event_name+ = "ignite":
+    # * <tt>mongo_mapper.state_machines.#{model_name}.#{machine_name}.events.#{event_name}</tt>
+    # * <tt>mongo_mapper.state_machines.#{model_name}.events.#{event_name}</tt>
+    # * <tt>mongo_mapper.state_machines.#{machine_name}.events.#{event_name}</tt>
+    # * <tt>mongo_mapper.state_machines.events.#{event_name}</tt>
+    # 
+    # An example translation configuration might look like so:
+    # 
+    #   es:
+    #     mongo_mapper:
+    #       state_machines:
+    #         states:
+    #           parked: 'estacionado'
+    #         events:
+    #           park: 'estacionarse'
+    module MongoMapper
+      include Base
+      include ActiveModel
+      
+      require 'state_machine/integrations/mongo_mapper/versions'
+      
+      # The default options to use for state machines using this integration
+      @defaults = {:action => :save}
+      
+      # Classes that include MongoMapper::Document will automatically use the
+      # MongoMapper integration.
+      def self.matching_ancestors
+        %w(MongoMapper::Document)
+      end
+      
+      protected
+        # Only runs validations on the action if using <tt>:save</tt>
+        def runs_validations_on_action?
+          action == :save
+        end
+        
+        # Gets the db default for the machine's attribute
+        def owner_class_attribute_default
+          attribute_key && attribute_key.default_value
+        end
+        
+        # Gets the Mongoid key for this machine's attribute (if it exists)
+        def attribute_key
+          owner_class.keys[attribute.to_s]
+        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, <<-end_eval, __FILE__, __LINE__ + 1
+            def initialize(*args)
+              self.class.state_machines.initialize_states(self, :static => :force) { super }
+            end
+          end_eval
+        end
+        
+        # Skips defining reader/writer methods since this is done automatically
+        def define_state_accessor
+          owner_class.key(attribute, String) unless attribute_key
+          super
+        end
+        
+        # Uses around callbacks to run state events if using the :save hook
+        def define_action_hook
+          if action_hook == :save
+            define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+              def save(*)
+                self.class.state_machine(#{name.inspect}).send(:around_save, self) { super }
+              end
+              
+              def save!(*)
+                self.class.state_machine(#{name.inspect}).send(:around_save, self) { super } || raise(::MongoMapper::DocumentNotValid.new(self))
+              end
+            end_eval
+          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| {: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)
+          define_scope(name, lambda {|values| {:conditions => {attribute => {'$nin' => values}}}})
+        end
+        
+        # Defines a new scope with the given name
+        def define_scope(name, scope)
+          lambda {|model, values| model.query.merge(model.query(scope.call(values)))}
+        end
+    end
+  end
+end