Datagrid 技术文档

1. 安装指南

在开始使用 Datagrid 之前，需要先将其添加到您的项目中。您可以通过以下方式将 Datagrid 添加到您的 Ruby 项目中：

gem 'datagrid'

然后，在您的项目根目录下执行以下命令来安装 Datagrid：

bundle install

确保您的项目已经安装了所需的 ORM (ActiveRecord、Mongoid、MongoMapper、Sequel 或 Array)，因为 Datagrid 需要与 ORM 集成。

2. 项目的使用说明

Datagrid 是一个 Ruby 库，它可以生成包括管理面板、分析和数据浏览器的报告。它提供了过滤、列、排序、本地化以及导出为 CSV 等功能。

要使用 Datagrid，您需要创建一个继承自 Datagrid::Base 的类，并在其中定义您的数据网格的范围、过滤器、列等信息。

以下是一个基本的使用示例：

class UsersGrid < Datagrid::Base
  scope { User.includes(:group) }
  filter(:category, :enum, select: ["first", "second"])
  column(:name)
  column(:group) { |user| user.group.name }
  column(:active) { |user| !user.disabled }
end

3. 项目API使用文档

Datagrid 的 API 使用非常直观。以下是一些核心的 API 方法：

• scope: 定义查询的范围。
• filter: 定义数据过滤器。
• column: 定义显示的列。

以下是具体的使用方法：

Scope

scope do
  User.includes(:group)
end

Filters

filter(:category, :enum, select: ["first", "second"])

Columns

column(:name)
column(:group, order: -> { joins(:group).order(groups: :name) }) { |user| user.name }
column(:active, header: "Activated") { |user| !user.disabled }

数据获取

report = UsersGrid.new(group_id: [1,2], logins_count: [1, nil], category: "first", order: :group, descending: true)

report.assets # 返回符合条件的 User 实例数组
report.header # 返回列头信息
report.rows   # 返回表格行数据
report.data   # 返回表格的完整数据，包括 header 和 rows
report.to_csv # 导出数据为 CSV 格式

4. 项目安装方式

项目安装方式已在安装指南中说明。简要步骤如下：

1. 将 gem 'datagrid' 添加到您的 Gemfile 文件中。
2. 执行 bundle install 命令安装 Datagrid。

请遵循上述指南来安装和使用 Datagrid。