simplestate 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 450c34a364264d7b24164fde023f5bcec59b9a08
-  data.tar.gz: cade1b14539a4590e7bcd4a36444209cabdf9d22
+  metadata.gz: e2ed13eeaa6d2b73c96ce7bec9e965d54ec108f0
+  data.tar.gz: 4e8de026210994a25eee48965ffbbb7c9c6e13ed
 SHA512:
-  metadata.gz: eceab10c44577b6674d3307bbab54cc26d562c06cd27032937133d29ea056df1def64dd1b656a8d546027091e77e2f625936f9b4b396db33d94a745207660017
-  data.tar.gz: c55a2fdb9a61a24471905e4605a32b9590ef0842ec312056f9105abd0c761c769a628dae4148f1021fedc4725145f09d2d5041033826d3c794628951ead2bf99
+  metadata.gz: 4323b583f0dd11ed6b4fa7a0dd3aae022a06d224a70aabc2ef06a40ddae2812f19ea1d30435cb6943be6d6605eba0728b357c3552c60da69e5adf16f0eb8e7fd
+  data.tar.gz: 2d909a5417d0b437d3a7b68882163ad5ba4d0d134612fd5f1ddcc508c7973736604137bc145fcacf3e14d472e6511a46d2a177581cbc070cfa9982986d0b148b

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
     $ gem install simplestate
 
 ## Usage
-Inherit from StateHolder to create the class of objects that will hold states:
+Inherit from StateHolder to create the class of the object that will hold states:
 
 ```ruby
 class Button < StateHolder
@@ -44,7 +44,7 @@ StateHolder expects to receive the initial state class in an opts hash at creati
 ```ruby
 button = Button.new(initial_state_class: Off)
 ```
-or alternate syntax:
+or use this alternate syntax:
 
 ```ruby
 button = Button.new(start_in: Off)
@@ -87,6 +87,29 @@ 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:
+
+```ruby
+class Button < StateHolder
+  ...
+
+  def prior_state
+    previous_states.last.class
+  end
+end
+
+ # Then in tests for example:
+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
+  assert_equal On, @button.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.
+
+# usage example
 The button module provides an example of the usage of Simplestate. Tests of this are provided in simplestate_test.rb.
 
 ## Development

data/lib/simplestate.rb

@@ -2,3 +2,4 @@ require "delegate"
 require "simplestate/version"
 require "simplestate/state_holder"
 require "simplestate/state"
+require "simplestate/nil_state"

data/lib/simplestate/nil_state.rb

@@ -0,0 +1,18 @@
+class NilState
+  attr_reader :holder, :previous_state_class, :previous_states
+  def initialize(holder, previous_state_class)
+    @holder = holder
+    @previous_state_class = previous_state_class
+    @previous_states = []
+  end
+
+private
+  def transition_to(new_state_class)
+  end
+
+  def enter
+  end
+
+  def exit
+  end
+end

data/lib/simplestate/state.rb

@@ -1,8 +1,9 @@
 class State
-  attr_reader :holder, :previous_state_class
+  attr_reader :holder, :previous_state_class, :previous_states
   def initialize(holder, previous_state_class)
     @holder = holder
     @previous_state_class = previous_state_class
+    @previous_states = build_previous_states_list
   end
 
 private
@@ -17,4 +18,11 @@ 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,8 +1,12 @@
 class StateHolder < SimpleDelegator
   def initialize(opts={})
-    set_initial_state_from(opts)
-    # Set current_state to initial state within SimpleDelegator
-    super(@initial_state)
+    # Set current_state to nil state within SimpleDelegator
+    nil_state = NilState.new(nil,nil)
+    super(nil_state)
+    # Then transition to the initial state class
+    initial_state_class = opts.fetch :start_in,
+                         (opts.fetch :initial_state_class, nil)
+    transition_to initial_state_class
   end
 
   def transition_to(new_state_class)
@@ -11,24 +15,17 @@ class StateHolder < SimpleDelegator
     current_state.send(:enter)
   end
 
+  def current_state
+    __getobj__
+  end
+
   def set_new_state(new_state_class)
     new_state = new_state_class.new(self, current_state.class)
     self.current_state = new_state
   end
 
-  def current_state
-    __getobj__
-  end
-
 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.2.0"
+  VERSION = "0.3.0"
 end

data/simplestate.gemspec

@@ -30,4 +30,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+
+  # Uncomment these to make pry available in testing
+  # Also make necessary changes in test_helper.rb
+  #spec.add_development_dependency "pry"
+  #spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplestate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mitchell C Kuppinger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-30 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - bin/console
 - bin/setup
 - lib/simplestate.rb
+- lib/simplestate/nil_state.rb
 - lib/simplestate/state.rb
 - lib/simplestate/state_holder.rb
 - lib/simplestate/version.rb