Removing boilerplate from async code


License
MIT
Install
gem install anachronic -v 0.44.0

Documentation

Anachronic

Simply execute your methods in a background process (ActiveJob, Sidekiq, etc...)

Instead of having to write a wrapper for every class, just add async before your method:

Usual boilerplate case:

class Human
  def speak
    puts('Truth!')
  end
end

class HumanJob < ApplicationJob
  def perform(human)
    human.speak
  end
end

HumanJob.perform_later(Human.new)

You can now write:

class Human
  extend Anachronic

  async def speak
    puts('Truth!')
  end
end

Human.new.speak

Installation

Add this line to your application's Gemfile:

gem 'anachronic'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install anachronic

Configuration

To configure, run this or add to an initializers file (in case of Rails)

Anachronic.configure do |config|
  config.default_executor = Sidekiq
end

In case no default_exeucutor is configured, the gem will use the first one that is available (defined) from the list:

  • Sidekiq
  • ApplicationJob
  • Resque

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/dvisockas/anachronic. 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 Anachronic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Inspired by