AsyncBlock
AsyncBlock - A usable code block for rails to run your code asynchronously, this will help in preventing writing of new jobs to run smaller pieces of code
Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add async_block
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install async_block
Usage
Add your code in wrapped inside AsyncBlock as described below.
** NOTE - AsyncBlock cannot be executed from irb/console
AsyncBlock.run do
puts('This is running in a temporary job')
puts('Put your code below')
end
To put some delay on the async execution (say 5 minutes):
AsyncBlock.run(delay: 5.minutes) do
puts('This is running in a temporary job')
puts('Put your code below')
end
To explicitly mention a queue for the async execution:
AsyncBlock.run(delay: 1.minute, queue: 'p3') do
puts('This is running in a temporary job')
puts('Put your code below')
end
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 build gem locally, run gem build
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/[USERNAME]/async_block. 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 AsyncBlock project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.