ApprovalCycle

Short description and motivation.

How to use my plugin.

Add this line to your application's Gemfile:

gem "approval_cycle"

And then execute:

$ bundle

Or install it yourself as:

$ gem install approval_cycle

Contribution directions go here.

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

1. Add the gem to your Gemfile:

gem 'approval_cycle'

2. Run bundle install to install the gem.
3. Add the initializer file with types (models that you want to be approvable):

rails generate approval_cycle:install

4. Customize the generated initializer file (config/initializers/approval_cycle.rb) to fit your application's needs. In the initializer, set up the approval cycle types:

ApprovalCycle.configure do |config|
  config.approval_cycle_setup_types = { dummy_request: 0 }
end

5. Run the migrations:

rails db:migrate

6. Include ApprovalCycle::Approvable in your models that require approval workflows:

class YourModel < ApplicationRecord
  include ApprovalCycle::Approvable
end

7. Approval cycle uses versioning for the approval cycle setups to not mess with old approvable records after updating the setup. To use the versioning, you must update your approval cycle setup with the SetupUpdater service:

ApprovalCycle::SetupUpdater.call(approval_cycle_setup: your_approval_cycle_setup_record, params: {attributes to update}, apply_to_versions: {true | false})