https://github.com/wizardone/minimus
Minimalistic state machine for ruby objects
https://github.com/wizardone/minimus
machine minimalistic ruby state
Last synced: 8 months ago
JSON representation
Minimalistic state machine for ruby objects
- Host: GitHub
- URL: https://github.com/wizardone/minimus
- Owner: wizardone
- License: mit
- Created: 2018-02-06T18:06:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-08T23:10:38.000Z (about 8 years ago)
- Last Synced: 2024-04-25T07:01:04.441Z (about 2 years ago)
- Topics: machine, minimalistic, ruby, state
- Language: Ruby
- Size: 17.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Minimus
[](https://travis-ci.org/wizardone/minimus)
Minimalistic predictable sequential state machine for Ruby. If you want something
really simple.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'minimus'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install minimus
## Usage
All you need to do is to provide a list of states, the first one will be the
default initial state.
```ruby
state = Minimus.new(:new, :updated, :destroyed)
state.initial_state
=> :new
state.current_state
=> :new
state.move(:destroyed)
=> false
state.move(:updated)
state.current_state
=> :updated
state.move!(:illegal)
=> Minimus::TransitionError
state.move!(:destroyed)
state.current_state
=> :destroyed
```
You can pass blocks as callbacks
```ruby
state.move(:updated) do
puts "Callback"
end
```
If you want to be slightly more unpredictable you can define your transitions:
```ruby
state.can(:new, possible: :destroyed)
state.current_state
=> :new
state.move(:destroyed)
state.current_state
=> :destroyed
```
You can also supply an array of possibilities:
```ruby
state.can(:new, possible: [:created, :destroyed])
```
## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/wizardone/minimus. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## 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 Minimus project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wizardone/minimus/blob/master/CODE_OF_CONDUCT.md).