administrate_filterable

管理自定义过滤器

一个管理插件，用于将自定义过滤器添加到索引页。该过滤器将呈现为画布外组件，因此它不会在索引页上占用太多空间。深受 ActiveAdmin 过滤器的启发。

为什么需要这个？

我们一致认为，管理团队在默认搜索或过滤功能方面做得非常出色。它已经支持多个搜索字段和关系表搜索。它很容易自定义（例如启用/禁用搜索、定义自定义搜索字段等）。

但我发现有一些缺点：

1. 由于它使用单个搜索框，因此其背后的搜索过程相当繁重。它将搜索模型的所有属性，如果数据很多，它会更慢。
2. 同样，由于它搜索所有属性，因此很难搜索特定属性。例如，如果您有registration_status和employment_status ，并且您只想搜索“active”注册状态，您将获得所有“active”记录，包括就业状态。
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文件中包含此 gem 的资产：

 // ... other code here ...

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

如果未加载资源，请运行rails assets:precompile 。

故障排除

覆盖默认搜索模板

默认情况下，这个 gem 会向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方法

该 gem 利用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 过滤器中一样）
• 改善切换按钮的用户体验（例如添加打开/关闭动画、添加动态打开/关闭标题等）

如果您有任何想法或建议，请通过创建问题或拉取请求让我知道。

贡献

您可以通过为这个项目做出贡献来帮助我改进这个 gem。非常感谢任何帮助。

1. 分叉此存储库并创建拉取请求
2. 请测试您的代码： bundle exec rspec
3. 如果需要，请记录您的代码

执照

麻省理工学院许可证

制作人员

非常感谢以下资源在创建这个宝石时为我提供了很多帮助：

• administrate_exportable：我只是从这个 gem 复制并粘贴代码并修改它以满足我的需要，如果您需要从管理导出数据，强烈推荐。
• Off-Canvas 菜单：当我寻找一种创建 Off-canvas 过滤器组件的方法时，我从 Google Images 中找到了这段代码。我对其进行了一些修改以满足我的需要。但CodePen似乎不再可用，所以我把存档版本放在这里。如果你们中有人知道原作者，请告诉我，以便我给予适当的认可。