verborghs-state_machine 0.9.4

data/examples/auto_shop.rb

@@ -0,0 +1,11 @@
+class AutoShop
+  state_machine :initial => :available do
+    event :tow_vehicle do
+      transition :available => :busy
+    end
+    
+    event :fix_vehicle do
+      transition :busy => :available 
+    end
+  end
+end

data/examples/car.rb

@@ -0,0 +1,19 @@
+class Car < Vehicle
+  state_machine do
+    event :reverse do
+      transition [:parked, :idling, :first_gear] => :backing_up
+    end
+    
+    event :park do
+      transition :backing_up => :parked
+    end
+    
+    event :idle do
+      transition :backing_up => :idling
+    end
+    
+    event :shift_up do
+      transition :backing_up => :first_gear
+    end
+  end
+end

data/examples/merb-rest/controller.rb

@@ -0,0 +1,51 @@
+class Users < Application
+  # GET /users
+  def index
+    @users = User.all
+    display @users
+  end
+  
+  # GET /users/1
+  def show(id)
+    @user = User.get(id)
+    raise NotFound unless @user
+    display @user
+  end
+  
+  # GET /users/new
+  def new
+    only_provides :html
+    @user = User.new
+    display @user
+  end
+  
+  # GET /users/1/edit
+  def edit(id)
+    only_provides :html
+    @user = User.get(id)
+    raise NotFound unless @user
+    display @user
+  end
+  
+  # POST /users
+  def create(user)
+    @user = User.new(user)
+    if @user.save
+      redirect resource(@user), :message => {:notice => "User was successfully created"}
+    else
+      message[:error] = "User failed to be created"
+      render :new
+    end
+  end
+  
+  # PUT /users/1
+  def update(id, user)
+    @user = User.get(id)
+    raise NotFound unless @user
+    if @user.update_attributes(user)
+       redirect resource(@user)
+    else
+      display @user, :edit
+    end
+  end
+end

data/examples/merb-rest/model.rb

@@ -0,0 +1,28 @@
+class User
+  include DataMapper::Resource
+  
+  property :id, Serial
+  property :name, String
+  
+  validates_present :name, :state, :access_state
+  
+  state_machine :initial => :unregistered do
+    event :register do
+      transition :unregistered => :registered
+    end
+    
+    event :unregister do
+      transition :registered => :unregistered
+    end
+  end
+  
+  state_machine :access_state, :initial => :enabled do
+    event :enable do
+      transition all => :enabled
+    end
+    
+    event :disable do
+      transition all => :disabled
+    end
+  end
+end

data/examples/merb-rest/view_edit.html.erb

@@ -0,0 +1,24 @@
+<h1>Editing User</h1>
+
+<%= form_for @user, :action => resource(@user) do %>
+  <%= error_messages %>
+  
+  <p>
+    <%= text_field :name, :label => 'Name' %>
+  </p>
+  
+  <p>
+    <%= label :state %><br />
+    <%= select :state_event, :selected => @user.state_event.to_s, :collection => @user.state_transitions, :value_method => :event, :text_method => :human_to_name, :prompt => @user.human_state_name %>
+  </p>
+  
+  <p>
+    <%= label :access_state %><br />
+    <%= select :access_state_event, :selected => @user.access_state_event.to_s, :collection => @user.access_state_transitions, :value_method => :event, :text_method => :human_event, :prompt => "don't change" %>
+  </p>
+  
+  <p><%= submit 'Update' %></p>
+<% end =%>
+
+<%= link_to 'Show', resource(@user) %> |
+<%= link_to 'Back', resource(:users) %>

data/examples/merb-rest/view_index.html.erb

@@ -0,0 +1,23 @@
+<h1>Listing Users</h1>
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>State</th>
+    <th>Access State</th>
+  </tr>
+  
+<% @users.each do |user| %>
+  <tr>
+    <td><%=h user.name %></td>
+    <td><%=h user.human_state_name %></td>
+    <td><%=h user.human_access_state_name %></td>
+    <td><%= link_to 'Show', resource(user) %></td>
+    <td><%= link_to 'Edit', resource(user, :edit) %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New User', resource(:users, :new) %>

data/examples/merb-rest/view_new.html.erb

@@ -0,0 +1,13 @@
+<h1>New User</h1>
+
+<%= form_for @user, :action => resource(:users) do %>
+  <%= error_messages %>
+  
+  <p>
+    <%= text_field :name, :label => 'Name' %>
+  </p>
+  
+  <p><%= submit 'Create' %></p>
+<% end =%>
+
+<%= link_to 'Back', resource(:users) %>

data/examples/merb-rest/view_show.html.erb

@@ -0,0 +1,17 @@
+<p>
+  <b>Name:</b>
+  <%=h @user.name %>
+</p>
+
+<p>
+  <b>State:</b>
+  <%=h @user.human_state_name %>
+</p>
+
+<p>
+  <b>Access State:</b>
+  <%=h @user.human_access_state_name %>
+</p>
+
+<%= link_to 'Edit', resource(@user, :edit) %> |
+<%= link_to 'Back', resource(:users) %>

data/examples/rails-rest/controller.rb

@@ -0,0 +1,43 @@
+class UsersController < ApplicationController
+  # GET /users
+  def index
+    @users = User.all
+  end
+  
+  # GET /users/1
+  def show
+    @user = User.find(params[:id])
+  end
+  
+  # GET /users/new
+  def new
+    @user = User.new
+  end
+  
+  # GET /users/1/edit
+  def edit
+    @user = User.find(params[:id])
+  end
+  
+  # POST /users
+  def create
+    @user = User.new(params[:user])
+    
+    if @user.save
+      redirect_to(@user)
+    else
+      render :action => 'new'
+    end
+  end
+  
+  # PUT /users/1
+  def update
+    @user = User.find(params[:id])
+    
+    if @user.update_attributes(params[:user])
+      redirect_to(@user)
+    else
+      render :action => 'edit'
+    end
+  end
+end

data/examples/rails-rest/migration.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :name, :state, :access_state
+    end
+  end
+  
+  def self.down
+    drop_table :users
+  end
+end

data/examples/rails-rest/model.rb

@@ -0,0 +1,23 @@
+class User < ActiveRecord::Base
+  validates_presence_of :name, :state, :access_state
+  
+  state_machine :initial => :unregistered do
+    event :register do
+      transition :unregistered => :registered
+    end
+    
+    event :unregister do
+      transition :registered => :unregistered
+    end
+  end
+  
+  state_machine :access_state, :initial => :enabled do
+    event :enable do
+      transition all => :enabled
+    end
+    
+    event :disable do
+      transition all => :disabled
+    end
+  end
+end

data/examples/rails-rest/view_edit.html.erb

@@ -0,0 +1,25 @@
+<h1>Editing User</h1>
+
+<% form_for(@user) do |f| %>
+  <%= f.error_messages %>
+  
+  <p>
+    <%= f.label :name %><br />
+    <%= f.text_field :name %>
+  </p>
+  
+  <p>
+    <%= f.label :state %><br />
+    <%= f.collection_select :state_event, @user.state_transitions, :event, :human_to_name, :include_blank => @user.human_state_name %>
+  </p>
+  
+  <p>
+    <%= f.label :access_state %><br />
+    <%= f.collection_select :access_state_event, @user.access_state_transitions, :event, :human_event, :include_blank => "don't change" %>
+  </p>
+  
+  <p><%= f.submit 'Update' %></p>
+<% end %>
+
+<%= link_to 'Show', @user %> |
+<%= link_to 'Back', users_path %>

data/examples/rails-rest/view_index.html.erb

@@ -0,0 +1,23 @@
+<h1>Listing Users</h1>
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>State</th>
+    <th>Access State</th>
+  </tr>
+  
+<% @users.each do |user| %>
+  <tr>
+    <td><%=h user.name %></td>
+    <td><%=h user.human_state_name %></td>
+    <td><%=h user.human_access_state_name %></td>
+    <td><%= link_to 'Show', user %></td>
+    <td><%= link_to 'Edit', edit_user_path(user) %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New User', new_user_path %>

data/examples/rails-rest/view_new.html.erb

@@ -0,0 +1,14 @@
+<h1>New User</h1>
+
+<% form_for @user do |f| %>
+  <%= f.error_messages %>
+  
+  <p>
+    <%= f.label :name %><br />
+    <%= f.text_field :name %>
+  </p>
+  
+  <p><%= f.submit 'Create' %></p>
+<% end %>
+
+<%= link_to 'Back', users_path %>

data/examples/rails-rest/view_show.html.erb

@@ -0,0 +1,17 @@
+<p>
+  <b>Name:</b>
+  <%=h @user.name %>
+</p>
+
+<p>
+  <b>State:</b>
+  <%=h @user.human_state_name %>
+</p>
+
+<p>
+  <b>Access State:</b>
+  <%=h @user.human_access_state_name %>
+</p>
+
+<%= link_to 'Edit', edit_user_path(@user) %> |
+<%= link_to 'Back', users_path %>

data/examples/traffic_light.rb

@@ -0,0 +1,7 @@
+class TrafficLight
+  state_machine :initial => :stop do
+    event :cycle do
+      transition :stop => :proceed, :proceed => :caution, :caution => :stop
+    end
+  end
+end

data/examples/vehicle.rb

@@ -0,0 +1,31 @@
+class Vehicle
+  state_machine :initial => :parked do
+    event :park do
+      transition [:idling, :first_gear] => :parked
+    end
+    
+    event :ignite do
+      transition :stalled => same, :parked => :idling
+    end
+    
+    event :idle do
+      transition :first_gear => :idling
+    end
+    
+    event :shift_up do
+      transition :idling => :first_gear, :first_gear => :second_gear, :second_gear => :third_gear
+    end
+    
+    event :shift_down do
+      transition :third_gear => :second_gear, :second_gear => :first_gear
+    end
+    
+    event :crash do
+      transition [:first_gear, :second_gear, :third_gear] => :stalled
+    end
+    
+    event :repair do
+      transition :stalled => :parked
+    end
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'state_machine'

data/lib/state_machine/assertions.rb

@@ -0,0 +1,36 @@
+module StateMachine
+  # Provides a set of helper methods for making assertions about the content
+  # of various objects
+  module Assertions
+    # Validates that the given hash *only* includes the specified valid keys.
+    # If any invalid keys are found, an ArgumentError will be raised.
+    #
+    # == Examples
+    # 
+    #   options = {:name => 'John Smith', :age => 30}
+    #   
+    #   assert_valid_keys(options, :name)           # => ArgumentError: Invalid key(s): age
+    #   assert_valid_keys(options, 'name', 'age')   # => ArgumentError: Invalid key(s): age, name
+    #   assert_valid_keys(options, :name, :age)     # => nil
+    def assert_valid_keys(hash, *valid_keys)
+      invalid_keys = hash.keys - valid_keys
+      raise ArgumentError, "Invalid key(s): #{invalid_keys.join(', ')}" unless invalid_keys.empty?
+    end
+    
+    # Validates that the given hash only includes at *most* one of a set of
+    # exclusive keys.  If more than one key is found, an ArgumentError will be
+    # raised.
+    # 
+    # == Examples
+    # 
+    #   options = {:only => :on, :except => :off}
+    #   assert_exclusive_keys(options, :only)                   # => nil
+    #   assert_exclusive_keys(options, :except)                 # => nil
+    #   assert_exclusive_keys(options, :only, :except)          # => ArgumentError: Conflicting keys: only, except
+    #   assert_exclusive_keys(options, :only, :except, :with)   # => ArgumentError: Conflicting keys: only, except
+    def assert_exclusive_keys(hash, *exclusive_keys)
+      conflicting_keys = exclusive_keys & hash.keys
+      raise ArgumentError, "Conflicting keys: #{conflicting_keys.join(', ')}" unless conflicting_keys.length <= 1
+    end
+  end
+end

data/lib/state_machine/callback.rb

@@ -0,0 +1,241 @@
+require 'state_machine/guard'
+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+
+    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 guard 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 guard to pass.
+    # 
+    # See StateMachine::Guard for more information.
+    attr_reader :guard
+    
+    # Creates a new callback that can get called based on the configured
+    # options.
+    # 
+    # In addition to the possible configuration options for guards, 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, or :around' unless [:before, :after, :around].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)
+      @guard = Guard.new(options)
+    end
+    
+    # Gets a list of the states known to this callback by looking at the
+    # guard's known states
+    def known_states
+      guard.known_states
+    end
+    
+    # Runs the callback as long as the transition context matches the guard
+    # 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 @guard.matches?(object, context)
+        run_methods(object, context, 0, *args, &block)
+        true
+      else
+        false
+      end
+    end
+    
+    # Verifies that the success requirement for this callback matches the given
+    # value
+    def matches_success?(success)
+      guard.success_requirement.matches?(success)
+    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 method = @methods[index]
+            yielded = false
+            evaluate_method(object, 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