finist 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ef4a139c70308a595e49e7ba7053a64631c33e0
-  data.tar.gz: 6a640ada556919739c4bc01de30d4aa3e9fba735
+  metadata.gz: 1bbf0d801dbbcdedc3e1ce1ce672229c2f3b9a8a
+  data.tar.gz: b93e52acbe5feb52b6ea4a784c073faf1c0377f1
 SHA512:
-  metadata.gz: c5720d02f6093f0eeb9bd20161f7b7b617f70c20ded4a85d8305cb2f61e5e38c50e2b3c18ea33c225fb35841cc6d0f28b88bbe75dc5e409a4297698965bbbd11
-  data.tar.gz: 2cc188dd3d8a6d7fd58bdab1c9727765ca7ddbb346132e687364617ece39a41d5127df78382838a4e333736cbe32241892c7fd4f4ece7f7cf75085a2cd2f6cae
+  metadata.gz: c78ebef60005b2f8696fd3f97284e00064daf4c961f4f312a62b7bca213dea74438a50b9454d21336b3799e8295a22d3546c4c8d28a92bc19280228bbb1436e6
+  data.tar.gz: 7d3674cea94bf30a3e2fa1471a7c84fb7eb7d7fe92ccf47d71a497a82f1c1c746318fa0437d09e3d060df81fee970e2bf78448d479a1e6947d327d09bc5e9ae3

data/CHANGELOG

@@ -0,0 +1,3 @@
+0.1.0
+
+Change order of returned values.

data/README.md

@@ -18,7 +18,8 @@ Meet us on IRC: [#lesscode](irc://chat.freenode.net/#lesscode) on
 Related projects
 ----------------
 
-There's an [alternative implementation for Lua][finist.lua].
+* [Finist implemented in Lua][finist.lua]
+* [Finist implemented in Rust][finist.rust]
 
 Getting started
 ---------------
@@ -67,24 +68,24 @@ And we can trigger an event:
 
 ```ruby
 machine.trigger("approve")
-# => [true, "approved"]
+# => ["approved", true]
 ```
 
 The `trigger` method returns an array of two values: the first
-represents whether a transition occurred, and the second represents
-the current state.
+represents the current state, and the second represents whether
+a transition occurred.
 
 Here's what happens if an event doesn't cause a transition:
 
 ```ruby
 machine.trigger("reset")
-# => [false, "approved"]
+# => ["approved", false]
 ```
 
 Here's a convenient way to use this flag:
 
 ```ruby
-changed, state = machine.trigger("reset")
+state, changed = machine.trigger("reset")
 
 if changed
   printf("State changed to %s\n", state)
@@ -100,6 +101,33 @@ machine.rm("reset")
 
 Note that every change is persisted in Redis.
 
+Representation
+--------------
+
+Each event is represented as a hash in Redis, and its field/value
+pairs are the possible transitions.
+
+For the FSM described in the examples above, the keys are laid out
+as follows:
+
+```ini
+# Current state
+finist:order (string)
+
+# Transitions for event `approve`
+finist:order:approve (hash)
+	pending   -> approved
+
+# Transitions for event `cancel`
+finist:order:cancel (hash)
+	pending   -> cancelled
+	approved  -> cancelled
+
+# Transitions for event `reset`
+finist:order:reset (hash)
+	cancelled -> pending
+```
+
 Installation
 ------------
 
@@ -110,3 +138,4 @@ $ gem install finist
 [redis]: http://redis.io
 [redic]: https://github.com/amakawa/redic
 [finist.lua]: https://github.com/soveran/finist.lua
+[finist.rust]: https://github.com/badboy/finist

data/finist.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "finist"
-  s.version = "0.0.1"
+  s.version = "0.1.0"
   s.summary = %{Redis based Finite State Machine}
   s.description = %Q{Finist is a finite state machine that is defined and persisted in Redis.}
   s.authors = ["Michel Martens"]

data/lib/finist.rb

@@ -43,11 +43,6 @@ class Finist
 
   def trigger(ev)
     result = send_event(ev)
-
-    if result[1]
-      return true, result[0]
-    else
-      return false, result[0]
-    end
+    return result[0], result[1] != nil
   end
 end

data/test/all.rb

@@ -1,8 +1,12 @@
 require_relative "helper"
 
-test do
-  c = Redic.new
+setup do
+  Redic.new.tap do |c|
+    c.call("FLUSHDB")
+  end
+end
 
+test do |c|
   fsm = Finist.new(c, "myfsm", "pending")
 
   fsm.on("approve", "pending", "approved")
@@ -38,13 +42,13 @@ test do
   assert_equal("cancelled", fsm2.state)
 
   # A successful event returns true
-  changed, state = fsm.trigger("reset")
+  state, changed = fsm.trigger("reset")
 
   assert_equal(true, changed)
   assert_equal("pending", state)
 
   # An unsuccessful event returns false
-  changed, state = fsm.trigger("reset")
+  state, changed = fsm.trigger("reset")
 
   assert_equal(false, changed)
   assert_equal("pending", state)
@@ -53,7 +57,7 @@ test do
   fsm.rm("approve")
 
   # Non existent events return false
-  changed, state = fsm.trigger("approve")
+  state, changed = fsm.trigger("approve")
 
   assert_equal(false, changed)
   assert_equal("pending", state)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finist
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redic
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gems
+- CHANGELOG
 - LICENSE
 - README.md
 - finist.gemspec