Sortable Table 项目技术文档

1. 安装指南

由于该项目已被标记为“DEPRECATED”，Thoughtbot 不再支持此项目。如果您仍然希望使用或维护此项目，请直接联系 Thoughtbot（[e-mail]）。

如果您决定继续使用此项目，可以按照以下步骤进行安装：

1.1 安装插件

在您的 Rails 应用中，通过以下命令安装 sortable_table 插件：

script/plugin install git://github.com/thoughtbot/sortable_table.git

1.2 配置控制器和助手

在 app/controllers/application_controller.rb 文件中，添加以下代码以包含 SortableTable 的控制器模块：

class ApplicationController < ActionController::Base
  include SortableTable::App::Controllers::ApplicationController
end

在 app/helpers/application_helper.rb 文件中，添加以下代码以包含 SortableTable 的助手模块：

module ApplicationHelper
  include SortableTable::App::Helpers::ApplicationHelper
end

2. 项目的使用说明

2.1 控制器配置

在您的控制器中，使用 sortable_attributes 方法定义可排序的属性。例如，在 UsersController 中：

class UsersController < Admin::BaseController
  sortable_attributes :name, :email, :age, :group => "groups.name"

  def index
    @users = User.paginate :page => params[:page], :order => sort_order
  end
end

sortable_attributes 方法会定义一个 sort_order 方法，该方法会在控制器的 index 动作中被调用。如果没有提供 params[:sort] 参数，默认会按照 :name 属性进行排序。

2.2 视图配置

在视图中，使用 sortable_table_header 方法创建可排序的表头。例如：

<h1>Users</h1>
<table>
  <tr>
    <%= sortable_table_header :name => "Name",  :sort => "name" %>
    <%= sortable_table_header :name => "Email", :sort => "email" %>
    <%= sortable_table_header :name => "Age",   :sort => "age" %>
    <%= sortable_table_header :name => "Group", :sort => "group" %>
  </tr>
  <% @users.each do |user| %>
    <tr>
      <td><%= html_escape(user.name) %></td>
      <td><%= html_escape(user.email) %></td>
      <td><%= html_escape(user.age) %></td>
      <td><%= html_escape(user.group.name) %></td>
    </tr>
  <% end %>
</table>

sortable_table_header 方法会生成一个包含排序链接的表头，并根据排序状态添加 ascending 或 descending 类，以便您可以自定义样式。

3. 项目API使用文档

3.1 sortable_attributes

sortable_attributes 方法用于定义控制器中可排序的属性。它会在控制器中生成一个 sort_order 方法，用于获取当前的排序顺序。

参数：

• :name：属性名称。
• :group：关联属性的名称（例如 "groups.name"）。

示例：

sortable_attributes :name, :email, :age, :group => "groups.name"

3.2 sortable_table_header

sortable_table_header 方法用于在视图中生成可排序的表头。它会根据当前的排序状态生成带有排序链接的表头。

参数：

• :name：表头显示的名称。
• :sort：对应的排序属性。

示例：

<%= sortable_table_header :name => "Name",  :sort => "name" %>

4. 项目安装方式

如前所述，该项目已被标记为“DEPRECATED”，Thoughtbot 不再支持此项目。如果您仍然希望使用此项目，可以通过以下方式安装：

script/plugin install git://github.com/thoughtbot/sortable_table.git

安装后，按照上述的控制器和视图配置进行使用。

---

注意：由于项目已被弃用，建议您寻找或开发替代方案以满足您的需求。