Skip to content
ActiveJob extension for recurrence
Ruby Shell
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib/active_job
spec
.gitignore
.rspec
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
active_job-cron.gemspec

README.md

Build Status Code Climate Test Coverage

ActiveJob::Cron

This gem provides recurrent functionality for your ActiveJob. The usage and implementation is highly inspired by Sidetiq.

Installation

Add this line to your application's Gemfile:

gem 'active_job-cron'

And then execute:

$ bundle

Or install it yourself as:

$ gem install active_job-cron

Usage

It's very simple to use, just include ActiveJob::Cron, and sets your job's recurrent frequency:

class MyJob < ActiveJob::Base
  include ActiveJob::Cron
  
  recurrence { daily }
  
  def perform
    # do something.....
  end
end

Or you can specify more complex recurrence like:

class MyJob < ActiveJob::Base
  include ActiveJob::Cron
  
  recurrence { weekly.day(:thursday) }
  
  def perform
    # do something.....
  end
end

It uses IceCube as recurrence's DSL, you can see more usages in its documentation.

Known Issues

Duplicate Jobs

If you have multiple servers, than you will face this issue. It means that it will have as many jobs triggered as the number of application you are running. It's because that every server has it's own clock to trigger a job, and for now there is no way to sync between different servers.

If anyone have a good idea to solve this, please open an issue 🙏.

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

  • More feature
  • More documentation
  • More tests

Bug reports and pull requests are welcome on GitHub at https://github.com/st0012/active_job-cron. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.