state_machines 0.5.0 → 0.6.0

data/lib/state_machines/state_collection.rb

@@ -2,25 +2,25 @@ module StateMachines
   # Represents a collection of states in a state machine
   class StateCollection < NodeCollection
     def initialize(machine) #:nodoc:
-      super(machine, :index => [:name, :qualified_name, :value])
+      super(machine, index: [:name, :qualified_name, :value])
     end
 
     # Determines whether the given object is in a specific state.  If the
     # object's current value doesn't match the state, then this will return
     # false, otherwise true.  If the given state is unknown, then an IndexError
     # will be raised.
-    # 
+    #
     # == Examples
-    # 
+    #
     #   class Vehicle
     #     state_machine :initial => :parked do
     #       other_states :idling
     #     end
     #   end
-    #   
+    #
     #   states = Vehicle.state_machine.states
     #   vehicle = Vehicle.new               # => #<Vehicle:0xb7c464b0 @state="parked">
-    #   
+    #
     #   states.matches?(vehicle, :parked)   # => true
     #   states.matches?(vehicle, :idling)   # => false
     #   states.matches?(vehicle, :invalid)  # => IndexError: :invalid is an invalid key for :name index
@@ -31,23 +31,23 @@ module StateMachines
     # Determines the current state of the given object as configured by this
     # state machine.  This will attempt to find a known state that matches
     # the value of the attribute on the object.
-    # 
+    #
     # == Examples
-    # 
+    #
     #   class Vehicle
     #     state_machine :initial => :parked do
     #       other_states :idling
     #     end
     #   end
-    #   
+    #
     #   states = Vehicle.state_machine.states
-    #   
+    #
     #   vehicle = Vehicle.new         # => #<Vehicle:0xb7c464b0 @state="parked">
     #   states.match(vehicle)         # => #<StateMachines::State name=:parked value="parked" initial=true>
-    #   
+    #
     #   vehicle.state = 'idling'
     #   states.match(vehicle)         # => #<StateMachines::State name=:idling value="idling" initial=true>
-    #   
+    #
     #   vehicle.state = 'invalid'
     #   states.match(vehicle)         # => nil
     def match(object)
@@ -58,20 +58,20 @@ module StateMachines
     # Determines the current state of the given object as configured by this
     # state machine.  If no state is found, then an ArgumentError will be
     # raised.
-    # 
+    #
     # == Examples
-    # 
+    #
     #   class Vehicle
     #     state_machine :initial => :parked do
     #       other_states :idling
     #     end
     #   end
-    #   
+    #
     #   states = Vehicle.state_machine.states
-    #   
+    #
     #   vehicle = Vehicle.new         # => #<Vehicle:0xb7c464b0 @state="parked">
     #   states.match!(vehicle)        # => #<StateMachines::State name=:parked value="parked" initial=true>
-    #   
+    #
     #   vehicle.state = 'invalid'
     #   states.match!(vehicle)        # => ArgumentError: "invalid" is not a known state value
     def match!(object)
@@ -80,13 +80,13 @@ module StateMachines
 
     # Gets the order in which states should be displayed based on where they
     # were first referenced.  This will order states in the following priority:
-    # 
+    #
     # 1. Initial state
     # 2. Event transitions (:from, :except_from, :to, :except_to options)
     # 3. States with behaviors
     # 4. States referenced via +state+ or +other_states+
     # 5. States referenced in callbacks
-    # 
+    #
     # This order will determine how the GraphViz visualizations are rendered.
     def by_priority
       order = select { |state| state.initial }.map { |state| state.name }
@@ -101,7 +101,8 @@ module StateMachines
       order
     end
 
-    private
+  private
+
     # Gets the value for the given attribute on the node
     def value(node, attribute)
       attribute == :value ? node.value(false) : super

data/lib/state_machines/state_context.rb

@@ -1,100 +1,98 @@
 module StateMachines
-
-  
   # Represents a module which will get evaluated within the context of a state.
-  # 
+  #
   # Class-level methods are proxied to the owner class, injecting a custom
   # <tt>:if</tt> condition along with method.  This assumes that the method has
   # support for a set of configuration options, including <tt>:if</tt>.  This
   # condition will check that the object's state matches this context's state.
-  # 
+  #
   # Instance-level methods are used to define state-driven behavior on the
   # state's owner class.
-  # 
+  #
   # == Examples
-  # 
+  #
   #   class Vehicle
   #     class << self
   #       attr_accessor :validations
-  #       
+  #
   #       def validate(options, &block)
   #         validations << options
   #       end
   #     end
-  #     
+  #
   #     self.validations = []
   #     attr_accessor :state, :simulate
-  #     
+  #
   #     def moving?
   #       self.class.validations.all? {|validation| validation[:if].call(self)}
   #     end
   #   end
-  # 
+  #
   # In the above class, a simple set of validation behaviors have been defined.
   # Each validation consists of a configuration like so:
-  # 
+  #
   #   Vehicle.validate :unless => :simulate
   #   Vehicle.validate :if => lambda {|vehicle| ...}
-  # 
+  #
   # In order to scope validations to a particular state context, the class-level
   # +validate+ method can be invoked like so:
-  # 
+  #
   #   machine = StateMachines::Machine.new(Vehicle)
   #   context = StateMachines::StateContext.new(machine.state(:first_gear))
   #   context.validate(:unless => :simulate)
-  #   
+  #
   #   vehicle = Vehicle.new     # => #<Vehicle:0xb7ce491c @simulate=nil, @state=nil>
   #   vehicle.moving?           # => false
-  #   
+  #
   #   vehicle.state = 'first_gear'
   #   vehicle.moving?           # => true
-  #   
+  #
   #   vehicle.simulate = true
   #   vehicle.moving?           # => false
   class StateContext < Module
 
     include EvalHelpers
-    
+
     # The state machine for which this context's state is defined
     attr_reader :machine
-    
+
     # The state that must be present in an object for this context to be active
     attr_reader :state
-    
+
     # Creates a new context for the given state
     def initialize(state)
       @state = state
       @machine = state.machine
-      
+
       state_name = state.name
       machine_name = machine.name
-      @condition = lambda {|object| object.class.state_machine(machine_name).states.matches?(object, state_name)}
+      @condition = lambda { |object| object.class.state_machine(machine_name).states.matches?(object, state_name) }
     end
-    
+
     # Creates a new transition that determines what to change the current state
     # to when an event fires from this state.
-    # 
+    #
     # Since this transition is being defined within a state context, you do
     # *not* need to specify the <tt>:from</tt> option for the transition.  For
     # example:
-    # 
+    #
     #   state_machine do
     #     state :parked do
     #       transition :to => :idling, :on => [:ignite, :shift_up]                          # Transitions to :idling
     #       transition :from => [:idling, :parked], :on => :park, :unless => :seatbelt_on?  # Transitions to :parked if seatbelt is off
     #     end
     #   end
-    # 
+    #
     # See StateMachines::Machine#transition for a description of the possible
     # configurations for defining transitions.
     def transition(options)
       options.assert_valid_keys(:from, :to, :on, :if, :unless)
       raise ArgumentError, 'Must specify :on event' unless options[:on]
       raise ArgumentError, 'Must specify either :to or :from state' unless !options[:to] ^ !options[:from]
-      
-      machine.transition(options.merge(options[:to] ? {:from => state.name} : {:to => state.name}))
+
+      machine.transition(options.merge(options[:to] ? {from: state.name} : {to: state.name}))
     end
-    
+
     # Hooks in condition-merging to methods that don't exist in this module
     def method_missing(*args, &block)
       # Get the configuration
@@ -103,28 +101,28 @@ module StateMachines
       else
         args << options = {}
       end
-      
+
       # Get any existing condition that may need to be merged
       if_condition = options.delete(:if)
       unless_condition = options.delete(:unless)
-      
+
       # Provide scope access to configuration in case the block is evaluated
       # within the object instance
       proxy = self
       proxy_condition = @condition
-      
+
       # Replace the configuration condition with the one configured for this
       # proxy, merging together any existing conditions
       options[:if] = lambda do |*condition_args|
         # Block may be executed within the context of the actual object, so
         # it'll either be the first argument or the executing context
         object = condition_args.first || self
-        
+
         proxy.evaluate_method(object, proxy_condition) &&
-        Array(if_condition).all? {|condition| proxy.evaluate_method(object, condition)} &&
-        !Array(unless_condition).any? {|condition| proxy.evaluate_method(object, condition)}
+        Array(if_condition).all? { |condition| proxy.evaluate_method(object, condition) } &&
+        !Array(unless_condition).any? { |condition| proxy.evaluate_method(object, condition) }
       end
-      
+
       # Evaluate the method on the owner class with the condition proxied
       # through
       machine.owner_class.send(*args, &block)