crumble-jobs

Background job framework for Crumble applications.

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     crumble-jobs:
       github: sbsoftware/crumble-jobs
   

2. Run shards install.

Usage

require "crumble-jobs"

Configure the queue

Configure a single queue backend for the app using the macro. The queue is reused by jobs and workers.

Crumble::Jobs.configure_queue Crumble::Jobs::InMemoryQueue.new
# or
Crumble::Jobs.configure_queue Crumble::Jobs::FileQueue.new("./tmp/jobs")

After configuration, jobs enqueue through Crumble::Jobs.queue and workers default to the same queue.

Define jobs

class IncrementCounterJob < Crumble::Jobs::Job
  params session_key : String, counter_id : Int64

  def perform : Nil
    # ...
  end
end

Enqueue a job:

IncrementCounterJob.enqueue("session-uuid", 123)

Worker

worker = Crumble::Jobs::Worker.new(max_concurrency: 4)
worker.start

Development

• Format: crystal tool format
• Tests: crystal spec

Contributing

1. Fork it (https://github.com/sbsoftware/crumble-jobs/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Stefan Bilharz - creator and maintainer