microfsm 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8380343e775bb2c143ccb457454ab729544226984831170d68d674faa5b674f
-  data.tar.gz: 3b9cc48b46baac3f500309345312302ce79069b568043979efc220a1adf98ae2
+  metadata.gz: c13fcd2761ef9a4a28e56b5366bb9cde6a7e13a41014666fce63bd81b461445b
+  data.tar.gz: e95df3ce4f7f737d20a61b9ddb690eb5648eb3badfbd36ace291e2668db6a408
 SHA512:
-  metadata.gz: 9ff4030bcdeb6a31ae300a1ec575aa252fb9f08267e8482eb361bd26884eb2b307bf30d397bfdd6e6a57bfb70f72900f593bf53f579e029dcbad5802d92ee561
-  data.tar.gz: fe18e71eca3810d8e0a2b862fc37cb580854b11162116fd27c78933654cb46b93494ea95431dfd9bdfcedf0e0b0423c9340e58fbf1166c792a02c79792dc0028
+  metadata.gz: bca81a60f2f226f0e8b5e321d66a223df846e561d274465db6a5d1286104676559ac26b08dcd2940a9775054566838319a2814acaae1d9a05fda8f4ed44773e8
+  data.tar.gz: cc3a71307b8d26498a31418de6742da0d33a6b0daec5dab0fe84696a5c5620ce92a89be7ab1823160b288dc71c41387decc07a7677e37e5ce92bf2f81e09afcd

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+bundle config set without production
+script: "bundle exec rake test"
+
+rvm:
+   - 2.7.2  # 2020-10-26
+
+notifications:
+  email: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    microfsm (0.0.1)
+    microfsm (0.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -17,7 +17,7 @@ GEM
     rake (13.0.3)
     regexp_parser (2.0.3)
     rexml (3.2.4)
-    rubocop (1.8.1)
+    rubocop (1.9.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -38,7 +38,7 @@ GEM
     unicode-display_width (2.0.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   bundler
@@ -50,4 +50,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.1.4
+   2.2.6

data/README.md

@@ -1,4 +1,8 @@
-# MicroFSM
+MicroFSM
+========
+
+[![Gem Version](https://badge.fury.io/rb/microfsm.svg)](https://badge.fury.io/rb/microfsm)
+[![Build Status](https://travis-ci.org/matique/microfsm.svg?branch=master)](https://travis-ci.org/matique/microfsm)
 
 MicroFSM implements a minimal/simple Finite-State Machine (FSM).
 Transitions are triggered by events.
@@ -9,17 +13,15 @@ Finite-State Machine are described elsewhere, e.g. Wikipedia.
 Several FSM implementations are available for Ruby.
 Please feel free to use any of them if they fit better to your work.
 
-The MicroFSM code consists of less than 70 locs.
+The MicroFSM code consists of less than 100 locs.
 No magic, no niceties, just an implementation using Ruby hashes.
 
-Check the examples directory for more information.
-
-
-## Installation
+Installation
+------------
 
 ~~~~
 # Gemfile
-gem "wysiwyg-rails"
+gem "microfsm"
 
 $ bundle install.
 
@@ -28,7 +30,8 @@ $ bundle install.
 $ [sudo] gem install microfsm
 ~~~~
 
-## Usage
+Usage
+-----
 
 ~~~~
 require 'microfsm'
@@ -53,8 +56,8 @@ fsm.trigger(:ignore)   #=> true
 fsm.state              #=> :ignored
 ~~~~
 
-You can also ask if an event will trigger a change in state. Following
-the example above:
+You can also ask if an event will trigger a change in state.
+Following the example above:
 
 ~~~~
 fsm.state              #=> :ignored
@@ -66,6 +69,21 @@ fsm.trigger?(:reset)   #=> true
 fsm.state              #=> :ignored
 ~~~~
 
+Actions
+-------
+
+Adding actions to a transition is trivial:
+
+~~~~
+fsm.when(:confirm, new: :confirmed) { |event| count += 1 }
+fsm.when(:confirm, new: :confirmed) { |event| foo(event) }
+~~~~
+
+Two actions/callbacks are triggered in the previous example.
+
+
+Miscellaneous
+-------------
 
 Finally, you can list possible events or states:
 
@@ -80,9 +98,17 @@ fsm.triggerable_events #=> [:confirm, :ignore]
 fsm.states #=> [:new, :confirmed, :ignored]
 ~~~~
 
+And, the state can be set (which may be useful for testing purposes):
+
+~~~~
+fsm.state = :new
+fsm.state              #=> :new
+~~~~
+
 Check the examples directory for more information.
 
-## Links
+Links
+-----
 
 - [Wikipedia](https://en.wikipedia.org/wiki/Finite-state_machine)
 - [micromachine](https://github.com/soveran/micromachine)

data/lib/microfsm.rb

@@ -34,11 +34,11 @@ class MicroFSM
 
   def trigger!(event)
     trigger(event) or
-      raise InvalidState.new("Event '#{event}' not valid from state '#{@state}'")
+      raise InvalidState.new(msg(event))
   end
 
   def trigger?(event)
-    raise InvalidEvent unless @transitions_for.has_key?(event)
+    raise InvalidEvent.new(msg(event)) unless @transitions_for.has_key?(event)
 
     @transitions_for[event].has_key?(state)
   end
@@ -55,6 +55,10 @@ class MicroFSM
     @transitions_for.values.map(&:to_a).flatten.uniq.sort
   end
 
+  def state=(state)
+    @state = state
+  end
+
  private
   def transit(event)
     callbacks = @callbacks_for[event][@state]
@@ -62,4 +66,8 @@ class MicroFSM
     callbacks.each { |callback| callback.call(event) }
     true
   end
+
+  def msg(event)
+    "State: #{@state}; Event: #{event}"
+  end
 end

data/lib/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 class MicroFSM
-  VERSION = '0.0.1'     # 2021-01-24
+  VERSION = '0.1.0'     # 2021-02-08
+  # VERSION = '0.0.1'     # 2021-01-24
 end

data/microfsm.gemspec

@@ -5,10 +5,10 @@ Gem::Specification.new do |s|
   s.name = "microfsm"
   s.version = MicroFSM::VERSION
   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.description = %Q{MicroFSM implements a minimal/simple Finite-State Machine (FSM). Transitions are triggered by events. Actions for a transition can be added as callbacks.}
   s.authors  = ['Dittmar Krall']
   s.email    = 'dittmar.krall@matique.de'
-  s.homepage = 'http://www.matique.de'
+  s.homepage = 'http://www.matique.com'
   s.license = "MIT"
 
   s.files = `git ls-files`.split("\n")

data/test/microfsm_test.rb

@@ -62,4 +62,11 @@ describe MicroFSM do
       fsm.when(:trigger, init: :wrong)
     end
   end
+
+  def test_state_assign
+    new_state = :unknown
+    refute_equal new_state, fsm.state
+    fsm.state = new_state
+    assert_equal new_state, fsm.state
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: microfsm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Dittmar Krall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: MicroFSM implements a minimal/simple Finite-State Machine (FSM). Transitions
+  are triggered by events. Actions for a transition can be added as callbacks.
 email: dittmar.krall@matique.de
 executables: []
 extensions: []
@@ -61,6 +62,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - ".watchr"
 - Gemfile
 - Gemfile.lock
@@ -77,7 +79,7 @@ files:
 - test/introspection_test.rb
 - test/microfsm_test.rb
 - test/test_helper.rb
-homepage: http://www.matique.de
+homepage: http://www.matique.com
 licenses:
 - MIT
 metadata: {}
@@ -96,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: Minimal Finite State Machine.