rails_audit_log 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb82307e35624fe226336c4fb33559b5432a6290c4978076aadec80e6939afa0
-  data.tar.gz: 47e700f38e3d1fbe2a0953ba687285389721b31e8a6531dcbc5e336c6d9af438
+  metadata.gz: cf93211ea95d97c01b541195ade4517d221d39035896e06a6432c512e5f284c0
+  data.tar.gz: f1bce85319393eaca9db2e078a0087e1f0818c1025fdd23e472fb8381a322b91
 SHA512:
-  metadata.gz: 5dc66b780e8d1875260ef21c143b3ec823832ffa7e90c58f8392e002515d4cbe30c797936f4766bd15791a9b1b37e2f8918973f33fec58e396ca117a3623a563
-  data.tar.gz: d7fbf0c15e39d95a57270203b296ce5bac2835cc15f69d44cd6a7b000a884bc8d639cee91de5c1dd84aeaec64795fa6325397a1926a67f9a8317cc1128c18808
+  metadata.gz: f0f9def2049dc5ca95e13fad9746bc84a79c7e8081d8e84dd0f4fbfd3915b57b9dd35aaa600687970475f49b395e15c6725d3c558b1272f7afda6ba3b18054c0
+  data.tar.gz: 1699b3f01dbfd55377144207ff36c987a83419adf318671a16676e5513fd31fc98f908e5b2f83cef3a9f7b597bdf7ac8fe2cf4da2c275f569bdcd4837a3a1727

data/README.md

@@ -179,6 +179,68 @@ entry.previous  # => the entry before this one
 entry.next      # => the entry after this one (nil if last)
 ```
 
+### Attaching a reason
+
+Record a free-text rationale alongside any write using a thread-local block — safe to nest, cleared automatically:
+
+```ruby
+RailsAuditLog.audit_log_reason("Approved by legal") do
+  contract.update!(status: "approved")
+end
+
+entry.reason  # => "Approved by legal"
+```
+
+### Arbitrary metadata
+
+The `metadata` JSON column accepts any key/value hash. Populate it automatically with `audit_log meta:`:
+
+```ruby
+class Article < ApplicationRecord
+  include RailsAuditLog::Auditable
+
+  # Zero-arg lambda — evaluated at write time (good for thread-locals)
+  # One-arg lambda — receives the record instance
+  audit_log meta: {
+    tenant_id:    -> { Current.tenant.id },
+    title_length: ->(record) { record.title.length }
+  }
+end
+
+entry.metadata  # => { "tenant_id" => "acme", "title_length" => 12 }
+```
+
+### Request metadata capture
+
+Enable opt-in capture of `remote_ip` and `user_agent` from the current request in an initializer:
+
+```ruby
+# config/initializers/rails_audit_log.rb
+RailsAuditLog.capture_request_metadata = true
+```
+
+When enabled, the `Controller` concern automatically stores these into each entry's `metadata` column:
+
+```ruby
+entry.metadata  # => { "remote_ip" => "203.0.113.1", "user_agent" => "Mozilla/5.0 ..." }
+```
+
+Request metadata and `audit_log meta:` values are merged together automatically.
+
+### Actor display name snapshot
+
+`whodunnit_snapshot` stores the actor's display name at write time so entries remain meaningful even after the actor record is deleted:
+
+```ruby
+entry.whodunnit_snapshot  # => "Alice"  (even if the User record is later deleted)
+```
+
+The default display proc uses `actor.name` if available, otherwise `actor.to_s`. Override globally in an initializer:
+
+```ruby
+RailsAuditLog.whodunnit_display = ->(actor) { actor.email }
+```
+
 ### Object snapshot storage
 
 By default every entry stores a full `object` snapshot of the pre-change state alongside `object_changes`. This makes `reify` and `version_at` reliable without any database lookups:

data/app/concerns/rails_audit_log/auditable.rb

@@ -5,6 +5,7 @@ module RailsAuditLog
     included do
       class_attribute :_audit_log_only,   default: nil
       class_attribute :_audit_log_ignore, default: nil
+      class_attribute :_audit_log_meta,   default: nil
 
       has_many :audit_log_entries,
                class_name: "RailsAuditLog::AuditLogEntry",
@@ -17,9 +18,10 @@ module RailsAuditLog
     end
 
     class_methods do
-      def audit_log(only: nil, ignore: nil)
+      def audit_log(only: nil, ignore: nil, meta: 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
       end
     end
 
@@ -51,17 +53,32 @@ module RailsAuditLog
       return if filtered.empty? && event == "update"
 
       actor = RailsAuditLog.actor
+      meta = build_audit_metadata
       RailsAuditLog::AuditLogEntry.create!(
-        event:          event,
-        item_type:      self.class.name,
-        item_id:        id,
-        object_changes: filtered,
-        object:         snapshot,
-        actor_type:     actor&.class&.name,
-        actor_id:       actor.respond_to?(:id) ? actor.id : nil
+        event:               event,
+        item_type:           self.class.name,
+        item_id:             id,
+        object_changes:      filtered,
+        object:              snapshot,
+        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 build_audit_metadata
+      meta = {}
+      if self.class._audit_log_meta
+        self.class._audit_log_meta.each do |key, callable|
+          meta[key.to_s] = callable.arity == 0 ? callable.call : callable.call(self)
+        end
+      end
+      meta.merge!(RailsAuditLog.request_metadata || {})
+      meta
+    end
+
     def filter_changes(changes)
       result = changes.dup
 

data/app/concerns/rails_audit_log/controller.rb

@@ -5,6 +5,8 @@ module RailsAuditLog
     included do
       before_action :set_audit_log_actor
       after_action  :clear_audit_log_actor
+      before_action :capture_audit_log_request_metadata
+      after_action  :clear_audit_log_request_metadata
     end
 
     class_methods do
@@ -27,5 +29,20 @@ module RailsAuditLog
     def clear_audit_log_actor
       RailsAuditLog.actor = nil
     end
+
+    def capture_audit_log_request_metadata
+      return unless RailsAuditLog.capture_request_metadata
+
+      RailsAuditLog.request_metadata = {
+        "remote_ip" => request.remote_ip,
+        "user_agent" => request.user_agent
+      }.compact
+    end
+
+    def clear_audit_log_request_metadata
+      return unless RailsAuditLog.capture_request_metadata
+
+      RailsAuditLog.request_metadata = nil
+    end
   end
 end

data/app/models/rails_audit_log/audit_log_entry.rb

@@ -10,6 +10,7 @@ module RailsAuditLog
     validates :event, presence: true, inclusion: { in: EVENTS }
     validates :item_type, presence: true
     validates :item_id, presence: true
+    validate :metadata_must_be_a_hash
 
     # Event scopes
     scope :created_events,  -> { where(event: "create") }
@@ -82,6 +83,14 @@ module RailsAuditLog
       object_changes.transform_values { |from_to| { from: from_to[0], to: from_to[1] } }
     end
 
+    private
+
+    def metadata_must_be_a_hash
+      errors.add(:metadata, "must be a Hash") if metadata.present? && !metadata.is_a?(Hash)
+    end
+
+    public
+
     # Attribute scope — uses json_extract (SQLite/MySQL) or ->> (PostgreSQL)
     scope :touching, ->(attribute) {
       if connection.adapter_name =~ /PostgreSQL/i

data/lib/generators/rails_audit_log/install/templates/create_audit_log_entries.rb

@@ -6,6 +6,9 @@ class CreateAuditLogEntries < ActiveRecord::Migration[<%= ActiveRecord::Migratio
       t.bigint  :item_id,    null: false
       t.json    :object_changes
       t.json    :object
+      t.json    :metadata
+      t.string  :reason
+      t.string  :whodunnit_snapshot
       t.string  :actor_type
       t.bigint  :actor_id
       t.datetime :created_at, null: false, default: -> { "CURRENT_TIMESTAMP" }

data/lib/rails_audit_log/version.rb

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

data/lib/rails_audit_log.rb

@@ -6,6 +6,18 @@ module RailsAuditLog
   # Override in an initializer: RailsAuditLog.ignored_attributes = %w[updated_at cached_at]
   mattr_accessor :ignored_attributes, default: %w[updated_at]
   mattr_accessor :store_snapshot, default: true
+  mattr_accessor :capture_request_metadata, default: false
+  mattr_accessor :whodunnit_display, default: ->(actor) {
+    actor.respond_to?(:name) ? actor.name.to_s : actor.to_s
+  }
+
+  def self.request_metadata
+    Thread.current[:rails_audit_log_request_metadata]
+  end
+
+  def self.request_metadata=(value)
+    Thread.current[:rails_audit_log_request_metadata] = value
+  end
 
   def self.actor
     Thread.current[:rails_audit_log_actor]
@@ -35,6 +47,22 @@ module RailsAuditLog
     Thread.current[:rails_audit_log_disabled] = previous
   end
 
+  def self.reason
+    Thread.current[:rails_audit_log_reason]
+  end
+
+  def self.reason=(value)
+    Thread.current[:rails_audit_log_reason] = value
+  end
+
+  def self.audit_log_reason(value)
+    previous = self.reason
+    self.reason = value
+    yield
+  ensure
+    self.reason = previous
+  end
+
   def self.version_at(record, time)
     entry = AuditLogEntry
       .where(item_type: record.class.name, item_id: record.id)

metadata

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