simplestate 2.0.8 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58265afde90f565033e45fa0ccb67ec7b19f8278
-  data.tar.gz: f5429f2ea2524d631611a9f822a4bbea12a0ec4b
+  metadata.gz: 2eeced360d2d970ddc18e95401b388903ff8e0e2
+  data.tar.gz: 6cd6ed7bc7779a30dec624eac085fc5660f1b018
 SHA512:
-  metadata.gz: 6e3b31aa17b7759176c30e1721bba7c7608fb588fe4f6a42d6ad4c60599fc635ed19ad3e1c56f6787eeffe3e1730278431dc8da986aaffde23c82945a7d04d74
-  data.tar.gz: 16d1d0504139ec6aaf6c094f2459d762077e2e1a2b2f17400e38dd187032e2061a411dfcb00067f197ad33727830be5e1bbe63ea4c68b25ebf6c729502e74ceb
+  metadata.gz: f2e83e88fb1e693991ca0ed6d758503cf6c15509b771ea258f97ad0ab752b20f3833c0d78edc656bdf32aef4a2c6de4b847426cf32b4186c7da160aa48c6d4d8
+  data.tar.gz: 5b1aae54d1fa3518c9c2df59ba9f9e74a77203b0de5df2bfd82647ace956ec24269d7676b6c569340054d916c92e626e6a7d2b24b164455360b1d4409012a85d

data/CHANGE_NOTES.md

@@ -1,3 +1,11 @@
+#### SimpleState version 2.1.0
+Make stateholder#transition_to a private method. Should have done all along. This is not representative of an event but rather a handler of the internal process of changing states.
+
+
+#### SimpleState version 2.0.8
+Cleanup tests. Remove some cruft.
+
+
 #### SimpleState version 2.0.7
 Provide initial state in the call to StateHolder#start. The call signatures for StateHolder#initialize and #start remain supported. This may change with the next major version change. Note that the state history will no longer begin with :NullState.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simplestate (2.0.7)
+    simplestate (2.0.8)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -72,7 +72,7 @@ Simplestate arose out of a desire for a very low ceremony mechanism to implement
 
 The current version (2.0.0) is a rewrite of SimpleState. State logic is provided via instances of the appropriate subclasses of State. A state is referenced via a symbol created by symbolizing the state's name. A list of state instances available for transitions is maintained by the state holder in a hash keyed on the state symbols. This is an incomplete variant of the singleton pattern. It solved some issues I was having with the previous version of SimpleState, but please use some care. For example, there is no logic to actually prevent creation of more than one instance of a given State subclass. Doing this would likely create bugs that will eventually bite you. :-(
 
-The StateHolder class provides the required functionality for a basic state machine: methods to set the initial state and to transition to a new state. To complement this a State class is provided to serve as ancestor to the states of the state holder. A State instance stores a reference to the state holder and a private __#transition\_to__ method which simply calls the state holder’s __#transition\_to__.
+The StateHolder class provides the required functionality for a basic state machine: methods to set the initial state and to transition to a new state. To complement this a State class is provided to serve as ancestor to the states of the state holder. A State instance stores a reference to the state holder and a private __#transition\_to__ method which simply calls the state holder’s private __#transition\_to__. This calling of a private method of another object is usually to be avoided. Making state_holder#transition_to private is chosen here to allow indication that external users of the state machine should not use state_holder#transition_to. The state_holder and it's associated states are closely linked and share much knowledge about each other. They are "co-dependent" due to the choice of using SimpleDelegator. As such I believe it is acceptable for a state to call the private method in its corresponding state holder.
 
 StateHolder and State are not expected to be used directly. Rather, they are intended to be the ancestors of the actual state holder and states. A state should provide only methods that are unique to it. Methods that are not specific to a state should be provided by the state holder. The public methods of a child state act as receivers of event messages via delegation from the state holder. Such events may cause effects that are managed by the current state and may also cause transition to a new state. State change logic is expected to be held within the current state. Two private methods, __#enter__ and __#exit__, *must* be provided by each state. These are called by the state holder __#transition_to__ method at the appropriate points in the state life cycle. Neither __#enter__ nor __#exit__ nor any other private method of a state are intended to be called by a user of the state holder. To avoid potentially stepping on the user's code __#enter__ and __#exit__ are called with __\_\_send\_\___.
 

data/lib/simplestate/state.rb

@@ -16,7 +16,7 @@ class State
 
   private
     def transition_to(state)
-      holder.transition_to(state)
+      holder.__send__ :transition_to, state
     end
 
     def enter

data/lib/simplestate/state_holder.rb

@@ -14,11 +14,6 @@ class StateHolder < SimpleDelegator
     enter_new_state(init_state)
   end
 
-  def transition_to(state)
-    leave_old_state
-    enter_new_state(state)
-  end
-
   # Convenience methods
   def current_state
     __getobj__
@@ -33,23 +28,28 @@ class StateHolder < SimpleDelegator
   end
 
   private
-    attr_reader :state_list, :state_history
-    def leave_old_state
-      current_state.__send__(:exit)
-    end
-
-    def enter_new_state(state)
-      self.current_state = state
-      state_history << current_state.symbol
-      current_state.__send__(:enter)
-    end
-
-    def current_state=(state)
-      state_obj = state_list[state]
-      __setobj__(state_obj)
-    end
-
-    def add_state(state_instance)
-      state_list.add state_instance
-    end
+  attr_reader :state_list, :state_history
+  def transition_to(state)
+    leave_old_state
+    enter_new_state(state)
+  end
+
+  def leave_old_state
+    current_state.__send__(:exit)
+  end
+
+  def enter_new_state(state)
+    self.current_state = state
+    state_history << current_state.symbol
+    current_state.__send__(:enter)
+  end
+
+  def current_state=(state)
+    state_obj = state_list[state]
+    __setobj__(state_obj)
+  end
+
+  def add_state(state_instance)
+    state_list.add state_instance
+  end
 end

data/lib/simplestate/version.rb

@@ -1,3 +1,3 @@
 module Simplestate
-  VERSION = "2.0.8"
+  VERSION = "2.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplestate
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.0.9
 platform: ruby
 authors:
 - Mitchell C Kuppinger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2016-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler