dcadenas-state_pattern 0.1.0 → 0.2.0

data/README.rdoc

@@ -3,42 +3,48 @@
 A Ruby state pattern implementation.
 The idea comes from this nice Jay Field's post http://blog.jayfields.com/2007/08/ruby-state-pattern-using-modules-and.html
 
-  module James
+  require 'rubygems'
+  require 'state_pattern'
+
+  module On
     protected
   
-    def name
-      transition_to(Lynn)
-      "James #{last_name}"
+    def press
+      transition_to(Off)
+      "#{button_name} is off"
     end
   end
   
-  module Lynn
+  module Off
     protected
   
-    def name
-      transition_to(James)
-      "Lynn #{last_name}"
+    def press
+      transition_to(On)
+      "#{button_name} is on"
     end
   end
   
-  class FamilyMember
+  class Button
     include StatePattern
-    add_states James, Lynn
-    set_initial_state Lynn
-  
-    def name
-      state_instance.name
+    add_states On, Off
+    set_initial_state Off
+    valid_transitions [On, :press] => Off, [Off, :press] => On
+
+    #this method can be removed as it will be mapped automatically anyways
+    #but is good to leave the option to do the delegation yourself in case you want to do more things
+    def press
+      delegate_to_event(:press)
     end
   
-    def last_name
-      "Holbrook"
+    def button_name
+      "Light button"
     end
   end
 
-  member = FamilyMember.new
-  puts member.name # => "Lynn Holbrook"
-  puts member.name # => "James Holbrook"
-  puts member.name # => "Lynn Holbrook"
+  button = Button.new
+  puts button.press # => "Light button is on"
+  puts button.press # => "Light button is off"
+  puts button.press # => "Light button is on"
 
 == Requirements
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/state_pattern.rb

@@ -1,33 +1,93 @@
 require 'facets'
 
 module StatePattern
+  class InvalidTransitionException < RuntimeError
+    attr_reader :from_module, :to_module
+    def initialize(from_module, to_module)
+      @from_module = from_module
+      @to_module = to_module
+    end
+
+    def message
+      "Cannot transition from #{@from_module} to #{@to_module}"
+    end
+  end
+
   def self.included(base)
-    base.class_eval do
-      attr_accessor :state
-      def self.add_states(*state_classes)
-        state_classes.each do |state_class|
-          include state_class
+    base.instance_eval do
+      def initial_state
+        @initial_state
+      end
+
+      def set_initial_state(state_module)
+        @initial_state = state_module
+      end
+
+      def add_states(*state_modules)
+        @state_modules = state_modules
+        @state_modules.each do |state_module|
+          include state_module
         end
+        delegate_all_events
       end
 
-      def self.set_initial_state(state_class)
-        @@initial_state = state_class
+      def valid_transitions(transitions_hash)
+        @transitions_hash = transitions_hash
       end
 
-      def initialize(*args)
-        super(*args)
-        self.state = @@initial_state
+      def transitions_hash
+        @transitions_hash
       end
 
-      def state_instance
-        as(state)
+      def delegate_all_events
+        state_methods.each do |method_name|
+          define_method method_name do |*args|
+            delegate_to_event(method_name, *args)
+          end
+        end
       end
 
-      def transition_to(state_module)
-        self.state = state_module
+      def state_methods
+        @state_modules.map{|state_module| state_module.__send__(:instance_methods)}.flatten.uniq
       end
     end
   end
+
+  attr_accessor :current_state_module, :current_event
+  def initialize(*args)
+    super(*args)
+    self.current_state_module = self.class.initial_state
+  end
+
+  def current_state_instance
+    as(current_state_module)
+  end
+
+  def transition_to(state_module)
+    raise InvalidTransitionException.new(self.current_state_module, state_module) unless self.valid_transition?(self.current_state_module, state_module)
+    self.current_state_module = state_module
+  end
+
+  def valid_transition?(from_module, to_module)
+    trans = self.class.transitions_hash
+    return true if trans.nil?
+    
+    #TODO: ugly
+    trans.has_key?(from_module) &&
+      (trans[from_module] == to_module ||
+       trans[from_module].include?(to_module)) ||
+     trans.has_key?([from_module, current_event]) &&
+     (trans[[from_module, current_event]] == to_module || trans[[from_module, current_event]].include?(to_module))
+  end
+
+  def state
+    self.current_state_module.to_s
+  end
+
+  def delegate_to_event(method_name, *args)
+    self.current_event = method_name.to_sym
+    self.current_state_instance.__send__(current_event, *args)
+  end
 end
 
 

data/state_pattern.gemspec

@@ -2,10 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{state_pattern}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
+
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Cadenas"]
-  s.date = %q{2009-06-05}
+  s.date = %q{2009-06-07}
   s.email = %q{dcadenas@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -21,7 +22,9 @@ Gem::Specification.new do |s|
      "lib/state_pattern.rb",
      "state_pattern.gemspec",
      "test/state_pattern_test.rb",
-     "test/test_helper.rb"
+     "test/test_class_creation_helper.rb",
+     "test/test_helper.rb",
+     "test/transition_validations_test.rb"
   ]
   s.homepage = %q{http://github.com/dcadenas/state_pattern}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -30,7 +33,9 @@ Gem::Specification.new do |s|
   s.summary = %q{A Ruby state pattern implementation}
   s.test_files = [
     "test/state_pattern_test.rb",
-     "test/test_helper.rb"
+     "test/test_class_creation_helper.rb",
+     "test/test_helper.rb",
+     "test/transition_validations_test.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/state_pattern_test.rb

@@ -1,55 +1,94 @@
 require 'test_helper'
 
-module James
-  protected
-
-  def name
-    transition_to(Lynn)
-    "James #{last_name}"
+module Family
+  module James
+    protected
+    def name
+      transition_to(Lynn)
+      "James #{last_name}"
+    end
   end
-end
 
-module Lynn
-  protected
-
-  def name
-    transition_to(James)
-    "Lynn #{last_name}"
+  module Lynn
+    protected
+    def name
+      transition_to(James)
+      "Lynn #{last_name}"
+    end
   end
-end
 
-class FamilyMember
-  include StatePattern
-  add_states James, Lynn
-  set_initial_state Lynn
+  class Member
+    include StatePattern
+    add_states James, Lynn
+    set_initial_state Lynn
+    valid_transitions [James, :name] => Lynn, [Lynn, :name] => James
 
-  def name
-    state_instance.name
-  end
+    #notice this method is optional, it will be delegated automatically if removed
+    def name
+      delegate_to_event :name
+    end
 
-  def last_name
-    "Holbrook"
+    def last_name
+      "Holbrook"
+    end
   end
 end
 
 Expectations do
   expect "Lynn Holbrook" do
-    member = FamilyMember.new
+    member = Family::Member.new
     member.name 
   end
 
   expect "James Holbrook" do
-    member = FamilyMember.new
+    member = Family::Member.new
     member.name 
     member.name 
   end
 
   expect "Lynn Holbrook" do
-    member = FamilyMember.new
+    member = Family::Member.new
     member.name 
     member.name 
     member.name 
   end
+
+  expect "on" do
+    with_test_class("Button", :states => ["On", "Off"], :initial_state => "Off",
+                    :transitions => {["On", :press] => "Off", ["Off", :press] => "On"}) do
+      button = Button.new
+      button.press
+    end
+  end
+
+  expect "off" do
+    with_test_class("Button", :states => ["On", "Off"], :initial_state => "Off",
+                    :transitions => {["On", :press] => "Off", ["Off", :press] => "On"}) do
+      button = Button.new
+      button.press
+      button.press
+    end
+  end
+
+  expect "on" do
+    with_test_class("Button", :states => ["On", "Off"], :initial_state => "Off",
+                    :transitions => {["On", :press] => "Off", ["Off", :press] => "On"}) do
+      button = Button.new
+      button.press
+      button.press
+      button.press
+    end
+  end
+
+  expect "on" do
+    with_test_class("Button", :states => ["On", "Off"], :initial_state => "Off",
+                    :transitions => {["On", :press] => "Off", ["Off", :press] => "On"}) do
+      button1 = Button.new
+      button2 = Button.new
+      button1.press
+      button2.press
+    end
+  end
 end
 
 

data/test/test_class_creation_helper.rb

@@ -0,0 +1,58 @@
+module TestClassCreationHelper
+  def with_test_class(main_state_module_name, options = {})
+    created_consts = []
+    transitions = options[:transitions] || {}
+    state_methods = transitions.keys.map{|t| t.last}.uniq || []
+
+    if options.has_key?(:states)
+      options[:states].each do |state_name|
+        created_consts << create_module(state_name) do
+          state_methods.each do |method_name|
+            define_method method_name do
+              next_state_name = transitions[[state_name, method_name]]
+              next_state_module = next_state_name && Object.const_get(next_state_name)
+              transition_to next_state_module
+              next_state_name.downcase
+            end
+          end
+        end
+      end
+    end
+
+    created_consts << create_class(main_state_module_name) do
+      include StatePattern
+      add_states *options[:states].map{|s| Object.const_get(s)} if options.has_key?(:states)
+      set_initial_state Object.const_get(options[:initial_state]) if options.has_key?(:initial_state)
+      if options.has_key?(:valid_transitions)
+        valid_transitions_with_constants = {}
+        options[:valid_transitions].each do |from_module_string_or_array, to_module_string|
+          if from_module_string_or_array.respond_to?(:to_ary)
+            valid_transitions_with_constants[[Object.const_get(from_module_string_or_array.first), from_module_string_or_array.last]] = Object.const_get(to_module_string)
+          else
+            valid_transitions_with_constants[Object.const_get(from_module_string_or_array)] = Object.const_get(to_module_string)
+          end
+        end
+        valid_transitions valid_transitions_with_constants
+      end
+    end
+
+    begin
+      yield
+    ensure 
+      created_consts.each do |created_const|
+        Object.send(:remove_const, created_const.to_s.to_sym)
+      end
+    end
+  end
+
+private
+
+  def create_module(module_name, module_or_class = Module, &block)
+    new_module = module_or_class.new &block
+    Object.const_set(module_name, new_module) unless Object.const_defined? module_name
+  end
+
+  def create_class(class_name, &block)
+    create_module(class_name, Class, &block)
+  end
+end

data/test/test_helper.rb

@@ -4,6 +4,10 @@ require 'expectations'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'state_pattern'
+require 'test_class_creation_helper'
+
+include TestClassCreationHelper
 
 class Test::Unit::TestCase
 end
+

data/test/transition_validations_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+Expectations do
+  expect "up" do
+    with_test_class("Switch", :states => ["Up", "Down", "Middle"], :initial_state => "Middle",
+                    :transitions => {["Up", :push_down] => "Middle",
+                                     ["Down", :push_up] => "Middle",
+                                     ["Middle", :push_up] => "Up",
+                                     ["Middle", :push_down] => "Down"}) do
+      switch = Switch.new
+      switch.push_up
+    end
+  end
+
+  expect "up" do
+    with_test_class("Switch", :states => ["Up", "Down", "Middle"], :initial_state => "Middle",
+                    :transitions => {["Up", :push_down] => "Middle",
+                                     ["Down", :push_up] => "Middle",
+                                     ["Middle", :push_up] => "Up",
+                                     ["Middle", :push_down] => "Down"},
+                     :valid_transitions => {["Up", :push_down] => "Middle",
+                                     ["Down", :push_up] => "Middle",
+                                     ["Middle", :push_up] => "Up",
+                                     ["Middle", :push_down] => "Down"}) do
+      switch = Switch.new
+      switch.push_up
+    end
+  end
+
+  expect StatePattern::InvalidTransitionException do
+    with_test_class("Switch", :states => ["Up", "Down", "Middle"], :initial_state => "Middle",
+                    :transitions => {["Up", :push_down] => "Middle",
+                                     ["Down", :push_up] => "Middle",
+                                     ["Middle", :push_up] => "Up",
+                                     ["Middle", :push_down] => "Down"},
+                     :valid_transitions => {["Up", :push_down] => "Middle",
+                                     ["Down", :push_up] => "Middle",
+                                     ["Middle", :push_down] => "Down"}) do
+      switch = Switch.new
+      switch.push_up
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dcadenas-state_pattern
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Daniel Cadenas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-05 00:00:00 -07:00
+date: 2009-06-07 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -32,7 +32,9 @@ files:
 - lib/state_pattern.rb
 - state_pattern.gemspec
 - test/state_pattern_test.rb
+- test/test_class_creation_helper.rb
 - test/test_helper.rb
+- test/transition_validations_test.rb
 has_rdoc: false
 homepage: http://github.com/dcadenas/state_pattern
 post_install_message: 
@@ -61,4 +63,6 @@ specification_version: 3
 summary: A Ruby state pattern implementation
 test_files: 
 - test/state_pattern_test.rb
+- test/test_class_creation_helper.rb
 - test/test_helper.rb
+- test/transition_validations_test.rb