approval 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bbb99b387759960e99f78286cc1e23713392670
-  data.tar.gz: 2c9336adf5bf81c8380bc16e1fc987c9ff824fa3
+  metadata.gz: b11eef9bb8afb6a55fefa35bc8fef5132d1908d0
+  data.tar.gz: 628a25ca361506832c1c709902af993c18c43d59
 SHA512:
-  metadata.gz: 1f7720b2a2b2f001e97f0c4cc9947966e3e0cd71df41f102fd582694962fb96ce81444ea76178ba0efb5190e2342002d604f23419daf45bc12cb1b1cbd0bc654
-  data.tar.gz: 8e3688f967f8686bcfe0878dd0de519f8aeb356f7d9de6abcd098670ca0f6bed3da23bac3d9a15842dbe07eb5d3d30264e8d1a98b6bb420d931dbfad1e552363
+  metadata.gz: e0a6c2f36e2234bc1c3612f8e6b27886bba1c0bf801ead75bd82c95f8e755ba588641d2107a936b28e5d275ea0d450f2850ebf2e49af7748548769c7b62bc300
+  data.tar.gz: 0bbd75b3e3e5dbdbbd7fa22e3dc4837134f19e895867293c51a99d0371e03044918e371d91a05e7b1fd4115c559f4a1267da90a54c64076fa5066b5646909a73

data/README.md

@@ -3,61 +3,138 @@
 [![Build Status](https://travis-ci.org/yhirano55/approval.svg?branch=master)](https://travis-ci.org/yhirano55/approval)
 [![Gem Version](https://badge.fury.io/rb/approval.svg)](https://badge.fury.io/rb/approval)
 
-:ok_woman::no_good:Approval workflow for Rails
+:ok_woman::no_good:Approval flow for Rails
 
 ## Installation
 
-```ruby
-gem 'approval'
-```
+1. Add approval to your `Gemfile`:
 
-Optionally, you can run the generator, which will set up approval models with some useful defaults for you:
+  ```ruby
+  gem 'approval'
+  ```
 
-```bash
-$ bin/rails g approval:install
-```
+2. Add approval_requests, approval_comments, approval_items tables to your database and an initializer file for configuration:
+
+  ```bash
+  $ bundle exec rails generate approval:install
+  ```
+
+3. Add `acts_as_approval_user` to your user model (`User`, `AdminUser`, `Member` ...etc)::
+
+  ```ruby
+  class User < ApplicationRecord
+    acts_as_approval_user
+  end
+  ```
+
+4. Add `acts_as_approval_resource` to the models you want use approval flow:
 
-## Usage
+  ```ruby
+  class Post < ApplicationRecord
+    acts_as_approval_resource
+  end
+  ```
 
-### Prepare
+## Approval Flow
 
-Call `acts_as_approval_user` in your resource of user model (`User`, `AdminUser`, `Member` etc):
+### Make request
+
+You send request, but resources aren't created/updated/destroied.
+
+#### :pray: Create
 
 ```ruby
-class User < ApplicationRecord
-  acts_as_approval_user
-end
+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.
+
+records = 10.times.map {|n| Book.new(name: "my_book_#{n}", price: 300) }
+request = staff.request_for_create(records, reason: "something")
+request.save!
 ```
 
-Call `acts_as_approval_resource` in your resource:
+#### :pray: Update
 
 ```ruby
-class Book < ApplicationRecord
-  acts_as_approval_resource
-end
+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 }
+request = staff.request_for_update(records, reason: "something")
+request.save!
 ```
 
-### Request
+#### :pray: Destroy
 
 ```ruby
 staff   = User.find_or_create_by(email: "staff@example.com")
-book    = 10.times.map { |n| Book.new(name: "my_book_#{n}") }
-request = staff.request_for_create(records, reason: "something")
+
+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!
 ```
 
-You send request, but resources aren't created.
-
 ### Respond
 
+#### :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")
+
 request = Approval::Request.first
 respond = admin.approve_request(request, reason: "something")
+respond.save! # Create/Update/Destroy resources
+```
+
+##### :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")
+
+request = Approval::Request.first
+respond = admin.reject_request(request, reason: "something")
+respond.save!
+```
+
+##### :wastebasket: Cancel
+
+```ruby
+staff = User.find_or_create_by(email: "staff@example.com")
+
+request = Approval::Request.first
+respond = staff.cancel_request(request, reason: "something")
 respond.save!
 ```
 
-Then resources are created, if respond user have approved the request.
+### 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
+end
+```
 
 ## License
 

data/lib/approval/version.rb

@@ -1,3 +1,3 @@
 module Approval
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 end

data/lib/generators/approval/templates/initializer.rb

@@ -1,4 +1,10 @@
 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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: approval
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Yoshiyuki Hirano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2017-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
-description: Approval workflow for Rails
+description: Approval flow for Rails
 email:
 - yhirano@me.com
 executables: []
@@ -101,7 +101,7 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: Approval workflow for Rails
+summary: Approval flow for Rails
 test_files:
 - spec/lib/config_spec.rb
 - spec/lib/version_spec.rb