stateology 0.1.2 → 0.1.3

data/README

@@ -4,6 +4,7 @@ Supports:
 * Dynamic switching between states (mixing and unmixing modules)
 * Clean DSL-style syntax 
 * Optional state_entry() and state_exit() hooks for each state (automatically called upon state entry and exit)
+* support for subclassing of classes that include Stateology (see below)
 
 Use as in the following:
 
@@ -77,6 +78,42 @@ s.do_something  #=> "Kicks a puppy"
 s.state nil
 s.do_something  #=> "stares at the ceiling"
 
+UPDATE:
+* made it so subclasses can inherit states from their superclasses e.g
+class A
+    include Stateology
+    
+    state(:Happy) {
+        def state_entry
+            puts "entering Happy state"
+        end
+        
+        def hello
+            puts "hello from A"
+        end
+    }
+end
+
+class B < A
+    state(:Happy) {
+        def hello
+            puts "hello from B"
+        end
+    }
+end
+
+b = B.new
+
+b.state :Happy
+#=> "entering Happy state"
+
+b.hello
+#=> "hello from B"
+
+* prior behaviour was for state_entry not to exist in class B as Happy module from class A was overwritten by the new Happy module in B
+* how does this fix work? the Happy module in B just includes any extant Happy module accessible in B
+
+
 
 
 ---=A FEW THINGS TO NOTE=---
@@ -99,6 +136,9 @@ In the above the string "hello" is passed as a parameter to the state_entry() me
 * The #state method can accept either a Symbol (e.g :Happy) or a Module (e.g Happy or Sample::Happy). The following are equivalent:
 s.state :Happy #=> change state to Happy
 
+* The #state method can take a block; the block will be executed after the successful change of state:
+e.g s.state(:Happy) { s.hello }    #=> hello method invoked immediately after change of state as it's in the block
+
 s.state Sample::Happy #=> equivalent to above (note the fully qualified name; as Happy is a module defined under the Sample class)
 
 * alternatively; if the #state method is invoked internally by another instance method of the Sample class then a fully qualified module name is not required:

data/lib/stateology.rb

@@ -65,7 +65,7 @@ module Stateology
         
     end
         
-    def state(*state_args)
+    def state(*state_args, &block)
                                             
         # behave as getter
         if(state_args.empty?) then            
@@ -89,10 +89,13 @@ module Stateology
                     
         # enter new state               
         __state_prologue(state_name, state_args)   
-        
+                        
         # update the current state variable    
         @__SM_cur_state = state_name
         
+        # if we were given a block, run it now
+        if(block) then yield end
+        
         rescue NameError
             raise NameError, "#{state_name} not a valid state" 
                                         

data/sample.rb

@@ -53,7 +53,18 @@ class Sample
     
 end
 
+class SampleChild < Sample
+    state(:Happy) {
+        def do_something
+            puts "pets a Kitten"
+        end
+    }
+end
+
 s = Sample.new
+sc = SampleChild.new
+
+puts "Testing Sample"
 
 # in Default state
 s.do_something  #=> "stares at the ceiling"
@@ -75,6 +86,40 @@ s.state :Angry
 # what state are we in?
 puts s.state
 
+# pass a block to state transition
+puts "passing a block"
+s.state :Happy do 
+    s.do_something; s.do_something; s.do_something 
+end
+
+
+puts "**********************"
+puts "Now Testing SampleChild"
+# in Default state
+sc.do_something  #=> "stares at the ceiling"
+
+# now switch to Happy state
+sc.state :Happy
+sc.do_something  #=> "Pets a puppy"
+
+# now switch to Angry state
+sc.state Sample::Angry
+sc.do_something  #=> "Kicks a puppy"
+
+# now switch back to Default state
+sc.state nil
+sc.do_something  #=> "stares at the ceiling"
+
+sc.state :Angry
+
+# what state are we in?
+puts sc.state
+
+# pass a block to state transition
+puts "passing a block"
+sc.state :Happy do
+    sc.do_something; sc.do_something; sc.do_something
+end
 
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stateology
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - John Mair