finist 0.0.1

checksums.yaml

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

data/.gems

@@ -0,0 +1,2 @@
+redic -v 1.2.0
+cutest -v 1.2.2

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Michel Martens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+Finist
+======
+
+Redis based Finite State Machine.
+
+Description
+-----------
+
+Finist is a finite state machine that is defined and persisted in
+[Redis][redis].
+
+Community
+---------
+
+Meet us on IRC: [#lesscode](irc://chat.freenode.net/#lesscode) on
+[freenode.net](http://freenode.net/).
+
+Related projects
+----------------
+
+There's an [alternative implementation for Lua][finist.lua].
+
+Getting started
+---------------
+
+Install [Redis][redis]. On most platforms it's as easy as grabbing
+the sources, running make and then putting the `redis-server` binary
+in the PATH.
+
+Once you have it installed, you can execute `redis-server` and it
+will run on `localhost:6379` by default. Check the `redis.conf`
+file that comes with the sources if you want to change some settings.
+
+Usage
+-----
+
+Finist requires a [Redic][redic] compatible client. To make things
+easier, `redic` is listed as a runtime dependency so the examples
+in this document will work.
+
+```ruby
+require "finist"
+
+# Initialize with a Redis client, the name of the machine and the
+# initial state. In this example, the machine is called "order" and
+# the initial status is "pending". The Redis client is connected to
+# the default host (127.0.0.1:6379).
+machine = Finist.new(Redic.new, "order", "pending")
+
+# Available transitions are defined with the `on` method
+# `machine.on(<event>, <initial_state>, <final_state>)`
+machine.on("approve", "pending", "approved")
+machine.on("cancel", "pending", "cancelled")
+machine.on("cancel", "approved", "cancelled")
+machine.on("reset", "cancelled", "pending")
+```
+
+Now that the possible transitions are defined, we can check the
+current state:
+
+```ruby
+machine.state
+# => "pending"
+```
+
+And we can trigger an event:
+
+```ruby
+machine.trigger("approve")
+# => [true, "approved"]
+```
+
+The `trigger` method returns an array of two values: the first
+represents whether a transition occurred, and the second represents
+the current state.
+
+Here's what happens if an event doesn't cause a transition:
+
+```ruby
+machine.trigger("reset")
+# => [false, "approved"]
+```
+
+Here's a convenient way to use this flag:
+
+```ruby
+changed, state = machine.trigger("reset")
+
+if changed
+  printf("State changed to %s\n", state)
+end
+```
+
+If you need to remove all the transitions for a given event, you
+can use `rm`:
+
+```ruby
+machine.rm("reset")
+```
+
+Note that every change is persisted in Redis.
+
+Installation
+------------
+
+```
+$ gem install finist
+```
+
+[redis]: http://redis.io
+[redic]: https://github.com/amakawa/redic
+[finist.lua]: https://github.com/soveran/finist.lua

data/finist.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "finist"
+  s.version = "0.0.1"
+  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"]
+  s.email = ["michel@soveran.com"]
+  s.homepage = "https://github.com/soveran/finist"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "redic"
+  s.add_development_dependency "cutest"
+end

data/lib/finist.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+
+require "redic"
+
+class Finist
+  SCRIPT = <<-EOS
+    local curr = redis.call("GET", KEYS[1])
+    local next = redis.call("HGET", KEYS[2], curr)
+
+    if next then
+      redis.call("SET", KEYS[1], next)
+      return { next, true }
+    else
+      return { curr, false }
+    end
+  EOS
+
+  def initialize(redis, name, init)
+    @name = sprintf("finist:%s", name)
+    @redis = redis
+    @redis.call("SET", @name, init, "NX")
+  end
+
+  def event_key(ev)
+    sprintf("%s:%s", @name, ev)
+  end
+
+  def on(ev, curr_state, next_state)
+    @redis.call("HSET", event_key(ev), curr_state, next_state)
+  end
+
+  def rm(ev)
+    @redis.call("DEL", event_key(ev))
+  end
+
+  def state
+    @redis.call("GET", @name)
+  end
+
+  def send_event(ev)
+    @redis.call("EVAL", SCRIPT, "2", @name, event_key(ev))
+  end
+
+  def trigger(ev)
+    result = send_event(ev)
+
+    if result[1]
+      return true, result[0]
+    else
+      return false, result[0]
+    end
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest -r ./test/helper.rb ./test/*.rb

data/test/all.rb

@@ -0,0 +1,60 @@
+require_relative "helper"
+
+test do
+  c = Redic.new
+
+  fsm = Finist.new(c, "myfsm", "pending")
+
+  fsm.on("approve", "pending", "approved")
+  fsm.on("cancel", "pending", "cancelled")
+  fsm.on("cancel", "approved", "cancelled")
+  fsm.on("reset", "cancelled", "pending")
+
+  # Verify initial state
+  assert_equal("pending", fsm.state)
+
+  # Send an event
+  fsm.trigger("approve")
+
+  # Verify transition to "approved"
+  assert_equal("approved", fsm.state)
+
+  # Send an event
+  fsm.trigger("cancel")
+
+  # Verify transition to "cancelled"
+  assert_equal("cancelled", fsm.state)
+
+  # Send an event
+  fsm.trigger("approve")
+
+  # Verify state remains as "cancelled"
+  assert_equal("cancelled", fsm.state)
+
+  # Create a different fsm with client
+  fsm2 = Finist.new(c, "myfsm", "pending")
+
+  # Verify state remains as "cancelled"
+  assert_equal("cancelled", fsm2.state)
+
+  # A successful event returns true
+  changed, state = fsm.trigger("reset")
+
+  assert_equal(true, changed)
+  assert_equal("pending", state)
+
+  # An unsuccessful event returns false
+  changed, state = fsm.trigger("reset")
+
+  assert_equal(false, changed)
+  assert_equal("pending", state)
+
+  # Delete an event
+  fsm.rm("approve")
+
+  # Non existent events return false
+  changed, state = fsm.trigger("approve")
+
+  assert_equal(false, changed)
+  assert_equal("pending", state)
+end

data/test/helper.rb

@@ -0,0 +1 @@
+require_relative "../lib/finist"

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: finist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Finist is a finite state machine that is defined and persisted in Redis.
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gems
+- LICENSE
+- README.md
+- finist.gemspec
+- lib/finist.rb
+- makefile
+- test/all.rb
+- test/helper.rb
+homepage: https://github.com/soveran/finist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Redis based Finite State Machine
+test_files: []