dcidev_approval 0.0.9 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e97350e7fc396ea5b6badf639f46c97c256de119290e7f4cf209a29b55c13fc2
-  data.tar.gz: 32378050bd803f53adf02652f4d5502b871e2ea6ce7aed380970a395d1562761
+  metadata.gz: ceacb6241a269f4b1c40dc7f83d1fb245619456759e9814514cbdb694365b757
+  data.tar.gz: d3fe771c426cd90a58d1f8bb83658652d42081f1fdda5e53a1f767196d9346b0
 SHA512:
-  metadata.gz: 59b9cf658199b5dd33f76c3eb22f6d302718a908f220d986a46d9fe90a28f82b490fbc31993a36193f555cadcd5bed77ef91f73c8276a513af210db61aa7f53b
-  data.tar.gz: f800249db88dacaafadfaa400946f602753c558288e6f0671c25c780de21b3fd4660d4e4954472ec8d1264fde3b3214d9c24dee755284224d2cbb146979d85de
+  metadata.gz: 1a85f826b582a4e27af4c43136024b7c033fbaf89a6f97fa93b459fde6de38c08fbfba026a96d48d80e5b5a8b0baef675af25a52a1baa411dbc432bde14a7ad0
+  data.tar.gz: 0a2a2d68986cd8285614bad0531030c064e759139da4180929c08b39ff23515505f3a87254e80c2f7e897f96ba54e890773ad2a8a9728b267a1566b1485e3528

data/README.md

@@ -4,8 +4,11 @@
 ```ruby
 class AddStatusToProduk < ActiveRecord::Migration[6.0]
     def change 
-        add_column :produk, :status, :string
-        add_column :produk, :change_status, :string
+        change_column :model do |t|
+            t.string :status
+            t.string :change_status
+            t.json :data_changes
+        end
     end
 end
 ```
@@ -18,8 +21,6 @@ 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
 
@@ -56,8 +57,23 @@ Explanation
 * `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 
+To track changes peformed to a record, call `instance_model.audit_trails`
+
+# Approval
+To approve / reject changes, call `approval(params)`.
+You MUST use `status` as the param name otherwise it wont work.
+```ruby
+        params do
+            requires :status, type: String, values: %w[approved rejected]
+        end
+        post "/approval/:id" do
+            @produk.approval(params, current_user)
+            present :produk, @produk
+        end
+```
+
 # 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`

data/lib/dcidev_approval.rb

@@ -1,170 +1,150 @@
-module DcidevApproval
-  def self.included base
-    base.send :include, InstanceMethods
-    base.extend ClassMethods
-  end
-
-  module InstanceMethods
-
-    def changes_present?(changes)
-      present = false
-      changes.each do |k, v|
-        begin
-          if eval("self.#{k}") != v
-            present = true
-            break
-          end
-        rescue => _
-        end
-      end
-      return present
-    end
-
-    def waiting_approval?
-      %w[pending_update pending_delete].include?(self.change_status) || self.status == "waiting"
-    end
-
-    def pending_insert?
-      self.change_status.nil? && %w[waiting rejected].include?(self.status)
-    end
-
-    def pending_update?
-      self.change_status == "pending_update"
-    end
-
-    def pending_delete?
-      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'
-        log = self.activity_logs.where("activity LIKE '%delete%'").limit(1).order(created_at: :desc).try(:first)
-      else
-        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)})" : nil,
-        modified_at: log.present? ? log.try(:created_at) || self.try(:updated_at) || self.try(:created_at) : nil
-      }
-    end
-
-    def created_by
-      log = self.activity_logs.try(:first)
-      {
-        created_by: log.present? && log.try(:agent).try(:name).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",
-        created_at: self.try(:created_at) || log.try(:created_at)
-      }
-    end
-
-    def last_approved_by
-      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 + " (#{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
-
-    def approve_changes
-
-      if self.change_status.nil? && %w[waiting rejected].include?(self.status)
-        raise self.errors.full_messages.join(", ") unless self.update(status: :approved, data_changes: nil, change_status: nil)
-        # ActivityLog.write("Approve insert to #{self.class.to_s}", request, agent, menu, self) if params.log
-        # self.delay(queue: "reorder_#{self.id}", priority: 0).reorder if self.class.column_names.include?("view_order")
-
-      end
-      if self.change_status == "pending_update"
-        raise self.errors.full_messages.join(", ") unless self.update_by_params(self.data_changes, false)
-        raise self.errors.full_messages.join(", ") unless self.update(status: :approved, data_changes: nil, change_status: nil)
-        # ActivityLog.write("Approve update to #{self.class.to_s}", request, agent, menu, self) if params.log
-        # self.delay(queue: "reorder_#{self.id}", priority: 0).reorder if self.class.column_names.include?("view_order")
+# frozen_string_literal: true
 
-      elsif self.change_status == "pending_delete"
-        raise self.errors.full_messages.join(", ") unless self.update(change_status: nil, data_changes: nil)
-        ActiveRecord::Base.transaction do
-          # ActivityLog.write("Approve delete to #{self.class.to_s}", request, agent, menu, self) if params.log
-          self.try(:destroy)
+module DcidevApproval
+    def self.included(base)
+        base.send :include, InstanceMethods
+        base.extend ClassMethods
+    end
+    
+    module InstanceMethods
+        def changes_present?(changes)
+            present = false
+            changes.each do |k, v|
+                if eval("self.#{k}") != v
+                    present = true
+                    break
+                end
+            rescue StandardError => _e
+            end
+            present
+        end
+        
+        def waiting_approval?
+            %w[pending_update pending_delete].include?(change_status) || status == 'waiting'
+        end
+        
+        def pending_insert?
+            change_status.nil? && %w[waiting rejected].include?(status)
+        end
+        
+        def pending_update?
+            change_status == 'pending_update'
+        end
+        
+        def pending_delete?
+            change_status == 'pending_delete'
+        end
+        
+        def approved?
+            status == 'approved' || change_status.nil?
+        end
+        
+        def rejected?
+            status == 'rejected'
+        end
+        
+        def waiting?
+            status == 'waiting'
+        end
+        
+        def last_modified_by
+            log = audit_trails.where(activity_type: %w[update delete]).limit(1).try(:first)
+            {
+                modified_by: log.present? ? log.try(:agent).try(:name).to_s + " (#{log.try(:agent).try(:roles).try(:first).try(:name)})" : nil,
+                modified_at: log.present? ? log.try(:created_at) || try(:updated_at) || try(:created_at) : nil
+            }
+        end
+        
+        def created_by
+            log = audit_trails(:asc).where(activity_type: :create).limit(1).try(:first)
+            {
+                created_by: log.present? && log.try(:agent).try(:name).present? ? log.try(:agent).try(:name).to_s + " (#{log.try(:agent_role).try(:name)})" : 'System',
+                created_at: self.try(:created_at) || log.try(:created_at)
+            }
+        end
+        
+        def last_approved_by
+            last_approve = audit_trails.where(approval: true).limit(1).try(:first)
+            last_entry = audit_trails.limit(1).try(:first)
+            {
+                approved_by: last_approve.try(:id) == last_entry.try(:id) ? last_approve.try(:agent).try(:name).to_s + " (#{last_approve.try(:agent_role).try(:name)})" : nil,
+                approved_at: last_approve.try(:id) == last_entry.try(:id) ? last_approve.try(:created_at) : nil
+            }
+        end
+        
+        def approve_changes
+            if change_status.nil? && %w[waiting rejected].include?(status) && !update(status: :approved, data_changes: nil, change_status: nil)
+                raise errors.full_messages.join(', ')
+            end
+            
+            case change_status
+            when 'pending_update'
+                raise errors.full_messages.join(', ') unless update_by_params(data_changes, false)
+                raise errors.full_messages.join(', ') unless update(status: :approved, data_changes: nil, change_status: nil)
+            when 'pending_delete'
+                destroy
+            end
+        end
+        
+        def delete_changes
+            raise errors.full_messages.join(', ') unless update(data_changes: nil, change_status: nil, status: status == 'waiting' ? :rejected : :approved)
+        end
+        
+        def edit_data(params, agent, bypass = true)
+            raise 'data still waiting for approval' if waiting_approval?
+            
+            if bypass
+                raise errors.full_messages.join(', ') unless update_by_params(params, false)
+            elsif changes_present?(params)
+                ActiveRecord::Base.transaction do
+                    data = agent.is_admin? || status == 'waiting' ? params :{ change_status: :pending_update, data_changes: agent.is_admin? ? nil : params }
+                    raise errors.full_messages.join(', ') unless update_by_params(data, false)
+                end
+            end
+            yield self
+        end
+        
+        def approval(params)
+            case params.status
+            when 'approved'
+                approve_changes
+            when 'rejected'
+                delete_changes
+            end
+            yield self
+        end
+        
+        def delete_data(agent, bypass = true)
+            raise 'data still waiting for approval' if waiting_approval?
+            
+            if bypass || agent.is_admin?
+                ActiveRecord::Base.transaction do
+                    raise errors.full_messages.join(', ') unless destroy
+                end
+            else
+                raise errors.full_messages.join(', ') unless update(change_status: :pending_delete)
+            end
+            yield true
         end
-      end
-    end
-
-    def delete_changes
-      # return unless %w[pending_update pending_delete].include? self.change_status
-      raise self.errors.full_messages.join(", ") unless self.update(data_changes: nil, change_status: nil, status: self.status == "waiting" ? :rejected : :approved)
-      # ActivityLog.write("Reject changes to #{self.class.to_s}", request, agent, menu, self) if params.log
-    end
-
-    def edit_data(params, agent, bypass = true)
-      raise "data still waiting for approval" if self.waiting_approval?
-      if bypass
-        raise self.errors.full_messages.join(", ") unless self.update_by_params(params, false)
-        # ActivityLog.write("Edit #{self.class.to_s}", request, agent, menu, self) if params.log
-      else
-        if self.changes_present?(params)
-          ActiveRecord::Base.transaction do
-            data = (agent.is_admin? || self.status == "waiting") ? params : { change_status: :pending_update, data_changes: agent.is_admin? ? nil : params }
-            raise self.errors.full_messages.join(", ") unless self.update_by_params(data, false)
-          end
-          # ActivityLog.write("#{agent.is_admin? ? nil : "Request "}Edit #{self.class.to_s}", request, agent, menu, self) if params.log
-        end
-      end
-      yield self
-    end
-
-    def approval(params)
-      if params.status == "approved"
-        self.approve_changes
-      elsif params.status == "rejected"
-        self.delete_changes
-      end
-      yield self
-    end
-
-    def delete_data(agent, bypass = true)
-      raise "data still waiting for approval" if self.waiting_approval?
-      if bypass || agent.is_admin?
-        ActiveRecord::Base.transaction do
-          # ActivityLog.write("Delete #{self.class.to_s}", request, agent, menu, self) if params.log
-          raise self.errors.full_messages.join(", ") unless self.destroy
-        end
-      else
-        raise self.errors.full_messages.join(", ") unless self.update(change_status: :pending_delete)
-        # ActivityLog.write("Request Delete #{self.class.to_s}", request, agent, menu, self) if params.log
-      end
-      yield true
     end
-  end
-
-  module ClassMethods
-    def create_data(params, agent, bypass = true)
-      if bypass
-        ActiveRecord::Base.transaction do
-          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
-        yield d
-      end
+    
+    module ClassMethods
+        def create_data(params, agent, bypass = true)
+            if bypass
+                ActiveRecord::Base.transaction do
+                    data = params.merge!({ status: :approved })
+                    d = new_from_params(data)
+                    raise d.errors.full_messages.join(', ') unless d.save
+                    
+                    yield d
+                end
+            else
+                d = new_from_params(params)
+                d.status = agent.is_admin? ? :approved : :waiting
+                raise d.errors.full_messages.join(', ') unless d.save
+                
+                yield d
+            end
+        end
     end
-  end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dcidev_approval
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.13
 platform: ruby
 authors:
 - Punto Damar P
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2022-06-14 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.1.2
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Logic for implementing record changes approval