rails_audit_log 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf93211ea95d97c01b541195ade4517d221d39035896e06a6432c512e5f284c0
-  data.tar.gz: f1bce85319393eaca9db2e078a0087e1f0818c1025fdd23e472fb8381a322b91
+  metadata.gz: 6cc56d9335d26c5f43d52de380aa354a268cbb266696799cf1775f051162c2d8
+  data.tar.gz: '027792cdf8815ec2822177492b674d05534a3d96163d463dd603a415d471ace2'
 SHA512:
-  metadata.gz: f0f9def2049dc5ca95e13fad9746bc84a79c7e8081d8e84dd0f4fbfd3915b57b9dd35aaa600687970475f49b395e15c6725d3c558b1272f7afda6ba3b18054c0
-  data.tar.gz: 1699b3f01dbfd55377144207ff36c987a83419adf318671a16676e5513fd31fc98f908e5b2f83cef3a9f7b597bdf7ac8fe2cf4da2c275f569bdcd4837a3a1727
+  metadata.gz: 107247da00cc1f7eec9750f9d59eb2b41fa47f4ec9c3a0b00f587882bf6080250fe5af5152a2d13491fdb6ebf6aa7d3f82a6418f89777b9dca3819c024692805
+  data.tar.gz: 3715691ec2538d7fca5538af23e9f087899469876dcb98b660d82f18230ee531f45660950c95e4230f15a6a430b4b85999691472b9c61cf1d4e88af6c90849c2

data/README.md

@@ -102,6 +102,55 @@ entry.diff
 # => { "title" => { from: "Hello", to: "World" } }
 ```
 
+### Association tracking
+
+Track `has_many` add and remove events by passing `associations: true` to `audit_log`. Call `audit_log` **before** the `has_many` declarations so the callbacks are wired at class load time:
+
+```ruby
+class Post < ApplicationRecord
+  include RailsAuditLog::Auditable
+  audit_log associations: true
+  has_many :tags
+  has_many :comments, dependent: :destroy
+end
+```
+
+Each add or remove creates an `update` entry on the parent with the associated record's identity in `object_changes`:
+
+```ruby
+post = Post.create!(title: "Hello")
+tag  = post.tags.create!(name: "Ruby")
+
+entry = post.audit_log_entries.updated_events.last
+entry.object_changes
+# => { "tags" => [nil, { "id" => 1, "type" => "Tag" }] }
+
+post.tags.delete(tag)
+entry = post.audit_log_entries.updated_events.last
+entry.object_changes
+# => { "tags" => [{ "id" => 1, "type" => "Tag" }, nil] }
+```
+
+Track only a named subset of associations:
+
+```ruby
+audit_log associations: [:tags]  # comments changes are not recorded
+```
+
+`has_many :through` and `has_and_belongs_to_many` work the same way — no extra configuration:
+
+```ruby
+class Post < ApplicationRecord
+  include RailsAuditLog::Auditable
+  audit_log associations: true
+  has_many :taggings
+  has_many :tags, through: :taggings   # tracked automatically
+  has_and_belongs_to_many :categories  # tracked automatically
+end
+```
+
+`belongs_to` foreign-key changes are already tracked as regular column updates and require no extra configuration.
+
 ### Selective tracking
 
 Track only specific attributes, or exclude noisy ones:

data/app/concerns/rails_audit_log/auditable.rb

@@ -3,9 +3,10 @@ module RailsAuditLog
     extend ActiveSupport::Concern
 
     included do
-      class_attribute :_audit_log_only,   default: nil
-      class_attribute :_audit_log_ignore, default: nil
-      class_attribute :_audit_log_meta,   default: nil
+      class_attribute :_audit_log_only,         default: nil
+      class_attribute :_audit_log_ignore,        default: nil
+      class_attribute :_audit_log_meta,          default: nil
+      class_attribute :_audit_log_associations,  default: nil
 
       has_many :audit_log_entries,
                class_name: "RailsAuditLog::AuditLogEntry",
@@ -15,13 +16,45 @@ module RailsAuditLog
       after_create  :record_audit_create
       after_update  :record_audit_update
       after_destroy :record_audit_destroy
+
+      # Intercept has_many (including :through) and has_and_belongs_to_many to
+      # inject after_add/after_remove callbacks when association tracking is
+      # enabled. Must be defined after has_many :audit_log_entries so that the
+      # internal association is not affected.
+      def self.has_many(name, scope = nil, **options, &extension)
+        if _audit_log_associations && name.to_s != "audit_log_entries"
+          options = _build_audit_association_options(name.to_s, options)
+        end
+        scope ? super(name, scope, **options, &extension) : super(name, **options, &extension)
+      end
+
+      def self.has_and_belongs_to_many(name, scope = nil, **options, &extension)
+        if _audit_log_associations
+          options = _build_audit_association_options(name.to_s, options)
+        end
+        scope ? super(name, scope, **options, &extension) : super(name, **options, &extension)
+      end
+
+      def self._build_audit_association_options(assoc_name, options)
+        tracked = _audit_log_associations == true ||
+                  Array(_audit_log_associations).map(&:to_s).include?(assoc_name)
+        return options unless tracked
+
+        add_cb    = ->(owner, rec) { owner.send(:record_audit_association_change, assoc_name, nil, { "id" => rec.id, "type" => rec.class.name }) }
+        remove_cb = ->(owner, rec) { owner.send(:record_audit_association_change, assoc_name, { "id" => rec.id, "type" => rec.class.name }, nil) }
+        options.merge(
+          after_add:    [*options[:after_add]]    + [add_cb],
+          after_remove: [*options[:after_remove]] + [remove_cb]
+        )
+      end
     end
 
     class_methods do
-      def audit_log(only: nil, ignore: nil, meta: nil)
+      def audit_log(only: nil, ignore: nil, meta: nil, associations: nil)
         self._audit_log_only   = only.map(&:to_s)   if only
         self._audit_log_ignore = ignore.map(&:to_s) if ignore
         self._audit_log_meta   = meta                if meta
+        self._audit_log_associations = associations  unless associations.nil?
       end
     end
 
@@ -46,6 +79,24 @@ module RailsAuditLog
       record_audit_entry("destroy", changes, snapshot)
     end
 
+    def record_audit_association_change(assoc_name, before, after)
+      return unless RailsAuditLog.enabled?
+
+      actor = RailsAuditLog.actor
+      meta  = build_audit_metadata
+      RailsAuditLog::AuditLogEntry.create!(
+        event:              "update",
+        item_type:          self.class.name,
+        item_id:            id,
+        object_changes:     { assoc_name => [before, after] },
+        reason:             RailsAuditLog.reason,
+        metadata:           meta.presence,
+        whodunnit_snapshot: actor ? RailsAuditLog.whodunnit_display.call(actor) : nil,
+        actor_type:         actor&.class&.name,
+        actor_id:           actor.respond_to?(:id) ? actor.id : nil
+      )
+    end
+
     def record_audit_entry(event, changes, snapshot = nil)
       return unless RailsAuditLog.enabled?
 

data/app/models/rails_audit_log/audit_log_entry.rb

@@ -51,8 +51,13 @@ module RailsAuditLog
         return instance
       end
 
-      # Fallback: diff-only mode or entries recorded before snapshot support
-      from_attrs = (object_changes || {}).transform_values { |from_to| from_to[0] }
+      # Fallback: diff-only mode or entries recorded before snapshot support.
+      # Filter to column names so association-change entries (e.g. tags, comments)
+      # don't get assigned to the record as if they were scalar attributes.
+      column_names = klass.column_names.map(&:to_s)
+      from_attrs = (object_changes || {})
+        .select { |k, _| column_names.include?(k) }
+        .transform_values { |from_to| from_to[0] }
 
       if event == "update"
         record = klass.find_by(id: item_id)

data/lib/rails_audit_log/version.rb

@@ -1,3 +1,3 @@
 module RailsAuditLog
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/rails_audit_log.rb

@@ -73,7 +73,10 @@ module RailsAuditLog
     return nil if entry.nil? || entry.event == "destroy"
 
     klass = record.class
-    to_attrs = (entry.object_changes || {}).transform_values { |v| v[1] }
+    column_names = klass.column_names.map(&:to_s)
+    to_attrs = (entry.object_changes || {})
+      .select { |k, _| column_names.include?(k) }
+      .transform_values { |v| v[1] }
     attrs = entry.object.present? ? entry.object.merge(to_attrs) : to_attrs
 
     instance = klass.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Chuck Smith