approval 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b64f5cbbf148b7340aff7de77d998bded8d7b3ee0437e7993f9a2089adb7c66
-  data.tar.gz: e80a019fd898640e4ed837664661e84053c7bee2501d1e26ea73ce1587ff6ace
+  metadata.gz: b569ae57b3644b8c2cc853e55ac67f14436447d84033bf334979e3bc77ef2a3f
+  data.tar.gz: 7e283cb4c83a1dc16e4b2866b2ee87e0ab39991614b1c6856b34d8afbf33debd
 SHA512:
-  metadata.gz: a0ab4cfb2e56c725b36188c4d6c91962c2c67c0cc64a95e9624e95d94d24560a733cc8d648ec9364e05b20bff396b553c49a439fb933bfbd576b9d42cf05a78f
-  data.tar.gz: '090a5b2c02d64f05a7c0b3519b5bb7c2439bc1ba4d279817c4df24c294228763ae9b56c7d38df49fa05223a8f26ade7e7e1ff485b637806ad4a5e8a6d054ce95'
+  metadata.gz: 3adfc855ae861184026e30ae8f55b2b632118cfae5d28d34f8d2c9171ba9179b58f056c54f5ccfeb9bac79df181ad5a79026db1c32473b08167b6fced7aaaca1
+  data.tar.gz: 534bc1feeeb6fb610f9a1d92c09e5a718c78b51a5affbf1d0446fbdb71a2ab91f774c728d577328d4ef38b5b4fd93f44b1db9096054d0e21572c46e485723675

data/app/models/approval/execute_form.rb

@@ -1,6 +1,7 @@
 module Approval
   class ExecuteForm
     include ::ActiveModel::Model
+    include ::Approval::FormNotifiable
 
     attr_accessor :user, :reason, :request
 
@@ -32,11 +33,13 @@ module Approval
     private
 
       def execute
-        ::Approval::Request.transaction do
-          request.lock!
-          request.comments.new(user_id: user.id, content: reason) if reason
-          request.execute
-          yield(request)
+        instrument "execute" do |payload|
+          ::Approval::Request.transaction do
+            request.lock!
+            payload[:comment] = request.comments.new(user_id: user.id, content: reason) if reason
+            request.execute
+            yield(request)
+          end
         end
       end
 

data/app/models/approval/request_form/base.rb

@@ -2,6 +2,7 @@ module Approval
   module RequestForm
     class Base
       include ::ActiveModel::Model
+      include ::Approval::FormNotifiable
 
       attr_accessor :user, :reason, :records
 

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

@@ -4,16 +4,18 @@ module Approval
       private
 
         def prepare
-          ::Approval::Request.transaction do
-            request.comments.new(user_id: user.id, content: reason)
-            Array(records).each do |record|
-              request.items.new(
-                event: "create",
-                resource_type: record.class.to_s,
-                params: record.create_params_for_approval,
-              )
+          instrument "request" do |payload|
+            ::Approval::Request.transaction do
+              payload[:comment] = request.comments.new(user_id: user.id, content: reason)
+              Array(records).each do |record|
+                request.items.new(
+                  event: "create",
+                  resource_type: record.class.to_s,
+                  params: record.create_params_for_approval,
+                )
+              end
+              yield(request)
             end
-            yield(request)
           end
         end
     end

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

@@ -4,16 +4,18 @@ module Approval
       private
 
         def prepare
-          ::Approval::Request.transaction do
-            request.comments.new(user_id: user.id, content: reason)
-            Array(records).each do |record|
-              request.items.new(
-                event: "destroy",
-                resource_type: record.class.to_s,
-                resource_id: record.id,
-              )
+          instrument "request" do |payload|
+            ::Approval::Request.transaction do
+              payload[:comment] = request.comments.new(user_id: user.id, content: reason)
+              Array(records).each do |record|
+                request.items.new(
+                  event: "destroy",
+                  resource_type: record.class.to_s,
+                  resource_id: record.id,
+                )
+              end
+              yield(request)
             end
-            yield(request)
           end
         end
     end

data/app/models/approval/request_form/perform.rb

@@ -4,16 +4,18 @@ module Approval
       private
 
         def prepare
-          ::Approval::Request.transaction do
-            request.comments.new(user_id: user.id, content: reason)
-            Array(records).each do |record|
-              request.items.new(
-                event: "perform",
-                resource_type: record.class.to_s,
-                params: extract_params_from(record),
-              )
+          instrument "request" do |payload|
+            ::Approval::Request.transaction do
+              payload[:comment] = request.comments.new(user_id: user.id, content: reason)
+              Array(records).each do |record|
+                request.items.new(
+                  event: "perform",
+                  resource_type: record.class.to_s,
+                  params: extract_params_from(record),
+                )
+              end
+              yield(request)
             end
-            yield(request)
           end
         end
 

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

@@ -4,17 +4,19 @@ module Approval
       private
 
         def prepare
-          ::Approval::Request.transaction do
-            request.comments.new(user_id: user.id, content: reason)
-            Array(records).each do |record|
-              request.items.new(
-                event: "update",
-                resource_type: record.class.to_s,
-                resource_id: record.id,
-                params: record.update_params_for_approval,
-              )
+          instrument "request" do |payload|
+            ::Approval::Request.transaction do
+              payload[:comment] = request.comments.new(user_id: user.id, content: reason)
+              Array(records).each do |record|
+                request.items.new(
+                  event: "update",
+                  resource_type: record.class.to_s,
+                  resource_id: record.id,
+                  params: record.update_params_for_approval,
+                )
+              end
+              yield(request)
             end
-            yield(request)
           end
         end
     end

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

@@ -6,11 +6,13 @@ module Approval
       private
 
         def prepare
-          ::Approval::Request.transaction do
-            request.lock!
-            request.assign_attributes(state: :approved, approved_at: Time.current, respond_user_id: user.id)
-            request.comments.new(user_id: user.id, content: reason)
-            yield(request)
+          instrument "approve" do |payload|
+            ::Approval::Request.transaction do
+              request.lock!
+              request.assign_attributes(state: :approved, approved_at: Time.current, respond_user_id: user.id)
+              payload[:comment] = request.comments.new(user_id: user.id, content: reason)
+              yield(request)
+            end
           end
         end
     end

data/app/models/approval/respond_form/approve_with_execute.rb

@@ -6,12 +6,14 @@ module Approval
       private
 
         def prepare
-          ::Approval::Request.transaction do
-            request.lock!
-            request.assign_attributes(state: :approved, approved_at: Time.current, respond_user_id: user.id)
-            request.comments.new(user_id: user.id, content: reason)
-            request.execute
-            yield(request)
+          instrument "approve_with_execute" do |payload|
+            ::Approval::Request.transaction do
+              request.lock!
+              request.assign_attributes(state: :approved, approved_at: Time.current, respond_user_id: user.id)
+              payload[:comment] = request.comments.new(user_id: user.id, content: reason)
+              request.execute
+              yield(request)
+            end
           end
         end
     end

data/app/models/approval/respond_form/base.rb

@@ -2,6 +2,7 @@ module Approval
   module RespondForm
     class Base
       include ::ActiveModel::Model
+      include ::Approval::FormNotifiable
 
       attr_accessor :user, :reason, :request
 

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

@@ -4,11 +4,13 @@ module Approval
       private
 
         def prepare
-          ::Approval::Request.transaction do
-            request.lock!
-            request.assign_attributes(state: :cancelled, cancelled_at: Time.current, respond_user_id: user.id)
-            request.comments.new(user_id: user.id, content: reason)
-            yield(request)
+          instrument "cancel" do |payload|
+            ::Approval::Request.transaction do
+              request.lock!
+              request.assign_attributes(state: :cancelled, cancelled_at: Time.current, respond_user_id: user.id)
+              payload[:comment] = request.comments.new(user_id: user.id, content: reason)
+              yield(request)
+            end
           end
         end
     end

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

@@ -6,11 +6,13 @@ module Approval
       private
 
         def prepare
-          ::Approval::Request.transaction do
-            request.lock!
-            request.assign_attributes(state: :rejected, rejected_at: Time.current, respond_user_id: user.id)
-            request.comments.new(user_id: user.id, content: reason)
-            yield(request)
+          instrument "reject" do |payload|
+            ::Approval::Request.transaction do
+              request.lock!
+              request.assign_attributes(state: :rejected, rejected_at: Time.current, respond_user_id: user.id)
+              payload[:comment] = request.comments.new(user_id: user.id, content: reason)
+              yield(request)
+            end
           end
         end
     end

data/app/models/concerns/approval/form_notifiable.rb

@@ -0,0 +1,12 @@
+module Approval
+  module FormNotifiable
+    extend ActiveSupport::Concern
+
+    private
+
+    def instrument(operation, payload = {}, &block)
+      payload.merge!(request: request, user: user, reason: reason)
+      ActiveSupport::Notifications.instrument("#{operation}.approval", payload, &block)
+    end
+  end
+end

data/config/locales/en.yml

@@ -34,3 +34,4 @@ en:
         cancelled_at: "Cancelled at"
         approved_at: "Approved at"
         rejected_at: "Rejected at"
+        executed_at: "Executed at"

data/config/locales/ja.yml

@@ -34,3 +34,4 @@ ja:
         cancelled_at: 取消日時
         approved_at: 承認日時
         rejected_at: 却下日時
+        executed_at: 実行日時

data/lib/approval/version.rb

@@ -1,3 +1,3 @@
 module Approval
-  VERSION = "0.5.0".freeze
+  VERSION = "0.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: approval
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yoshiyuki Hirano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,6 +50,7 @@ files:
 - app/models/approval/respond_form/reject.rb
 - app/models/concerns/approval/acts_as_resource.rb
 - app/models/concerns/approval/acts_as_user.rb
+- app/models/concerns/approval/form_notifiable.rb
 - app/models/concerns/approval/mixins.rb
 - config/locales/en.yml
 - config/locales/ja.yml