golem_statemachine 0.9

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the golem_statemachine plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the golem_statemachine plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GolemStatemachine'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/examples/document.rb

@@ -0,0 +1,44 @@
+$: << File.expand_path(File.dirname(__FILE__)+"/../lib")
+require 'golem'
+
+class Document
+  
+  def initialize
+    @has_signature = false
+  end
+
+  def sign!
+    @has_signature = true
+  end
+
+  def has_signature?
+    @has_signature
+  end
+
+  include Golem
+  define_statemachine do
+    initial_state :NEW
+
+    state :NEW do
+      on :submit, :to => :SUBMITTED
+    end
+
+    state :SUBMITTED do
+      on :review do
+        transition :to => :APPROVED, :if => :has_signature?
+        transition :to => :REJECTED
+      end
+    end
+
+    state :REJECTED do
+      on :revise, :to => :REVISED
+    end
+
+    state :REVISED do
+      on :submit, :to => :SUBMITTED
+    end
+
+    state :APPROVED
+  end
+end
+

data/examples/monster.rb

@@ -0,0 +1,100 @@
+$: << File.expand_path(File.dirname(__FILE__)+"/../lib")
+require 'golem'
+
+class Monster
+  include Golem
+  
+  attr_accessor :deeds
+  attr_accessor :journal
+
+  def initialize
+    @deeds = []
+    @journal = []
+  end
+
+  def stretch
+    @deeds << :stretched
+  end
+
+  def grumble
+    @deeds << :grumbled
+  end
+
+  def yawn
+    @deeds << :yawned
+  end
+
+  def barf
+    @deeds << :barfed
+  end
+
+  def likes_food?(food)
+    food == :hamburger
+  end
+
+  def hates_food?(food)
+    food == :tofu
+  end
+
+  def is_tired?
+    deeds.last == :yawned
+  end
+
+  def mouth_is_open?
+    mouth_state == :open
+  end
+
+  def write_in_journal(event, transition, *args)
+    @journal << event.name if event.kind_of?(Golem::Model::Event) && transition.kind_of?(Golem::Model::Transition)
+  end
+
+  # statemachine representing the Monster's affect (i.e. how it is feeling)
+  define_statemachine :affect do
+    initial_state :sleeping
+    on_all_transitions :write_in_journal
+
+    state :sleeping do
+      on :wake_up, :to => :hungry
+      exit :stretch
+    end
+
+    state :hungry do
+      enter :grumble
+      on :feed, :if => :mouth_is_open?, :guard_options => {:failure_message => "its mouth is not open"} do
+        transition :to => :satiated do
+          guard :likes_food?, :failure_message => "it does not like the food"
+          action {|monster,food| monster.deeds << "ate_tasty_#{food}".to_sym}
+        end
+        transition :to => :self do
+          guard :hates_food?, :failure_message => "it does not hate the food"
+          action :barf
+        end
+        transition :to => :self do
+          action {|monster,food| monster.deeds << "ate_#{food}".to_sym}
+        end
+      end
+      on :lullaby, :action => :yawn
+      on :tickle do
+        action {|monster| monster.deeds << :giggled }
+      end
+    end
+
+    state :satiated do
+      on :lullaby do
+        transition :to => :sleeping, :if => :is_tired?
+        transition :to => :self, :action => :yawn
+      end
+    end
+  end
+
+  # secondary statemachine representing the Monster's mouth
+  define_statemachine :mouth do
+    initial_state :closed
+    state :open do
+      on :lullaby, :to => :closed
+    end
+    state :closed do
+      on :tickle, :to => :open
+    end
+  end
+end

data/examples/seminar.rb

@@ -0,0 +1,138 @@
+$: << File.expand_path(File.dirname(__FILE__)+"/../lib")
+require 'golem'
+
+
+class Seminar
+  attr_accessor :status
+  attr_accessor :students
+  attr_accessor :waiting_list
+  attr_accessor :max_class_size
+  attr_accessor :notifications_sent
+
+  @@out = STDOUT
+
+  def self.output=(output)
+    @@out = output
+  end
+
+  def initialize
+    @students = [] # list of students enrolled in the course
+    @max_class_size = 5
+    @notifications_sent = []
+  end
+
+  def seats_available
+    @max_class_size - @students.size
+  end
+
+  def waiting_list_is_empty?
+    @waiting_list.empty?
+  end
+
+  def student_is_enrolled?(student)
+    @students.include? student
+  end
+
+  def add_student_to_waiting_list(student)
+    @waiting_list << student
+  end
+
+  def create_waiting_list
+    @waiting_list = []
+  end
+
+  def notify_waiting_list_that_enrollment_is_closed
+    @waiting_list.each{|student| self.notifications_sent << "#{student}: waiting list is closed"}
+  end
+
+  def notify_students_that_the_seminar_is_cancelled
+    (@students + @waiting_list).each{|student| self.notifications_sent << "#{student}: the seminar has been cancelled"}
+  end  
+
+
+  include Golem
+
+  define_statemachine do
+    initial_state :proposed
+    state_attribute :status
+
+    state :proposed do
+      on :schedule, :to => :scheduled
+    end
+
+    state :scheduled do
+      on :open, :to => :open_for_enrollment
+    end
+
+    state :open_for_enrollment do
+      on :close, :to => :closed_to_enrollment
+      on :enroll_student do
+        transition do
+          guard {|seminar, student| !seminar.student_is_enrolled?(student) && seminar.seats_available > 1 }
+          action {|seminar, student| seminar.students << student}
+        end
+        transition :to => :full do
+          guard {|seminar, student| !seminar.student_is_enrolled?(student) }
+          action do |seminar, student|
+            seminar.create_waiting_list
+            if seminar.seats_available == 1
+              seminar.students << student
+            else
+              seminar.add_student_to_waiting_list(student)
+            end
+          end
+        end
+      end
+      on :drop_student do
+        transition :if => :student_is_enrolled? do
+          action {|seminar, student| seminar.students.delete student}
+        end
+      end
+    end
+
+    state :full do
+      on :move_to_bigger_classroom, :to => :open_for_enrollment,
+        :action => Proc.new{|seminar, additional_seats| seminar.max_class_size += additional_seats}
+      # Note that this :if condition applies to all transitions inside the event, in addition to each
+      # transaction's own :if/guard statement.
+      on :drop_student, :if => :student_is_enrolled? do
+        transition :to => :open_for_enrollment, :if => :waiting_list_is_empty? do
+          action {|seminar, student| seminar.students.delete student}
+        end
+        transition do
+          action do |seminar, student|
+            seminar.students.delete student
+            seminar.enroll_student seminar.waiting_list.shift
+          end
+        end
+      end
+      on :enroll_student, :if => Proc.new{|seminar, student| !seminar.student_is_enrolled?(student)} do
+        transition do
+          guard {|seminar, student| seminar.seats_available > 0}
+          action {|seminar, student| seminar.students << student}
+        end
+        transition :action => :add_student_to_waiting_list
+      end
+      on :close, :to => :closed_to_enrollment
+    end
+
+    state :closed_to_enrollment do
+      enter :notify_waiting_list_that_enrollment_is_closed
+    end
+
+    state :cancelled do
+      enter :notify_students_that_the_seminar_is_cancelled
+    end
+
+    # The 'cancel' event can occur in all states.
+    all_states.each do |state|
+      state.on :cancel, :to => :cancelled
+    end
+
+    on_all_transitions do |seminar, event, transition, *event_args|
+      @@out.puts "==[#{event.name}(#{event_args.collect{|arg| arg.inspect}.join(",")})]==>  #{transition.from.name} --> #{transition.to.name}"
+      @@out.puts "   ENROLLED: #{seminar.students.inspect}"
+      @@out.puts "   WAITING: #{seminar.waiting_list.inspect}"
+    end
+  end
+end

data/examples/seminar_enrollment.rb

@@ -0,0 +1,141 @@
+$: << File.expand_path(File.dirname(__FILE__)+"/../lib")
+require 'golem'
+
+
+class Seminar
+  attr_accessor :status
+  attr_accessor :students
+  attr_accessor :waiting_list
+  attr_accessor :max_size
+
+  def initialize
+    @students = [] # list of students enrolled in the course
+    @max_class_size = 5
+  end
+
+  def seats_available?
+    @students.size < @max_class_size
+  end
+
+  def waiting_list_is_empty?
+    @waiting_list.empty?
+  end
+
+  def student_is_enrolled?(student)
+    @students.include? student
+  end
+
+  def add_student_to_waiting_list(student)
+    @waiting_list << student
+  end
+
+  def create_waiting_list
+    @waiting_list = []
+  end
+
+  def notify_waiting_list_that_enrollment_is_closed
+    @waiting_list.each{|student| puts "#{student}: waiting list is closed!"}
+  end
+
+  def notify_students_that_the_seminar_is_cancelled
+    (@students + @waiting_list).each{|student| puts "#{student}: the seminar has been cancelled!"}
+  end  
+
+
+  include Golem
+
+  define_statemachine do
+    state :proposed do
+      on :schedule, :to => :scheduled
+    end
+
+    state :scheduled do
+      on :open, :to => :open_for_enrollment
+    end
+
+    state :open_for_enrollment do
+      on :close, :to => :closed_to_enrollment
+      on :enroll_student do
+        transition :if => :seats_available? do |seminar, student|
+          seminar.students << student
+        end
+        transition :to => :full, :if => Proc.new{|seminar, student| not seminar.student_is_enrolled?} do |seminar, student|
+          seminar.add_student_to_waiting_list(student)
+        end
+      end
+    end
+
+    state :full do
+      on :move_to_bigger_classroom, :to => :open_for_enrollment
+      on :drop_student do
+        transition :to => :open_for_enrollment, 
+          :if => Proc.new{|seminar, student| seminar.student_is_enrolled?(student) && seminar.waiting_list_is_empty?} do
+            seminar.students.delete student
+          end
+        transition :if => :student_is_enrolled? do |seminar, student|
+          seminar.students.delete student
+          seminar.enroll_student! seminar.waiting_list.shift
+        end
+      end
+      on :enroll_student do
+        transition :if => :seats_available? do |seminar, student|
+          seminar.students << student
+        end
+        transition :action => :add_student_to_waiting_list
+      end
+      on :close, :to => :closed_to_enrollment
+      enter :create_waiting_list
+    end
+
+    state :closed_to_enrollment do
+      enter :notify_waiting_list_that_enrollment_is_closed
+    end
+
+    state :cancelled do
+      enter :notify_students_that_the_seminar_is_cancelled
+    end
+
+    # The 'cancel' event can occur in all states.
+    all_states.each do |state|
+      state.on :cancel, :to => :cancelled
+    end
+
+    initial_state :proposed
+    current_state_from :status
+
+    on_all_transitions Proc.new{|obj, event, transition, event_args| puts "Transitioning from #{transition.from.name.inspect} to #{transition.to.name.inspect}"}
+  end
+end
+
+
+s = Seminar.new
+s.schedule!
+s.open!
+s.enroll_student! "bobby"
+puts s.inspect
+s.enroll_student! "eva"
+puts s.inspect
+s.enroll_student! "sally"
+puts s.inspect
+s.enroll_student! "matt"
+puts s.inspect
+s.enroll_student! "karina"
+puts s.inspect
+s.enroll_student! "tony"
+puts s.inspect
+s.enroll_student! "rich"
+puts s.inspect
+s.enroll_student! "suzie"
+puts s.inspect
+s.enroll_student! "fred"
+puts s.inspect
+s.drop_student! "sally"
+puts s.inspect
+s.drop_student! "bobby"
+puts s.inspect
+s.drop_student! "tony"
+puts s.inspect
+s.drop_student! "rich"
+puts s.inspect
+s.drop_student! "eva"
+puts s.inspect