Parallelixir

A Ruby background job framework powered by Elixir.

This library uses Redis to enqueue jobs and notify Elixir to run them through Erlang ports.

WARNING: This project is experimental, so don't use it in production!

Installation

First, you will need to have Elixir installed. Follow the instructions in the official guide to install it.

Add this line to your application's Gemfile:

gem 'parallelixir'

Add parallelixir to your list of dependencies in mix.exs:

def deps do
  [
    {:parallelixir, git: "https://github.com/mansakondo/parallelixir"}
  ]
end

Then fetch the dependencies:

$ bundle install
$ mix deps.get

Usage

This library works with Rails out-of-the-box. To use it in non-Rails environments, you need to define a Rake task named :environment which loads all your dependencies the same way the Rails :environment task does.

Include the Parallelixir::Job mixin in your classes:

class SomeJob
  include Parallelixir::Job

  def perform(*args)
    # do some work
  end
end

Call perform_later to enqueue jobs:

SomeJob.perform_later(*args)

Use the :wait option with the supported arguments (ActiveSupport::Date, ActiveSupport::DateTime, ActiveSupport::Time,ActiveSupport::Duration, Integer) to schedule jobs to be run at a specific time:

SomeJob.perform_later(*args, wait: Date.tomorrow)
SomeJob.perform_later(*args, wait: 24.hours)
SomeJob.perform_later(*args, wait: 86400.seconds)

Run this in another terminal window to start the Parallelixir server:

$ mix run

Or add this command in a Procfile if you're using Foreman.

Configuration

You can configure Parallelixir using Parallelixir.configure:

Parallelixir.configure do |config|
  config.redis = { ... } # or ConnectionPool.new(...)
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 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]/parallelixir.