Bp3::Noticed

bp3-noticed adapts noticed for BP3, the persuavis/black_phoebe_3 multi-site multi-tenant rails application.

Installation

Add this line to your application's Gemfile:

gem 'bp3-noticed'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install bp3-noticed

Usage

Do NOT change Noticed.parent_class, as this gem is making the necessary changes.

In your app's ApplicationJob:

include Bp3::Noticed::CommonIncludes
include Bp3::Noticed::JobIncludes

In every custom job class that inherits from ApplicationJob:

prepend Bp3::Noticed::PrependPerform

If there is que job class (outside of ActiveJob), inheriting from Que::Job:

include Bp3::Noticed::CommonIncludes
include Bp3::Noticed::QueIncludes

In every custom job class that inherits from that que job class`:

prepend Bp3::Noticed::PrependPerform

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 rake install. To release a new version, update the version number in version.rb, and then run 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.

Testing

Run rake to run rspec tests and rubocop linting.

Documentation

A .yardopts file is provided to support yard documentation.

License

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