administrate_filterable

Администрирование пользовательского фильтра

Плагин администрирования для добавления пользовательского фильтра на вашу индексную страницу. Фильтр будет отображаться как компонент за пределами холста, поэтому он не будет занимать слишком много места на вашей индексной странице. Очень вдохновлен фильтром ActiveAdmin.

Зачем вам это нужно?

Согласитесь, команда Администратора отлично поработала над стандартным функционалом поиска или фильтрации. Он уже поддерживает несколько полей поиска и поиск по реляционным таблицам. Его легко настроить (например, включить/отключить поиск, определить пользовательские поля поиска и т. д.).

Но есть некоторые недостатки, которые я обнаружил:

1. Поскольку он использует одно окно поиска, процесс поиска в нем довольно тяжелый. Он будет искать все атрибуты модели и будет работать медленнее, если у вас много данных.
2. Опять же, поскольку он ищет все атрибуты, будет сложно найти конкретный атрибут. Например, если у вас есть registration_status и employment_status и вы хотите выполнить поиск только по «активному» статусу регистрации, вы получите все «активные» записи, включая статус занятости.
3. Это неудобно для пользователя, когда речь идет об определенном списке поиска (например, раскрывающемся списке). Пользователю придется вводить значение вручную, и это не очень удобно для пользователя.

Пожалуйста, поделитесь своими мыслями, если у вас есть другие причины.

Требования

• Версия Ruby on Rails >= 5.0
• Администрирование версии >= 0.2.2

Установка

Добавьте administrate_filterable в ваш Gemfile:

 gem 'administrate_filterable'

И затем выполните:

 $ bundle install

Или просто запустите:

 $ bundle add administrate_filterable

Использование

Включить фильтр

Для каждого ресурса, к которому вы хотите добавить собственный фильтр, добавьте следующую строку в его контроллер администрирования соответственно.

 include AdministrateFilterable :: Filterer

Пример:

 class UsersController < Administrate :: ApplicationController
  include AdministrateFilterable :: Filterer

  # ...
end

Настройка полей фильтра

По умолчанию все атрибуты из COLLECTION_ATTRIBUTES будут отображаться как поля фильтра. Вы можете обойти это, добавив FILTER_ATTRIBUTES в файл панели администратора.

Пример ( app/dashboards/user_dashboard.rb ):

 class UserDashboard < Administrate :: BaseDashboard
  # ..
  FILTER_ATTRIBUTES = [
    :first_name ,
    :last_name ,
    :email ,
    :created_at
  ] . freeze
  # ..
end

Настройка шаблона фильтра

Можно настроить шаблон фильтра (например, изменить значок кнопки фильтра и т. д.). Вы можете сделать это, переопределив шаблон по умолчанию в своем приложении, просто создайте новый файл с именем _index_filter.html.erb в нужной папке ресурсов.

Например, если вы хотите переопределить шаблон фильтра для ресурса users , вам необходимо создать файл в app/views/admin/users/_index_filter.html.erb . Затем просто скопируйте сюда содержимое шаблона по умолчанию и измените его в соответствии со своими потребностями.

Конвейер активов

Если вы используете конвейер ресурсов, вам необходимо включить ресурсы этого драгоценного камня в файл app/assets/config/manifest.js :

 // ... other code here ...

//= link administrate_filterable/application.css
//= link administrate_filterable/application.js

Запустите rails assets:precompile если ресурсы не загружены.

Поиск неисправностей

Переопределенный шаблон поиска по умолчанию

По умолчанию этот драгоценный камень добавит кнопку фильтра в views/admin/application/_search.html.erb . Но если вы переопределили этот фрагмент в своем приложении, вы можете добавить кнопку вручную, добавив следующую строку:

 <%= render 'index_filter' %>

Пример ( app/views/admin/users/_search.html.erb ):

 < form class =" search " role =" search " >
  ... other code here ...
</ form >

<%= render 'index_filter' %>

Переопределенный scoped_resource

Этот драгоценный камень использует scoped_resource для фильтрации ресурсов, переопределяя его поведение по умолчанию. Если вы случайно также переопределите этот метод в своем контроллере приложения, вы также переопределите функциональность фильтра, и он не будет работать.

Чтобы это исправить, вам нужно добавить следующий код в последнюю строку переопределенного scoped_resource :

 filtered_resources ( your_scoped_resource )

Например:

 def scoped_resource
  # Your custom filter logic here
  resources = super . where ( status : 'active' )
  # Add this line to make the filter work
  filtered_resources ( resources )
end

Кнопка фильтра не отображается

Поскольку я использую партиал _search.html.erb для добавления кнопки фильтра, она может не отображаться, если вы установите для всех атрибутов поиска значение false на панели управления модели. Поэтому убедитесь, что у вас есть хотя бы один атрибут, доступный для поиска, чтобы кнопка фильтра отображалась.

Причина, по которой я использую частичный вариант, заключается в том, что:

1. Пользователь редко переопределяет ее, поэтому в большинстве случаев вам не придется добавлять кнопку вручную.
2. Раньше я использовал партиал _index_header.html.erb , но он конфликтует с кнопкой экспорта из administrate_exportable. Использование обоих драгоценных камней приводит к отсутствию одной кнопки из-за частичного переопределения.

Сделать

Еще многое предстоит сделать, чтобы сделать этот драгоценный камень лучше. Вот некоторые из них (отсортированы по наивысшему приоритету):

• Добавить поддержку реляционного фильтра (например, фильтр по ассоциации belongs_to и т. д.).
• Добавьте поддержку настройки раскрывающегося списка (например, добавьте параметр prompt , добавьте параметр include_blank и т. д.).
• Исключить флажок, переключатель или выбрать значение из параметров фильтра, если над ними не выполняется никаких действий.
• Найдите лучший способ реализации функции фильтра (в настоящее время я переопределяю scoped_resource )
• Найдите лучший способ передать атрибуты фильтра в форму (в настоящее время я использую переменную экземпляра в переопределенном scoped_resource ).
• Добавьте возможность настройки поведения фильтра (например, поиск по точному совпадению, поиск по частичному совпадению и т. д., как в фильтре ActiveAdmin).
• Улучшите взаимодействие с пользователем кнопки переключения (например, добавьте анимацию открытия/закрытия, добавьте динамический заголовок открытия/закрытия и т. д.)

Если у вас есть какие-либо идеи или предложения, дайте мне знать, создав проблему или запрос на включение.

Содействие

Вы можете помочь мне улучшить этот драгоценный камень, внеся свой вклад в этот проект. Любая помощь высоко ценится.

1. Форкните это репо и создайте запрос на включение
2. Пожалуйста, проверьте свой код: bundle exec rspec
3. Пожалуйста, задокументируйте свой код, если необходимо.

Лицензия

Лицензия MIT

Кредиты

Огромное спасибо за следующие ресурсы, которые очень помогли мне в создании этого драгоценного камня:

• administrate_exportable: я просто копирую и вставляю код из этого драгоценного камня и изменяю его в соответствии со своими потребностями. Настоятельно рекомендуется, если вам нужно экспортировать данные из Administrate.
• Меню вне холста: я нашел этот код в Google Images, когда искал способ создания компонента фильтра вне холста. Я немного модифицировал его под свои нужды. Но, похоже, CodePen больше не доступен, поэтому выкладываю архивную версию здесь. Если кто-нибудь из вас знает оригинального автора, сообщите мне, чтобы я мог отдать должное.