Workflow::Join
Installation
Add this line to your application's Gemfile:
gem 'workflow-join'And then execute:
$ bundle
Or install it yourself as:
$ gem install workflow-join
Usage
class Master
include Workflow
attr_accessor :slave
def initialize(*)
@slave = Slave.new
end
workflow do
state :meeting do
event :go, transitions_to: :after_meeting
end
state :after_meeting
# before entering :after_meeting state, wait for @slave to enter :resolved state
guard :@slave, inner: :after_meeting, outer: :resolved
# OR: guard :slave, inner: :after_meeting, outer: :resolved
# OR: guard inner: :after_meeting, outer: :resolved, &:slave
end
end
class Slave
include Workflow
workflow do
state :unresolved do
event :resolve, transitions_to: :resolved
end
state :resolved
end
end
ActiveRecord support
Introduce two new fields in each model, that uses workflow joins:
-
workflow_pending_transitions, workflow_pending_callbacks
and enjoy:
class Master < ActiveRecord::Base
has_one :slave
include Workflow
workflow do
state :meeting do
event :go, transitions_to: :after_meeting
end
state :after_meeting
# before entering :after_meeting state, wait for @slave to enter :resolved state
guard :slave, inner: :after_meeting, outer: :resolved
# OR: guard inner: :after_meeting, outer: :resolved, &:slave
end
end
class Slave < ActiveRecord::Base
belongs_to :master
include Workflow
workflow do
state :unresolved do
event :resolve, transitions_to: :resolved
end
state :resolved
end
endAs a matter of fact, this gem tries to create the fields above on first usage, but since it happens in the middle of class loading process, the whole application start crashes. That is an intended behavior! The columns will be created and simple application restart will enable the feature.
This part is hardly tested, though, that’s why the preferred way would be to create columns manually.
Use Sidekiq jobs as guards
Starting with version 0.3.0, we support sidekiq jobs as guards:
class LongRunningChecker
include ::Sidekiq::Worker
def perform(*_args)
do_requests(*args) # sleep 10
end
end
class Master < ActiveRecord::Base
include Workflow
workflow do
state :initial do
event :validate, transitions_to: :validated
end
state :validated
guard inner: :validated, job: LongRunningChecker
end
endChangelog
0.3.0 Sidekiq jobs as guards
0.2.4 ActiveRecord support
It is of any good?
Yes.
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/workflow-join. 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.