tangledwires-audited 6.0.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ecb53136ee29db88a0b1baeb8278767eecc1bd05c72846fa43c07c0395adf89
-  data.tar.gz: 8a893fe19e2468d48ddd85d3a32f15a751f21cc2ed9502cfdc229c7267b89b18
+  metadata.gz: 8595ede793eed6955e5140df3030c279680e85a65d9497f924e96a6f801169a1
+  data.tar.gz: 1fef5c05d2e1e9d2e7e0342a550b587fca3b77060ce2aa716de2cfd82c6f56a0
 SHA512:
-  metadata.gz: 0dfbacc7c5280a43bccb9f116b972a1e3f9189de9eb0841365980e436ac521e6cc31844e385f4d08864c510057caa4dec769e3c3629f70df52d9151d789edbe8
-  data.tar.gz: b14b86bb8069096f0ec360c16c14a9167b767105ba2921563ff5776d01fac31cc8f8e05b47ffc64cdf46d9231faf1a7cf53fd1d6590d0b7beb9f046c2a216d5d
+  metadata.gz: cb0a4d73b7a68a1891c00204f2d84fa611d451f6e332e378d9dfa042a80e5f75746e4560a099fd944dc2ecc8cb3d3dbb27e2762448b1dff983c506524bfc50be
+  data.tar.gz: 0c636c2739c5be06a4eb055893cfeda5b3ef1be0d0b31914f5b6e8d1ab0dbd8589ce992913a9e588db3df22d8c7f072a66c04c770584603fc371c87de1311c26

data/README.md

@@ -6,8 +6,13 @@ TangledWires Audited
 
 **Audited** (previously acts_as_audited) is an ORM extension that logs all changes to your models. Audited can also record who made those changes, save comments and associate models related to the changes.
 
+Audited currently (6.2) works with Rails 8.0, 7.2, 7.1, 7.0.
 
-Audited currently (5.6) works with Rails 8.0, 7.2, 7.1, 7.0.
+## Changes from `collectiveidea/audited`
+* Remove support for Rails versions below 7.0
+* Add support for auditing HABTM associations
+* Allow multiple associated audits ([collectiveidea/audited#406](https://github.com/collectiveidea/audited/pull/406))
+* Add an option to redact a record's audits when the record is deleted
 
 ## Supported Rubies
 

data/lib/audited/auditor.rb

@@ -58,6 +58,13 @@ module Audited
       #       end
       #     end
       #
+      # * +redact_after_destroy+ - If an array is passed, the columns in the array
+      #   will be redacted from audits when the record is destroyed.
+      #
+      #     class User < ActiveRecord::Base
+      #       audited redact_after_destroy: [:name, :email, :address]
+      #     end
+      #
       def audited(options = {})
         audited? ? update_audited_options(options) : set_audit(options)
       end
@@ -90,6 +97,53 @@ module Audited
         before_update :audit_update if audited_options[:on].include?(:update)
         after_touch :audit_touch if audited_options[:on].include?(:touch) && ::ActiveRecord::VERSION::MAJOR >= 6
         before_destroy :audit_destroy if audited_options[:on].include?(:destroy)
+        after_destroy :redact_after_destroy unless audited_options[:redact_after_destroy].nil?
+
+        reflect_on_all_associations(:has_and_belongs_to_many).each do |reflection|
+          associated_model = reflection.name
+
+          # Attach callbacks to HABTM associations to create an audit when something is added or removed.
+          # after_add and after_remove are called only when the associated objects are added or removed through the association collection
+          add_callback_to_reflection reflection, :after_add, ->(owner, record) { owner.send("_pending_#{association}_audit")[:add] << record.id }
+          add_callback_to_reflection reflection, :after_remove, ->(owner, record) { owner.send("_pending_#{association}_audit")[:remove] << record.id }
+
+          # This is used so that only one audit is created even if multiple items are added/removed from the association.
+          # Since after_add and after_remove are fired *before* saving, we can build a list of things added and removed, then combine them into one audit *after* everything is saved.
+          define_method "_pending_#{associated_model}_audit" do
+            instance_variable_get("@_pending_#{associated_model}_audit") || instance_variable_set("@_pending_#{associated_model}_audit", { add: [], remove: [] })
+          end
+
+          # The following section creates audits when HABTM associations are modified in a way other than the association collection.
+          ids_method = "#{associated_model.to_s.singularize}_ids"
+          mod = Module.new do
+            define_method "#{ids_method}=" do |new_ids|
+              old_ids = send ids_method
+              super new_ids # Call original Rails setter
+
+              added = new_ids - old_ids
+              removed = old_ids - new_ids
+
+              send("_pending_#{associated_model}_audit")[:add].concat(added)
+              send("_pending_#{associated_model}_audit")[:remove].concat(removed)
+            end
+          end
+          prepend mod
+
+          after_save do
+            pending = send("_pending_#{associated_model}_audit")
+            next if pending[:add].empty? && pending[:remove].empty?
+
+            write_audit(
+              action: "update",
+              audited_changes: {
+                associated_model.to_s => pending.transform_values(&:uniq)
+              }
+            )
+
+            # Clear pending changes
+            instance_variable_set "@_pending_#{associated_model}_audit", { add: [], remove: [] }
+          end
+        end
 
         # Define and set after_audit and around_audit callbacks. This might be useful if you want
         # to notify a party after the audit has been created or if you want to access the newly-created
@@ -117,6 +171,15 @@ module Audited
         normalize_audited_options
         self.audit_associated_with = audited_options[:associated_with]
       end
+
+      private
+      def add_callback_to_reflection(reflection, type, callback)
+        reflection.options[type] ||= []
+
+        unless reflection.options[type].include?(callback)
+          reflection.options[type] << callback
+        end
+      end
     end
 
     module AuditedInstanceMethods
@@ -375,6 +438,16 @@ module Audited
         end
       end
 
+      def redact_after_destroy
+        audits.each do |audit|
+          filter_attr_values(
+            audited_changes: audit.audited_changes,
+            attrs: Array(audited_options[:redact_after_destroy]).map(&:to_s),
+            placeholder: audited_options[:redaction_value] || REDACTED
+          )
+        end
+      end
+
       def write_audit(attrs)
         self.audit_comment = nil
 

data/lib/audited/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Audited
-  VERSION = "6.0.1"
+  VERSION = "6.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tangledwires-audited
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.2.0
 platform: ruby
 authors:
 - TangledWires Ltd
@@ -236,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Log all changes to your models
 test_files: []