verborghs-state_machine 0.9.4

data/lib/state_machine/extensions.rb

@@ -0,0 +1,149 @@
+require 'state_machine/machine_collection'
+
+module StateMachine
+  module ClassMethods
+    def self.extended(base) #:nodoc:
+      base.class_eval do
+        @state_machines = MachineCollection.new
+      end
+    end
+    
+    # Gets the current list of state machines defined for this class.  This
+    # class-level attribute acts like an inheritable attribute.  The attribute
+    # is available to each subclass, each having a copy of its superclass's
+    # attribute.
+    # 
+    # The hash of state machines maps <tt>:attribute</tt> => +machine+, e.g.
+    # 
+    #   Vehicle.state_machines # => {:state => #<StateMachine::Machine:0xb6f6e4a4 ...>}
+    def state_machines
+      @state_machines ||= superclass.state_machines.dup
+    end
+  end
+  
+  module InstanceMethods
+    # Runs one or more events in parallel.  All events will run through the
+    # following steps:
+    # * Before callbacks
+    # * Persist state
+    # * Invoke action
+    # * After callbacks
+    # 
+    # For example, if two events (for state machines A and B) are run in
+    # parallel, the order in which steps are run is:
+    # * A - Before transition callbacks
+    # * B - Before transition callbacks
+    # * A - Persist new state
+    # * B - Persist new state
+    # * A - Invoke action
+    # * B - Invoke action (only if different than A's action)
+    # * A - After transition callbacks
+    # * B - After transition callbacks
+    # 
+    # *Note* that multiple events on the same state machine / attribute cannot
+    # be run in parallel.  If this is attempted, an ArgumentError will be
+    # raised.
+    # 
+    # == Halting callbacks
+    # 
+    # When running multiple events in parallel, special consideration should
+    # be taken with regard to how halting within callbacks affects the flow.
+    # 
+    # For *before* callbacks, any <tt>:halt</tt> error that's thrown will
+    # immediately cancel the perform for all transitions.  As a result, it's
+    # possible for one event's transition to affect the continuation of
+    # another.
+    # 
+    # On the other hand, any <tt>:halt</tt> error that's thrown within an
+    # *after* callback with only affect that event's transition.  Other
+    # transitions will continue to run their own callbacks.
+    # 
+    # == Example
+    # 
+    #   class Vehicle
+    #     state_machine :initial => :parked do
+    #       event :ignite do
+    #         transition :parked => :idling
+    #       end
+    #       
+    #       event :park do
+    #         transition :idling => :parked
+    #       end
+    #     end
+    #     
+    #     state_machine :alarm_state, :namespace => 'alarm', :initial => :on do
+    #       event :enable do
+    #         transition all => :active
+    #       end
+    #       
+    #       event :disable do
+    #         transition all => :off
+    #       end
+    #     end
+    #   end
+    #   
+    #   vehicle = Vehicle.new                         # => #<Vehicle:0xb7c02850 @state="parked", @alarm_state="active">
+    #   vehicle.state                                 # => "parked"
+    #   vehicle.alarm_state                           # => "active"
+    #   
+    #   vehicle.fire_events(:ignite, :disable_alarm)  # => true
+    #   vehicle.state                                 # => "idling"
+    #   vehicle.alarm_state                           # => "off"
+    #   
+    #   # If any event fails, the entire event chain fails
+    #   vehicle.fire_events(:ignite, :enable_alarm)   # => false
+    #   vehicle.state                                 # => "idling"
+    #   vehicle.alarm_state                           # => "off"
+    #   
+    #   # Exception raised on invalid event
+    #   vehicle.fire_events(:park, :invalid)          # => StateMachine::InvalidEvent: :invalid is an unknown event
+    #   vehicle.state                                 # => "idling"
+    #   vehicle.alarm_state                           # => "off"
+    def fire_events(*events)
+      self.class.state_machines.fire_events(self, *events)
+    end
+    
+    # Run one or more events in parallel.  If any event fails to run, then
+    # a StateMachine::InvalidTransition exception will be raised.
+    # 
+    # See StateMachine::InstanceMethods#fire_events for more information.
+    # 
+    # == Example
+    # 
+    #   class Vehicle
+    #     state_machine :initial => :parked do
+    #       event :ignite do
+    #         transition :parked => :idling
+    #       end
+    #       
+    #       event :park do
+    #         transition :idling => :parked
+    #       end
+    #     end
+    #     
+    #     state_machine :alarm_state, :namespace => 'alarm', :initial => :active do
+    #       event :enable do
+    #         transition all => :active
+    #       end
+    #       
+    #       event :disable do
+    #         transition all => :off
+    #       end
+    #     end
+    #   end
+    #   
+    #   vehicle = Vehicle.new                         # => #<Vehicle:0xb7c02850 @state="parked", @alarm_state="active">
+    #   vehicle.fire_events(:ignite, :disable_alarm)  # => true
+    #   
+    #   vehicle.fire_events!(:ignite, :disable_alarm) # => StateMachine::InvalidTranstion: Cannot run events in parallel: ignite, disable_alarm
+    def fire_events!(*events)
+      run_action = [true, false].include?(events.last) ? events.pop : true
+      fire_events(*(events + [run_action])) || raise(StateMachine::InvalidTransition, "Cannot run events in parallel: #{events * ', '}")
+    end
+    
+    protected
+      def initialize_state_machines(options = {}) #:nodoc:
+        self.class.state_machines.initialize_states(self, options)
+      end
+  end
+end

data/lib/state_machine/guard.rb

@@ -0,0 +1,230 @@
+require 'state_machine/matcher'
+require 'state_machine/eval_helpers'
+require 'state_machine/assertions'
+
+module StateMachine
+  # Represents a set of requirements that must be met in order for a transition
+  # or callback to occur.  Guards verify that the event, from state, and to
+  # state of the transition match, in addition to if/unless conditionals for
+  # an object's state.
+  class Guard
+    include Assertions
+    include EvalHelpers
+    
+    # The condition that must be met on an object
+    attr_reader :if_condition
+    
+    # The condition that must *not* be met on an object
+    attr_reader :unless_condition
+    
+    # The requirement for verifying the event being guarded
+    attr_reader :event_requirement
+    
+    # One or more requirements for verifying the states being guarded.  All
+    # requirements contain a mapping of {:from => matcher, :to => matcher}.
+    attr_reader :state_requirements
+    
+    # The requirement for verifying the success of the event
+    attr_reader :success_requirement
+    
+    # A list of all of the states known to this guard.  This will pull states
+    # from the following options (in the same order):
+    # * +from+ / +except_from+
+    # * +to+ / +except_to+
+    attr_reader :known_states
+    
+    # Creates a new guard
+    def initialize(options = {}) #:nodoc:
+      # Build conditionals
+      @if_condition = options.delete(:if)
+      @unless_condition = options.delete(:unless)
+      
+      # Build event requirement
+      @event_requirement = build_matcher(options, :on, :except_on)
+      
+      # Build success requirement
+      @success_requirement = options.delete(:include_failures) ? AllMatcher.instance : WhitelistMatcher.new([true])
+      
+      if (options.keys - [:from, :to, :on, :except_from, :except_to, :except_on]).empty?
+        # Explicit from/to requirements specified
+        @state_requirements = [{:from => build_matcher(options, :from, :except_from), :to => build_matcher(options, :to, :except_to)}]
+      else
+        # Separate out the event requirement
+        options.delete(:on)
+        options.delete(:except_on)
+        
+        # Implicit from/to requirements specified
+        @state_requirements = options.collect do |from, to|
+          from = WhitelistMatcher.new(from) unless from.is_a?(Matcher)
+          to = WhitelistMatcher.new(to) unless to.is_a?(Matcher)
+          {:from => from, :to => to}
+        end
+      end
+      
+      # Track known states.  The order that requirements are iterated is based
+      # on the priority in which tracked states should be added.
+      @known_states = []
+      @state_requirements.each do |state_requirement|
+        [:from, :to].each {|option| @known_states |= state_requirement[option].values}
+      end
+    end
+    
+    # Determines whether the given object / query matches the requirements
+    # configured for this guard.  In addition to matching the event, from state,
+    # and to state, this will also check whether the configured :if/:unless
+    # conditions pass on the given object.
+    # 
+    # == Examples
+    # 
+    #   guard = StateMachine::Guard.new(:parked => :idling, :on => :ignite)
+    #   
+    #   # Successful
+    #   guard.matches?(object, :on => :ignite)                                    # => true
+    #   guard.matches?(object, :from => nil)                                      # => true
+    #   guard.matches?(object, :from => :parked)                                  # => true
+    #   guard.matches?(object, :to => :idling)                                    # => true
+    #   guard.matches?(object, :from => :parked, :to => :idling)                  # => true
+    #   guard.matches?(object, :on => :ignite, :from => :parked, :to => :idling)  # => true
+    #   
+    #   # Unsuccessful
+    #   guard.matches?(object, :on => :park)                                      # => false
+    #   guard.matches?(object, :from => :idling)                                  # => false
+    #   guard.matches?(object, :to => :first_gear)                                # => false
+    #   guard.matches?(object, :from => :parked, :to => :first_gear)              # => false
+    #   guard.matches?(object, :on => :park, :from => :parked, :to => :idling)    # => false
+    def matches?(object, query = {})
+      !match(object, query).nil?
+    end
+    
+    # Attempts to match the given object / query against the set of requirements
+    # configured for this guard.  In addition to matching the event, from state,
+    # and to state, this will also check whether the configured :if/:unless
+    # conditions pass on the given object.
+    # 
+    # If a match is found, then the event/state requirements that the query
+    # passed successfully will be returned.  Otherwise, nil is returned if there
+    # was no match.
+    # 
+    # Query options:
+    # * <tt>:from</tt> - One or more states being transitioned from.  If none
+    #   are specified, then this will always match.
+    # * <tt>:to</tt> - One or more states being transitioned to.  If none are
+    #   specified, then this will always match.
+    # * <tt>:on</tt> - One or more events that fired the transition.  If none
+    #   are specified, then this will always match.
+    # 
+    # == Examples
+    # 
+    #   guard = StateMachine::Guard.new(:parked => :idling, :on => :ignite)
+    #   
+    #   guard.match(object, :on => :ignite) # => {:to => ..., :from => ..., :on => ...}
+    #   guard.match(object, :on => :park)   # => nil
+    def match(object, query = {})
+      if (match = match_query(query)) && matches_conditions?(object)
+        match
+      end
+    end
+    
+    # Draws a representation of this guard on the given graph.  This will draw
+    # an edge between every state this guard matches *from* to either the
+    # configured to state or, if none specified, then a loopback to the from
+    # state.
+    # 
+    # For example, if the following from states are configured:
+    # * +idling+
+    # * +first_gear+
+    # * +backing_up+
+    # 
+    # ...and the to state is +parked+, then the following edges will be created:
+    # * +idling+      -> +parked+
+    # * +first_gear+  -> +parked+
+    # * +backing_up+  -> +parked+
+    # 
+    # Each edge will be labeled with the name of the event that would cause the
+    # transition.
+    # 
+    # The collection of edges generated on the graph will be returned.
+    def draw(graph, event, valid_states)
+      state_requirements.inject([]) do |edges, state_requirement|
+        # From states determined based on the known valid states
+        from_states = state_requirement[:from].filter(valid_states)
+        
+        # If a to state is not specified, then it's a loopback and each from
+        # state maps back to itself
+        if state_requirement[:to].values.empty?
+          loopback = true
+        else
+          to_state = state_requirement[:to].values.first
+          to_state = to_state ? to_state.to_s : 'nil'
+          loopback = false
+        end
+        
+        # Generate an edge between each from and to state
+        from_states.each do |from_state|
+          from_state = from_state ? from_state.to_s : 'nil'
+          edges << graph.add_edge(from_state, loopback ? from_state : to_state, :label => event.to_s)
+        end
+        
+        edges
+      end
+    end
+    
+    protected
+      # Builds a matcher strategy to use for the given options.  If neither a
+      # whitelist nor a blacklist option is specified, then an AllMatcher is
+      # built.
+      def build_matcher(options, whitelist_option, blacklist_option)
+        assert_exclusive_keys(options, whitelist_option, blacklist_option)
+        
+        if options.include?(whitelist_option)
+          WhitelistMatcher.new(options[whitelist_option])
+        elsif options.include?(blacklist_option)
+          BlacklistMatcher.new(options[blacklist_option])
+        else
+          AllMatcher.instance
+        end
+      end
+      
+      # Verifies that all configured requirements (event and state) match the
+      # given query.  If a match is found, then a hash containing the
+      # event/state requirements that passed will be returned; otherwise, nil.
+      def match_query(query)
+        query ||= {}
+        
+        if match_success(query) && match_event(query) && (state_requirement = match_states(query))
+          state_requirement.merge(:on => event_requirement)
+        end
+      end
+      
+      # Verifies that the success requirement matches the given query
+      def match_success(query)
+        matches_requirement?(query, :success, success_requirement)
+      end
+      
+      # Verifies that the event requirement matches the given query
+      def match_event(query)
+        matches_requirement?(query, :on, event_requirement)
+      end
+      
+      # Verifies that the state requirements match the given query.  If a
+      # matching requirement is found, then it is returned.
+      def match_states(query)
+        state_requirements.detect do |state_requirement|
+          [:from, :to].all? {|option| matches_requirement?(query, option, state_requirement[option])}
+        end
+      end
+      
+      # Verifies that an option in the given query matches the values required
+      # for that option
+      def matches_requirement?(query, option, requirement)
+        !query.include?(option) || requirement.matches?(query[option], query)
+      end
+      
+      # Verifies that the conditionals for this guard evaluate to true for the
+      # given object
+      def matches_conditions?(object)
+        Array(if_condition).all? {|condition| evaluate_method(object, condition)} &&
+        !Array(unless_condition).any? {|condition| evaluate_method(object, condition)}
+      end
+  end
+end

data/lib/state_machine/initializers/merb.rb

@@ -0,0 +1 @@
+Merb::Plugins.add_rakefiles("#{File.dirname(__FILE__)}/../../tasks/state_machine") if defined?(Merb::Plugins)

data/lib/state_machine/initializers/rails.rb

@@ -0,0 +1,5 @@
+class StateMachine::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/state_machine.rb'
+  end
+end if defined?(Rails::Railtie)

data/lib/state_machine/initializers.rb

@@ -0,0 +1,4 @@
+# Load each application initializer
+Dir["#{File.dirname(__FILE__)}/initializers/*.rb"].sort.each do |path|
+  require "state_machine/initializers/#{File.basename(path)}"
+end

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_model/observer.rb

@@ -0,0 +1,45 @@
+module StateMachine
+  module Integrations #:nodoc:
+    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, ActiveModel only supports passing the record into the
+      # callbacks.
+      # 
+      # For example:
+      # 
+      #   class VehicleObserver < ActiveModel::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:
+          if args.any?
+            send(observed_method, object, *args) if respond_to?(observed_method)
+          else
+            update_without_multiple_args(observed_method, object)
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveModel::Observer.class_eval do
+  include StateMachine::Integrations::ActiveModel::Observer
+end if defined?(ActiveModel::Observer)