TablePrint 项目技术文档

1. 安装指南

独立安装

使用RubyGems独立安装table_print：

gem install table_print

Rails项目安装

在Rails项目的Gemfile文件中添加以下代码：

gem "table_print"

然后执行以下命令安装：

bundle install

2. 项目使用说明

table_print可以轻松地将以表格形式显示对象，便于阅读。它甚至允许你嵌套其他表格，以表格形式展示相关对象的数据。

以下是如何在Rails项目内外使用table_print：

Rails项目内使用

在Rails控制台中，可以直接使用：

rails c
tp array_of_objects, options

Rails项目外使用

在Ruby交互式解释器（IRB）中，首先导入table_print：

irb
require 'table_print'
tp array_of_objects, options

例如，使用Book模型的数据：

tp Book.all

输出将类似于：

AUTHOR            | SUMMARY                         | TITLE
------------------|---------------------------------|------------------
Michael Connelly  | Another book by Michael Con...  | The Fifth Witness
Manning Marable   | From acclaimed historian Ma...  | Malcolm X
Tina Fey          | Worth it. -Trees                | Bossypants

3. 项目API使用文档

以下是一些table_print的API使用示例：

显示特定列

你可以自定义输出，显示较少的列或显示你在模型上编写的其他方法：

tp User.limit(30), :include => :yearly_income, :except => :hourly_rate

或者，只显示特定信息：

tp User.limit(30), :address, 'city', 'state', :zip

嵌套对象

如果你有包含嵌套对象的数据，你可以使用方法链来引用这些对象：

tp Author.limit(3), "name", "books.title", "books.photos.caption"

列选项

你可以通过使用列作为哈希键的选项，为单个列传递选项：

tp User.all, :email => {:width => 12}

以下是一些可用的列选项：

• display_method：用于填充列的方法名称或过程。
• formatters：一个对象数组，每个对象在被打印的单元格上依次调用。
• time_format：用于时间列的格式。
• width：列的宽度。
• display_name：用于列名的字符串，如果列名中需要空格，非常有用。
• separator：列分隔符，默认是竖线，用于控制台和Markdown输出，可以更改为逗号以输出CSV格式。

HTML输出

目前，在HTML页面上显示table_print输出的最佳方法是在<pre>标签中使用。你可以创建一个辅助方法，直接将table_print输出发送到<pre>标签中：

def tp_pre data, options={}
  content_tag :pre, TablePrint::Printer.new(data, options).table_print
end

CSV输出

将列分隔符设置为逗号，以获取可以保存为CSV的输出：

tp.set :separator, ","

配置

使用tp.set和tp.clear在不同的类上设置选项：

tp.set User, :id, :email

现在，每次打印用户时，只显示ID和电子邮件。

你可以重置配置：

tp.clear User

多字节字符串

如果要处理大量多字节字符，请先设置多字节选项：

tp.set :multibyte, true

4. 项目安装方式

请参考上述“安装指南”部分。