Approval
Installation
- Add approval to your
Gemfile:
gem 'approval'- Add approval_requests, approval_comments, approval_items tables to your database and an initializer file for configuration:
$ bundle exec rails generate approval:install- Add
acts_as_approval_userto your user model (User,AdminUser,Member...etc)::
class User < ApplicationRecord
acts_as_approval_user
end- Add
acts_as_approval_resourceto the models you want use approval flow:
class Book < ApplicationRecord
acts_as_approval_resource
endOr if you want to use PORO:
class SomeProcess
def self.perform
# something
end
endApproval Flow
Make request
You send request, but resources aren't created/updated/destroyed.
🙏 Create
staff = User.find_or_create_by(email: "[email protected]")
record = Book.new(name: "Ruby Way", price: 2980)
request = staff.request_for_create(record, reason: "something")
request.save # Created Approval::Request record.
records = 10.times.map {|n| Book.new(name: "my_book_#{n}", price: 300) }
request = staff.request_for_create(records, reason: "something")
request.save!🙏 Update
staff = User.find_or_create_by(email: "[email protected]")
record = Book.find(1).tap {|record| record.name = "new book title" }
request = staff.request_for_update(record, reason: "something")
request.save
records = Book.where(id: [1, 2, 3]).each {|record| record.price *= 0.5 }
request = staff.request_for_update(records, reason: "something")
request.save!🙏 Destroy
staff = User.find_or_create_by(email: "[email protected]")
record = Book.find(1)
request = staff.request_for_destroy(record, reason: "something")
request.save
records = Book.where(id: [1, 2, 3])
request = staff.request_for_destroy(records, reason: "something")
request.save!🙏 Perform
staff = User.find_or_create_by(email: "[email protected]")
record = MyProcess.new(recipient: "[email protected]")
request = staff.request_for_perform(record, reason: "something")
request.saveRespond
🙆♀️ Approve
Then resources are created/updated/destroyed, if respond user have approved the request.
admin = User.find_or_create_by(email: "[email protected]")
request = Approval::Request.first
respond = admin.approve_request(request, reason: "something")
respond.save! # Create/Update/Destroy resources🙅 Reject
Then resources are not created/updated/destroyed, if respond user have rejected the request.
admin = User.find_or_create_by(email: "[email protected]")
request = Approval::Request.first
respond = admin.reject_request(request, reason: "something")
respond.save!🗑️ Cancel
staff = User.find_or_create_by(email: "[email protected]")
request = Approval::Request.first
respond = staff.cancel_request(request, reason: "something")
respond.save!Comment
admin = User.find_or_create_by(email: "[email protected]")
request = Approval::Request.first
admin.approval_comments.create(request: request, content: "Hello")Configuration
# config/initializers/approval.rb
Approval.configure do |config|
# User Class Name (e.g: User, AdminUser, Member)
config.user_class_name = "User"
# Maximum characters of comment for reason (default: 2000)
config.comment_maximum = 2000
# Permit to respond to own request? (default: false)
config.permit_to_respond_to_own_request = false
endLicense
The gem is available as open source under the terms of the MIT License.