auditron 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44f360e57980c1ff2fd3b0c87daefd2bad45eb643b588cd38dea1e5912f2af80
-  data.tar.gz: 1f14c7d53bd1689b5ee39e5b5bc1fc99d05bf58d2e5f0426287193a95b3edb72
+  metadata.gz: 8d81d9849d620fd0965ee9e42495554abb5c9cb3d03db2768dbde6cc6cf84933
+  data.tar.gz: ab9d9baceb9c1942f9f52e9c8863e29843378bb481d299e6f84d1dffed47409e
 SHA512:
-  metadata.gz: 278d96b4441fa49d9f4124dff4ac5917c4ab38b09265e53d2346bea57140771dece7d3f70e0049ea6d33f31aa53b7d0e08541f3521e7a233e9f2821a55e5ddf9
-  data.tar.gz: 56c8b00ff1b7d71f7b6a7942039fd19c70c4a7716a9cafdf9f54545bcdaf2898741a2610b088c6f844625e8ba0a6fd4d4123c5830498efeff30372e7ffd3e5a3
+  metadata.gz: bfe04d8854fc308a4552d19497531eed265b052bc9da3b609a60ad72ca86ba34b6450bdcb74efdb4fd291bbba7ccca320de3fbc32f0c276315c2445f668ac119
+  data.tar.gz: 2171c1878c75b9097896348329017adb349026dec846827d463ea2ae78a5cc1aae6f4236ef0761f306dae169748f1e845501166030cba00cfacd55ab7173b34f

data/CHANGELOG.md

@@ -7,6 +7,155 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [1.1.0] - 2026-04-10
+
+### Added
+
+#### Interactive initializer — zero-config setup in one command
+
+`rails generate auditron:install` now walks the developer through a short
+wizard and **automatically creates `config/initializers/auditron.rb`** — no
+manual file creation, no copy-pasting from the README.
+
+**Before (1.0.x):**
+```
+rails generate auditron:install
+  → creates db/migrate/create_audit_logs.rb
+  → prints "Next steps: create config/initializers/auditron.rb manually"
+```
+
+**After (1.1.0):**
+```
+rails generate auditron:install
+  → Step 1: creates db/migrate/create_audit_logs.rb
+  → Step 2: asks 4 quick questions, writes config/initializers/auditron.rb
+```
+
+The wizard asks:
+
+| Prompt | Config written | Default |
+|--------|---------------|---------|
+| Ignored fields | `config.ignored_fields` | `[:updated_at, :created_at]` |
+| Store IP address? | `config.store_ip` | `false` |
+| Retention period (days) | `config.retention_days` | `nil` (keep forever) |
+| Current actor method | Comment example in initializer | `current_user` |
+
+Every prompt has a default — pressing Enter on all four produces a working
+initializer instantly. The generated file looks like:
+
+```ruby
+# frozen_string_literal: true
+
+# Auditron configuration
+# Generated by: rails generate auditron:install
+# Auditron version: 1.1.0
+
+Auditron.configure do |config|
+
+  # ── Ignored Fields ───────────────────────────────────────────────────
+  # Fields excluded from change tracking across all auditable models.
+  config.ignored_fields = [:updated_at, :created_at]
+
+  # ── IP Tracking ──────────────────────────────────────────────────────
+  # When true, the actor's remote IP is stored on every audit log.
+  config.store_ip = false
+
+  # ── Retention ────────────────────────────────────────────────────────
+  # Auto-purge logs older than this many days. nil = keep forever.
+  config.retention_days = nil
+
+  # ── Actor Resolution ─────────────────────────────────────────────────
+  # Set Auditron.current_actor in a before_action in your controller.
+  # Example (ApplicationController):
+  #   before_action :set_audit_actor
+  #   def set_audit_actor
+  #     Auditron.current_actor = current_user
+  #   end
+
+end
+```
+
+Re-running the generator overwrites the existing initializer — useful when
+onboarding new environments or resetting config to a clean state.
+
+#### ASCII logo in generator output
+
+The generator now displays an AUDITRON block-character logo on startup:
+
+```
+  █████╗ ██╗   ██╗██████╗ ██╗████████╗██████╗  ██████╗ ███╗   ██╗
+ ██╔══██╗██║   ██║██╔══██╗██║╚══██╔══╝██╔══██╗██╔═══██╗████╗  ██║
+ ███████║██║   ██║██║  ██║██║   ██║   ██████╔╝██║   ██║██╔██╗ ██║
+ ██╔══██║██║   ██║██║  ██║██║   ██║   ██╔══██╗██║   ██║██║╚██╗██║
+ ██║  ██║╚██████╔╝██████╔╝██║   ██║   ██║  ██║╚██████╔╝██║ ╚████║
+ ╚═╝  ╚═╝ ╚═════╝ ╚═════╝ ╚═╝   ╚═╝   ╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═══╝
+
+               Audit Logging for Rails  ─── v1.1.0
+```
+
+All generator output goes through `$stdout` directly — Thor's buffering is
+bypassed entirely to prevent the duplicate-output issue seen in some
+Thor / Rails version combinations.
+
+### Changed
+
+- Generator install flow split into two clearly labelled steps:
+  **Step 1: Migration** and **Step 2: Initializer**
+- Post-install "Next steps" section updated — manual initializer creation
+  instruction removed since the file is now written automatically
+- Generator intro updated to list initializer creation as part of what
+  the installer does
+
+### Removed
+
+- Manual `config/initializers/auditron.rb` instructions removed from
+  post-install output — no longer needed since the generator creates it
+
+---
+
+## [1.0.1] - 2026-04-08
+
+### Fixed
+
+- **Migration version hardcoded to `[7.0]`** — the generated `create_audit_logs`
+  migration previously always inherited from `ActiveRecord::Migration[7.0]`
+  regardless of the host application's Rails version. Running
+  `rails generate auditron:install` on a Rails 7.1, 7.2, or 8.0 app would
+  generate an incorrect migration class header.
+
+  The generator now reads `ActiveRecord::VERSION::MAJOR` and
+  `ActiveRecord::VERSION::MINOR` at generation time and injects the correct
+  version bracket automatically:
+
+  ```ruby
+  # Before (hardcoded — wrong on Rails 7.1+)
+  class CreateAuditLogs < ActiveRecord::Migration[7.0]
+
+  # After (dynamic — always matches the host app)
+  class CreateAuditLogs < ActiveRecord::Migration[7.1]   # on Rails 7.1
+  class CreateAuditLogs < ActiveRecord::Migration[7.2]   # on Rails 7.2
+  class CreateAuditLogs < ActiveRecord::Migration[8.0]   # on Rails 8.0
+  ```
+
+- **`ArgumentError: wrong number of arguments (given 3, expected 0)`** on
+  `rails generate auditron:install` when running Rails 7.1+.
+
+  Rails 7.1 removed the third positional options hash from `migration_template`.
+  Passing `migration_version:` as a keyword argument to `migration_template`
+  caused an `ArgumentError` crash immediately after the user confirmed
+  installation — no files were created.
+
+  The generator now sets `@migration_version` as an instance variable before
+  calling `migration_template`, which makes it available inside the ERB
+  template directly. This approach is compatible with Rails 6.0 through 8.x.
+
+### Compatibility
+
+This release is fully backwards-compatible. No changes to public API,
+configuration, model DSL, or query interface.
+
+---
+
 ## [1.0.0] - 2026-04-04
 
 ### Added
@@ -61,7 +210,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Compatibility
 
-- Ruby `>= 3.0`
-- ActiveRecord `>= 7.0`
-- Rails `>= 7.0` (optional)
-- PostgreSQL, MySQL, SQLite
+| Version | Ruby    | ActiveRecord | Rails         | Databases                  |
+|---------|---------|--------------|---------------|----------------------------|
+| 1.1.0   | >= 3.0  | >= 7.0       | >= 7.0 (opt.) | PostgreSQL, MySQL, SQLite  |
+| 1.0.1   | >= 3.0  | >= 7.0       | >= 7.0 (opt.) | PostgreSQL, MySQL, SQLite  |
+| 1.0.0   | >= 3.0  | >= 7.0       | >= 7.0 (opt.) | PostgreSQL, MySQL, SQLite  |

data/README.md

@@ -1,5 +1,8 @@
 # Auditron
 
+
+[![Gem Version](https://badge.fury.io/rb/auditron.svg?icon=si%3Arubygems&icon_color=%23ce0303)](https://badge.fury.io/rb/auditron)
+![GitHub Repo Views](https://gitviews.com/repo/spatelpatidar/auditron.svg)
 > Audit logging for API-first Rails apps — built-in retention, flexible actor tracking, and a clean query DSL.
 
 ---

data/lib/auditron/audit_log.rb

@@ -43,6 +43,7 @@ module Auditron
 
     def changed_fields
       value = self[:changed_fields]
+      return {} if value.nil?
       return value if value.is_a?(Hash)
       JSON.parse(value.to_s)
     rescue JSON::ParserError

data/lib/auditron/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Auditron
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/generators/auditron/install/install_generator.rb

@@ -11,110 +11,268 @@ module Auditron
       source_root File.expand_path("templates", __dir__)
 
       def install
-        display_banner
-        display_intro
+        print_logo
+        print_intro
         return cancel_install unless confirm_install?
 
-        say ""
-        say "  Creating migration...", :cyan
+        # ── Step 1: Migration ────────────────────────────────────────────────
+        puts_out ""
+        puts_out cyan("  ┌─ Step 1: Migration ──────────────────────────────────────────────┐")
+        puts_out ""
+        puts_out "  \e[37mCreating audit_logs migration...\e[0m"
+        puts_out ""
+
+        @migration_version = migration_version
         migration_template(
           "create_audit_logs.rb.erb",
           "db/migrate/create_audit_logs.rb"
         )
-        say ""
 
-        display_initializer_hint
-        display_success
+        # ── Step 2: Initializer ──────────────────────────────────────────────
+        puts_out ""
+        puts_out cyan("  ┌─ Step 2: Initializer ────────────────────────────────────────────┐")
+        puts_out ""
+
+        @cfg = {}
+        collect_ignored_fields
+        collect_store_ip
+        collect_retention_days
+        collect_actor_method
+
+        write_initializer
+
+        print_next_steps
+        print_done
       end
 
       private
 
-      def display_banner
-        say ""
-        say "  +===================================================+", :cyan
-        say "  |                                                   |", :cyan
-        say "  |       AUDITRON  --  Audit Logging Gem             |", :cyan
-        say "  |                    v#{Auditron::VERSION.ljust(6)}                        |", :cyan
-        say "  |                                                   |", :cyan
-        say "  +===================================================+", :cyan
-        say ""
-      end
-
-      def display_intro
-        say "  Auditron will set up audit logging for your Rails app.", :white
-        say ""
-        say "  This installer will:", :white
-        say ""
-        say "    [+]  Create the audit_logs migration", :green
-        say "    [+]  Add indexes for fast querying", :green
-        say "    [+]  Track: auditable, actor, action, changed fields, IP", :green
-        say ""
-        say "  ---------------------------------------------------", :cyan
-        say ""
-        say "  After install, add to any model:", :yellow
-        say ""
-        say "    class User < ApplicationRecord", :white
-        say "      auditable only: [:email, :role, :status]", :green
-        say "    end", :white
-        say ""
-        say "  ---------------------------------------------------", :cyan
-        say ""
+      # =========================================================================
+      # Interactive config collection
+      # =========================================================================
+
+      def collect_ignored_fields
+        puts_out "  \e[37mIgnored fields\e[0m"
+        puts_out "  \e[33m  (Comma-separated field names to exclude from change tracking)\e[0m"
+        puts_out "  \e[33m  (Press Enter to use default: updated_at, created_at)\e[0m"
+        print_out "  \e[36m›\e[0m \e[33m[updated_at, created_at]\e[0m: "
+
+        raw = $stdin.gets.to_s.strip
+        if raw.empty?
+          @cfg[:ignored_fields] = %i[updated_at created_at]
+        else
+          @cfg[:ignored_fields] = raw.split(",").map { |f| f.strip.to_sym }
+        end
+        puts_out ""
       end
 
-      def confirm_install?
-        answer = ask(
-          "  Ready to install? This will create the audit_logs migration. [Y/n]:",
-          :yellow
-        ).strip.downcase
+      def collect_store_ip
+        puts_out "  \e[37mStore IP address\e[0m"
+        puts_out "  \e[33m  (When true, the actor's IP is saved on every audit log)\e[0m"
+        print_out "  \e[36m  Store IP in audit logs? (y/n)\e[0m "
+
+        answer = $stdin.gets.to_s.strip.downcase
+        @cfg[:store_ip] = answer.start_with?("y")
+        puts_out ""
+      end
+
+      def collect_retention_days
+        puts_out "  \e[37mRetention period\e[0m"
+        puts_out "  \e[33m  (Auto-delete audit logs older than N days. Press Enter to keep forever)\e[0m"
+        print_out "  \e[36m›\e[0m \e[33m[nil — keep forever]\e[0m: "
+
+        raw = $stdin.gets.to_s.strip
+        @cfg[:retention_days] = raw.empty? ? nil : raw.to_i
+        puts_out ""
+      end
+
+      def collect_actor_method
+        puts_out "  \e[37mCurrent actor method\e[0m"
+        puts_out "  \e[33m  (The controller method / variable that returns the logged-in user)\e[0m"
+        print_out "  \e[36m›\e[0m \e[33m[current_user]\e[0m: "
+
+        raw = $stdin.gets.to_s.strip
+        @cfg[:actor_method] = raw.empty? ? "current_user" : raw
+        puts_out ""
+      end
+
+      # =========================================================================
+      # Write initializer
+      # =========================================================================
+
+      def write_initializer
+        dir  = File.join(destination_root, "config", "initializers")
+        path = File.join(dir, "auditron.rb")
+        FileUtils.mkdir_p(dir)
+        File.write(path, build_initializer_content)
+        puts_out "\e[32m  ✅  Created config/initializers/auditron.rb\e[0m"
+        puts_out ""
+      end
+
+      def build_initializer_content
+        ignored = @cfg[:ignored_fields].map { |f| ":#{f}" }.join(", ")
+        retention = @cfg[:retention_days].nil? ? "nil" : @cfg[:retention_days].to_s
+
+        b = Lines.new
+        b << "# frozen_string_literal: true"
+        b << ""
+        b << "# Auditron configuration"
+        b << "# Generated by: rails generate auditron:install"
+        b << "# Auditron version: #{Auditron::VERSION}"
+        b << ""
+        b << "Auditron.configure do |config|"
+        b << ""
+        b << "  # ── Ignored Fields ───────────────────────────────────────────────────"
+        b << "  # Fields excluded from change tracking across all auditable models."
+        b << "  config.ignored_fields = [#{ignored}]"
+        b << ""
+        b << "  # ── IP Tracking ──────────────────────────────────────────────────────"
+        b << "  # When true, the actor's remote IP is stored on every audit log."
+        b << "  config.store_ip = #{@cfg[:store_ip]}"
+        b << ""
+        b << "  # ── Retention ────────────────────────────────────────────────────────"
+        b << "  # Auto-purge logs older than this many days. nil = keep forever."
+        b << "  config.retention_days = #{retention}"
+        b << ""
+        b << "  # ── Actor Resolution ─────────────────────────────────────────────────"
+        b << "  # Proc called to resolve the current actor from the request context."
+        b << "  # Set Auditron.current_actor in a before_action in your controller."
+        b << "  # Example (ApplicationController):"
+        b << "  #   before_action :set_audit_actor"
+        b << "  #   def set_audit_actor"
+        b << "  #     Auditron.current_actor = #{@cfg[:actor_method]}"
+        b << "  #   end"
+        b << ""
+        b << "end"
+        b << ""
+        b.to_s
+      end
+
+      # =========================================================================
+      # Logo & intro
+      # =========================================================================
+
+      LOGO = <<~LOGO
+
+           █████╗ ██╗   ██╗██████╗ ██╗████████╗██████╗  ██████╗ ███╗   ██╗
+          ██╔══██╗██║   ██║██╔══██╗██║╚══██╔══╝██╔══██╗██╔═══██╗████╗  ██║
+          ███████║██║   ██║██║  ██║██║   ██║   ██████╔╝██║   ██║██╔██╗ ██║
+          ██╔══██║██║   ██║██║  ██║██║   ██║   ██╔══██╗██║   ██║██║╚██╗██║
+          ██║  ██║╚██████╔╝██████╔╝██║   ██║   ██║  ██║╚██████╔╝██║ ╚████║
+          ╚═╝  ╚═╝ ╚═════╝ ╚═════╝ ╚═╝   ╚═╝   ╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═══╝
 
+                        Audit Logging for Rails  ─── v#{Auditron::VERSION}
+
+      LOGO
+
+      def print_logo
+        puts_out ""
+        LOGO.each_line { |line| $stdout.print "\e[36m#{line.chomp}\e[0m\n" }
+        puts_out ""
+        $stdout.flush
+      end
+
+      def print_intro
+        puts_out "  \e[36m#{"─" * 68}\e[0m"
+        puts_out ""
+        puts_out "  \e[37mThis wizard will:\e[0m"
+        puts_out ""
+        puts_out "    \e[32m[+]  Create the audit_logs migration\e[0m"
+        puts_out "    \e[32m[+]  Create config/initializers/auditron.rb\e[0m"
+        puts_out "    \e[32m[+]  Ask you a few quick questions to tailor the config\e[0m"
+        puts_out ""
+        puts_out "  \e[33m  All settings can be changed later by editing the initializer.\e[0m"
+        puts_out ""
+        puts_out "  \e[36m#{"─" * 68}\e[0m"
+        puts_out ""
+      end
+
+      # =========================================================================
+      # Confirm
+      # =========================================================================
+
+      def confirm_install?
+        print_out "\e[33m  Ready to install Auditron? (y/n) \e[0m"
+        answer = $stdin.gets.to_s.strip.downcase
         answer == "y" || answer == "yes" || answer == ""
       end
 
-      def display_initializer_hint
-        say "  ---------------------------------------------------", :cyan
-        say ""
-        say "  Next steps:", :white
-        say ""
-        say "    1.  Run the migration:", :yellow
-        say "          rails db:migrate", :green
-        say ""
-        say "    2.  Create config/initializers/auditron.rb:", :yellow
-        say "          Auditron.configure do |config|", :green
-        say "            config.ignored_fields = %i[updated_at created_at]", :green
-        say "            config.store_ip       = false", :green
-        say "            config.retention_days = nil", :green
-        say "          end", :green
-        say ""
-        say "    3.  Set current actor in ApplicationController:", :yellow
-        say "          before_action :set_audit_actor", :green
-        say "          def set_audit_actor", :green
-        say "            Auditron.current_actor = @current_user", :green
-        say "          end", :green
-        say ""
-        say "    4.  Add auditable to your models:", :yellow
-        say "          auditable only: [:email, :role]", :green
-        say ""
-        say "    5.  Query your logs:", :yellow
-        say "          user.audit_logs", :green
-        say "          AuditLog.by(admin).action(:deleted).since(1.week.ago)", :green
-        say ""
-        say "  ---------------------------------------------------", :cyan
-        say ""
-      end
-
-      def display_success
-        say "  [OK]  Auditron installed successfully!", :green
-        say "  [OK]  Run 'rails db:migrate' to complete setup.", :green
-        say ""
-        say "  Happy auditing!", :cyan
-        say ""
+      # =========================================================================
+      # Next steps & done
+      # =========================================================================
+
+      def print_next_steps
+        puts_out "  \e[36m#{"─" * 68}\e[0m"
+        puts_out ""
+        puts_out "  \e[37mNext steps:\e[0m"
+        puts_out ""
+        puts_out "    \e[33m1.  Run the migration:\e[0m"
+        puts_out "          \e[32mrails db:migrate\e[0m"
+        puts_out ""
+        puts_out "    \e[33m2.  Set current actor in ApplicationController:\e[0m"
+        puts_out "          \e[32mbefore_action :set_audit_actor\e[0m"
+        puts_out "          \e[32mdef set_audit_actor\e[0m"
+        puts_out "            \e[32mAuditron.current_actor = #{@cfg[:actor_method]}\e[0m"
+        puts_out "          \e[32mend\e[0m"
+        puts_out ""
+        puts_out "    \e[33m3.  Add auditable to your models:\e[0m"
+        puts_out "          \e[32mauditable only: [:email, :role]\e[0m"
+        puts_out ""
+        puts_out "    \e[33m4.  Query your logs:\e[0m"
+        puts_out "          \e[32muser.audit_logs\e[0m"
+        puts_out "          \e[32mAuditLog.by(admin).action(:deleted).since(1.week.ago)\e[0m"
+        puts_out ""
+        puts_out "  \e[36m#{"─" * 68}\e[0m"
+        puts_out ""
+      end
+
+      def print_done
+        puts_out "  \e[32m✅  Auditron installed successfully!\e[0m"
+        puts_out "  \e[32m✅  Run 'rails db:migrate' to complete setup.\e[0m"
+        puts_out ""
+        puts_out "  \e[36mHappy auditing!\e[0m"
+        puts_out ""
       end
 
       def cancel_install
-        say ""
-        say "  [CANCELLED]  Installation cancelled.", :red
-        say "  Run 'rails generate auditron:install' again when ready.", :yellow
-        say ""
+        puts_out ""
+        puts_out "  \e[31m[CANCELLED]  Installation cancelled.\e[0m"
+        puts_out "  \e[33mRun 'rails generate auditron:install' again when ready.\e[0m"
+        puts_out ""
+      end
+
+      # =========================================================================
+      # IO helpers — bypass Thor to prevent duplicate output
+      # =========================================================================
+
+      def puts_out(str = "")
+        $stdout.puts str
+        $stdout.flush
+      end
+
+      def print_out(str)
+        $stdout.print str
+        $stdout.flush
+      end
+
+      def cyan(str) = "\e[36m#{str}\e[0m"
+
+      # =========================================================================
+      # Migration version
+      # =========================================================================
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      # =========================================================================
+      # Line buffer for building file content
+      # =========================================================================
+
+      class Lines
+        def initialize = (@buf = [])
+        def <<(str)    = @buf << str
+        def to_s       = @buf.join("\n") + "\n"
       end
     end
   end

data/lib/generators/auditron/install/templates/create_audit_logs.rb.erb

@@ -1,21 +1,70 @@
-class CreateAuditLogs < ActiveRecord::Migration[7.0]
+# frozen_string_literal: true
+
+# Migration generated by Auditron <%= Auditron::VERSION %>
+# Rails version detected: ActiveRecord::Migration<%= @migration_version %>
+#
+# This migration is version-aware — @migration_version is set automatically
+# by the generator to match your app's installed Rails version.
+
+class CreateAuditLogs < ActiveRecord::Migration<%= @migration_version %>
   def change
+    # Detect database adapter to use correct JSON column type
+    # PostgreSQL supports jsonb (faster, indexable)
+    # MySQL and SQLite use json
+    json_type = postgresql? ? :jsonb : :json
+
     create_table :audit_logs do |t|
+      # ── The record being audited (polymorphic) ──────────────────────────
       t.string  :auditable_type, null: false
       t.bigint  :auditable_id,   null: false
+
+      # ── What happened ────────────────────────────────────────────────────
+      # Examples: "created", "updated", "deleted", "approved", "rejected"
       t.string  :action,         null: false
-      t.text    :changed_fields
+
+      # ── What changed (JSON serialised diff) ─────────────────────────────
+      # Stores before/after values: { "email": ["old@x.com", "new@x.com"] }
+      t.column  :changed_fields, json_type
+
+      # ── Who did it (polymorphic actor, e.g. User, AdminUser) ─────────────
       t.string  :actor_type
       t.bigint  :actor_id
+
+      # ── Request context ───────────────────────────────────────────────────
       t.string  :ip_address
-      t.text    :metadata
+      t.column  :metadata,       json_type
 
+      # ── Timestamp (no updated_at — audit logs are immutable) ─────────────
       t.datetime :created_at, null: false
     end
 
-    add_index :audit_logs, [:auditable_type, :auditable_id]
-    add_index :audit_logs, [:actor_type, :actor_id]
-    add_index :audit_logs, :action
-    add_index :audit_logs, :created_at
+    # ── Indexes ───────────────────────────────────────────────────────────
+    # Fetch all logs for a specific record (most common query)
+    add_index :audit_logs, %i[auditable_type auditable_id],
+              name: "idx_audit_logs_on_auditable"
+
+    # Fetch all actions performed by a specific actor
+    add_index :audit_logs, %i[actor_type actor_id],
+              name: "idx_audit_logs_on_actor"
+
+    # Filter by action type (e.g. all :deleted events)
+    add_index :audit_logs, :action,
+              name: "idx_audit_logs_on_action"
+
+    # Time-range queries and retention cleanup
+    add_index :audit_logs, :created_at,
+              name: "idx_audit_logs_on_created_at"
+
+    # GIN index only available on PostgreSQL with jsonb
+    if postgresql?
+      add_index :audit_logs, :changed_fields, using: :gin
+      add_index :audit_logs, :metadata,       using: :gin
+    end
+  end
+
+  private
+
+  def postgresql?
+    ActiveRecord::Base.connection.adapter_name.downcase.include?("postgresql")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auditron
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Shailendra Kumar
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-08 00:00:00.000000000 Z
+date: 2026-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -155,7 +155,7 @@ metadata:
   homepage_uri: https://github.com/spatelpatidar/auditron
   source_code_uri: https://github.com/spatelpatidar/auditron
   changelog_uri: https://github.com/spatelpatidar/auditron/blob/main/CHANGELOG.md
-  bug_tracker_uri: https://github.com/spatelpatidar/auditron/auditron/issues
+  bug_tracker_uri: https://github.com/spatelpatidar/auditron/issues
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []