Using ransackable_attributes with Active Admin errors when using Active Storage #8077

vic778 · 2023-09-22T14:47:11Z

vic778
Sep 22, 2023

I'm using active admin gem for the admin dashboard. I have never faced same the ransackable error since I've used it, I have the user model which has the active storage so I got this error

Define a `ransackable_attributes` class method in your `ActiveStorage::Attachment` model

, yet rails don't create the active storage class in the model folder. I've done research about how to fix that but I didn't find a proper way.
So as I said here is what the gem error shows like a solution

class ActiveStorage::Attachment < ApplicationRecord
  def self.ransackable_attributes(auth_object = nil)
    ["blob_id", "created_at", "id", "name", "record_id", "record_type"]
  end
end

but rails don't create the active storage class.

Answered by Eddayy

Nov 16, 2023

I was also having the same issue, i found this works for me, you'll have to remove the activestorage tables from being searchable

ActiveAdmin.register Post do
  remove_filter :featured_image_attachment, :featured_image_blob
end

View full answer

Lordnibbler · 2023-10-29T04:31:37Z

Lordnibbler
Oct 29, 2023

Similar error here. I have a model, simplified for brevity

class Blog::Post < ApplicationRecord
  has_one_attached :featured_image
  has_many_attached :images
end

and when loading the ActiveAdmin views for this model I receive this error:

RuntimeError at /admin/blog_posts

Ransack needs Blog::Post attributes explicitly allowlisted as
searchable. Define a `ransackable_attributes` class method in your `Blog::Post`
model, watching out for items you DON'T want searchable (for
example, `encrypted_password`, `password_reset_token`, `owner` or
other sensitive information). You can use the following as a base:

class Blog::Post < ApplicationRecord
  # ...
  def self.ransackable_attributes(auth_object = nil)
    ["body", "created_at", "description", "id", "id_value", "published", "slug", "title", "updated_at", "user_id"]
  end
  # ...
end

When updating the model accordingly, I see a new error:

Ransack needs Blog::Post associations explicitly allowlisted as
searchable. Define a `ransackable_associations` class method in your `Blog::Post`
model, watching out for items you DON'T want searchable (for
example, `encrypted_password`, `password_reset_token`, `owner` or
other sensitive information). You can use the following as a base:

class Blog::Post < ApplicationRecord
  # ...
  def self.ransackable_associations(auth_object = nil)
    ["featured_image_attachment", "featured_image_blob", "images_attachments", "images_blobs", "user"]
  end
  # ...
end

And finally, when updating the model accordingly again, I'm back to (a variation) on the first error:

Ransack needs ActiveStorage::Attachment attributes explicitly allowlisted as
searchable. Define a `ransackable_attributes` class method in your `ActiveStorage::Attachment`
model, watching out for items you DON'T want searchable (for
example, `encrypted_password`, `password_reset_token`, `owner` or
other sensitive information). You can use the following as a base:

class ActiveStorage::Attachment < ApplicationRecord
  # ...
  def self.ransackable_attributes(auth_object = nil)
    ["blob_id", "created_at", "id", "id_value", "name", "record_id", "record_type"]
  end
  # ...
end

0 replies

Eddayy · 2023-11-16T08:01:49Z

Eddayy
Nov 16, 2023

I was also having the same issue, i found this works for me, you'll have to remove the activestorage tables from being searchable

ActiveAdmin.register Post do
  remove_filter :featured_image_attachment, :featured_image_blob
end

3 replies

javierjulio Dec 1, 2023
Maintainer

Thanks! I ran into this locally when updating the ActiveAdmin demo repository. This is a simple workaround that others should use.

mabeller Jul 23, 2024

And for reference, if you have a has_many_attached relationship it'll need to be :featured_images_attachments, :featured_images_blobs

LRosdobutko Nov 28, 2024

Do you mind if I ask what file you are supposed to insert that code snippet into? I'm fairly new to rails and basically teaching myself when I can, where I can, and some hand holding is greatly appreciated. lol

TeamRainless · 2023-12-20T21:30:00Z

TeamRainless
Dec 20, 2023

This should be on the main page somewhere if it isn't already... I would imagine every single ActiveAdmin user (or most of them) must run into this problem eventually. Took me all day to find this discussion.

0 replies

abhinaykumar · 2024-02-27T15:46:15Z

abhinaykumar
Feb 27, 2024

Took me couple of hours to realise that this answer points to *_attachment and *_blob version of the association on the model.

0 replies

TeamRainless · 2024-02-27T18:44:33Z

TeamRainless
Feb 27, 2024

That means you're just as smart as everyone else here... only slower! :)

…

On Tue, Feb 27, 2024 at 4:46 PM Abhinay Kumar ***@***.***> wrote: Took me couple of hours to realise that this answer <#8077 (comment)> points to *_attachment and *_blob version of the association on the model. — Reply to this email directly, view it on GitHub <#8077 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA2KI56YTLXPD4YDXBGH4GTYVX5VLAVCNFSM6AAAAAA7NW2UOGVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4DMMBXGAYTS> . You are receiving this because you commented.Message ID: ***@***.*** com>

0 replies

TeamRainless · 2024-11-28T22:22:48Z

TeamRainless
Nov 28, 2024

Which code snippet are you referring to? If you mean the "has_many" relationships... They go into your model.

…

On Thu, Nov 28, 2024, 11:08 PM LRosdobutko ***@***.***> wrote: Do you mind if I ask what file you are supposed to insert that code snippet into? I'm fairly new to rails and basically teaching myself when I can, where I can, and some hand holding is greatly appreciated. lol — Reply to this email directly, view it on GitHub <#8077 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA2KI55ECZ2QP2MRCONWHM32C6H5RAVCNFSM6AAAAAA7NW2UOGVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTCNBRGA2DQMQ> . You are receiving this because you commented.Message ID: ***@***.*** com>

0 replies

innocentamadi · 2025-05-03T23:30:15Z

innocentamadi
May 3, 2025

Here's what worked for me: Create a module in an initializer that extends ActiveSupport::Concern and include the ransackable_attributes mapping.

# config/initializers/attachment_extensions.rb

module AttachmentExtensions
  extend ActiveSupport::Concern

  included do
    def self.ransackable_associations(*, **) = reflections.keys
    def self.ransackable_attributes(*, **) = attribute_names
  end
end

Rails.application.config.to_prepare do
  ActiveStorage::Attachment.include AttachmentExtensions
end

1 reply

changmason May 17, 2025

Confirmed this solution works, thank you so much!!

TeamRainless · 2025-05-17T02:03:48Z

TeamRainless
May 17, 2025

It's not REALLY a "solution"... It's more of a workaround. In my opinion this issue shouldn't have been closed until the issue was actually fixed. I mean it's been YEARS now...

…

On Sat, May 17, 2025, 3:34 AM Mason Chang ***@***.***> wrote: Confirmed this solution works, thank you so much!! — Reply to this email directly, view it on GitHub <#8077 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA2KI55ZUVIVZK4MVECLVTD262G37AVCNFSM6AAAAAB4MHBKKWVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTGMJXGY2DSNI> . You are receiving this because you commented.Message ID: ***@***.*** com>

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using ransackable_attributes with Active Admin errors when using Active Storage #8077

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 8 comments 4 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Using ransackable_attributes with Active Admin errors when using Active Storage #8077

Replies: 8 comments · 4 replies

javierjulio Dec 1, 2023 Maintainer

Replies: 8 comments 4 replies

javierjulio Dec 1, 2023
Maintainer