microfsm 0.1.7 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25f7dba6b2b63792351334e86f075f63ad9fcefda142adf3a8659a3526c7cde7
-  data.tar.gz: 26aa4f34e819701f1643b408e5c9e11818ddd8792c5756d79c93b5f25c3b44ab
+  metadata.gz: a01daa1886bcb3bd776f670e34fb6dae95a817707e6061bddbded1cec021661b
+  data.tar.gz: 28775fed9e92be9913912508ec3ca66c27e70d361d7bbe17c08bd84ce6170d25
 SHA512:
-  metadata.gz: 12ccddd7ccdb718d24308ff1401297f4f6b3dec3e0a88dddf2a7bc3201f775184fad58295516c2b758aaa2c7a6b6bcaad745432700eaafaf64e56d2b72e41889
-  data.tar.gz: 2169f5e53d5ae49eddb591bb34cdace9611b12b5fee5099d0cda41e31e753892da0563f86e3f3297bb39c24a2b4c74ba170518597d0e219c14d4a50e8443c3d3
+  metadata.gz: 9734e1f849e44ccae2a55e1f2f48487980a0965ad25464b1b3a65f07e31cc27a23be56ede14ea8a28db569637f3be4e7830e32bfe59cf5106c8dd9d97791c357
+  data.tar.gz: cf2b4b5d2be2e14b8711922c6bd3143134f807fcdf78490c7c6b1ab622894fb54aad7552324a7d0bf2f8eb079d39093f4c82fbfd4ca3bd3378a37ac8b54b2e73

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021-2024 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 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

@@ -2,6 +2,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/microfsm.svg)](https://badge.fury.io/rb/microfsm)
 [![GEM Downloads](https://img.shields.io/gem/dt/microfsm?color=168AFE&logo=ruby&logoColor=FE1616)](https://rubygems.org/gems/microfsm)
+[![rake](https://github.com/matique/microfsm/actions/workflows/rake.yml/badge.svg)](https://github.com/matique/microfsm/actions/workflows/rake.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit/)
 
 MicroFSM implements a minimal/simple Finite-State Machine (FSM).
 Transitions are triggered by events.
@@ -97,7 +100,7 @@ fsm.state = :new
 fsm.state              #=> :new
 ```
 
-Check the examples directory for more information.
+Check the _examples_ directory for more information.
 
 ## Links
 
@@ -106,5 +109,5 @@ Check the examples directory for more information.
 
 ## Miscellaneous
 
-Copyright (c) 2021-2023 Dittmar Krall (www.matiq.com),
+Copyright (c) 2021-2024 Dittmar Krall (www.matiq.com),
 released under the [MIT license](https://opensource.org/licenses/MIT).

data/lib/microfsm/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class MicroFSM
+  VERSION = "0.1.10" # 2024-10-20
+  # VERSION = "0.1.9" # 2024-05-22
+  # VERSION = "0.1.7" # 2023-12-12
+  # VERSION = "0.1.6" # 2023-04-25
+  # VERSION = "0.1.5" # 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/lib/{version.rb → microfsm/version.rb.bak}

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 class MicroFSM
-  VERSION = "0.1.7" # 2023-12-12
+  VERSION = "0.1.9" # 2024-05-22
+  # VERSION = "0.1.7" # 2023-12-12
   # VERSION = "0.1.6" # 2023-04-25
   # VERSION = "0.1.5" # 2022-12-22
   # VERSION = "0.1.3" # 2021-06-22

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: microfsm
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.10
 platform: ruby
 authors:
 - Dittmar Krall
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2024-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -43,32 +43,23 @@ description: MicroFSM implements a minimal/simple Finite-State Machine (FSM). Tr
 email: dittmar.krall@matiq.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
 files:
-- ".github/workflows/rake.yml"
-- ".gitignore"
-- ".ruby-gemset"
-- ".ruby-version"
-- Gemfile
-- Gemfile.lock
-- LICENSE
+- MIT-LICENSE
 - README.md
-- Rakefile
 - examples/advanced.rb
 - examples/basic.rb
 - examples/callbacks.rb
 - lib/microfsm.rb
-- lib/version.rb
-- microfsm.gemspec
-- test/callbacks_test.rb
-- test/introspection_test.rb
-- test/microfsm_test.rb
-- test/test_helper.rb
+- lib/microfsm/version.rb
+- lib/microfsm/version.rb.bak
 homepage: https://github.com/matique/microfsm
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key: 
+rubygems_version: 3.5.20
+signing_key:
 specification_version: 4
 summary: Minimal Finite State Machine.
 test_files: []

data/.github/workflows/rake.yml

@@ -1,22 +0,0 @@
-# see also https://github.com/whitequark/parser/blob/master/.github/workflows/test.yml
-name: Rake
-
-on: [push]
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby_version: ["3.0", 3.2]
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby_version }}
-          bundler-cache: true
-      - name: Build and test with Rake
-        run: bundle exec rake

data/.gitignore

@@ -1,11 +0,0 @@
-.bundle/
-coverage/
-.watchr
-
-*.gem
-*.log
-*.lock
-*.sqlite3
-**/*.gem
-**/*.log
-**/*.lock

data/.ruby-gemset

@@ -1 +0,0 @@
-rails-7.1

data/.ruby-version

@@ -1 +0,0 @@
-ruby-3.2.2

data/Gemfile

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

data/Gemfile.lock

@@ -1,60 +0,0 @@
-PATH
-  remote: .
-  specs:
-    microfsm (0.1.7)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    docile (1.4.0)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    minitest (5.20.0)
-    observr (1.0.5)
-    parallel (1.23.0)
-    parser (3.2.2.4)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.3)
-    rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.8.3)
-    rexml (3.2.6)
-    ricecream (0.2.1)
-    rubocop (1.59.0)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.2.2.4)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  microfsm!
-  minitest
-  observr
-  rake
-  ricecream
-  rubocop
-  simplecov
-
-BUNDLED WITH
-   2.4.22

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2021-2023 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
-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/Rakefile

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

data/microfsm.gemspec

@@ -1,19 +0,0 @@
-$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 = %{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://github.com/matique/microfsm"
-  s.license = "MIT"
-  s.platform = Gem::Platform::RUBY
-
-  s.files = `git ls-files`.split("\n")
-
-  s.add_development_dependency "rake"
-  s.add_development_dependency "minitest"
-end

data/test/callbacks_test.rb

@@ -1,35 +0,0 @@
-require "test_helper"
-
-describe MicroFSM do
-  let(:fsm) {
-    MicroFSM.new(:pending)
-      .when(:confirm, pending: :confirmed) { @state = "Confirmed" }
-      .when(:reset, confirmed: :pending) { @state = "Pending" }
-  }
-
-  def test_executes_callbacks_during_transition
-    fsm.trigger(:confirm)
-    assert_equal "Confirmed", @state
-
-    fsm.trigger(:reset)
-    assert_equal "Pending", @state
-  end
-
-  def test_two_callbacks_during_transition
-    fsm.when(:confirm, pending: :confirmed) { @state2 = "Confirmed2" }
-
-    fsm.trigger(:confirm)
-    assert_equal "Confirmed", @state
-    assert_equal "Confirmed2", @state2
-  end
-
-  def test_passing_the_event_name_to_the_callbacks
-    event_name = nil
-    fsm.when(:confirm, pending: :confirmed) do |event|
-      event_name = event
-    end
-
-    fsm.trigger(:confirm)
-    assert_equal :confirm, event_name
-  end
-end

data/test/introspection_test.rb

@@ -1,22 +0,0 @@
-require "test_helper"
-
-describe MicroFSM do
-  let(:fsm) {
-    MicroFSM.new(:pending)
-      .when(:confirm, pending: :confirmed)
-      .when(:ignore, pending: :ignored)
-      .when(:reset, confirmed: :pending, ignored: :pending)
-  }
-
-  def test_returns_an_array_with_the_defined_events
-    assert_equal %i[confirm ignore reset], fsm.events
-  end
-
-  def test_list_the_available_events_for_the_current_state
-    assert_equal %i[confirm ignore], fsm.triggerable_events
-  end
-
-  def test_returns_an_array_with_the_defined_states
-    assert_equal %i[confirmed ignored pending], fsm.states
-  end
-end

data/test/microfsm_test.rb

@@ -1,72 +0,0 @@
-require "test_helper"
-
-describe MicroFSM do
-  let(:fsm) {
-    MicroFSM.new(:pending)
-      .when(:confirm, pending: :confirmed)
-      .when(:ignore, pending: :ignored)
-      .when(:reset, confirmed: :pending, ignored: :pending)
-  }
-
-  def test_class
-    assert_kind_of MicroFSM, fsm
-  end
-
-  def test_defines_initial_state
-    assert_equal :pending, fsm.state
-  end
-
-  def test_changes_the_state
-    assert fsm.trigger?(:confirm)
-    assert fsm.trigger(:confirm)
-    assert_equal :confirmed, fsm.state
-  end
-
-  def test_preserves_the_state_if_transition_is_not_possible
-    refute fsm.trigger?(:reset)
-    refute fsm.trigger(:reset)
-    assert_equal :pending, fsm.state
-  end
-
-  def test_multiple_transitions
-    fsm.trigger(:confirm)
-    assert_equal :confirmed, fsm.state
-
-    fsm.trigger(:reset)
-    assert_equal :pending, fsm.state
-
-    fsm.trigger(:ignore)
-    assert_equal :ignored, fsm.state
-
-    fsm.trigger(:reset)
-    assert_equal :pending, fsm.state
-  end
-
-  def test_raises_an_error_if_an_invalid_event_is_triggered
-    assert_raises(MicroFSM::InvalidEvent) do
-      fsm.trigger(:random_event)
-    end
-  end
-
-  def test_raises_error_if_trigger_from_incompatible_state
-    assert_raises(MicroFSM::InvalidState) do
-      fsm.trigger!(:reset)
-    end
-  end
-
-  def test_raises_an_error_if_a_transition_is_overwritten
-    fsm = MicroFSM.new(:init)
-
-    fsm.when(:trigger, init: :started)
-    assert_raises(MicroFSM::InvalidTransition) 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

data/test/test_helper.rb

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