simplestate 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fdb020f0abef3fdccbc30bf720dbc35047ffd14
-  data.tar.gz: 0304e8b3a88cbf05244332fe05b291a5f411b0f4
+  metadata.gz: 3c899bf018689c01a33b5d830d07899ce62ec930
+  data.tar.gz: f36c330f1c1e152f24573ceecbf1cdb55047c231
 SHA512:
-  metadata.gz: 29d884b9ab06f2a216695e9e8750f241954423f005a2a1cad82fdec60c783484905c49c99aec30f2418c35a513303166479cbe59bec862c801970512ca45783f
-  data.tar.gz: a2a05dcb6a56e3309137a8ccd93124d08cf52135baba0760eb0a491de3475e2052e66208f124ae91a7744d496704c25eb691eea31e98b18669f90bad06a43cd0
+  metadata.gz: 0e9664a43777c82389fe56d9af35f3c3246d5e3b92de9850e3f7c188140c2ffae6b96c27594897cf02860d73feef0908c5b65c358d3f691592e6134df6e6f9a0
+  data.tar.gz: d3a4ff105ccf61640de63c467b3f093e245695eda1b825719289a96263603c0c3a0ba4c429b696ad48f4a21676132b40d96abbd6adaaa3bd1790fad6a4ded15e

data/README.md

@@ -87,19 +87,22 @@ A state has access to methods on the state holder via #holder:
 holder.a_special_holder_method
 ```
 
-### version 0.3.0 addition
-A state has a *previous_states* method that returns an array of the states through which the state holder has transitioned to reach that state. Currently that array size is limited to 1. Old entries are dropped as new entries are added. DO NOT rely on that size limit. The last item in the list will be the most recent previous state. This is a public method on a state so it can be used via the state holder:
+#### version 1.0.0
+A state holder tracks the history of state transitions in an array accessed via #state_history. The array size defaults to 5. The last item in the array will be the most recent previous state instance. The size may be set at holder creation in the opts hash (:hx_size_limit). The history size limit has a getter and a setter defined as well. (#hx_size_limit= & #hx_size_limit).
 
 ```ruby
 class Button < StateHolder
   ...
-
   def prior_state
-    previous_states.last.class
+    state_history.last.class
   end
 end
 
  # Then in tests for example:
+def setup
+  @button = Button.new(start_in: Off, color: 'Red', hz_size_limit: 3)
+end
+
 def test_a_button_returns_its_last_prior_state
   @button.press # Curr state: On,  Prior state: Off
   @button.press # Curr state: Off, Prior state: On
@@ -107,10 +110,13 @@ def test_a_button_returns_its_last_prior_state
 end
 ```
 
-Please note that State#previous_state_class does not have to agree with previous_states.last.class. #previous_state_class is set arbitrarily at instance creation. #previous_states is updated automatically at each state transition. #previous_state_class will be removed at some point in the future.
+Please note that the State instance method, previous_state_class, has been removed in this release.
+
+#### version 0.3.0 addition
+The 0.3.0 version contained a serious code smell: A state was expected to know about the history of state transitions. However, a state should know only the states to which it may transition and it's holder to support triggering those transitions. Knowlege of the transition history belongs with the state holder, if it is tracked at all.
 
-### usage example
-The button module provides an example of the usage of Simplestate. Tests of this are provided in simplestate_test.rb.
+#### usage example
+The button module (test/dummys/button.rb) provides an example of the usage of Simplestate. Tests of this are provided in simplestate_test.rb.
 
 ## Development
 

data/lib/simplestate/nil_state.rb

@@ -1,9 +1,7 @@
 class NilState
-  attr_reader :holder, :previous_state_class, :previous_states
-  def initialize(holder, previous_state_class)
+  attr_reader :holder
+  def initialize(holder)
     @holder = holder
-    @previous_state_class = previous_state_class
-    @previous_states = []
   end
 
 private

data/lib/simplestate/state.rb

@@ -1,9 +1,7 @@
 class State
-  attr_reader :holder, :previous_state_class, :previous_states
-  def initialize(holder, previous_state_class)
+  attr_reader :holder
+  def initialize(holder)
     @holder = holder
-    @previous_state_class = previous_state_class
-    @previous_states = build_previous_states_list
   end
 
 private
@@ -18,11 +16,4 @@ private
   def exit
     raise "#{self.class.name} does not implement #exit."
   end
-
-  def build_previous_states_list
-    hcs = holder.current_state
-    psa = hcs.previous_states || []
-    psa.shift
-    psa << hcs
-  end
 end

data/lib/simplestate/state_holder.rb

@@ -1,7 +1,11 @@
 class StateHolder < SimpleDelegator
+  attr_reader :state_history
+  attr_accessor :hx_size_limit
   def initialize(opts={})
+    @state_history = []
+    @hx_size_limit = opts.fetch :hx_size_limit, 5
     # Set current_state to nil state within SimpleDelegator
-    nil_state = NilState.new(nil,nil)
+    nil_state = NilState.new(nil)
     super(nil_state)
     # Then transition to the initial state class
     initial_state_class = opts.fetch :start_in,
@@ -10,6 +14,7 @@ class StateHolder < SimpleDelegator
   end
 
   def transition_to(new_state_class)
+    update_state_history
     current_state.send(:exit)
     set_new_state(new_state_class)
     current_state.send(:enter)
@@ -20,7 +25,7 @@ class StateHolder < SimpleDelegator
   end
 
   def set_new_state(new_state_class)
-    new_state = new_state_class.new(self, current_state.class)
+    new_state = new_state_class.new(self)
     self.current_state = new_state
   end
 
@@ -28,4 +33,9 @@ private
   def current_state=(state)
     __setobj__(state)
   end
+
+  def update_state_history
+    @state_history << current_state
+    @state_history = @state_history.last(hx_size_limit)
+  end
 end

data/lib/simplestate/version.rb

@@ -1,3 +1,3 @@
 module Simplestate
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
 end

metadata

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