Using new ransack version with acts_as_taggable_on for tag search

[Dragonicity]

Previously this sort of form selection worked:

<%= form.select :tags_name_in, ActsAsTaggableOn::Tag.distinct.order(:name).pluck(:name), {include_blank: true,  class: "form-control" }, { } %>

This now gives you the error and suggested resolution:

Ransack needs ActsAsTaggableOn::Tag attributes explicitly allowlisted as
searchable. Define a ransackable_attributes class method in your ActsAsTaggableOn::Tag
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 ActsAsTaggableOn::Tag < ApplicationRecord
  # ...
  def self.ransackable_attributes(auth_object = nil)
    ["created_at", "id", "name", "taggings_count", "updated_at"]
  end
  # ...
end

However, including the above in a Tag model to monkey-patch the Tag class does not work. Neither does the following:

module ActsAsTaggableOn
  class Tag < ActsAsTaggableOn.base_class.constantize
    def self.ransackable_attributes(auth_object = nil)
      ["id", "name"]
    end
  end
end

Any idea how to proceed to resolve this?

[Floppy]

@Dragonicity did you ever resolve this? If so, what did you do? I've run into exactly the same problem.

[Dragonicity]

Hi Floppy

I made some changes and it started working recently (but upgrades were made to other libraries as well in the interim so who knows). I put the following in the application.rb file:

# Monkey patch suggested as workaround to the allowlisted issue 
# This may be removed when an official fix is included in Ransack

class ActsAsTaggableOn::Tag 
  class << self
    def ransackable_associations(auth_object = nil)
      ["taggings"]
    end

    def ransackable_attributes(auth_object = nil)
      ["name"]
    end
  end
end

Then I made the following changes for the class concerned.

In the model:

 private

  def self.ransackable_attributes(auth_object = nil)
    ["name", "tags"]
  end

  def self.ransackable_associations(auth_object = nil)
    ["base_tags", "tags"]
  end

In the controller:

 def index
    params.merge!(q:{tags_name_in: params[:tag]}) if params[:tag].present?
    @q = Klass.all.sort_by_params(params[:sort], sort_direction).ransack(params[:q])
    @pagy, @objects = pagy(@q.result, items: 12)
    @objects.load
  end
  
  ...
  
 def object_params
    params.require(:object).permit(:id, :name, :tag_list)
 end
  

In the index view:

 <%= search_form_for @q do |form| %>
  <div class="container">
    <div class="flex items-center form-group">  
      <div class="mb-2 mr-2">
        <%= form.label :name_cont, t(:name), class: "inline-block" %>
        <%= form.search_field :name_cont, class: 'form-control' %>
      </div>
      <div class="mb-2 mr-2">
        <%= form.label :tags_name_in, t(:tags), class: "inline-block" %>
        <%= form.select :tags_name_in, ActsAsTaggableOn::Tag.distinct.order(:name).pluck(:name), {include_blank: true,  class: "form-control" }, { } %>
        <%# This is how multiple items are selected from the list %>
        <%#= form.select :tags_name_in, ActsAsTaggableOn::Tag.distinct.order(:name).pluck(:name), { class: "form-control" }, { multiple: true } %>
      </div>
      <div class="form-group flex justify-between">
        <button class="btn btn-tertiary mt-11 mr-2" type="submit"><%= t(:search) %></button>
        <%= link_to t(:clear), objects_path, class: "clear btn btn-tertiary btn-outline mt-11" %>
      </div>
    </div>
  </div>
<% end %>

I am using these gem versions:

gem 'acts-as-taggable-on', '~> 9.0'
gem 'ransack'

Hope this helps you and you get yours working!

[Floppy]

Thanks very much, I got it worked out, and delayed_job at the same time. I put mine in the initialiser, see manyfold3d/manyfold#1432. For anyone looking at this in future, the main gotcha is that you need to leave out the inheritance from the example code that ransack suggests in the error message, it just confuses things (or maybe it just confused me).