simplestate 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c017617be36d0cbfb928ecdfa4cc18257a2962d
-  data.tar.gz: 53e41c6cc17d58b45e37e2ea988e651b7bcdee6a
+  metadata.gz: 450c34a364264d7b24164fde023f5bcec59b9a08
+  data.tar.gz: cade1b14539a4590e7bcd4a36444209cabdf9d22
 SHA512:
-  metadata.gz: e8bdfbcd3eb58fe841ea42f674abadd76f61d7ec0fcf79f0600ac93980228e5977676016a9dfa4e0d251fc0174ec36455975666e9435551cdd0949cac9b6cd5a
-  data.tar.gz: 8781ea5e2562ca7022f83b3cefd1e8e935e1f71730fe7d372645186a276f6c8ab10364a797ea2da037fa065344064cda03b55d258d75a577d9a16e3b35e710e9
+  metadata.gz: eceab10c44577b6674d3307bbab54cc26d562c06cd27032937133d29ea056df1def64dd1b656a8d546027091e77e2f625936f9b4b396db33d94a745207660017
+  data.tar.gz: c55a2fdb9a61a24471905e4605a32b9590ef0842ec312056f9105abd0c761c769a628dae4148f1021fedc4725145f09d2d5041033826d3c794628951ead2bf99

data/README.md

@@ -38,7 +38,23 @@ class Button < StateHolder
   # button methods here
 end
 ```
-If you want to set additional attributes at creation of a new button, new is called with an opts hash. Set the attribute from the opts hash in initialize. You *must* call super if you provide an initialize method in your holder class.
+
+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:
+
+```ruby
+button = Button.new(initial_state_class: Off)
+```
+or 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.
+
+```ruby
+button = Button.new(start_in: Off, color: 'Red')
+```
+
 
 Inherit from State to create a class to provide specific state behaviors:
 
@@ -63,18 +79,13 @@ private
   end
 end
 ```
-The subclassed state may provide *private* enter and exit methods. Any other state methods intended to be available via a call to that method on the state holder must be public. #enter and #exit will always be called appropriately during state transitions.
+The subclassed state may provide *private* enter and exit methods. Any other state methods intended to be available via a method call on the state holder must be public. #enter and #exit will always be called appropriately during state transitions.
 
 A state has access to methods on the state holder via #holder:
 
 ```ruby
 holder.a_special_holder_method
 ```
-Creation of a holder instance *must* specify the initial state class:
-
-```ruby
-button = Button.new(initial_state_class: Off)
-```
 
 The button module provides an example of the usage of Simplestate. Tests of this are provided in simplestate_test.rb.
 

data/lib/simplestate/state_holder.rb

@@ -1,9 +1,8 @@
 class StateHolder < SimpleDelegator
   def initialize(opts={})
-    initial_state_class = opts.fetch :initial_state_class
-    initial_state = initial_state_class.new(self, nil)
-    # Set current_state within SimpleDelegator
-    super(initial_state)
+    set_initial_state_from(opts)
+    # Set current_state to initial state within SimpleDelegator
+    super(@initial_state)
   end
 
   def transition_to(new_state_class)
@@ -25,4 +24,11 @@ private
   def current_state=(state)
     __setobj__(state)
   end
+
+  def set_initial_state_from(opts)
+    initial_state_class = opts.fetch :start_in,
+                         (opts.fetch :initial_state_class, nil)
+    @initial_state = initial_state_class.new(self, nil)
+  end
+
 end

data/lib/simplestate/version.rb

@@ -1,3 +1,3 @@
 module Simplestate
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplestate
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Mitchell C Kuppinger