dcadenas-state_pattern 0.2.0 → 1.0.0

data/README.rdoc

@@ -1,26 +1,21 @@
 = state_pattern
 
 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
 
   require 'rubygems'
   require 'state_pattern'
 
-  module On
-    protected
-  
+  class On < StatePattern::State
     def press
       transition_to(Off)
-      "#{button_name} is off"
+      "#{stateable.button_name} is off"
     end
   end
   
-  module Off
-    protected
-  
+  class Off < StatePattern::State
     def press
       transition_to(On)
-      "#{button_name} is on"
+      "#{stateable.button_name} is on"
     end
   end
   
@@ -31,7 +26,7 @@ The idea comes from this nice Jay Field's post http://blog.jayfields.com/2007/08
     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
+    #but it is good to leave the option to do the delegation yourself in case you want more freedom
     def press
       delegate_to_event(:press)
     end
@@ -46,9 +41,21 @@ The idea comes from this nice Jay Field's post http://blog.jayfields.com/2007/08
   puts button.press # => "Light button is off"
   puts button.press # => "Light button is on"
 
-== Requirements
+== Validations
+
+One of the few drawbacks the state pattern has is that it can get difficult to see the global picture of your state machine when dealing with complex cases.
+To deal with this problem you have the option of using the valid_transitions statement to "draw" your state diagram in code. Whenever a state transition is performed, the valid_transitions hash is checked and if the transition is not valid a StatePattern::InvalidTransitionException is thrown.
+
+Examples:
+
+The most basic notation
+  valid_transitions On => Off, Off => On
+
+With more than one target state
+  valid_transitions Up => [Middle, Down], Down => Middle, Middle => Up 
 
-facets
+Using event names to gain more detail
+  valid_transitions [Up, :switch] => [Middle, Down], [Down, :switch] => Middle, [Middle, :switch] => Up 
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/lib/state_pattern.rb

@@ -1,34 +1,29 @@
-require 'facets'
+require 'state_pattern/state'
+require 'state_pattern/invalid_transition_exception'
 
 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.instance_eval do
-      def initial_state
-        @initial_state
+      def state_classes
+        @state_classes ||= []
       end
 
-      def set_initial_state(state_module)
-        @initial_state = state_module
+      def initial_state_class
+        @initial_state_class
       end
 
-      def add_states(*state_modules)
-        @state_modules = state_modules
-        @state_modules.each do |state_module|
-          include state_module
+      def set_initial_state(state_class)
+        @initial_state_class = state_class
+      end
+
+      def add_states(*state_classes)
+        state_classes.each do |state_class|
+          add_state_class(state_class)
         end
-        delegate_all_events
+      end
+
+      def add_state_class(state_class)
+        state_classes << state_class
       end
 
       def valid_transitions(transitions_hash)
@@ -39,33 +34,52 @@ module StatePattern
         @transitions_hash
       end
 
-      def delegate_all_events
-        state_methods.each do |method_name|
-          define_method method_name do |*args|
-            delegate_to_event(method_name, *args)
+      def delegate_all_state_events
+        state_methods.each do |state_method|
+          define_method state_method do |*args|
+            delegate_to_event(state_method)
           end
         end
       end
 
       def state_methods
-        @state_modules.map{|state_module| state_module.__send__(:instance_methods)}.flatten.uniq
+        state_classes.map{|state_class| state_class.public_instance_methods(false)}.flatten.uniq
       end
     end
   end
 
-  attr_accessor :current_state_module, :current_event
+  attr_accessor :current_state, :current_event, :states
   def initialize(*args)
     super(*args)
-    self.current_state_module = self.class.initial_state
+    self.states = {}
+    add_state_instances
+    set_state(self.class.initial_state_class)
+    self.class.delegate_all_state_events
   end
 
-  def current_state_instance
-    as(current_state_module)
+  def set_state(state_class)
+    add_state_instance(state_class)
+    self.current_state = self.states[state_class]
   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
+  def add_state_instances
+    self.class.state_classes.map do |state_class|
+      add_state_instance(state_class)
+    end
+  end
+  
+  def add_state_instance(state_class)
+    self.states[state_class] = state_class.new(self) if !self.states.has_key?(state_class) || self.states[state_class].nil?
+  end
+
+  def delegate_to_event(method_name, *args)
+    self.current_event = method_name.to_sym
+    self.current_state.send(current_event, *args)
+  end
+
+  def transition_to(state_class)
+    raise InvalidTransitionException.new(self.current_state.class, state_class, self.current_event) unless self.valid_transition?(self.current_state.class, state_class)
+    set_state(state_class)
   end
 
   def valid_transition?(from_module, to_module)
@@ -81,12 +95,7 @@ module StatePattern
   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)
+    self.current_state.state
   end
 end
 

data/lib/state_pattern/invalid_transition_exception.rb

@@ -0,0 +1,14 @@
+module StatePattern
+  class InvalidTransitionException < RuntimeError
+    attr_reader :from_module, :to_module, :event
+    def initialize(from_module, to_module, event)
+      @from_module = from_module
+      @to_module = to_module
+      @event = event
+    end
+
+    def message
+      "Event #@event cannot transition from #@from_module to #@to_module"
+    end
+  end
+end

data/lib/state_pattern/state.rb

@@ -0,0 +1,16 @@
+module StatePattern
+  class State
+    attr_reader :stateable
+    def initialize(stateable)
+      @stateable = stateable
+    end
+
+    def transition_to(state_class)
+      @stateable.transition_to(state_class)
+    end
+
+    def state
+      self.class.to_s
+    end
+  end
+end

data/state_pattern.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{state_pattern}
-  s.version = "0.2.0"
+  s.version = "1.0.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-07}
+  s.date = %q{2009-06-08}
   s.email = %q{dcadenas@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -20,6 +20,8 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/state_pattern.rb",
+     "lib/state_pattern/invalid_transition_exception.rb",
+     "lib/state_pattern/state.rb",
      "state_pattern.gemspec",
      "test/state_pattern_test.rb",
      "test/test_class_creation_helper.rb",

data/test/state_pattern_test.rb

@@ -1,19 +1,17 @@
 require 'test_helper'
 
 module Family
-  module James
-    protected
+  class James < StatePattern::State
     def name
       transition_to(Lynn)
-      "James #{last_name}"
+      "James #{stateable.last_name}"
     end
   end
 
-  module Lynn
-    protected
+  class Lynn < StatePattern::State
     def name
       transition_to(James)
-      "Lynn #{last_name}"
+      "Lynn #{stateable.last_name}"
     end
   end
 

data/test/test_class_creation_helper.rb

@@ -1,4 +1,5 @@
 module TestClassCreationHelper
+  #TODO: ugly
   def with_test_class(main_state_module_name, options = {})
     created_consts = []
     transitions = options[:transitions] || {}
@@ -6,7 +7,7 @@ module TestClassCreationHelper
 
     if options.has_key?(:states)
       options[:states].each do |state_name|
-        created_consts << create_module(state_name) do
+        created_consts << create_class(state_name, StatePattern::State) do
           state_methods.each do |method_name|
             define_method method_name do
               next_state_name = transitions[[state_name, method_name]]
@@ -47,12 +48,12 @@ module TestClassCreationHelper
 
 private
 
-  def create_module(module_name, module_or_class = Module, &block)
-    new_module = module_or_class.new &block
+  def create_module(module_name, superklass = Object, module_or_class = Module, &block)
+    new_module = module_or_class.new(superklass, &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)
+  def create_class(class_name, superklass = Object, &block)
+    create_module(class_name, superklass, Class, &block)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dcadenas-state_pattern
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Daniel Cadenas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-07 00:00:00 -07:00
+date: 2009-06-08 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,8 @@ files:
 - Rakefile
 - VERSION
 - lib/state_pattern.rb
+- lib/state_pattern/invalid_transition_exception.rb
+- lib/state_pattern/state.rb
 - state_pattern.gemspec
 - test/state_pattern_test.rb
 - test/test_class_creation_helper.rb