StateBoss

state_boss is state machine for PORO.

Installation

Add this line to your application's Gemfile:

gem 'state_boss'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install state_boss

Usage

class Monster
  include StateBoss

  state_machine do
    state :eevee, to: [:jolteon, :vaporeon, :flareon], as: :default
    state :jolteon, as: :finish
    state :vaporeon, as: :finish
    state :flareon, as: :finish

    event(:water_stone, to: :vaporeon) do
      puts "use water stone"
    end

    event(:thunder_stone, to: :jolteon) do
      puts "use thunder stone"
    end

    event(:fire_stone, to: :flareon) do
      puts "use fire stone"
    end
  end
end

monster = Monster.new # => #<Monster:0x00007fd129052380>
monster.current_state # => eevee
monster.eevee?        # => true
monster.jolteon?      # => false
monster.thunder_stone # => use thunder stone
monster.jolteon?      # => true

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ta1kt0me/state_boss. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the StateBoss project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.