approval 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b11eef9bb8afb6a55fefa35bc8fef5132d1908d0
-  data.tar.gz: 628a25ca361506832c1c709902af993c18c43d59
+  metadata.gz: 0f6a5f60b035099e2da46cd42dc3c09deafe3b8a
+  data.tar.gz: 920839f43297af114060d06f66f2256a22b2040b
 SHA512:
-  metadata.gz: e0a6c2f36e2234bc1c3612f8e6b27886bba1c0bf801ead75bd82c95f8e755ba588641d2107a936b28e5d275ea0d450f2850ebf2e49af7748548769c7b62bc300
-  data.tar.gz: 0bbd75b3e3e5dbdbbd7fa22e3dc4837134f19e895867293c51a99d0371e03044918e371d91a05e7b1fd4115c559f4a1267da90a54c64076fa5066b5646909a73
+  metadata.gz: cf0ef7bdf54a232f8e2e0bf200c952b5e5dedbfebc8d9606c405b135863387c2eb4b3732f1d93bf132d922a4371a9fa4a0da2edb77b43f3569524dced809faea
+  data.tar.gz: bdd3df5ceff8e92e949df3baa53860b1a374962a0564879520f4be02c07687fa1010fa6cb1b7bbd941c950706417efcadc25183fcbd184769f01724256b7e238

data/README.md

@@ -30,7 +30,7 @@
 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
   ```
@@ -44,7 +44,7 @@ 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")
@@ -58,13 +58,13 @@ request.save!
 #### :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!
 ```
@@ -72,13 +72,13 @@ 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!
 ```
@@ -90,7 +90,7 @@ request.save!
 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")
@@ -102,7 +102,7 @@ respond.save! # Create/Update/Destroy resources
 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")
@@ -119,15 +119,21 @@ 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
 

data/lib/approval/config.rb

@@ -2,13 +2,11 @@ module Approval
   class Config
     attr_accessor(
       :comment_maximum,
-      :user_class_name,
       :permit_to_respond_to_own_request,
     )
 
     def initialize
       @comment_maximum = 2000
-      @user_class_name = "User"
       @permit_to_respond_to_own_request = false
     end
 

data/lib/approval/mixins.rb

@@ -5,7 +5,7 @@ module Approval
     class_methods do
       def acts_as_approval_resource(ignore_fields: [])
         include ::Approval::Mixins::Resource
-        append_ignore_fields(ignore_fields)
+        assign_ignore_fields(ignore_fields)
       end
 
       def acts_as_approval_user

data/lib/approval/mixins/resource.rb

@@ -3,22 +3,26 @@ module Approval
     module Resource
       extend ActiveSupport::Concern
 
-      DEFAULT_IGNORE_FIELDS = %w[id created_at updated_at].freeze
-
       included do
         class_attribute :approval_ignore_fields
+        self.approval_ignore_fields = %w[id created_at updated_at]
+
         has_many :approval_items, class_name: :"Approval::Item", as: :resource
       end
 
       class_methods do
-        def append_ignore_fields(ignore_fields = [])
-          self.approval_ignore_fields = DEFAULT_IGNORE_FIELDS.dup.concat(ignore_fields).map(&:to_s).uniq
+        def assign_ignore_fields(ignore_fields = [])
+          self.approval_ignore_fields = approval_ignore_fields.concat(ignore_fields).map(&:to_s).uniq
         end
       end
 
-      def params_for_approval
+      def create_params_for_approval
         attributes.except(*approval_ignore_fields).compact
       end
+
+      def update_params_for_approval
+        changes.except(*approval_ignore_fields).each_with_object({}) { |(k, v), h| h[k] = v.last }.compact
+      end
     end
   end
 end

data/lib/approval/mixins/user.rb

@@ -6,6 +6,9 @@ module Approval
       included do
         has_many :approval_requests, class_name: :"Approval::Request", foreign_key: :request_user_id
         has_many :approval_comments, class_name: :"Approval::Comment", foreign_key: :user_id
+
+        Approval::Request.define_user_association(self)
+        Approval::Comment.define_user_association(self)
       end
 
       def request_for_create(records, reason:)

data/lib/approval/models/approval/comment.rb

@@ -2,8 +2,13 @@ module Approval
   class Comment < ::ActiveRecord::Base
     self.table_name_prefix = "approval_".freeze
 
+    class << self
+      def define_user_association(klass)
+        belongs_to :user, class_name: klass.to_s
+      end
+    end
+
     belongs_to :request, class_name: :"Approval::Request", inverse_of: :comments
-    belongs_to :user,    class_name: Approval.config.user_class_name
 
     validates :content, presence: true, length: { maximum: Approval.config.comment_maximum }
   end

data/lib/approval/models/approval/item.rb

@@ -15,6 +15,7 @@ module Approval
       validates :resource_id, unless: :create_event?
       validates :resource_type
       validates :event, inclusion: { in: EVENTS }
+      validates :params, if: :update_event?
     end
 
     validate :ensure_resource_be_valid

data/lib/approval/models/approval/request.rb

@@ -2,9 +2,13 @@ module Approval
   class Request < ::ActiveRecord::Base
     self.table_name_prefix = "approval_".freeze
 
-    with_options class_name: Approval.config.user_class_name do
-      belongs_to :request_user
-      belongs_to :respond_user, optional: true
+    class << self
+      def define_user_association(klass)
+        with_options class_name: klass.to_s do
+          belongs_to :request_user
+          belongs_to :respond_user, optional: true
+        end
+      end
     end
 
     with_options dependent: :destroy, inverse_of: :request do
@@ -18,7 +22,6 @@ module Approval
 
     with_options presence: true do
       validates :state
-      validates :request_user
       validates :respond_user, unless: :pending?
       validates :comments
       validates :items

data/lib/approval/models/approval/request_form/create.rb

@@ -4,14 +4,14 @@ module Approval
       private
 
         def prepare
-          ::ActiveRecord::Base.transaction do
+          ::Approval::Request.transaction do
             request = user.approval_requests.new
             request.comments.new(user: user, content: reason)
             Array(records).each do |record|
               request.items.new(
                 event: "create",
                 resource_type: record.class.to_s,
-                params: record.params_for_approval,
+                params: record.create_params_for_approval,
               )
             end
             yield(request)

data/lib/approval/models/approval/request_form/destroy.rb

@@ -4,7 +4,7 @@ module Approval
       private
 
         def prepare
-          ::ActiveRecord::Base.transaction do
+          ::Approval::Request.transaction do
             request = user.approval_requests.new
             request.comments.new(user: user, content: reason)
             Array(records).each do |record|

data/lib/approval/models/approval/request_form/update.rb

@@ -4,7 +4,7 @@ module Approval
       private
 
         def prepare
-          ::ActiveRecord::Base.transaction do
+          ::Approval::Request.transaction do
             request = user.approval_requests.new
             request.comments.new(user: user, content: reason)
             Array(records).each do |record|
@@ -12,7 +12,7 @@ module Approval
                 event: "update",
                 resource_type: record.class.to_s,
                 resource_id: record.id,
-                params: record.params_for_approval,
+                params: record.update_params_for_approval,
               )
             end
             yield(request)

data/lib/approval/models/approval/respond_form/approve.rb

@@ -6,7 +6,7 @@ module Approval
       private
 
         def prepare
-          ::ActiveRecord::Base.transaction do
+          ::Approval::Request.transaction do
             request.lock!
             request.assign_attributes(state: :approved, approved_at: Time.current, respond_user: user)
             request.comments.new(user: user, content: reason)

data/lib/approval/models/approval/respond_form/cancel.rb

@@ -4,7 +4,7 @@ module Approval
       private
 
         def prepare
-          ::ActiveRecord::Base.transaction do
+          ::Approval::Request.transaction do
             request.lock!
             request.assign_attributes(state: :cancelled, cancelled_at: Time.current, respond_user: user)
             request.comments.new(user: user, content: reason)

data/lib/approval/models/approval/respond_form/reject.rb

@@ -6,7 +6,7 @@ module Approval
       private
 
         def prepare
-          ::ActiveRecord::Base.transaction do
+          ::Approval::Request.transaction do
             request.lock!
             request.assign_attributes(state: :rejected, rejected_at: Time.current, respond_user: user)
             request.comments.new(user: user, content: reason)

data/lib/approval/version.rb

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

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

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

data/spec/models/book_spec.rb

@@ -3,25 +3,28 @@ require "spec_helper"
 RSpec.describe Book, type: :model do
   it { is_expected.to have_many(:approval_items).class_name("Approval::Item") }
 
-  describe ".append_ignore_fields" do
-    subject { described_class.append_ignore_fields(ignore_fields) }
+  describe ".assign_ignore_fields" do
+    subject { described_class.assign_ignore_fields(ignore_fields) }
 
-    context "when ignore_fields are blank" do
-      let(:ignore_fields) { [] }
-      it { is_expected.to match_array Approval::Mixins::Resource::DEFAULT_IGNORE_FIELDS }
-    end
-
-    context "when ignore_fields are present" do
-      let(:ignore_fields) { ["published_at"] }
-      it { is_expected.to match_array Approval::Mixins::Resource::DEFAULT_IGNORE_FIELDS.dup.concat(["published_at"]) }
+    context "when ignore_fields are duplicated symbolized value" do
+      let(:ignore_fields) { %i[id id created_at updated_at] }
+      it { is_expected.to match_array %w[id created_at updated_at] }
     end
   end
 
-  describe "#params_for_approval" do
+  describe "#create_params_for_approval" do
     let(:book) { build :book }
     let(:result) { book.attributes.except("id", "created_at", "updated_at") }
 
-    subject { book.params_for_approval }
+    subject { book.create_params_for_approval }
+    it { is_expected.to eq result }
+  end
+
+  describe "#update_params_for_approval" do
+    let(:book) { create(:book).tap { |book| book.name = "changed name" } }
+    let(:result) { { "name" => "changed name" } }
+
+    subject { book.update_params_for_approval }
     it { is_expected.to eq result }
   end
 end

data/spec/models/comment_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 RSpec.describe Approval::Comment, type: :model do
   it { is_expected.to belong_to(:request).class_name("Approval::Request").inverse_of(:comments) }
-  it { is_expected.to belong_to(:user).class_name(Approval.config.user_class_name) }
+  it { is_expected.to belong_to(:user).class_name("User") }
 
   it { is_expected.to validate_presence_of(:content) }
   it { is_expected.to validate_length_of(:content).is_at_most(Approval.config.comment_maximum) }

data/spec/models/request_form/update_spec.rb

@@ -9,13 +9,23 @@ RSpec.describe Approval::RequestForm::Update do
     subject { form.save }
 
     context "when records is single" do
-      let(:records) { create :book }
+      let(:records) do
+        book = create(:book)
+        book.name = "changed name"
+        book
+      end
+
       it { expect { subject }.not_to raise_error }
       it { expect { subject }.to change { Approval::Item.count }.from(0).to(1) }
     end
 
     context "when records is multiple" do
-      let(:records) { create_list :book, 3 }
+      let(:records) do
+        books = create_list(:book, 3)
+        books.map.with_index { |book, i| book.name = "changed name #{i}" }
+        books
+      end
+
       it { expect { subject }.not_to raise_error }
       it { expect { subject }.to change { Approval::Item.count }.from(0).to(3) }
     end

data/spec/models/request_spec.rb

@@ -2,8 +2,8 @@ require "spec_helper"
 
 RSpec.describe Approval::Request, type: :model do
   describe "Association" do
-    it { is_expected.to belong_to(:request_user).class_name(Approval.config.user_class_name) }
-    it { is_expected.to belong_to(:respond_user).class_name(Approval.config.user_class_name) }
+    it { is_expected.to belong_to(:request_user).class_name("User") }
+    it { is_expected.to belong_to(:respond_user).class_name("User") }
     it { is_expected.to have_many(:comments).class_name("::Approval::Comment").dependent(:destroy) }
     it { is_expected.to have_many(:items).class_name("::Approval::Item").dependent(:destroy) }
   end
@@ -12,7 +12,6 @@ RSpec.describe Approval::Request, type: :model do
 
   describe "Validation" do
     it { is_expected.to validate_presence_of(:state) }
-    it { is_expected.to validate_presence_of(:request_user) }
     it { is_expected.to validate_presence_of(:comments) }
     it { is_expected.to validate_presence_of(:items) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: approval
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Yoshiyuki Hirano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler