rails_audit_log 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40a23f8ea1990a26ea7f575102fb5ddd5f1a7323c796315672de57f0154faec3
-  data.tar.gz: 8b0563eebeeb21fe9836f3ff091640ae4a1c5484b45dc515abfc4647510cfae9
+  metadata.gz: fb6120f7ce9f0f2a2fb19553a77ff4c6bf5c24a1945270e2e6393403b9ffc3a0
+  data.tar.gz: a978f7082c30a68c37344e0b819af1e70d077b3092337c5ea31c4e35473ffef6
 SHA512:
-  metadata.gz: 29cc8682459e2d7968555a49faa77e47c00da42a54bf633f286dd01e89979be8fff6790aa0880de5d7516d23f1fc16f4a88c10b1e4aa086921c6052fdb812784
-  data.tar.gz: f1a1ba92cfe1c9a1ff0640b9b8a78f94275195fb018da97d89557b9612d631c31293b228e0715d059b790a3f0d2888069066f9897f376e43a40467c8c0c6dbd2
+  metadata.gz: 8670a4ceb147508b45d03679eb3765c6984393c144434f4ad90b40bf69c64478ff8b92b0ab3bdb0b054cb0f64d2794f05044d546f81fa2fde17496ff65fde4de
+  data.tar.gz: 5ba060114539abc8555a5873aa7671c226cdc2c19a3bd66a4549595f68ea170372a968de324485dc0bf2eabb0bd253fa14e5c14c98b7b4ad9fe691bc15973fbb

data/README.md

@@ -26,6 +26,7 @@ Audit logging for Rails. Tracks `create`, `update`, and `destroy` events as stru
   - [Time-based retention](#time-based-retention)
   - [Scheduled and manual pruning](#scheduled-and-manual-pruning)
   - [Encrypting audit data](#encrypting-audit-data)
+  - [Multi-tenancy](#multi-tenancy)
   - [Selective tracking](#selective-tracking)
   - [Disabling auditing](#disabling-auditing)
   - [Object reconstruction](#object-reconstruction)
@@ -427,6 +428,55 @@ The generator creates:
 - `config/initializers/rails_audit_log_encryption.rb` — reads the generated keys from credentials and passes them to `ActiveRecord::Encryption`
 - `db/migrate/TIMESTAMP_encrypt_rails_audit_log_entries.rb` — re-encrypts existing plain-text audit entries; edit `ENCRYPTED_MODELS` to list your model class names, then run `bin/rails db:migrate`
 
+### Multi-tenancy
+
+Store the current tenant on every audit entry so queries are naturally isolated per tenant.
+
+Run the generator to add the `tenant_id` column:
+
+```bash
+bin/rails generate rails_audit_log:tenant
+bin/rails db:migrate
+```
+
+Set a global resolver in your initializer — the block is called at write time:
+
+```ruby
+# config/initializers/rails_audit_log.rb
+RailsAuditLog.current_tenant { Current.tenant_id }
+```
+
+Or override per model:
+
+```ruby
+class Order < ApplicationRecord
+  include RailsAuditLog::Auditable
+  audit_log tenant: -> { Current.tenant_id }
+end
+```
+
+The per-model lambda takes precedence over the global resolver. Both accept zero-argument lambdas and store whatever the block returns in the `tenant_id` string column.
+
+Scope queries to a single tenant with `for_tenant`:
+
+```ruby
+AuditLogEntry.for_tenant("acme")
+AuditLogEntry.for_tenant(Current.tenant_id).updated_events.since(1.week.ago)
+```
+
+The web dashboard (`/audit`) automatically applies `for_tenant` when `current_tenant` is configured, so entries from other tenants are never exposed.
+
+#### Acts As Tenant integration
+
+Wire the resolver to `ActsAsTenant` in one line:
+
+```ruby
+# config/initializers/rails_audit_log.rb
+RailsAuditLog.acts_as_tenant!
+```
+
+This is equivalent to `RailsAuditLog.current_tenant { ActsAsTenant.current_tenant&.id }`.
+
 ### Selective tracking
 
 Track only specific attributes, or exclude noisy ones:

data/app/concerns/rails_audit_log/auditable.rb

@@ -31,6 +31,7 @@ module RailsAuditLog
       class_attribute :_audit_log_retain_for,     default: nil
       class_attribute :_audit_log_async,          default: false
       class_attribute :_audit_log_encrypt,        default: nil
+      class_attribute :_audit_log_tenant,         default: nil
 
       _warn_if_audit_table_missing
 
@@ -119,18 +120,21 @@ module RailsAuditLog
       #   host app to configure +config.active_record.encryption+; decryption is
       #   transparent — {AuditLogEntry#diff}, {AuditLogEntry#reify}, and
       #   {AuditLogEntry.touching} work unchanged for non-SQL access paths
+      # @param tenant [Proc, nil] zero-argument lambda evaluated at write time;
+      #   return value is stored in the +tenant_id+ column; overrides
+      #   {RailsAuditLog.current_tenant} for this model
       # @return [void]
       # @example
       #   class Article < ApplicationRecord
       #     include RailsAuditLog::Auditable
       #     audit_log only: %i[title body published_at],
-      #               meta: { tenant_id: -> { Current.tenant_id } },
+      #               tenant: -> { Current.tenant_id },
       #               associations: %i[tags],
       #               version_limit: 100,
       #               retain_for: 30.days,
       #               encrypt: true
       #   end
-      def audit_log(only: nil, ignore: nil, meta: nil, associations: nil, version_limit: nil, retain_for: nil, async: nil, encrypt: nil)
+      def audit_log(only: nil, ignore: nil, meta: nil, associations: nil, version_limit: nil, retain_for: nil, async: nil, encrypt: nil, tenant: 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
@@ -139,6 +143,7 @@ module RailsAuditLog
         self._audit_log_retain_for    = retain_for          unless retain_for.nil?
         self._audit_log_async         = async               unless async.nil?
         self._audit_log_encrypt       = encrypt             unless encrypt.nil?
+        self._audit_log_tenant        = tenant              unless tenant.nil?
       end
     end
 
@@ -183,6 +188,7 @@ module RailsAuditLog
         object:             nil,
         reason:             RailsAuditLog.reason,
         metadata:           meta.presence,
+        tenant_id:          resolve_tenant_id,
         whodunnit_snapshot: actor ? RailsAuditLog.whodunnit_display.call(actor) : nil,
         actor_type:         actor&.class&.name,
         actor_id:           actor.respond_to?(:id) ? actor.id : nil
@@ -205,6 +211,7 @@ module RailsAuditLog
         object:              maybe_encrypt(snapshot),
         reason:              RailsAuditLog.reason,
         metadata:            meta.presence,
+        tenant_id:           resolve_tenant_id,
         whodunnit_snapshot:  actor ? RailsAuditLog.whodunnit_display.call(actor) : nil,
         actor_type:          actor&.class&.name,
         actor_id:            actor.respond_to?(:id) ? actor.id : nil
@@ -248,6 +255,11 @@ module RailsAuditLog
       end
     end
 
+    def resolve_tenant_id
+      tenant_proc = self.class._audit_log_tenant || RailsAuditLog.current_tenant
+      tenant_proc&.call
+    end
+
     def build_audit_metadata
       meta = {}
       if self.class._audit_log_meta

data/app/controllers/rails_audit_log/application_controller.rb

@@ -13,5 +13,10 @@ module RailsAuditLog
 
       instance_exec(self, &auth) || request_http_basic_authentication("Audit Log")
     end
+
+    def base_audit_scope
+      tenant_id = RailsAuditLog.current_tenant&.call
+      tenant_id ? AuditLogEntry.for_tenant(tenant_id) : AuditLogEntry.all
+    end
   end
 end

data/app/controllers/rails_audit_log/audit_log_entries_controller.rb

@@ -21,7 +21,7 @@ module RailsAuditLog
     end
 
     def filtered_scope
-      scope = AuditLogEntry.order(created_at: :desc)
+      scope = base_audit_scope.order(created_at: :desc)
       scope = scope.where(event: @event)                          if @event
       scope = scope.where(item_type: @item_type)                  if @item_type
       scope = scope.for_period(@period)                           if @period

data/app/controllers/rails_audit_log/resources_controller.rb

@@ -5,7 +5,7 @@ module RailsAuditLog
       @item_type = params[:item_type]
       @item_id   = params[:item_id]
       @pagy, @entries = pagy(
-        AuditLogEntry
+        base_audit_scope
           .where(item_type: @item_type, item_id: @item_id)
           .order(created_at: :asc)
       )

data/app/models/rails_audit_log/audit_log_entry.rb

@@ -91,6 +91,16 @@ module RailsAuditLog
       end
     }
 
+    # Entries belonging to a specific tenant.
+    # Composable with all other scopes.
+    #
+    # @param id [String, Integer] the tenant identifier stored in +tenant_id+
+    # @return [ActiveRecord::Relation]
+    # @example
+    #   AuditLogEntry.for_tenant("acme")
+    #   AuditLogEntry.for_tenant(Current.tenant_id).updated_events
+    scope :for_tenant, ->(id) { where(tenant_id: id) }
+
     # @!endgroup
 
     # @!group Time scopes

data/lib/generators/rails_audit_log/tenant/templates/add_tenant_id_to_audit_log_entries.rb

@@ -0,0 +1,6 @@
+class AddTenantIdToAuditLogEntries < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :audit_log_entries, :tenant_id, :string
+    add_index  :audit_log_entries, :tenant_id
+  end
+end

data/lib/generators/rails_audit_log/tenant/tenant_generator.rb

@@ -0,0 +1,33 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module RailsAuditLog
+  module Generators
+    class TenantGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates a migration that adds a tenant_id column and index to audit_log_entries."
+
+      def create_migration_file
+        migration_template(
+          "add_tenant_id_to_audit_log_entries.rb",
+          "db/migrate/add_tenant_id_to_audit_log_entries.rb"
+        )
+      end
+
+      def print_next_steps
+        say ""
+        say "Next steps:", :green
+        say "  1. Run `bin/rails db:migrate` to add the tenant_id column."
+        say "  2. Set a global resolver in your initializer:"
+        say "       RailsAuditLog.current_tenant { Current.tenant_id }"
+        say "     or per-model:"
+        say "       audit_log tenant: -> { Current.tenant_id }"
+        say "  3. Use AuditLogEntry.for_tenant(id) to scope queries to a tenant."
+        say ""
+      end
+    end
+  end
+end

data/lib/rails_audit_log/version.rb

@@ -1,3 +1,3 @@
 module RailsAuditLog
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/rails_audit_log.rb

@@ -114,6 +114,35 @@ module RailsAuditLog
     yield self
   end
 
+  # Sets or returns the global tenant resolver block. The block is called at
+  # write time and its return value is stored in the +tenant_id+ column of each
+  # {AuditLogEntry}. Override per-model with <tt>audit_log tenant: -> { ... }</tt>.
+  #
+  # @yield block called with no arguments at write time; return the tenant id
+  # @return [Proc, nil] the stored block, or +nil+ when not configured
+  # @example
+  #   RailsAuditLog.current_tenant { Current.tenant_id }
+  def self.current_tenant(&block)
+    @current_tenant = block if block_given?
+    @current_tenant
+  end
+
+  # Wires {.current_tenant} to +ActsAsTenant.current_tenant&.id+ so audit
+  # entries are automatically scoped to the Acts As Tenant context.
+  # Call once in an initializer after the gem is loaded.
+  #
+  # @raise [RuntimeError] if the +acts_as_tenant+ gem is not loaded
+  # @return [void]
+  # @example
+  #   RailsAuditLog.acts_as_tenant!
+  def self.acts_as_tenant!
+    unless defined?(ActsAsTenant)
+      raise "ActsAsTenant is not loaded. Add the `acts_as_tenant` gem to your Gemfile."
+    end
+
+    current_tenant { ActsAsTenant.current_tenant&.id }
+  end
+
   # Sets or returns the authentication block used to gate the web dashboard.
   # The block is evaluated in controller context, so controller helpers
   # (e.g. +current_user+) are available directly.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -118,6 +118,8 @@ files:
 - lib/generators/rails_audit_log/install/templates/create_audit_log_entries.rb
 - lib/generators/rails_audit_log/migrate_from_paper_trail/migrate_from_paper_trail_generator.rb
 - lib/generators/rails_audit_log/migrate_from_paper_trail/templates/migrate_from_paper_trail.rb
+- lib/generators/rails_audit_log/tenant/templates/add_tenant_id_to_audit_log_entries.rb
+- lib/generators/rails_audit_log/tenant/tenant_generator.rb
 - lib/rails_audit_log.rb
 - lib/rails_audit_log/engine.rb
 - lib/rails_audit_log/matchers.rb