simplestate 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e1f8cc60b7d971102eb515eee2ad348019ee584
-  data.tar.gz: 7fa1b45429847b3bde13bedc3f54d61a807c8666
+  metadata.gz: 98120d72e903183f217fc3f3b3ab4e4ef41f3aa8
+  data.tar.gz: 1c02dc9ec7c5830b9701a86e23593aa9fd1810df
 SHA512:
-  metadata.gz: 18351282659d21e6279bd8901241de36b067616d4e5684af05babf72b9e6d48a4ed22ea81957cfedff6435dda577864f794a1fbf5c788d5e367babd262384e90
-  data.tar.gz: 18915fdb2f13b90e816f61c80162d84b1804434b56dda0b2cddb8c1a9040bce8f8c04fa11e0d8e203d0c47d3ef663b307a4c60ab5618b8962bd5a84ceaf8222f
+  metadata.gz: 9348c67eb908105f981aea17d1998d6ed535e5bb613b790e6558169481615610a3ac71b0c648f0db8f842f7549aed870208d6056edb4f21ec65f23308f4e649e
+  data.tar.gz: ccee6da7323d35f86f36c55a6d905866ebe544f574ad3d981e2fa3637c6d20d7b403b352527334363e2611868fb573de7760d59a9c16c5d205c3482fa0a7a441

data/README.md

@@ -12,20 +12,32 @@ end
 class Off < State
   def press; transition_to(On); end
   private
-    def enter; end
-    def exit; end
+    def enter
+      # send_message_to_log("entering off state")
+      # turn_light_off
+    end
+
+    def exit
+      # send_message_to_log("leaving off state")
+    end
 end
 
 class On < State
   def press; transition_to(Off); end
   private
-    def enter; end
-    def exit; end
+    def enter
+      # send_message_to_log("entering on state")
+      # turn_light_on
+    end
+
+    def exit
+      # send_message_to_log("leaving on state")
+    end
 end
 
 button = Button.new(start_in: Off)
-button.press    # current_state: On
-button.press    # current_state: Off
+button.press    #=> current_state: On
+button.press    #=> current_state: Off
 ````
 # Description
 Simplestate arose out of a desire for a very low ceremony mechanism to implement a state machine. SimpleDelegator (delegate.rb) is used to implement this. Because SimpleDelegator supports dynamically swapping the object to which methods are delegated, it provides a good base for Simplestate.
@@ -58,7 +70,9 @@ Or install it yourself as:
     $ gem install simplestate
 
 ## Usage
-Inherit from StateHolder to create the class of the object that will hold states:
+
+#### State Holder
+Inherit from StateHolder to create the class of the object that will hold states. You *must* call super if you provide an initialize method in your holder class:
 
 ```ruby
 class Button < StateHolder
@@ -72,7 +86,7 @@ class Button < StateHolder
 end
 ```
 
-StateHolder expects to receive the initial state class in an opts hash at creation. Creation of a holder instance *must* specify the initial state class:
+Creation of a StateHolder instance *must* specify the initial state class. StateHolder expects to receive the initial state class in an opts hash at creation:
 
 ```ruby
 button = Button.new(initial_state_class: Off)
@@ -82,12 +96,13 @@ or use this alternate syntax:
 ```ruby
 button = Button.new(start_in: Off)
 ```
-If you want to set additional attributes at creation of a new button, do so within the opts hash when new is called. Set the attribute from the opts hash in initialize. You *must* call super if you provide an initialize method in your holder class.
+If you want to set additional attributes at creation of a new button, do so within the opts hash when new is called. Set the attribute from the opts hash in initialize.
 
 ```ruby
 button = Button.new(start_in: Off, color: 'Red')
 ```
 
+#### States
 
 Inherit from State to create a class to provide specific state behaviors:
 

data/lib/simplestate/version.rb

@@ -1,3 +1,3 @@
 module Simplestate
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplestate
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Mitchell C Kuppinger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler