simply_fsm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aba0392debc9515f01b6b95bca88ed5c3a4aace120a3b725c4d1a840854a1725
+  data.tar.gz: 1d7883abe1ce6b0db890203293ea4f3ff2ab275fb876628daf07fb0f9ea087d6
+SHA512:
+  metadata.gz: 9320692222abae9ec39bebf5b5594f023d97efecec721d400f6aacb5ed758cf0e02d23fc4e5845d604a0ec39682de16d7e919d8024ce69f762722cf134d1243b
+  data.tar.gz: c1552d33ce0b9e1d682e7e1d7cbbc7cd6ec59fbc4435d63582f67735f6a75cb0fe114910266624aee241f694aa77c2031634351466b798563981fc71f112ef71

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-02-21
+
+- Initial release supports finite state machine with event guards and failure handling 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simply_fsm.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    simply_fsm (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.2)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  simply_fsm!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Kumanan Yogaratnam
+
+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,195 @@
+# SimplyFSM
+
+`simply_fsm` is a bare-necessities finite state machine data-type for use with any Ruby class. I created `simply_fsm` because I wanted the minimal FSM data type that was easy to use and did everything I would expect from a core data type.
+
+If you need storage/persistence/Rails/etc support, I recommend [AASM](https://github.com/aasm/aasm) whose API was an inspiration for this gem.  
+
+**Contents**
+- [Installation](#installation)
+- [Usage](#usage)
+  - [One state machine](#one-state-machine)
+  - [Multiple state machines](#multiple-state-machines)
+  - [Handle failed events](#handle-failed-events)
+  - [Guarding events](#guarding-events)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simply_fsm'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simply_fsm
+
+## Usage
+
+### One state machine
+
+Here's a single-state example of a `Job` class (unashamedly based on [this `aasm` example](https://github.com/aasm/aasm#usage)).
+ 
+```ruby
+class Job
+  include SimplyFSM
+
+  state_machine :status do
+    state :sleeping, initial: true
+    state :running
+    state :cleaning
+
+    event :run, transition: { from: :sleeping, to: :running } do
+      # executed when transition succeeds
+    end
+
+    event :clean, transition: { from: :running, to: :cleaning } do
+      # do the cleaning since transition succeeded
+    end
+
+    event :sleep, transition: { from: [:running, :cleaning], to: :sleeping }
+  end
+end
+```
+
+This provides the following public methods for the class. 
+
+```ruby
+job = Job.new
+job.status    # => :sleeping
+job.sleeping? # => true
+job.may_run?  # => true
+job.run       # => true on success
+job.running?  # => true
+job.sleeping? # => false
+job.may_run?  # => false
+job.run       # => false on failure
+```
+
+### Multiple state machines
+
+A class can define as many state machines as needed as long as each has a unique name. 
+
+```ruby
+class Player
+  include SimplyFSM
+  
+  state_machine :motion do
+    state :idling, initial: true
+    state :walking
+
+    event :idle, transition: { from: :any, to: :idling }
+    event :walk, transition: { from: :idling, to: :walking }
+  end
+
+  state_machine :action do
+    state :ready, initial: true
+    state :blocking
+
+    event :hold, transition: { from: :any, to: :ready }
+    event :block, transition: { from: :any, to: :blocking }
+  end
+end
+```
+This provides the following public methods for the class. 
+
+| Public method for           | `motion` state machine   | `action`  state machine   |
+| --------------------------- | ------------------------ | ------------------------- |
+| current state               | `motion`                 | `action`                  |
+| event methods               | `idle`, `walk`           | `hold`, `block`           |
+| event precondition checking | `may_idle?`, `may_walk?` | `may_hold?`, `may_block?` |
+| state checking              | `idling?`, `walking?`    | `ready?`, `blocking?`     |
+
+### Handle failed events
+
+It's possible to specify an ebent failure handler via lambda or method name either for the entire state machine or for each event. If specified, the `fail` handler is called before an event returns `false`
+
+```ruby
+class JobWithErrors
+  class Error < StandardError; end
+  class RunError < StandardError; end
+
+  include SimplyFSM
+
+  state_machine :activity, fail: :on_any_fail do
+    state :sleeping, initial: true
+    state :running
+    state :cleaning
+
+    event :sleep, transition: { from: %i[running cleaning], to: :sleeping }
+    event :clean, transition: { from: :running, to: :cleaning }
+    event :run,
+          fail: ->(_event) { raise RunError, "Cannot run" },
+          transition: { from: :sleeping, to: :running }
+  end
+
+  def on_any_fail(event_name)
+    raise Error, "Cannot do: #{event_name}"
+  end
+end
+```
+
+### Guarding events
+
+It's possible guard events against additional constraints by specifying a lambda for each event which is executed in the instance of the class with the state machine. In addition to checking the allowed `from` state, the `guard`, if specified, must return `true` for the transition to occur.
+
+```ruby
+class AgilePlayer
+  class LeapError < StandardError; end
+
+  include SimplyFSM
+
+  state_machine :motion do
+    state :idling, initial: true
+    state :walking
+    state :running
+
+    event :idle, transition: { from: :any, to: :idling }
+    event :walk, transition: { from: :any, to: :walking }
+    event :run, transition: { from: :any, to: :running }
+  end
+
+  state_machine :action do
+    state :ready, initial: true
+    state :jumping
+    state :leaping
+
+    event :hold, transition: { from: :any, to: :ready }
+    event :jump,
+          guard: -> { !running? },
+          transition: { from: :ready, to: :jumping }
+    event :leap,
+          guard: -> { running? },
+          fail: ->(_event) { raise LeapError, "Cannot leap" },
+          transition: { from: :ready, to: :leaping }
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and sugestions are welcome. Otherwise, at this time, this project is closed for code changes and pull requests. I appreciate your understanding.
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nogginly/simply_fsm/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `simply_fsm` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nogginly/simply_fsm/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simply_fsm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simply_fsm.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module SimplyFSM
+  VERSION = "0.1.0"
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def state_machine(name, opts = {}, &block)
+      fsm = StateMachine.new(name, self, fail: opts[:fail])
+      fsm.instance_eval(&block)
+    end
+  end
+
+  class StateMachine
+    attr_reader :initial_state, :states, :events, :name, :full_name
+
+    def initialize(name, owner_class, fail: nil)
+      @owner_class = owner_class
+      @name = name.to_sym
+      @full_name = "#{owner_class.name}/#{name}"
+      @states = []
+      @events = []
+      @initial_state = nil
+      @fail_handler = fail
+
+      setup_base_methods
+    end
+
+    def state(state_name, initial: false)
+      unless state_name.nil? || @states.include?(state_name)
+        status = state_name.to_sym
+        state_machine_name = @name
+        @states << status
+        @initial_state = status if initial
+
+        make_owner_method "#{state_name}?", lambda {
+          send(state_machine_name) == status
+        }
+      end
+    end
+
+    def event(event_name, transition:, guard: nil, fail: nil, &after)
+      if event_name && transition
+        @events << event_name
+        from = transition[:from]
+        to = transition[:to]
+        state_machine_name = @name
+        var_name = "@#{state_machine_name}"
+        may_event_name = "may_#{event_name}?"
+        fail = @fail_handler if fail.nil?
+
+        setup_may_event_method may_event_name, from, to, guard
+
+        #
+        # Setup the event method to attempt to make the state
+        # transition or report failure
+        make_owner_method event_name, lambda {
+          if send(may_event_name)
+            instance_variable_set(var_name, to)
+            instance_exec(&after) if after
+            return true
+          end
+          # unable to satisfy pre-conditions for the event
+          if fail
+            if fail.is_a?(String) || fail.is_a?(Symbol)
+              send(fail, event_name)
+            else
+              instance_exec(event_name, &fail)
+            end
+          end
+          false
+        }
+
+      end
+    end
+
+    private
+
+    def setup_may_event_method(may_event_name, from, _to, guard)
+      state_machine_name = @name
+      #
+      # Instead of one "may_event?" method that checks all variations
+      # every time it's called, here we check the event definition and
+      # define the most optimal lambda to ensure the check is as fast as
+      # possible
+      method_lambda = if from == :any && !guard
+                        -> { true } # unguarded transition from any state
+                      elsif from == :any
+                        guard         # guarded transition from any state
+                      elsif !guard
+                        if from.is_a?(Array)
+                          lambda {    # unguarded transition from choice of states
+                            current = send(state_machine_name)
+                            from.include?(current)
+                          }
+                        else
+                          lambda {    # unguarded transition from one state
+                            current = send(state_machine_name)
+                            from == current
+                          }
+                        end
+                      elsif from.is_a?(Array)
+                        lambda {    # guarded transition from choice of states
+                          current = send(state_machine_name)
+                          from.include?(current) && instance_exec(&guard)
+                        }
+                      else
+                        lambda {    # guarded transition from one state
+                          current = send(state_machine_name)
+                          from == current && instance_exec(&guard)
+                        }
+                      end
+      make_owner_method may_event_name, method_lambda
+    end
+
+    def setup_base_methods
+      var_name = "@#{name}"
+      fsm = self
+      make_owner_method @name, lambda {
+                                 instance_variable_get(var_name) ||
+                                   fsm.initial_state
+                               }
+      make_owner_method "#{@name}_states", -> { fsm.states }
+      make_owner_method "#{@name}_events", -> { fsm.events }
+    end
+
+    def make_owner_method(method_name, method_definition)
+      @owner_class.define_method(method_name, method_definition)
+    end
+  end
+end

data/simply_fsm.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/simply_fsm"
+
+Gem::Specification.new do |spec|
+  spec.name = "simply_fsm"
+  spec.version = SimplyFSM::VERSION
+  spec.authors = ["nogginly"]
+  spec.email = ["nogginly@icloud.com"]
+
+  spec.summary = "Simple finite state mechine (FSM) data-type mixin for Ruby objects."
+  spec.description = "Use it to setup one or more FSMs in any Ruby object."
+  spec.homepage = "https://github.com/nogginly/simply_fsm"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.date = Time.now
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/nogginly/simply_fsm/CHANGELOG.md"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ["lib"]
+
+  # no deployment dependencies
+
+  # development
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "simply_fsm"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }

data/spec/support/state_machine_examples.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "state machine basics" do |state_machine, initial_state:, states:, events:|
+  describe "state machine for #{state_machine}" do
+    it "initially #{initial_state}" do
+      expect(subject.send(state_machine)).to eq initial_state
+    end
+
+    context "defines event methods" do
+      events.each do |event|
+        it event.to_s do
+          expect(subject.class.method_defined?(event)).to be true
+        end
+      end
+    end
+
+    context "defines info methods" do
+      it "#{state_machine}_states" do
+        expect(subject.send("#{state_machine}_states")).to eq states
+      end
+
+      it "#{state_machine}_events" do
+        expect(subject.send("#{state_machine}_events")).to eq events
+      end
+    end
+
+    context "defines state methods" do
+      states.each do |state|
+        it "#{state}?" do
+          expect(subject.class.method_defined?("#{state}?")).to be true
+        end
+      end
+    end
+
+    context "defines event pre-condition methods" do
+      events.each do |event|
+        it "may_#{event}?" do
+          expect(subject.class.method_defined?("may_#{event}?")).to be true
+        end
+      end
+    end
+  end
+end

data/spec/unit/fail_events_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class FailHandlingStateMachine
+  class Error < StandardError; end
+  class RunError < StandardError; end
+
+  include SimplyFSM
+
+  state_machine :activity, fail: :on_any_fail do
+    state :sleeping, initial: true
+    state :running
+    state :cleaning
+
+    event :sleep, transition: { from: %i[running cleaning], to: :sleeping }
+    event :clean, transition: { from: :running, to: :cleaning }
+    event :run,
+          fail: ->(_event) { raise RunError, "Cannot run" },
+          transition: { from: :sleeping, to: :running }
+  end
+
+  def on_any_fail(event_name)
+    raise Error, "Cannot do: #{event_name}"
+  end
+end
+
+RSpec.describe FailHandlingStateMachine do
+  describe "#sleep" do
+    it "error if already sleeping" do
+      expect { subject.sleep }.to raise_error(FailHandlingStateMachine::Error)
+    end
+  end
+
+  describe "#run" do
+    it "custom error if already running" do
+      subject.run
+      expect { subject.run }.to raise_error(FailHandlingStateMachine::RunError)
+    end
+
+    it "custom error if cleaning" do
+      subject.run
+      subject.clean
+      expect { subject.run }.to raise_error(FailHandlingStateMachine::RunError)
+    end
+  end
+
+  describe "#clean" do
+    it "error if sleeping" do
+      expect { subject.clean }.to raise_error(FailHandlingStateMachine::Error)
+    end
+
+    it "error if already cleaning" do
+      subject.run
+      subject.clean
+      expect { subject.clean }.to raise_error(FailHandlingStateMachine::Error)
+    end
+  end
+end

data/spec/unit/guard_events_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class GuardingEvents
+  class LeapError < StandardError; end
+
+  include SimplyFSM
+
+  state_machine :motion do
+    state :idling, initial: true
+    state :walking
+    state :running
+
+    event :idle, transition: { from: :any, to: :idling }
+    event :walk, transition: { from: :any, to: :walking }
+    event :run, transition: { from: :any, to: :running }
+  end
+
+  state_machine :action do
+    state :ready, initial: true
+    state :jumping
+    state :leaping
+
+    event :hold, transition: { from: :any, to: :ready }
+    event :jump,
+          guard: -> { !running? },
+          transition: { from: :ready, to: :jumping }
+    event :leap,
+          guard: -> { running? },
+          fail: ->(_event) { raise LeapError, "Cannot leap" },
+          transition: { from: :ready, to: :leaping }
+  end
+end
+
+RSpec.describe GuardingEvents do
+  describe "#jump" do
+    it "guard fails if motion is running" do
+      subject.run
+      expect(subject.may_jump?).to be false
+      expect(subject.jump).to be false
+    end
+  end
+
+  describe "#leap" do
+    it "guard raises error if motion is not running" do
+      subject.walk
+      expect(subject.may_leap?).to be false
+      expect { subject.leap }.to raise_error(GuardingEvents::LeapError)
+    end
+  end
+end

data/spec/unit/one_state_machine_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+class OneStateMachine
+  include SimplyFSM
+
+  state_machine :activity do
+    state :sleeping, initial: true
+    state :running
+    state :cleaning
+
+    event :run, transition: { from: :sleeping, to: :running }
+    event :clean, transition: { from: :running, to: :cleaning }
+    event :sleep, transition: { from: %i[running cleaning], to: :sleeping }
+  end
+end
+
+RSpec.describe OneStateMachine do
+  include_examples "state machine basics", :activity,
+                   initial_state: :sleeping,
+                   states: %i[sleeping running cleaning],
+                   events: %i[run clean sleep]
+
+  describe "#sleep" do
+    it "fails if already sleeping" do
+      expect(subject.may_sleep?).to be false
+      expect(subject.sleep).to be false
+    end
+    it "succeeds if running" do
+      subject.run
+      expect(subject.may_sleep?).to be true
+      expect(subject.sleep).to be true
+    end
+    it "succeeds if cleaning" do
+      subject.run
+      subject.clean
+      expect(subject.may_sleep?).to be true
+      expect(subject.sleep).to be true
+    end
+  end
+
+  describe "#run" do
+    it "succeeds if sleeping" do
+      expect(subject.may_run?).to be true
+      expect(subject.run).to be true
+    end
+
+    it "fails if already running" do
+      subject.run
+      expect(subject.may_run?).to be false
+      expect(subject.run).to be false
+    end
+
+    it "fails if cleaning" do
+      subject.run
+      subject.clean
+      expect(subject.may_run?).to be false
+      expect(subject.run).to be false
+    end
+  end
+
+  describe "#clean" do
+    it "succeeds if running" do
+      subject.run
+      expect(subject.may_clean?).to be true
+      expect(subject.clean).to be true
+    end
+
+    it "fails if sleeping" do
+      expect(subject.may_clean?).to be false
+      expect(subject.clean).to be false
+    end
+
+    it "fails if already cleaning" do
+      subject.run
+      subject.clean
+      expect(subject.may_clean?).to be false
+      expect(subject.clean).to be false
+    end
+  end
+end

data/spec/unit/simply_fsm_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class UsingFSM
+  include SimplyFSM
+end
+
+RSpec.describe SimplyFSM do
+  it "has a version number" do
+    expect(SimplyFSM::VERSION).not_to be nil
+  end
+
+  describe "when included" do
+    it "sets up state machine constructor" do
+      expect(UsingFSM.respond_to?(:state_machine)).not_to be nil
+    end
+  end
+end

data/spec/unit/two_state_machines_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class TwoStateMachines
+  include SimplyFSM
+
+  state_machine :motion do
+    state :idling, initial: true
+    state :walking
+
+    event :idle, transition: { from: :any, to: :idling }
+    event :walk, transition: { from: :idling, to: :walking }
+  end
+
+  state_machine :action do
+    state :ready, initial: true
+    state :blocking
+
+    event :hold, transition: { from: :any, to: :ready }
+    event :block, transition: { from: :any, to: :blocking }
+  end
+end
+
+RSpec.describe TwoStateMachines do
+  include_examples "state machine basics", :motion,
+                   initial_state: :idling,
+                   states: %i[idling walking],
+                   events: %i[idle walk]
+
+  include_examples "state machine basics", :action,
+                   initial_state: :ready,
+                   states: %i[ready blocking],
+                   events: %i[hold block]
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: simply_fsm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nogginly
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Use it to setup one or more FSMs in any Ruby object.
+email:
+- nogginly@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simply_fsm.rb
+- simply_fsm.gemspec
+- spec/spec_helper.rb
+- spec/support/state_machine_examples.rb
+- spec/unit/fail_events_spec.rb
+- spec/unit/guard_events_spec.rb
+- spec/unit/one_state_machine_spec.rb
+- spec/unit/simply_fsm_spec.rb
+- spec/unit/two_state_machines_spec.rb
+homepage: https://github.com/nogginly/simply_fsm
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nogginly/simply_fsm
+  source_code_uri: https://github.com/nogginly/simply_fsm
+  changelog_uri: https://github.com/nogginly/simply_fsm/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Simple finite state mechine (FSM) data-type mixin for Ruby objects.
+test_files:
+- spec/spec_helper.rb
+- spec/support/state_machine_examples.rb
+- spec/unit/fail_events_spec.rb
+- spec/unit/guard_events_spec.rb
+- spec/unit/one_state_machine_spec.rb
+- spec/unit/simply_fsm_spec.rb
+- spec/unit/two_state_machines_spec.rb