Cronex
A cron like system, built in Elixir, that you can mount in your supervision tree.
Cronex's DSL for adding cron jobs is inspired by whenever Ruby gem.
Installation
Add cronex to your list of dependencies in mix.exs:
def deps do
[{:cronex, "~> 0.4.0"}]
endThen run mix deps.get to get the package.
Getting started
Cronex makes it really easy and intuitive to schedule cron like jobs.
You use the Cronex.Scheduler module to define a scheduler and add jobs to it.
Cronex will gather jobs from the scheduler you defined and will run them at the expected time.
# Somewhere in your application define your scheduler
defmodule MyApp.Scheduler do
use Cronex.Scheduler
every :hour do
IO.puts "Every hour job"
end
every :day, at: "10:00" do
IO.puts "Every day job at 10:00"
end
end
# Start scheduler with start_link
MyApp.Scheduler.start_link
# Or add it to your supervision tree
defmodule MyApp.Supervisor do
use Supervisor
# ...
def init(_opts) do
children = [
# ...
supervisor(MyApp.Scheduler, [])
# ...
]
supervise(children, ...)
end
# ...
endYou can define as much schedulers as you want.
Testing
Cronex comes with Cronex.Test module which provides helpers to test your cron jobs.
defmodule MyApp.SchedulerTest do
use ExUnit.Case
use Cronex.Test
test "every hour job is defined in MyApp.Scheduler" do
assert_job_every :hour, in: MyApp.Scheduler
end
test "every day job at 10:00 is defined in MyApp.Scheduler" do
assert_job_every :day, at: "10:00", in: MyApp.Scheduler
end
endDocumentation
The project documentation can be found here.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jbernardo95/cronex.
License
Cronex source code is licensed under the MIT License.