microfsm 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f001afae7bd77ec4b88a0d8e4d1ff5cab0c3f0ee03f3db230fb2e6ae9124b47b
-  data.tar.gz: ed4b2860cca3cfe1b8f1f135a4180c77d2da8c2a6013191dfe60ea11c0dc74ec
+  metadata.gz: afc1b721660dde4225b57491fc30f99a4776473d918c7bb75fe59c103b6da37d
+  data.tar.gz: 575c2c67815e3ee7250c4aa49ab4a19a952c59bad6bf006cd9cb5b8d09066796
 SHA512:
-  metadata.gz: 59659548f32f60823744f452cad8ebb4a5d2a193d2fc63c37978844056ac89f7592e95d32ac4da12bf5571fb8e6302415952c455b8a8d8cbcfab8764f5eb55f8
-  data.tar.gz: ca69ff6bf93b10d190b522998091474288e56ae2b8569010b558ecf206d7235f02a72f6a1f00ade1bd68fe8d934d8f0e0d6886e3bdd796e69e55785a48012fb2
+  metadata.gz: 146a4d85345da08f2030767fb4a203d6e4516004da3ee55e8b115d17f5ef297824d72bfbc828e49369f82ae0cb71853415464f881bc6a32654de96218d465778
+  data.tar.gz: 407ccf0c6a370b65f7802256bcf588e73f85b604f005e2980ec2e7f223348d6934e43ef1dd371fa82f2085cd2fbb606e73a659bf117528c795a028f954d58bec

data/.github/workflows/rake.yml

@@ -0,0 +1,26 @@
+# see also https://github.com/whitequark/parser/blob/master/.github/workflows/test.yml
+name: Rake
+
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: ["2.7", "3.0", "3.1", head]
+        test_command: ["bundle exec rake test"]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Bundle install
+      run: |
+        bundle config path /home/runner/bundle
+        bundle install
+        bundle update
+    - run: ${{ matrix.test_command }}

data/.ruby-gemset

@@ -1 +1 @@
-rails-6.1
+rails-7.0

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.2
+ruby-3.1.3

data/Gemfile

@@ -1,9 +1,9 @@
-source 'https://rubygems.org'
-
+source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem 'observr'
-  gem 'rubocop', require: false
-  gem 'simplecov', require: false
+  gem "observr"
+  gem "ricecream"
+  gem "rubocop", require: false
+  gem "simplecov", require: false
 end

data/Gemfile.lock

@@ -1,41 +1,44 @@
 PATH
   remote: .
   specs:
-    microfsm (0.0.2)
+    microfsm (0.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    docile (1.3.5)
-    minitest (5.14.3)
+    docile (1.4.0)
+    json (2.6.3)
+    minitest (5.16.3)
     observr (1.0.5)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rubocop (1.9.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    ricecream (0.2.1)
+    rubocop (1.41.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
-    unicode-display_width (2.0.0)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   x86_64-linux
@@ -46,8 +49,9 @@ DEPENDENCIES
   minitest
   observr
   rake
+  ricecream
   rubocop
   simplecov
 
 BUNDLED WITH
-   2.2.6
+   2.3.26

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2021 Dittmar Krall
+The MIT License (MIT)
+
+Copyright (c) 2021-2022 Dittmar Krall (www.matiq.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,6 @@
-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.
@@ -16,33 +14,27 @@ Please feel free to use any of them if they fit better to your work.
 The MicroFSM code consists of less than 100 locs.
 No magic, no niceties, just an implementation using Ruby hashes.
 
-Installation
-------------
+## Installation
 
-~~~~
+As usual:
+```ruby
 # Gemfile
 gem "microfsm"
+```
+and run "bundle install".
 
-$ bundle install.
+## Usage
 
-# or manually
-
-$ [sudo] gem install microfsm
-~~~~
-
-Usage
------
-
-~~~~
+```ruby
 require 'microfsm'
 
 fsm = MicroFSM.new(:new) # Initial state.
 
 # Define the possible transitions for each event.
 #   Template: fsm.when(<event>, <from> => <to>)
-fsm.when(:confirm, :new => :confirmed)
-fsm.when(:ignore, :new => :ignored)
-fsm.when(:reset, :confirmed => :new, :ignored => :new)
+fsm.when(:confirm, new: :confirmed)
+fsm.when(:ignore, new: :ignored)
+fsm.when(:reset, confirmed: :new, ignored: :new)
 
 fsm.trigger(:confirm)  #=> true
 fsm.state              #=> :confirmed
@@ -55,12 +47,12 @@ fsm.state              #=> :new
 
 fsm.trigger(:ignore)   #=> true
 fsm.state              #=> :ignored
-~~~~
+```
 
 You can also ask if an event will trigger a change in state.
 Following the example above:
 
-~~~~
+```ruby
 fsm.state              #=> :ignored
 
 fsm.trigger?(:ignore)  #=> false
@@ -68,27 +60,25 @@ fsm.trigger?(:reset)   #=> true
 
 # And the state is preserved, because you were only asking.
 fsm.state              #=> :ignored
-~~~~
+```
 
-Actions
--------
+## Actions
 
 Adding actions to a transition is trivial:
 
-~~~~
+```ruby
 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
--------------
+## Miscellaneous
 
 Finally, you can list possible events or states:
 
-~~~~
+```ruby
 # All possible events
 fsm.events #=> [:confirm, :ignore, :reset]
 
@@ -97,19 +87,25 @@ fsm.triggerable_events #=> [:confirm, :ignore]
 
 # All possible states
 fsm.states #=> [:new, :confirmed, :ignored]
-~~~~
+```
 
 And, the state can be set (which may be useful for testing purposes):
 
-~~~~
+```ruby
 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)
+
+## Miscellaneous
+
+Copyright (c) 2021-2022 Dittmar Krall (www.matiq.com),
+released under the MIT license:
+
+* https://opensource.org/licenses/MIT

data/Rakefile

@@ -1,10 +1,10 @@
-require 'rake'
-require 'rake/testtask'
+require "rake"
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs.push 'test'
-  t.pattern = 'test/*_test.rb'
+  t.libs.push "test"
+  t.pattern = "test/*_test.rb"
 end
 
-desc 'Default: run unit tests.'
-task :default => :test
+desc "Default: run unit tests."
+task default: :test

data/examples/advanced.rb

@@ -1,12 +1,12 @@
-require 'microfsm'
+require "microfsm"
 
 # This example can be run with ruby -I lib/ ./examples/advanced.rb
 
 fsm = MicroFSM.new(:pending)
-proc = -> (event) { puts fsm.state.capitalize }
-fsm.when(:confirm, :pending => :confirmed, &proc)
-   .when(:ignore,  :pending => :ignored, &proc)
-   .when(:reset,   :confirmed => :pending, :ignored => :pending, &proc)
+proc = ->(event) { puts fsm.state.capitalize }
+fsm.when(:confirm, pending: :confirmed, &proc)
+  .when(:ignore, pending: :ignored, &proc)
+  .when(:reset, confirmed: :pending, ignored: :pending, &proc)
 
 puts "Should print Confirmed, Pending and Ignored:"
 fsm.trigger(:confirm)

data/examples/basic.rb

@@ -1,11 +1,11 @@
-require 'microfsm'
+require "microfsm"
 
 # This example can be run with ruby -I lib/ ./examples/basic.rb
 
 fsm = MicroFSM.new(:pending)
-        .when(:confirm,  :pending => :confirmed)
-        .when(:ignore,   :pending => :ignored)
-        .when(:reset,    :confirmed => :pending, :ignored => :pending)
+  .when(:confirm, pending: :confirmed)
+  .when(:ignore, pending: :ignored)
+  .when(:reset, confirmed: :pending, ignored: :pending)
 
 puts "Should print Confirmed, Reset and Ignored:"
 

data/examples/callbacks.rb

@@ -1,13 +1,13 @@
-require 'microfsm'
+require "microfsm"
 
 # This example can be run with ruby -I lib/ ./examples/callbacks.rb
 
 fsm = MicroFSM.new(:pending)
-        .when(:confirm,  :pending => :confirmed) { puts "Confirmed" }
-        .when(:ignore,   :pending => :ignored) { puts "Ignored" }
-        .when(:reset,    :confirmed => :pending, :ignored => :pending) {
-          puts "Reset"
-        }
+  .when(:confirm, pending: :confirmed) { puts "Confirmed" }
+  .when(:ignore, pending: :ignored) { puts "Ignored" }
+  .when(:reset, confirmed: :pending, ignored: :pending) {
+  puts "Reset"
+}
 
 puts "Should print Confirmed, Reset and Ignored:"
 fsm.trigger(:confirm)

data/lib/microfsm.rb

@@ -5,7 +5,7 @@ class MicroFSM
   InvalidState = Class.new(ArgumentError)
   InvalidTransition = Class.new(ArgumentError)
 
-  attr_reader :state
+  attr_accessor :state
 
   def initialize(initial_state)
     @state = initial_state
@@ -23,7 +23,7 @@ class MicroFSM
 
       @transitions_for[event][from] = to
       @callbacks_for[event][from] ||= []
-      @callbacks_for[event][from] << block if block_given?
+      @callbacks_for[event][from] << block if block
     end
     self
   end
@@ -55,11 +55,8 @@ class MicroFSM
     @transitions_for.values.map(&:to_a).flatten.uniq.sort
   end
 
-  def state=(state)
-    @state = state
-  end
+  private
 
- private
   def transit(event)
     callbacks = @callbacks_for[event][@state]
     @state = @transitions_for[event][@state]

data/lib/version.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 class MicroFSM
-  VERSION = '0.1.2'     # 2021-02-10
-  # VERSION = '0.1.1'     # 2021-02-08
-  # VERSION = '0.0.1'     # 2021-01-24
+  VERSION = "0.1.4" # 2022-12-22
+  # VERSION = "0.1.3" # 2021-06-22
+  # VERSION = "0.1.2" # 2021-02-10
+  # VERSION = "0.1.1" # 2021-02-08
+  # VERSION = "0.0.1" # 2021-01-24
 end

data/microfsm.gemspec

@@ -1,22 +1,23 @@
-$LOAD_PATH.push File.expand_path('lib', __dir__)
-require 'version'
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+require "version"
 
 Gem::Specification.new do |s|
   s.name = "microfsm"
   s.version = MicroFSM::VERSION
-  s.summary = %{Minimal Finite State Machine.}
-  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 = 'https://github.com/matique'
+  s.summary = %(Minimal Finite State Machine.)
+  s.description = %{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@matiq.com"
+  s.homepage = "https://matiq.com"
   s.license = "MIT"
+  s.platform = Gem::Platform::RUBY
 
-  s.metadata['source_code_uri'] = 'https://github.com/matique/microfsm'
+  s.metadata["source_code_uri"] = "https://github.com/matique/microfsm"
 
   s.files = `git ls-files`.split("\n")
 
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rake'
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
 
-  s.add_development_dependency 'minitest'
+  s.add_development_dependency "minitest"
 end

data/test/callbacks_test.rb

@@ -1,10 +1,10 @@
-require 'test_helper'
+require "test_helper"
 
 describe MicroFSM do
-  let (:fsm) {
+  let(:fsm) {
     MicroFSM.new(:pending)
-            .when(:confirm, pending: :confirmed) { @state = "Confirmed" }
-            .when(:reset, confirmed: :pending) { @state = "Pending" }
+      .when(:confirm, pending: :confirmed) { @state = "Confirmed" }
+      .when(:reset, confirmed: :pending) { @state = "Pending" }
   }
 
   def test_executes_callbacks_during_transition

data/test/introspection_test.rb

@@ -1,11 +1,11 @@
-require 'test_helper'
+require "test_helper"
 
 describe MicroFSM do
-  let (:fsm) {
+  let(:fsm) {
     MicroFSM.new(:pending)
-            .when(:confirm, pending: :confirmed)
-            .when(:ignore, pending: :ignored)
-            .when(:reset, confirmed: :pending, ignored: :pending)
+      .when(:confirm, pending: :confirmed)
+      .when(:ignore, pending: :ignored)
+      .when(:reset, confirmed: :pending, ignored: :pending)
   }
 
   def test_returns_an_array_with_the_defined_events

data/test/microfsm_test.rb

@@ -1,11 +1,11 @@
-require 'test_helper'
+require "test_helper"
 
 describe MicroFSM do
-  let (:fsm) {
+  let(:fsm) {
     MicroFSM.new(:pending)
-            .when(:confirm, pending: :confirmed)
-            .when(:ignore, pending: :ignored)
-            .when(:reset, confirmed: :pending, ignored: :pending)
+      .when(:confirm, pending: :confirmed)
+      .when(:ignore, pending: :ignored)
+      .when(:reset, confirmed: :pending, ignored: :pending)
   }
 
   def test_class

data/test/test_helper.rb

@@ -1,11 +1,10 @@
-if ENV['COVERAGE']
-  require 'simplecov'
+if ENV["COVERAGE"]
+  require "simplecov"
   SimpleCov.start do
-    add_filter 'test'
-    command_name 'Minitest'
+    add_filter "/test/"
   end
 end
 
-require 'minitest/autorun'
+require "minitest/autorun"
 
-require 'microfsm'
+require "microfsm"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: microfsm
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Dittmar Krall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2022-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,16 +54,14 @@ dependencies:
         version: '0'
 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
+email: dittmar.krall@matiq.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
+- ".github/workflows/rake.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
-- ".watchr"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -79,7 +77,7 @@ files:
 - test/introspection_test.rb
 - test/microfsm_test.rb
 - test/test_helper.rb
-homepage: https://github.com/matique
+homepage: https://matiq.com
 licenses:
 - MIT
 metadata:
@@ -99,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Minimal Finite State Machine.

data/.rubocop.yml

@@ -1,19 +0,0 @@
-inherit_from:
-  - ~/configs/.rubocop.yml
-
-AllCops:
-  Include:
-    - 'lib/**/*.rb'
-
-  Exclude:
-    - 'bin/**/*'
-    - 'test/**/*'
-  SuggestExtensions: false
-
-Layout/AccessModifierIndentation:
-  Enabled: false
-Layout/EmptyLinesAroundAccessModifier:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-sudo: false
-
-bundler_args: --without production
-# bundle config set without production
-script: 'bundle exec rake test'
-
-rvm:
-  - 2.7.2  # 2020-10-26
-
-matrix:
-  fast_finish: true
-
-notifications:
-  email: false

data/.watchr

@@ -1,57 +0,0 @@
-HH = '#' * 22  unless defined?(HH)
-H = '#' * 5    unless defined?(H)
-
-def usage
-  puts <<-EOS
-  Ctrl-\\ or ctrl-4   Running all tests
-  Ctrl-C             Exit
-  EOS
-end
-
-def run(cmd)
-  puts "#{HH} #{Time.now} #{HH}"
-  puts "#{H} #{cmd}"
-  system "/usr/bin/time --format '#{HH} Elapsed time %E' #{cmd}"
-end
-
-def run_it(type, file)
-  case type
-  when 'test';  run %Q(ruby -I"lib:test" -r rubygems #{file})
-  else;         puts "#{H} unknown type: #{type}, file: #{file}"
-  end
-end
-
-def run_all_tests
-  puts "\n#{HH} Running all tests #{HH}\n"
-  %w[test].each { |dir| run "rake #{dir}"  if  File.exist?(dir) }
-end
-
-def run_matching_files(base)
-  base = base.split('_').first
-  %w[test spec].each { |type|
-    files = Dir["#{type}/**/*.rb"].select { |file| file =~ /#{base}_.*\.rb/ }
-    run_it type, files.join(' ')  unless files.empty?
-  }
-end
-
-%w[test spec].each { |type|
-  watch("#{type}/#{type}_helper\.rb") { run_all_tests }
-  watch("#{type}/.*/*_#{type}\.rb")   { |match| run_it type, match[0] }
-  watch("#{type}/data/(.*)\.rb") { |match|
-    m1 = match[1]
-    run_matching_files("#{type}/#{m1}/#{m1}_#{type}.rb")
-  }
-}
-%w[rb erb haml slim].each { |type|
-#  watch("app/.*/(.*)\.#{type}") { |match|
-  watch(".*/(.*)\.#{type}") { |match|
-p [11, match]
-    run_matching_files(match[1])
-  }
-}
-
-# Ctrl-\ or ctrl-4
-    Signal.trap('QUIT') { run_all_tests }
-# Ctrl-C
-    Signal.trap('INT')  { abort("Interrupted\n") }
-usage