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

README.md

Rocket Job

Gem Version Build Status Downloads License Support

Ruby's missing batch system

Checkout http://rocketjob.io/

Rocket Job

Documentation

Support

Contributing to the documentation

To contribute to the documentation it is as easy as forking the repository and then editing the markdown pages directly via the github web interface.

For more complex documentation changes checkout the source code locally.

Local checkout

  • Fork the repository in github.
  • Checkout your fork of the source code locally.
  • Install Jekyll
    cd docs
    bundle update
  • Run Jekyll web server:
    jekyll serve
  • Open a web browser to view the local documentation: http://127.0.0.1:4000
  • Edit the files in the /docs folder.
  • Refresh the page to see the changes.

Once the changes are complete, submit a github pull request.

Upgrading to V3

V3 replaces MongoMapper with Mongoid which supports the latest MongoDB Ruby client driver.

Upgrading Mongo Config file

Replace mongo.yml with mongoid.yml.

Start with the sample mongoid.yml.

For more information on the new Mongoid config file.

Note: The rocketjob and rocketjob_slices clients in the above mongoid.yml file are required.

Other changes

  • Arguments are no longer supported, use fields for defining all named arguments for a job.

  • Replace usages of rocket_job do to set default values:

  rocket_job do |job|
    job.priority = 25
  end

With:

  self.priority = 25
  • Replace key with field when adding attributes to a job:
  key :inquiry_defaults, Hash

With:

  field :inquiry_defaults, type: Hash, default: {}
  • Replace usage of public_rocket_job_properties with the user_editable option:
field :priority, type: Integer, default: 50, user_editable: true

Ruby Support

Rocket Job is tested and supported on the following Ruby platforms:

  • Ruby 2.1, 2.2, 2.3, 2.4, and above
  • JRuby 9.0.5 and above

Versioning

This project uses Semantic Versioning.

Author

Reid Morrison

Contributors