dcidev_approval 0.0.5 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23cb421610c1a7d394f5039930b9f039188e3ef8620b663296bfe2fcd33f4e66
-  data.tar.gz: 05d8d685bd2ccc8d6420c991f0bc77fcfa2e7a516bd1d940de42556e1e8c734b
+  metadata.gz: e97350e7fc396ea5b6badf639f46c97c256de119290e7f4cf209a29b55c13fc2
+  data.tar.gz: 32378050bd803f53adf02652f4d5502b871e2ea6ce7aed380970a395d1562761
 SHA512:
-  metadata.gz: 9df2fd6a8f2cc9f131e816fb47b13defa76cff853da54b6dc21cf9dc74eeaf58ce0d21978bc980635a99330243f26006260fefd6a86c682720fd84da33947081
-  data.tar.gz: 07675120b1e915524d2e8bf898fc8fe7bd336f10c6ef6bf0eff509975c7593376e378c29a9ea1b70bc376b10367b87e429aa784461d74ced0d4acd34113f312d
+  metadata.gz: 59b9cf658199b5dd33f76c3eb22f6d302718a908f220d986a46d9fe90a28f82b490fbc31993a36193f555cadcd5bed77ef91f73c8276a513af210db61aa7f53b
+  data.tar.gz: f800249db88dacaafadfaa400946f602753c558288e6f0671c25c780de21b3fd4660d4e4954472ec8d1264fde3b3214d9c24dee755284224d2cbb146979d85de

data/README.md

@@ -1 +1,93 @@
-dcidev_approval
+# Setup
+##### 1. Add new column named `status` to every model requiring this gem
+`db/migrate/migration_file.rb`
+```ruby
+class AddStatusToProduk < ActiveRecord::Migration[6.0]
+    def change 
+        add_column :produk, :status, :string
+        add_column :produk, :change_status, :string
+    end
+end
+```
+`app/models/model.rb`
+```ruby
+STATUS = %w[waiting approved rejected].freeze
+enum status: STATUS.zip(STATUS).to_h, _prefix: true
+
+CHANGE_STATUS = %w(pending_delete pending_update).freeze
+enum change_status: CHANGE_STATUS.zip(CHANGE_STATUS).to_h, _prefix: true
+```
+
+
+
+##### 2. Format your `Agent` and `Role` with one-many relationship.
+##### 3.  Declare instance method `is_admin?` to `Agent` to find out whether an agent is an admin or not
+
+```ruby
+def is_admin?
+    # add your custom logic here
+    self.approved? && ["admin", "super_admin", "checker"].include?(self.try(:roles).try(:first).try(:code))
+end
+```
+
+##### 4. Include the module to every model requiring approval. Or just put it in `ApplicationRecord`
+`app/models/application_record.rb`
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+    include DcidevApproval
+    self.abstract_class = true
+    # ...
+end
+```
+
+# Features
+* Create: `Model.create_data(declared(params), current_user, bypass)`
+* Update: `model.edit_data(declared(params), current_user, bypass)`
+* Delete: `model.delete_data(declared(params), current_user, bypass)`
+* Approval: `model.approval(declared(params))`
+* Compare current database value and argument to check if there are any update: `model.changes_present?(params)`
+* Check approval status: `model.waiting_approval?`, `model.pending_insert?`, `model.pending_update?`, `model.pending_delete?`
+* Find last lodifier & timestamp: `model.last_modified_by`
+* Find author: `model.created_by`
+* Find approval agent & timestamp: `model.last_approved_by`
+
+Explanation
+* `declared(params)`: is a hash value from Grape Parameters, plain ruby hash can also be used
+* `current_user`: the agent responsible for the changes
+* `bypass`: boolean value to toogle the approval system. If not sent, the default value is `true`
+
+To track changes peformed to a record, call 
+# Callbacks
+To execute code before/after the CRUD, include module `DcidevApproval` in `ApplicationRecord` and peform overide and or overload on it's child model.
+
+`app/models/application_record.rb`
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+    include DcidevApproval
+    self.abstract_class = true
+    # ...
+end
+```
+
+`app/models/child_model.rb`
+```ruby
+class ChildModel < ApplicationRecord
+    # ...
+    def self.create_data(params, agent, request)
+        super(params, agent, false) do |data|
+            # do something after the record is successfully created
+            # in this case, write an activity log
+            # the data variable will return the created record
+            ActivityLog.write("#{agent.is_admin? || params.bypass ? nil : "Request "} Add #{self.class.to_s}", request, agent, menu, data) if params.log
+        end
+    end
+    
+    def edit_data(params, agent, request)
+        super(params, agent, false) do |_|
+            # do something after the record is successfully edited and require approval
+        end
+    end
+    # ...
+end
+
+```

data/lib/dcidev_approval.rb

@@ -36,6 +36,18 @@ module DcidevApproval
       self.change_status == "pending_delete"
     end
 
+    def approved?
+      self.status == "approved" || self.change_status.nil?
+    end
+
+    def rejected?
+        self.status == "rejected"
+    end
+
+    def waiting?
+        self.status == "waiting"
+    end
+
     def last_modified_by
       # p self.audit_trail
       if self.try(:change_status).present? && self.try(:change_status) == 'pending_delete'
@@ -44,7 +56,7 @@ module DcidevApproval
         log = self.activity_logs.where("activity LIKE '%edit%'").limit(1).order(created_at: :desc).try(:first)
       end
       {
-        modified_by: log.present? ? log.try(:agent).try(:name).to_s + " (#{log.try(:agent).try(:username).to_s} | #{log.try(:agent).try(:roles).try(:first).try(:name)})" : "System",
+        modified_by: log.present? ? log.try(:agent).try(:name).to_s + " (#{log.try(:agent).try(:username).to_s} | #{log.try(:agent).try(:roles).try(:first).try(:name)})" : nil,
         modified_at: log.present? ? log.try(:created_at) || self.try(:updated_at) || self.try(:created_at) : nil
       }
     end
@@ -61,7 +73,7 @@ module DcidevApproval
       last_approve = self.activity_logs.where("activity LIKE '%approv%'").limit(1).order(created_at: :desc).try(:first)
       last_entry = self.activity_logs.last
       {
-        approved_by: last_approve.try(:id) == last_entry.try(:id) ? last_approve.try(:agent).try(:name).to_s + " (#{log.try(:agent).try(:username).to_s} | #{log.try(:agent).try(:roles).try(:first).try(:name)})"  : nil,
+        approved_by: last_approve.try(:id) == last_entry.try(:id) ? last_approve.try(:agent).try(:name).to_s + " (#{last_approve.try(:agent).try(:username).to_s} | #{last_approve.try(:agent).try(:roles).try(:first).try(:name)})"  : nil,
         approved_at: last_approve.try(:id) == last_entry.try(:id) ? last_approve.try(:created_at) : nil
       }
     end
@@ -109,7 +121,7 @@ module DcidevApproval
           # ActivityLog.write("#{agent.is_admin? ? nil : "Request "}Edit #{self.class.to_s}", request, agent, menu, self) if params.log
         end
       end
-      yield true
+      yield self
     end
 
     def approval(params)
@@ -118,7 +130,7 @@ module DcidevApproval
       elsif params.status == "rejected"
         self.delete_changes
       end
-      yield true
+      yield self
     end
 
     def delete_data(agent, bypass = true)
@@ -143,15 +155,15 @@ module DcidevApproval
           data = params.merge!({ status: :approved })
           d = self.new_from_params(data)
           raise d.errors.full_messages.join(", ") unless d.save
+          yield d
           # ActivityLog.write("#{agent.is_admin? ? nil : "Request "} Add #{self.to_s}", request, agent, menu, d) if params.log
         end
       else
         d = self.new_from_params(params)
         d.status = agent.is_admin? ? :approved : :waiting
         raise d.errors.full_messages.join(", ") unless d.save
-        # ActivityLog.write("Add #{self.to_s}", request, agent, menu, d) if params.log
+        yield d
       end
-      yield d
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dcidev_approval
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.9
 platform: ruby
 authors:
 - Punto Damar P
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dcidev_active_record
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Logic for implementing record changes approval