rails_audit_log 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3323e92d5f10ecd832a198a65bf6e0fd65c7bf0ff35069230bc8b7791d14e7fa
-  data.tar.gz: 4cd882a647d273ee3fe8a6c7b7f89a3b241ee0fa9b22b84aed93b8aea2a30c6d
+  metadata.gz: 5cd71899d109aa978910a72ef144aeafb601dc70790e044ef723b49d1d560f65
+  data.tar.gz: 8884deec2a0abf63f14639794d6ac614689c9799e09b375ffc0cc7d788943e7d
 SHA512:
-  metadata.gz: 7c8d577a7b027d8c300b62545930e94798967f5cdc7f57d4d84a06b3f1968d1357b6ea1db9ae8abf1cb3e36bda8e6fd12be6c2da0798cf7d6d6a02e60849621c
-  data.tar.gz: 69a905ee623f28403c53d280a56009cd81696406e22ff2f258ef2d0ec56fc4d7a154f72a0a345557ec8a39e0b36b655b3fba7c1a128bee954834e73d537946b6
+  metadata.gz: c32ada5189eda30461ea1dbc10a67982fb0ff6c4244da4339aa3376082b38a5272bb3a1b91fe50110c08ae9ee0ae3ede52d2a43701c0f7260a4d5a6581c0f42d
+  data.tar.gz: 448becbb80428dd754bca4d1ab43625de5ec85a2c9d712e9e4a28f7c14b0c18ce6865b25dfd9ea6c46f7b1814988d0eea77ae8b6aee7a230927cc37a80f60cf3

data/README.md

@@ -23,6 +23,14 @@ bin/rails generate rails_audit_log:install
 bin/rails db:migrate
 ```
 
+Optionally scaffold a commented initializer with every configuration option:
+
+```bash
+bin/rails generate rails_audit_log:initializer
+```
+
+This creates `config/initializers/rails_audit_log.rb` with all settings documented as commented examples inside a `RailsAuditLog.configure` block.
+
 ## Usage
 
 ### Tracking a model
@@ -384,6 +392,76 @@ To save storage at the cost of reduced reification accuracy, switch to diff-only
 RailsAuditLog.store_snapshot = false
 ```
 
+### Test helper
+
+`without_audit_log` silences audit tracking inside the block — useful in FactoryBot factories and seed data to avoid noise in the audit trail:
+
+```ruby
+# spec/rails_helper.rb (or spec/support/factory_helpers.rb)
+require "rails_audit_log/test_helpers"
+
+RSpec.configure do |config|
+  config.include RailsAuditLog::TestHelpers
+end
+
+# Or include directly in FactoryBot definitions:
+FactoryBot.define do
+  factory :post do
+    after(:create) { |p| without_audit_log { p.update!(cached_at: Time.current) } }
+  end
+end
+```
+
+`without_audit_log` is a prefix-free wrapper around `RailsAuditLog.disable` — thread-safe and restores tracking even if the block raises.
+
+### Minitest assertions
+
+Add to your `test/test_helper.rb`:
+
+```ruby
+require "rails_audit_log/minitest_assertions"
+
+class ActiveSupport::TestCase
+  include RailsAuditLog::MinitestAssertions
+end
+```
+
+Then use the assertions in any test:
+
+```ruby
+assert_audit_log_entry post                                      # any entry
+assert_audit_log_entry post, event: :update                      # update entry
+assert_audit_log_entry post, event: :update, touching: :title    # touching title
+refute_audit_log_entry post, event: :update                      # no update entry
+assert_audit_log_entry post, event: :update, message: "custom"  # custom failure message
+```
+
+### RSpec matchers
+
+Add to your `spec/rails_helper.rb` (or `spec_helper.rb`):
+
+```ruby
+require "rails_audit_log/matchers"
+
+RSpec.configure do |config|
+  config.include RailsAuditLog::Matchers
+end
+```
+
+Then use the matchers in any spec:
+
+```ruby
+# Assert a record has a matching audit entry
+expect(post).to have_audit_log_entry
+expect(post).to have_audit_log_entry(:update)
+expect(post).to have_audit_log_entry(:update).touching(:title)
+
+# Assert a block creates a matching audit entry
+expect { post.update!(title: "New") }.to create_audit_log_entry
+expect { post.update!(title: "New") }.to create_audit_log_entry(event: :update)
+expect { post.update!(title: "New") }.to create_audit_log_entry(event: :update).touching(:title)
+```
+
 ## Requirements
 
 - Ruby >= 3.3

data/app/concerns/rails_audit_log/auditable.rb

@@ -10,6 +10,8 @@ module RailsAuditLog
       class_attribute :_audit_log_version_limit,  default: nil
       class_attribute :_audit_log_async,          default: false
 
+      _warn_if_audit_table_missing
+
       has_many :audit_log_entries,
                class_name: "RailsAuditLog::AuditLogEntry",
                as: :item,
@@ -52,6 +54,18 @@ module RailsAuditLog
     end
 
     class_methods do
+      def _warn_if_audit_table_missing
+        return if connection.table_exists?("audit_log_entries")
+
+        warn "[RailsAuditLog] WARNING: #{name} includes RailsAuditLog::Auditable but the " \
+             "'audit_log_entries' table does not exist. " \
+             "Run `bin/rails generate rails_audit_log:install && bin/rails db:migrate` to create it."
+      rescue ActiveRecord::NoDatabaseError,
+             ActiveRecord::ConnectionNotEstablished,
+             ActiveRecord::StatementInvalid
+        # DB not reachable during this phase (e.g. before db:create) — skip the check
+      end
+
       def audit_log(only: nil, ignore: nil, meta: nil, associations: nil, version_limit: nil, async: nil)
         self._audit_log_only          = only.map(&:to_s)   if only
         self._audit_log_ignore        = ignore.map(&:to_s) if ignore

data/lib/generators/rails_audit_log/initializer/initializer_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators"
+
+module RailsAuditLog
+  module Generators
+    class InitializerGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates a commented RailsAuditLog initializer in config/initializers."
+
+      def create_initializer_file
+        template "rails_audit_log.rb", "config/initializers/rails_audit_log.rb"
+      end
+    end
+  end
+end

data/lib/generators/rails_audit_log/initializer/templates/rails_audit_log.rb

@@ -0,0 +1,31 @@
+# config/initializers/rails_audit_log.rb
+# Generated by `bin/rails generate rails_audit_log:initializer`
+#
+# All settings are optional. Remove the comments around any line you want to activate.
+
+RailsAuditLog.configure do |config|
+  # Global columns excluded from all audited models. Default: ["updated_at"]
+  # config.ignored_attributes = %w[updated_at cached_at]
+
+  # Store a full attribute snapshot alongside object_changes. Default: true
+  # Disable to save storage; reify and version_at fall back to diff-only reconstruction.
+  # config.store_snapshot = false
+
+  # Capture remote_ip and user_agent into each entry's metadata column. Default: false
+  # Requires including RailsAuditLog::Controller in ApplicationController.
+  # config.capture_request_metadata = true
+
+  # Customise how the actor's display name is stored at write time. Default: actor.name
+  # config.whodunnit_display = ->(actor) { actor.email }
+
+  # Global cap on entries retained per tracked record. Default: nil (no limit)
+  # Per-model `audit_log version_limit: N` takes precedence.
+  # config.version_limit = 100
+
+  # Write all audit entries asynchronously via WriteAuditLogJob. Default: false
+  # Per-model `audit_log async: true` also works.
+  # config.async = true
+
+  # Route AuditLogEntry to a dedicated database (Rails multi-DB). Default: nil
+  # config.connects_to = { database: { writing: :audit_log, reading: :audit_log } }
+end

data/lib/rails_audit_log/matchers.rb

@@ -0,0 +1,103 @@
+module RailsAuditLog
+  module Matchers
+    def have_audit_log_entry(event = nil)
+      HaveAuditLogEntry.new(event)
+    end
+
+    def create_audit_log_entry(event: nil, touching: nil)
+      CreateAuditLogEntry.new(event: event, touching: touching)
+    end
+
+    class HaveAuditLogEntry
+      def initialize(event)
+        @event    = event
+        @touching = nil
+      end
+
+      def touching(attribute)
+        @touching = attribute
+        self
+      end
+
+      def matches?(record)
+        @record = record
+        scope = record.audit_log_entries
+        scope = scope.where(event: @event.to_s) if @event
+        scope = scope.touching(@touching)       if @touching
+        scope.exists?
+      end
+
+      def failure_message
+        "expected #{@record.class}##{@record.id} to have an audit log entry#{qualifier}"
+      end
+
+      def failure_message_when_negated
+        "expected #{@record.class}##{@record.id} not to have an audit log entry#{qualifier}"
+      end
+
+      def description
+        "have an audit log entry#{qualifier}"
+      end
+
+      private
+
+      def qualifier
+        parts = []
+        parts << " with event '#{@event}'" if @event
+        parts << " touching '#{@touching}'" if @touching
+        parts.join
+      end
+    end
+
+    class CreateAuditLogEntry
+      def initialize(event:, touching:)
+        @event    = event
+        @touching = touching
+      end
+
+      def touching(attribute)
+        @touching = attribute
+        self
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      def matches?(block)
+        @before = matching_scope.count
+        block.call
+        @after = matching_scope.count
+        @after > @before
+      end
+
+      def failure_message
+        "expected block to create an audit log entry#{qualifier}, but none was created"
+      end
+
+      def failure_message_when_negated
+        "expected block not to create an audit log entry#{qualifier}, but one was created"
+      end
+
+      def description
+        "create an audit log entry#{qualifier}"
+      end
+
+      private
+
+      def matching_scope
+        scope = RailsAuditLog::AuditLogEntry.all
+        scope = scope.where(event: @event.to_s) if @event
+        scope = scope.touching(@touching)       if @touching
+        scope
+      end
+
+      def qualifier
+        parts = []
+        parts << " with event '#{@event}'" if @event
+        parts << " touching '#{@touching}'" if @touching
+        parts.join
+      end
+    end
+  end
+end

data/lib/rails_audit_log/minitest_assertions.rb

@@ -0,0 +1,31 @@
+module RailsAuditLog
+  module MinitestAssertions
+    def assert_audit_log_entry(record, event: nil, touching: nil, message: nil)
+      scope = build_scope(record, event, touching)
+      msg   = message || default_message("to have", record, event, touching)
+      assert scope.exists?, msg
+    end
+
+    def refute_audit_log_entry(record, event: nil, touching: nil, message: nil)
+      scope = build_scope(record, event, touching)
+      msg   = message || default_message("not to have", record, event, touching)
+      refute scope.exists?, msg
+    end
+
+    private
+
+    def build_scope(record, event, touching)
+      scope = record.audit_log_entries
+      scope = scope.where(event: event.to_s) if event
+      scope = scope.touching(touching)       if touching
+      scope
+    end
+
+    def default_message(polarity, record, event, touching)
+      parts = []
+      parts << " with event '#{event}'" if event
+      parts << " touching '#{touching}'" if touching
+      "Expected #{record.class}##{record.id} #{polarity} an audit log entry#{parts.join}"
+    end
+  end
+end

data/lib/rails_audit_log/test_helpers.rb

@@ -0,0 +1,7 @@
+module RailsAuditLog
+  module TestHelpers
+    def without_audit_log(&block)
+      RailsAuditLog.disable(&block)
+    end
+  end
+end

data/lib/rails_audit_log/version.rb

@@ -1,3 +1,3 @@
 module RailsAuditLog
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/rails_audit_log.rb

@@ -5,6 +5,10 @@ module RailsAuditLog
   # Global default columns to ignore across all audited models.
   # Override in an initializer: RailsAuditLog.ignored_attributes = %w[updated_at cached_at]
   mattr_accessor :ignored_attributes, default: %w[updated_at]
+
+  def self.configure
+    yield self
+  end
   mattr_accessor :store_snapshot, default: true
   mattr_accessor :capture_request_metadata, default: false
   mattr_accessor :version_limit, default: nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -46,10 +46,15 @@ files:
 - app/models/rails_audit_log/audit_log_entry.rb
 - app/views/layouts/rails_audit_log/application.html.erb
 - config/routes.rb
+- lib/generators/rails_audit_log/initializer/initializer_generator.rb
+- lib/generators/rails_audit_log/initializer/templates/rails_audit_log.rb
 - lib/generators/rails_audit_log/install/install_generator.rb
 - lib/generators/rails_audit_log/install/templates/create_audit_log_entries.rb
 - lib/rails_audit_log.rb
 - lib/rails_audit_log/engine.rb
+- lib/rails_audit_log/matchers.rb
+- lib/rails_audit_log/minitest_assertions.rb
+- lib/rails_audit_log/test_helpers.rb
 - lib/rails_audit_log/version.rb
 - lib/tasks/rails_audit_log_tasks.rake
 homepage: https://github.com/eclectic-coding/rails_audit_log