spree-state_machine 2.0.0.beta1

data/lib/state_machine/branch.rb

@@ -0,0 +1,225 @@
+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.  Branches 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 Branch
+    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 matched
+    attr_reader :event_requirement
+    
+    # One or more requirements for verifying the states being matched.  All
+    # requirements contain a mapping of {:from => matcher, :to => matcher}.
+    attr_reader :state_requirements
+    
+    # A list of all of the states known to this branch.  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 branch
+    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)
+      
+      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 branch.  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
+    # 
+    #   branch = StateMachine::Branch.new(:parked => :idling, :on => :ignite)
+    #   
+    #   # Successful
+    #   branch.matches?(object, :on => :ignite)                                   # => true
+    #   branch.matches?(object, :from => nil)                                     # => true
+    #   branch.matches?(object, :from => :parked)                                 # => true
+    #   branch.matches?(object, :to => :idling)                                   # => true
+    #   branch.matches?(object, :from => :parked, :to => :idling)                 # => true
+    #   branch.matches?(object, :on => :ignite, :from => :parked, :to => :idling) # => true
+    #   
+    #   # Unsuccessful
+    #   branch.matches?(object, :on => :park)                                     # => false
+    #   branch.matches?(object, :from => :idling)                                 # => false
+    #   branch.matches?(object, :to => :first_gear)                               # => false
+    #   branch.matches?(object, :from => :parked, :to => :first_gear)             # => false
+    #   branch.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 branch.  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.
+    # * <tt>:guard</tt> - Whether to guard matches with the if/unless
+    #   conditionals defined for this branch.  Default is true.
+    # 
+    # == Examples
+    # 
+    #   branch = StateMachine::Branch.new(:parked => :idling, :on => :ignite)
+    #   
+    #   branch.match(object, :on => :ignite)  # => {:to => ..., :from => ..., :on => ...}
+    #   branch.match(object, :on => :park)    # => nil
+    def match(object, query = {})
+      assert_valid_keys(query, :from, :to, :on, :guard)
+      
+      if (match = match_query(query)) && matches_conditions?(object, query)
+        match
+      end
+    end
+    
+    # Draws a representation of this branch on the given graph.  This will draw
+    # an edge between every state this branch 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.
+    def draw(graph, event, valid_states)
+      state_requirements.each do |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'
+          graph.add_edges(from_state, loopback ? from_state : to_state, :label => event.to_s)
+        end
+      end
+      
+      true
+    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)
+          value = options[whitelist_option]
+          value.is_a?(Matcher) ? value : WhitelistMatcher.new(options[whitelist_option])
+        elsif options.include?(blacklist_option)
+          value = options[blacklist_option]
+          raise ArgumentError, ":#{blacklist_option} option cannot use matchers; use :#{whitelist_option} instead" if value.is_a?(Matcher)
+          BlacklistMatcher.new(value)
+        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_event(query) && (state_requirement = match_states(query))
+          state_requirement.merge(:on => event_requirement)
+        end
+      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 branch evaluate to true for the
+      # given object
+      def matches_conditions?(object, query)
+        query[:guard] == false ||
+        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/callback.rb

@@ -0,0 +1,236 @@
+require 'state_machine/branch'
+require 'state_machine/eval_helpers'
+
+module StateMachine
+  # Callbacks represent hooks into objects that allow logic to be triggered
+  # before, after, or around a specific set of transitions.
+  class Callback
+    include EvalHelpers
+    
+    class << self
+      # Determines whether to automatically bind the callback to the object
+      # being transitioned.  This only applies to callbacks that are defined as
+      # lambda blocks (or Procs).  Some integrations, such as DataMapper, handle
+      # callbacks by executing them bound to the object involved, while other
+      # integrations, such as ActiveRecord, pass the object as an argument to
+      # the callback.  This can be configured on an application-wide basis by
+      # setting this configuration to +true+ or +false+.  The default value
+      # is +false+.
+      # 
+      # *Note* that the DataMapper and Sequel integrations automatically
+      # configure this value on a per-callback basis, so it does not have to
+      # be enabled application-wide.
+      # 
+      # == Examples
+      # 
+      # When not bound to the object:
+      # 
+      #   class Vehicle
+      #     state_machine do
+      #       before_transition do |vehicle|
+      #         vehicle.set_alarm
+      #       end
+      #     end
+      #     
+      #     def set_alarm
+      #       ...
+      #     end
+      #   end
+      # 
+      # When bound to the object:
+      # 
+      #   StateMachine::Callback.bind_to_object = true
+      #   
+      #   class Vehicle
+      #     state_machine do
+      #       before_transition do
+      #         self.set_alarm
+      #       end
+      #     end
+      #     
+      #     def set_alarm
+      #       ...
+      #     end
+      #   end
+      attr_accessor :bind_to_object
+      
+      # The application-wide terminator to use for callbacks when not
+      # explicitly defined.  Terminators determine whether to cancel a
+      # callback chain based on the return value of the callback.
+      # 
+      # See StateMachine::Callback#terminator for more information.
+      attr_accessor :terminator
+    end
+    
+    # The type of callback chain this callback is for.  This can be one of the
+    # following:
+    # * +before+
+    # * +after+
+    # * +around+
+    # * +failure+
+    attr_accessor :type
+    
+    # An optional block for determining whether to cancel the callback chain
+    # based on the return value of the callback.  By default, the callback
+    # chain never cancels based on the return value (i.e. there is no implicit
+    # terminator).  Certain integrations, such as ActiveRecord and Sequel,
+    # change this default value.
+    # 
+    # == Examples
+    # 
+    # Canceling the callback chain without a terminator:
+    # 
+    #   class Vehicle
+    #     state_machine do
+    #       before_transition do |vehicle|
+    #         throw :halt
+    #       end
+    #     end
+    #   end
+    # 
+    # Canceling the callback chain with a terminator value of +false+:
+    # 
+    #   class Vehicle
+    #     state_machine do
+    #       before_transition do |vehicle|
+    #         false
+    #       end
+    #     end
+    #   end
+    attr_reader :terminator
+    
+    # The branch that determines whether or not this callback can be invoked
+    # based on the context of the transition.  The event, from state, and
+    # to state must all match in order for the branch to pass.
+    # 
+    # See StateMachine::Branch for more information.
+    attr_reader :branch
+    
+    # Creates a new callback that can get called based on the configured
+    # options.
+    # 
+    # In addition to the possible configuration options for branches, the
+    # following options can be configured:
+    # * <tt>:bind_to_object</tt> - Whether to bind the callback to the object involved.
+    #   If set to false, the object will be passed as a parameter instead.
+    #   Default is integration-specific or set to the application default.
+    # * <tt>:terminator</tt> - A block/proc that determines what callback
+    #   results should cause the callback chain to halt (if not using the
+    #   default <tt>throw :halt</tt> technique).
+    # 
+    # More information about how those options affect the behavior of the
+    # callback can be found in their attribute definitions.
+    def initialize(type, *args, &block)
+      @type = type
+      raise ArgumentError, 'Type must be :before, :after, :around, or :failure' unless [:before, :after, :around, :failure].include?(type)
+      
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      @methods = args
+      @methods.concat(Array(options.delete(:do)))
+      @methods << block if block_given?
+      raise ArgumentError, 'Method(s) for callback must be specified' unless @methods.any?
+      
+      options = {:bind_to_object => self.class.bind_to_object, :terminator => self.class.terminator}.merge(options)
+      
+      # Proxy lambda blocks so that they're bound to the object
+      bind_to_object = options.delete(:bind_to_object)
+      @methods.map! do |method|
+        bind_to_object && method.is_a?(Proc) ? bound_method(method) : method
+      end
+      
+      @terminator = options.delete(:terminator)
+      @branch = Branch.new(options)
+    end
+    
+    # Gets a list of the states known to this callback by looking at the
+    # branch's known states
+    def known_states
+      branch.known_states
+    end
+    
+    # Runs the callback as long as the transition context matches the branch
+    # requirements configured for this callback.  If a block is provided, it
+    # will be called when the last method has run.
+    # 
+    # If a terminator has been configured and it matches the result from the
+    # evaluated method, then the callback chain should be halted.
+    def call(object, context = {}, *args, &block)
+      if @branch.matches?(object, context)
+        run_methods(object, context, 0, *args, &block)
+        true
+      else
+        false
+      end
+    end
+    
+    private
+      # Runs all of the methods configured for this callback.
+      # 
+      # When running +around+ callbacks, this will evaluate each method and
+      # yield when the last method has yielded.  The callback will only halt if
+      # one of the methods does not yield.
+      # 
+      # For all other types of callbacks, this will evaluate each method in
+      # order.  The callback will only halt if the resulting value from the
+      # method passes the terminator.
+      def run_methods(object, context = {}, index = 0, *args, &block)
+        if type == :around
+          if current_method = @methods[index]
+            yielded = false
+            evaluate_method(object, current_method, *args) do
+              yielded = true
+              run_methods(object, context, index + 1, *args, &block)
+            end
+            
+            throw :halt unless yielded
+          else
+            yield if block_given?
+          end
+        else
+          @methods.each do |method|
+            result = evaluate_method(object, method, *args)
+            throw :halt if @terminator && @terminator.call(result)
+          end
+        end
+      end
+      
+      # Generates a method that can be bound to the object being transitioned
+      # when the callback is invoked
+      def bound_method(block)
+        type = self.type
+        arity = block.arity
+        arity += 1 if arity >= 0 # Make sure the object gets passed
+        arity += 1 if arity == 1 && type == :around  # Make sure the block gets passed
+        
+        method = if RUBY_VERSION >= '1.9'
+          lambda do |object, *args|
+            object.instance_exec(*args, &block)
+          end
+        else
+          # Generate a thread-safe unbound method that can be used on any object.
+          # This is a workaround for not having Ruby 1.9's instance_exec
+          unbound_method = Object.class_eval do
+            time = Time.now
+            method_name = "__bind_#{time.to_i}_#{time.usec}"
+            define_method(method_name, &block)
+            method = instance_method(method_name)
+            remove_method(method_name)
+            method
+          end
+          
+          # Proxy calls to the method so that the method can be bound *and*
+          # the arguments are adjusted
+          lambda do |object, *args|
+            unbound_method.bind(object).call(*args)
+          end
+        end
+        
+        # Proxy arity to the original block
+        (class << method; self; end).class_eval do
+          define_method(:arity) { arity }
+        end
+        
+        method
+      end
+  end
+end

data/lib/state_machine/core.rb

@@ -0,0 +1,7 @@
+# Load all of the core implementation required to use state_machine.  This
+# includes:
+# * StateMachine::MacroMethods which adds the state_machine DSL to your class
+# * A set of initializers for setting state_machine defaults based on the current
+#   running environment (such as within Rails)
+require 'state_machine/macro_methods'
+require 'state_machine/initializers'

data/lib/state_machine/core_ext/class/state_machine.rb

@@ -0,0 +1,5 @@
+require 'state_machine/macro_methods'
+
+Class.class_eval do
+  include StateMachine::MacroMethods
+end

data/lib/state_machine/core_ext.rb

@@ -0,0 +1,2 @@
+# Loads all of the extensions to be made to Ruby core classes
+require 'state_machine/core_ext/class/state_machine'

data/lib/state_machine/error.rb

@@ -0,0 +1,13 @@
+module StateMachine
+  # An error occurred during a state machine invocation
+  class Error < StandardError
+    # The object that failed
+    attr_reader :object
+    
+    def initialize(object, message = nil) #:nodoc:
+      @object = object
+      
+      super(message)
+    end
+  end
+end

data/lib/state_machine/eval_helpers.rb

@@ -0,0 +1,87 @@
+module StateMachine
+  # Provides a set of helper methods for evaluating methods within the context
+  # of an object.
+  module EvalHelpers
+    # Evaluates one of several different types of methods within the context
+    # of the given object.  Methods can be one of the following types:
+    # * Symbol
+    # * Method / Proc
+    # * String
+    # 
+    # == Examples
+    # 
+    # Below are examples of the various ways that a method can be evaluated
+    # on an object:
+    # 
+    #   class Person
+    #     def initialize(name)
+    #       @name = name
+    #     end
+    #     
+    #     def name
+    #       @name
+    #     end
+    #   end
+    #   
+    #   class PersonCallback
+    #     def self.run(person)
+    #       person.name
+    #     end
+    #   end
+    # 
+    #   person = Person.new('John Smith')
+    #   
+    #   evaluate_method(person, :name)                            # => "John Smith"
+    #   evaluate_method(person, PersonCallback.method(:run))      # => "John Smith"
+    #   evaluate_method(person, Proc.new {|person| person.name})  # => "John Smith"
+    #   evaluate_method(person, lambda {|person| person.name})    # => "John Smith"
+    #   evaluate_method(person, '@name')                          # => "John Smith"
+    # 
+    # == Additional arguments
+    # 
+    # Additional arguments can be passed to the methods being evaluated.  If
+    # the method defines additional arguments other than the object context,
+    # then all arguments are required.
+    # 
+    # For example,
+    # 
+    #   person = Person.new('John Smith')
+    #   
+    #   evaluate_method(person, lambda {|person| person.name}, 21)                              # => "John Smith"
+    #   evaluate_method(person, lambda {|person, age| "#{person.name} is #{age}"}, 21)          # => "John Smith is 21"
+    #   evaluate_method(person, lambda {|person, age| "#{person.name} is #{age}"}, 21, 'male')  # => ArgumentError: wrong number of arguments (3 for 2)
+    def evaluate_method(object, method, *args, &block)
+      case method
+        when Symbol
+          klass = (class << object; self; end)
+          args = [] if (klass.method_defined?(method) || klass.private_method_defined?(method)) && object.method(method).arity == 0
+          object.send(method, *args, &block)
+        when Proc, Method
+          args.unshift(object)
+          arity = method.arity
+          
+          # Procs don't support blocks in < Ruby 1.9, so it's tacked on as an
+          # argument for consistency across versions of Ruby
+          if block_given? && Proc === method && arity != 0
+            if [1, 2].include?(arity)
+              # Force the block to be either the only argument or the 2nd one
+              # after the object (may mean additional arguments get discarded)
+              args = args[0, arity - 1] + [block]
+            else
+              # Tack the block to the end of the args
+              args << block
+            end
+          else
+            # These method types are only called with 0, 1, or n arguments
+            args = args[0, arity] if [0, 1].include?(arity)
+          end
+          
+          method.is_a?(Proc) ? method.call(*args) : method.call(*args, &block)
+        when String
+          eval(method, object.instance_eval {binding}, &block)
+        else
+          raise ArgumentError, 'Methods must be a symbol denoting the method to call, a block to be invoked, or a string to be evaluated'
+      end
+    end
+  end
+end