如何为所有Rails模型动态配置Ransack可搜索关联？

问题场景 #

此前代码运行正常，安装gem 'ipaddress'后，所有已创建的模型均触发错误：

Ransack needs <MODEL_NAME> associations explicitly allowlisted as searchable.

常规做法是在每个模型里手动定义ransackable_associations类方法，比如User模型的示例：

class User < ApplicationRecord
  # ...

  def self.ransackable_associations(auth_object = nil)
    ["comments", "created_by", "favorites", "impressions_by_user", "updated_by", "user_group"]
  end

  # ...
end

但这种方式需要为每个模型重复编写，效率低下，且难以统一维护敏感关联的排除规则。

动态实现方案 #

通过ActiveRecord模型基类扩展的方式，统一实现动态获取可搜索关联的逻辑，同时排除指定敏感关联。

步骤1：创建模型扩展文件 #

在app/models/concerns/ransackable.rb中添加以下代码：

module Ransackable
  extend ActiveSupport::Concern

  class_methods do
    # 全局定义需要排除的敏感关联，可按需补充
    def excluded_ransack_associations
      ["encrypted_password", "password_reset_token", "owner"]
    end

    def ransackable_associations(auth_object = nil)
      # 获取模型所有关联名称，排除敏感项后返回
      reflect_on_all_associations.map(&:name).map(&:to_s) - excluded_ransack_associations
    end
  end
end

步骤2：在基类中引入扩展 #

修改app/models/application_record.rb，让所有模型自动继承该扩展：

class ApplicationRecord < ActiveRecord::Base
  self.abstract_class = true
  include Ransackable # 引入扩展
end

自定义排除规则（可选） #

如果某个模型需要额外排除特定关联，只需在该模型中重写excluded_ransack_associations方法：

class AdminUser < ApplicationRecord
  def self.excluded_ransack_associations
    super + ["secret_notes", "audit_logs"] # 在全局排除规则基础上新增
  end
end

补充说明 #

• 该方案自动获取模型所有关联，过滤全局或模型自定义的敏感关联，无需逐个模型手动编写ransackable_associations。
• 若需根据权限（auth_object）设置不同可搜索关联，可在ransackable_associations方法中加入角色判断逻辑，进一步细化规则。

内容的提问来源于stack exchange，提问作者B. Cratty