micromachine 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b235594232cccbcac8ea901232262324cd7748
-  data.tar.gz: 3c6c8d2b2cbcbdc5d435a30e30bf6ed2f078bddf
+  metadata.gz: a4a51863f3095d478f8d824e502a59e477a9eeb2
+  data.tar.gz: b13a296f50c14fb37b332fff619fce2008cc9b9f
 SHA512:
-  metadata.gz: 0c15ea016bf6bec45f30cc52e17369476be9503361bc935b85b3c4b7999bd980b9b8fd60f36dd6c5d7a5d2cda85fc68b9cd6166055c268ae9f74b84aee23e7da
-  data.tar.gz: fbdf2e41392c293b9afd9433dad03d672aa196cd97a4efcd286801d8b8c92ffac611efc46031de3e6dafde83f7588f665df39cd7f53299b1a6691cfd1c138616
+  metadata.gz: 4445768d0cdc3ccab91f13197e619f91713a86b28f5bd10cabc35c3ddd775be2a1dd872f73f621bd6d0601be580239255ab407b045e9ee79e686c38ab5121f53
+  data.tar.gz: 15737673b2f56817b9dc69b01ad6a9628354e59f7121b4a377e603ca3c6ce8bbb1fa008ae3347537c995a1286a60b70db0f6cccd0f08e850ff5167719341d102

data/README.md

@@ -89,6 +89,18 @@ end
 Note that `:any` is a special key. Using it as a state when declaring
 transitions will give you unexpected results.
 
+You can also pass any data as the second argument for `trigger` and
+`trigger!` which will be passed to every callback as the second
+argument too:
+
+``` ruby
+machine.on(:any) do |_status, payload|
+  puts payload.inspect
+end
+
+machine.trigger(:cancel, from: :user)
+```
+
 Finally, you can list possible events or states:
 
 ``` ruby

data/lib/micromachine.rb

@@ -19,12 +19,12 @@ class MicroMachine
     transitions_for[event] = transitions
   end
 
-  def trigger(event)
-    trigger?(event) and change(event)
+  def trigger(event, payload = nil)
+    trigger?(event) and change(event, payload)
   end
 
-  def trigger!(event)
-    trigger(event) or
+  def trigger!(event, payload = nil)
+    trigger(event, payload) or
       raise InvalidState.new("Event '#{event}' not valid from state '#{@state}'")
   end
 
@@ -47,10 +47,10 @@ class MicroMachine
 
 private
 
-  def change(event)
+  def change(event, payload = nil)
     @state = transitions_for[event][@state]
     callbacks = @callbacks[@state] + @callbacks[:any]
-    callbacks.each { |callback| callback.call(event) }
+    callbacks.each { |callback| callback.call(event, payload) }
     true
   end
 end

data/micromachine.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "micromachine"
-  s.version = "2.1.0"
+  s.version = "3.0.0"
   s.summary = %{Minimal Finite State Machine.}
   s.description = %Q{There are many finite state machine implementations for Ruby, and they all provide a nice DSL for declaring events, exceptions, callbacks, and all kinds of niceties in general.\n\nBut if all you want is a finite state machine, look no further: this has less than 50 lines of code and provides everything a finite state machine must have, and nothing more.}
   s.author = ["Michel Martens"]

data/test/callbacks.rb

@@ -42,3 +42,18 @@ test "passing the event name to the callbacks" do
 
   assert_equal(:confirm, event_name)
 end
+
+test "passing the payload from transition to the callbacks" do
+  received_payload = nil
+
+  machine = MicroMachine.new(:pending)
+  machine.when(:confirm, pending: :confirmed)
+
+  machine.on(:confirmed) do |_event, payload|
+    received_payload = payload
+  end
+
+  machine.trigger(:confirm, foo: :bar)
+
+  assert_equal({ foo: :bar }, received_payload)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: micromachine
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-07 00:00:00.000000000 Z
+date: 2017-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest