museadmin/state-machine

A customisable Ruby state machine implemented as a Gem

State::Machine

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/state/machine. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'state-machine'

And then execute:

$ bundle

Or install it yourself as:

$ gem install state-machine

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. 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/[USERNAME]/state-machine. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

state-machine's Issues

Create a dependency check

Some action packs could have dependencies on other action packs. So we need a mechanism for checking if all dependencies are met when starting the state machine:

Requirement:
Each action pack should be able to register its dependent action packs in a table in the DB

AC's
Dependencies are written by action packs on import to state machine
AP's register themselves in the DB via parent class helper method
State machine checks all dependent action packs are registered in the DB