Project

swarm

0.0
No release in over 3 years
Low commit activity in last 3 years
A Ruby workflow engine
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.8
>= 0
~> 10.0
~> 3.0
~> 0.7

Runtime

>= 0
 Project Readme

Swarm

Gem Version

Swarm is a (very much still work-in-progress) workflow engine for Ruby, combining a process definition DSL, a set of built-in expressions, a worker framework to actually run process instances, and a storage mechanism to persist instances and deferred expressions.

Currently it requires Redis as a backend to persist state (though for testing you can use transient in-process memory storage). The goal is to extract the storage so other backends can be swapped in as the process state repository.

For performing the work itself, Swarm only comes with an in-process memory storage, which means jobs queued up at the time of stopping the worker will be lost. For a non-volatile worker, you'll want to use swarm-beanstalk, which uses beanstalkd (via beaneater).

Installation

Add this line to your application's Gemfile:

gem 'swarm'

And then execute:

$ bundle

Or install it yourself as:

$ gem install swarm

Usage

Instructions coming soon!

Acknowledgements

Huge thanks to @jmettraux, author of (now discontinued) ruote, for getting me excited about workflow engines, and for inspiring this fun and educational project of mine.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swarm-beanstalk. 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.