aasm-vis

aasm-vis generates a visual representation of the state machines defined with aasm gem.

Installation

Add gem 'aasm-vis', group: :development to your Gemfile and run bundle.

Usage

bundle exec rake aasm_vis:generate

To visualise the results you can use the github cli: gh gist create tmp/aasm-vis.md or any other tool that can render markdown files supporting mermaid.

Selecting models

By default every AASM state machine in the application is diagrammed. To limit the output to specific classes, pass them as rake task arguments:

bundle exec rake 'aasm_vis:generate[Job,Order]'

The quotes are required in zsh, which otherwise treats the brackets as a glob. Namespaced classes must be given in full, e.g. 'aasm_vis:generate[Billing::Invoice]'.

Example

The following ruby code defines a simple state machine for a Job model:

class Job < ApplicationRecord
  include AASM

  aasm :state do
    state :created, initial: true
    state :running
    state :finished_successfully
    state :finished_with_error

    event :run do
      transitions from: :created, to: :running
    end

    event :succeed do
      transitions from: :running, to: :finished_successfully
    end

    event :error do
      transitions from: :running, to: :finished_with_error
    end
  end
end

It will generate the following mermaid diagram. Each edge is labelled with the event that triggers the transition, so transitions leaving the same state stay distinguishable:

---
title: Job#state
---
stateDiagram-v2

created : Created
running : Running
finished_successfully : Finished successfully
finished_with_error : Finished with error

created --> running : run
running --> finished_successfully : succeed
running --> finished_with_error : error

finished_successfully --> [*]
finished_with_error --> [*]

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kamil-gwozdz/aasm-vis. 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 AASM::Vis project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.