enum_state_machine 0.0.1 → 0.0.2

data/lib/enum_state_machine/callback.rb

@@ -1,232 +0,0 @@
-require 'enum_state_machine/branch'
-require 'enum_state_machine/eval_helpers'
-
-module EnumStateMachine
-  # 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 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+.
-      #
-      # == 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:
-      # 
-      #   EnumStateMachine::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 EnumStateMachine::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,
-    # 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 EnumStateMachine::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/enum_state_machine/core.rb

@@ -1,12 +0,0 @@
-module EnumStateMachine
-  # Graphing extensions aren't required, so they're loaded when referenced
-  autoload :Graph, 'enum_state_machine/graph'
-end
-
-# Load all of the core implementation required to use state_machine.  This
-# includes:
-# * EnumStateMachine::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 'enum_state_machine/macro_methods'
-require 'enum_state_machine/initializers'

data/lib/enum_state_machine/core_ext.rb

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

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

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

data/lib/enum_state_machine/error.rb

@@ -1,13 +0,0 @@
-module EnumStateMachine
-  # 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/enum_state_machine/eval_helpers.rb

@@ -1,87 +0,0 @@
-module EnumStateMachine
-  # 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

data/lib/enum_state_machine/event.rb

@@ -1,257 +0,0 @@
-require 'enum_state_machine/transition'
-require 'enum_state_machine/branch'
-require 'enum_state_machine/assertions'
-require 'enum_state_machine/matcher_helpers'
-require 'enum_state_machine/error'
-
-module EnumStateMachine
-  # An invalid event was specified
-  class InvalidEvent < Error
-    # The event that was attempted to be run
-    attr_reader :event
-    
-    def initialize(object, event_name) #:nodoc:
-      @event = event_name
-      
-      super(object, "#{event.inspect} is an unknown state machine event")
-    end
-  end
-  
-  # An event defines an action that transitions an attribute from one state to
-  # another.  The state that an attribute is transitioned to depends on the
-  # branches configured for the event.
-  class Event
-    include Assertions
-    include MatcherHelpers
-    
-    # The state machine for which this event is defined
-    attr_accessor :machine
-    
-    # The name of the event
-    attr_reader :name
-    
-    # The fully-qualified name of the event, scoped by the machine's namespace 
-    attr_reader :qualified_name
-    
-    # The human-readable name for the event
-    attr_writer :human_name
-    
-    # The list of branches that determine what state this event transitions
-    # objects to when fired
-    attr_reader :branches
-    
-    # A list of all of the states known to this event using the configured
-    # branches/transitions as the source
-    attr_reader :known_states
-    
-    # Creates a new event within the context of the given machine
-    # 
-    # Configuration options:
-    # * <tt>:human_name</tt> - The human-readable version of this event's name
-    def initialize(machine, name, options = {}) #:nodoc:
-      assert_valid_keys(options, :human_name)
-      
-      @machine = machine
-      @name = name
-      @qualified_name = machine.namespace ? :"#{name}_#{machine.namespace}" : name
-      @human_name = options[:human_name] || @name.to_s.tr('_', ' ')
-      reset
-      
-      # Output a warning if another event has a conflicting qualified name
-      if conflict = machine.owner_class.state_machines.detect {|other_name, other_machine| other_machine != @machine && other_machine.events[qualified_name, :qualified_name]}
-        name, other_machine = conflict
-        warn "Event #{qualified_name.inspect} for #{machine.name.inspect} is already defined in #{other_machine.name.inspect}"
-      else
-        add_actions
-      end
-    end
-    
-    # Creates a copy of this event in addition to the list of associated
-    # branches to prevent conflicts across events within a class hierarchy.
-    def initialize_copy(orig) #:nodoc:
-      super
-      @branches = @branches.dup
-      @known_states = @known_states.dup
-    end
-    
-    # Transforms the event name into a more human-readable format, such as
-    # "turn on" instead of "turn_on"
-    def human_name(klass = @machine.owner_class)
-      @human_name.is_a?(Proc) ? @human_name.call(self, klass) : @human_name
-    end
-    
-    # Evaluates the given block within the context of this event.  This simply
-    # provides a DSL-like syntax for defining transitions.
-    def context(&block)
-      instance_eval(&block)
-    end
-    
-    # Creates a new transition that determines what to change the current state
-    # to when this event fires.
-    # 
-    # Since this transition is being defined within an event context, you do
-    # *not* need to specify the <tt>:on</tt> option for the transition.  For
-    # example:
-    # 
-    #  state_machine do
-    #    event :ignite do
-    #      transition :parked => :idling, :idling => same, :if => :seatbelt_on? # Transitions to :idling if seatbelt is on
-    #      transition all => :parked, :unless => :seatbelt_on?                  # Transitions to :parked if seatbelt is off
-    #    end
-    #  end
-    # 
-    # See EnumStateMachine::Machine#transition for a description of the possible
-    # configurations for defining transitions.
-    def transition(options)
-      raise ArgumentError, 'Must specify as least one transition requirement' if options.empty?
-      
-      # Only a certain subset of explicit options are allowed for transition
-      # requirements
-      assert_valid_keys(options, :from, :to, :except_from, :except_to, :if, :unless) if (options.keys - [:from, :to, :on, :except_from, :except_to, :except_on, :if, :unless]).empty?
-      
-      branches << branch = Branch.new(options.merge(:on => name))
-      @known_states |= branch.known_states
-      branch
-    end
-    
-    # Determines whether any transitions can be performed for this event based
-    # on the current state of the given object.
-    # 
-    # If the event can't be fired, then this will return false, otherwise true.
-    # 
-    # *Note* that this will not take the object context into account.  Although
-    # a transition may be possible based on the state machine definition,
-    # object-specific behaviors (like validations) may prevent it from firing.
-    def can_fire?(object, requirements = {})
-      !transition_for(object, requirements).nil?
-    end
-    
-    # Finds and builds the next transition that can be performed on the given
-    # object.  If no transitions can be made, then this will return nil.
-    # 
-    # Valid requirement options:
-    # * <tt>:from</tt> - One or more states being transitioned from.  If none
-    #   are specified, then this will be the object's current state.
-    # * <tt>:to</tt> - One or more states being transitioned to.  If none are
-    #   specified, then this will match any to state.
-    # * <tt>:guard</tt> - Whether to guard transitions with the if/unless
-    #   conditionals defined for each one.  Default is true.
-    def transition_for(object, requirements = {})
-      assert_valid_keys(requirements, :from, :to, :guard)
-      requirements[:from] = machine.states.match!(object).name unless custom_from_state = requirements.include?(:from)
-      
-      branches.each do |branch|
-        if match = branch.match(object, requirements)
-          # Branch allows for the transition to occur
-          from = requirements[:from]
-          to = if match[:to].is_a?(LoopbackMatcher)
-            from
-          else
-            values = requirements.include?(:to) ? [requirements[:to]].flatten : [from] | machine.states.map {|state| state.name}
-            
-            match[:to].filter(values).first
-          end
-          
-          return Transition.new(object, machine, name, from, to, !custom_from_state)
-        end
-      end
-      
-      # No transition matched
-      nil
-    end
-    
-    # Attempts to perform the next available transition on the given object.
-    # If no transitions can be made, then this will return false, otherwise
-    # true.
-    # 
-    # Any additional arguments are passed to the EnumStateMachine::Transition#perform
-    # instance method.
-    def fire(object, *args)
-      machine.reset(object)
-      
-      if transition = transition_for(object)
-        transition.perform(*args)
-      else
-        on_failure(object)
-        false
-      end
-    end
-    
-    # Marks the object as invalid and runs any failure callbacks associated with
-    # this event.  This should get called anytime this event fails to transition.
-    def on_failure(object)
-      state = machine.states.match!(object)
-      machine.invalidate(object, :state, :invalid_transition, [[:event, human_name(object.class)], [:state, state.human_name(object.class)]])
-      
-      Transition.new(object, machine, name, state.name, state.name).run_callbacks(:before => false)
-    end
-    
-    # Resets back to the initial state of the event, with no branches / known
-    # states associated.  This allows you to redefine an event in situations
-    # where you either are re-using an existing state machine implementation
-    # or are subclassing machines.
-    def reset
-      @branches = []
-      @known_states = []
-    end
-    
-    # Draws a representation of this event on the given graph.  This will
-    # create 1 or more edges on the graph for each branch (i.e. transition)
-    # configured.
-    # 
-    # Configuration options:
-    # * <tt>:human_name</tt> - Whether to use the event's human name for the
-    #   node's label that gets drawn on the graph
-    def draw(graph, options = {})
-      valid_states = machine.states.by_priority.map {|state| state.name}
-      branches.each do |branch|
-        branch.draw(graph, options[:human_name] ? human_name : name, valid_states)
-      end
-      
-      true
-    end
-    
-    # Generates a nicely formatted description of this event's contents.
-    # 
-    # For example,
-    # 
-    #   event = EnumStateMachine::Event.new(machine, :park)
-    #   event.transition all - :idling => :parked, :idling => same
-    #   event   # => #<EnumStateMachine::Event name=:park transitions=[all - :idling => :parked, :idling => same]>
-    def inspect
-      transitions = branches.map do |branch|
-        branch.state_requirements.map do |state_requirement|
-          "#{state_requirement[:from].description} => #{state_requirement[:to].description}"
-        end * ', '
-      end
-      
-      "#<#{self.class} name=#{name.inspect} transitions=[#{transitions * ', '}]>"
-    end
-    
-    protected
-      # Add the various instance methods that can transition the object using
-      # the current event
-      def add_actions
-        # Checks whether the event can be fired on the current object
-        machine.define_helper(:instance, "can_#{qualified_name}?") do |machine, object, *args|
-          machine.event(name).can_fire?(object, *args)
-        end
-        
-        # Gets the next transition that would be performed if the event were
-        # fired now
-        machine.define_helper(:instance, "#{qualified_name}_transition") do |machine, object, *args|
-          machine.event(name).transition_for(object, *args)
-        end
-        
-        # Fires the event
-        machine.define_helper(:instance, qualified_name) do |machine, object, *args|
-          machine.event(name).fire(object, *args)
-        end
-        
-        # Fires the event, raising an exception if it fails
-        machine.define_helper(:instance, "#{qualified_name}!") do |machine, object, *args|
-          object.send(qualified_name, *args) || raise(EnumStateMachine::InvalidTransition.new(object, machine, name))
-        end
-      end
-  end
-end