Allows to use ActiveRecord transactional callbacks outside of ActiveRecord models, literally everywhere in your application.
Inspired by these articles:
- https://dev.to/evilmartians/rails-aftercommit-everywhere--4j9g
- https://blog.arkency.com/2015/10/run-it-in-background-job-after-commit/
Add this line to your application's Gemfile:
gem 'after_commit_everywhere'
And then execute:
$ bundle
Or install it yourself as:
$ gem install after_commit_everywhere
Recommended usage is to include it to your base service class or anything:
class ServiceObjectBtw
include AfterCommitEverywhere
def call
ActiveRecord::Base.transaction do
after_commit { puts "We're all done!" }
end
end
end
Or just extend it whenever you need it:
extend AfterCommitEverywhere
ActiveRecord::Base.transaction do
after_commit { puts "We're all done!" }
end
That's it!
But the main benefit is that it works with nested transaction
blocks (may be even spread across many files in your codebase):
include AfterCommitEverywhere
ActiveRecord::Base.transaction do
puts "We're in transaction now"
ActiveRecord::Base.transaction do
puts "More transactions"
after_commit { puts "We're all done!" }
end
puts "Still in transaction…"
end
Will output:
We're in transaction now
More transactions
Still in transaction…
We're all done!
Will be executed right after outermost transaction have been successfully committed and data become available to other DBMS clients.
If called outside transaction will execute callback immediately.
Will be executed right before outermost transaction will be commited (I can't imagine use case for it but if you can, please open a pull request or issue).
If called outside transaction will execute callback immediately.
Will be executed right after transaction in which it have been declared was rolled back (this might be nested savepoint transaction block with requires_new: true
).
If called outside transaction will raise an exception!
Please keep in mind ActiveRecord's limitations for rolling back nested transactions.
Yes.
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/Envek/after_commit_everywhere.
The gem is available as open source under the terms of the MIT License.