simplestate 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b88600a7f311b9c2b85581f4eb88a723ffec79a
-  data.tar.gz: 2557d44569ccd323304f8faab7bbf2970be3f529
+  metadata.gz: db5428361e6e4a05f7b412039b9d2d4573d0347a
+  data.tar.gz: 32e57aa972d3dc98978d67091a60be22094151a1
 SHA512:
-  metadata.gz: 380a5239dfa7ce6168cba6f5603eb22d5fd905a2a3acd06dc4ae4b5f4e480bbdfbf3de69da5c480d0adcbf75c585a8c83bdf02e7a504afbcb4554e974a921344
-  data.tar.gz: 6095ed9e3290016f296d794da764ec17e13c125e60af33a4cf5a31c11df324596eef3e164d4549f3ef3b66bac34e725f96c87545cc2469c96bcb734c7c5546ad
+  metadata.gz: 1d76b961961d90952e91af330cd86581a9f2c8168296cbd0e329c6dfd98fdf7de09c9144c0f5c38e17b18a029dbaaa0b93b9ea7684ad31e25f1d93b445297520
+  data.tar.gz: 023400cb7e1f81178ba104d29d2517ad2aaead23c443f75f97bcc26a0ffc071466190a675080296fe550497fb8885e45eb77b1179591e727df2faed2228d3b4f

data/CHANGE_NOTES.md

@@ -1,3 +1,7 @@
+#### 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.
+
+
 #### SimpleState version 2.0.6
 Remove some cruft from testing setup.
 Code grooming.

data/Gemfile

@@ -3,5 +3,9 @@ source 'https://rubygems.org'
 #gem 'coveralls', require: false
 gem "codeclimate-test-reporter", group: :test, require: nil
 
+#gem "pry"
+#gem "pry-byebug"
+
+
 # Specify your gem's dependencies in simplestate.gemspec
 gemspec

data/Gemfile.lock

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

data/README.md

@@ -7,7 +7,7 @@
 ```ruby
 class Button < StateHolder
   attr_reader :name
-  def initialize(initial_state: :Off, state_history: StateHistory.new, opts: {})
+  def initialize(opts: {})
     @name = opts.fetch :name
     super
   end
@@ -107,7 +107,7 @@ Inherit from StateHolder to create the class of the object that will hold states
 ```ruby
 class Button < StateHolder
   attr_reader :color
-  def initialize( initial_state: :Off, opts: {} )
+  def initialize(opts: {})
     @color = opts.fetch :color
     super
   end
@@ -116,17 +116,33 @@ class Button < StateHolder
 end
 ```
 
-Creation of a StateHolder instance *must* specify the initial state. StateHolder expects to receive the initial state as a symbol based on the state name. The name case is preserved in creating the symbol.:
+Creation of a StateHolder instance may specify the initial state. StateHolder expects to receive the initial state as a symbol based on the state name. The name case is preserved in creating the symbol.:
 
 ```ruby
 button = Button.new( initial_state: :Off )
 ```
+or
+```ruby
+button = Button.new()
+```
 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( initial_state: :Off,
-                     opts: {color: 'Red'} )
+button = Button.new( opts: {color: 'Red'} )
+```
+After creation of a state holder it must be started:
+
+```ruby
+button = Button.new
+button.start(:Off)
 ```
+If the initial state is not directly supplied to the start method, then it must have been supplied at state holder creation:
+
+```ruby
+button = Button.new( initial_state: :Off )
+button.start
+```
+
 
 #### States
 
@@ -159,7 +175,7 @@ holder.specialmethod
 ```
 
 #### Usage Example
-The button module (test/dummys/button.rb) provides an example of the usage of Simplestate. Tests of this are provided in button\_test.rb.
+The button module (test/dummy/button.rb) provides an example of the usage of Simplestate. Tests of this are provided in button\_test.rb.
 
 A working minimal example app is provided at ```https://github.com/dpneumo/simplestate-demo```
 

data/lib/simplestate/null_state.rb

@@ -3,12 +3,9 @@ class NullState
   # Avoid chicken and egg problem by mimicing rather than inheriting from State
 
   attr_reader :holder
-  def initialize(holder: nil, opts: {})
+  def initialize(holder:, opts: {})
     @holder = holder
-  end
-
-  def self.list
-    {}
+    @holder.__send__(:add_state, self)
   end
 
   def name

data/lib/simplestate/state_holder.rb

@@ -1,17 +1,17 @@
 class StateHolder < SimpleDelegator
-  attr_reader :initial_state, :state_history
+  attr_reader :initial_state
 
-  def initialize(initial_state:, state_history: StateHistory.new, opts: {})
-    @initial_state = initial_state
+  def initialize( initial_state: nil,
+                  state_history: StateHistory.new,
+                  state_list: StateList.new,
+                  opts: {})
     @state_history = state_history
-    @state_list = StateList.new
-
-    super(NullState.new)
+    @state_list    = state_list
+    super
   end
 
-  def start
-    state_history << current_state.symbol
-    transition_to(initial_state)
+  def start(init_state=initial_state)
+    enter_new_state(init_state)
   end
 
   def transition_to(state)
@@ -33,7 +33,7 @@ class StateHolder < SimpleDelegator
   end
 
   private
-    attr_reader :state_list
+    attr_reader :state_list, :state_history
     def leave_old_state
       current_state.__send__(:exit)
     end

data/lib/simplestate/version.rb

@@ -1,3 +1,3 @@
 module Simplestate
-  VERSION = "2.0.6"
+  VERSION = "2.0.7"
 end

metadata

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