README.md in approval-0.2.3 vs README.md in approval-0.3.0
- old
+ new
@@ -28,11 +28,11 @@
```
4. Add `acts_as_approval_resource` to the models you want use approval flow:
```ruby
- class Post < ApplicationRecord
+ class Book < ApplicationRecord
acts_as_approval_resource
end
```
## Approval Flow
@@ -42,11 +42,11 @@
You send request, but resources aren't created/updated/destroied.
#### :pray: Create
```ruby
-staff = User.find_or_create_by(email: "staff@example.com")
+staff = User.find_or_create_by(email: "staff@example.com")
record = Book.new(name: "Ruby Way", price: 2980)
request = staff.request_for_create(record, reason: "something")
request.save # Created Approval::Request record.
@@ -56,31 +56,31 @@
```
#### :pray: Update
```ruby
-staff = User.find_or_create_by(email: "staff@example.com")
+staff = User.find_or_create_by(email: "staff@example.com")
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).map {|record| record.price *= 0.5 }
+records = Book.where(id: [1, 2, 3]).each {|record| record.price *= 0.5 }
request = staff.request_for_update(records, reason: "something")
request.save!
```
#### :pray: Destroy
```ruby
-staff = User.find_or_create_by(email: "staff@example.com")
+staff = User.find_or_create_by(email: "staff@example.com")
record = Book.find(1)
request = staff.request_for_destroy(record, reason: "something")
request.save
-records = Book.where(id: 1, 2, 3)
+records = Book.where(id: [1, 2, 3])
request = staff.request_for_destroy(records, reason: "something")
request.save!
```
### Respond
@@ -88,11 +88,11 @@
#### :ok_woman: Approve
Then resources are created/updated/destroied, if respond user have approved the request.
```ruby
-admin = User.find_or_create_by(email: "admin@example.com")
+admin = User.find_or_create_by(email: "admin@example.com")
request = Approval::Request.first
respond = admin.approve_request(request, reason: "something")
respond.save! # Create/Update/Destroy resources
```
@@ -100,11 +100,11 @@
##### :no_good: Reject
Then resources are not created/updated/destroied, if respond user have rejected the request.
```ruby
-admin = User.find_or_create_by(email: "admin@example.com")
+admin = User.find_or_create_by(email: "admin@example.com")
request = Approval::Request.first
respond = admin.reject_request(request, reason: "something")
respond.save!
```
@@ -117,18 +117,24 @@
request = Approval::Request.first
respond = staff.cancel_request(request, reason: "something")
respond.save!
```
+### Comment
+
+```ruby
+admin = User.find_or_create_by(email: "admin@example.com")
+
+request = Approval::Request.first
+admin.approval_comments.create(request: request, content: "Hello")
+```
+
### Configuration
```ruby
# config/initializers/approval.rb
Approval.configure do |config|
- # Your user model name (e.g. User, AdminUser, Member, default: User)
- 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