end_state 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3fceb0c3ef5dd0efcf27176e899e75ad55f1243
-  data.tar.gz: 600cc39bea6aeca957285707a280c29b07092ad1
+  metadata.gz: 4ab1a46deb255c511c400aa621f8115710df91b1
+  data.tar.gz: cf724f635788d18944aa6184c39d8a2eb99b5467
 SHA512:
-  metadata.gz: 05317e5548b4924e211f422a2a9c4eb6f6ddcc872f4fdff91828acf27768cde90ec608f10c35d50b098576e797a6c2ec4ae9a8a010fd9046c09c0e4a01e282f5
-  data.tar.gz: d3432693ec760a0ea06ba9790f075a3837571b0b53518b06f781ccaa9654832ff96b875eea229afb5ffe147fd1fbdc25bb9be93b4a6ea250552695c0cf3f7b2f
+  metadata.gz: 2a98ddb418c8ebd011a13d61d11132f325c16d00de89470199d849b80052f3c9a372766c9673d8b2649d5b545732c504358041846e45c4cdfcb61c63658208cc
+  data.tar.gz: d87346b6f8a48c9f2fb6d0e72a1f39b5216f2cf1af4ed23a42aa457bc47deb73d035c51648185cd9288244606ea626e9e2533baa0cd17364261a6aed803ac341

data/README.md

@@ -73,6 +73,28 @@ class Machine < EndState::StateMachine
 end
 ```
 
+## Special State - :any_state
+
+You can specify the special state `:any_state` as the beginning of a transition. This will allow
+the machine to transition to the new state specified from any actual state.
+
+```ruby
+class Machine < EndState::StateMachine
+  transition a: :b
+  transition b: :c
+  transition any_state: :d
+end
+
+machine = Machine.new(StatefulObject.new(:a))
+machine.d!      # true
+machine.state   # :d
+
+machine = Machine.new(StatefulObject.new(:a))
+machine.b!      # true
+machine.d!      # true
+machine.state   # :d
+```
+
 ## Guards
 
 Guards can be created by subclassing `EndState::Guard`. Your class will be provided access to:
@@ -230,6 +252,36 @@ machine.go!                 # => false
 machine.failure_messages    # => ['Cannot go!']
 ```
 
+## Parameters
+
+When calling a transition, you can optionally provide a hash of parameters which will be available to the guards
+and concluders you include in the transition definition.
+
+When defining a transition you can indicate what parameters you are expecting with `allow_params` and `require_params`.
+If you require any params then attempting to transition without them provided will raise an error. Specifying allowed
+params is purely for documentation purposes.
+
+```
+class Machine < EndState::StateMachine
+  transition a: :b do |t|
+    t.allow_params :foo, :bar
+  end
+end
+```
+
+```
+class Machine < EndState::StateMachine
+  transition a: :b do |t|
+    t.require_params :foo, :bar
+  end
+end
+
+machine = Machine.new(StatefulObject.new(:a))
+
+machine.b!                        # => error raised: 'Missing params: foo, bar'
+machine.b! foo: 1, bar: 'value'   # => true
+```
+
 ## State storage
 
 You may want to use an attribute other than `state` to track the state of the machine.

data/lib/end_state/state_machine.rb

@@ -128,7 +128,8 @@ module EndState
     def state_for_event(event)
       transitions = self.class.events[event]
       return false unless transitions
-      return invalid_event(event) unless transitions.map { |t| t.keys.first }.include?(state.to_sym)
+      start_states = transitions.map { |t| t.keys.first }
+      return invalid_event(event) unless start_states.include?(state.to_sym) || start_states.include?(:any_state)
       transitions.first.values.first
     end
 

data/lib/end_state/version.rb

@@ -1,3 +1,3 @@
 module EndState
-  VERSION = '0.10.0'
+  VERSION = '0.10.1'
 end

data/spec/end_state/state_machine_spec.rb

@@ -221,6 +221,17 @@ module EndState
           end
         end
       end
+
+      context 'when using any_state with an event' do
+        before do
+          StateMachine.transition any_state: :end, as: :jump_to_end
+        end
+
+        it 'transitions the state to :end' do
+          machine.jump_to_end!
+          expect(machine.state).to eq :end
+        end
+      end
     end
 
     describe '#can_transition?' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: end_state
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - alexpeachey