Command Line Reporter 技术文档

1. 安装指南

1.1 通过 Bundler 安装

如果你使用 Bundler 管理 Ruby 项目的依赖，可以在 Gemfile 中添加以下内容：

gem 'command_line_reporter', '>=3.0'

然后运行以下命令安装：

bundle install

1.2 直接安装

你也可以通过 RubyGems 直接安装该 gem：

gem install command_line_reporter

2. 项目的使用说明

2.1 引入模块

在你的 Ruby 脚本中，首先需要引入 command_line_reporter 模块：

require 'command_line_reporter'

class MyReport
  include CommandLineReporter
  # 你的代码
end

2.2 基本使用

CommandLineReporter 提供了一系列方法，帮助你生成格式化的命令行报告。以下是一些常用的方法：

• header 和 footer：用于生成报告的头部和尾部。
• report：用于生成报告的主体部分。
• table：用于生成表格。
• horizontal_rule：用于生成水平分隔线。
• vertical_spacing：用于生成垂直空白行。
• datetime：用于生成时间戳。
• aligned：用于生成对齐的文本。

3. 项目 API 使用文档

3.1 header 和 footer

header 和 footer 方法用于生成报告的头部和尾部。它们接受一个哈希参数，包含以下选项：

• :title：标题文本，默认为 'Report'。
• :width：宽度（字符数），默认为 100。
• :align：对齐方式，可选 'left'、'right' 或 'center'，默认为 'left'。
• :spacing：垂直空白行数，默认为 1。
• :timestamp：是否包含时间戳，默认为 false。
• :rule：是否包含水平分隔线，默认为 false。
• :color：文本颜色，如 'red'、'blue' 或 'green'。
• :bold：是否加粗文本，默认为 false。

3.2 report

report 方法用于生成报告的主体部分。它接受一个哈希参数和一个代码块：

report(options) do
  # 你的代码
end

3.3 table

table 方法用于生成表格。它接受一个哈希参数和一个代码块：

table(options) do
  row do
    column 'Header 1', align: 'center'
    column 'Header 2', align: 'center'
  end
  row do
    column 'Data 1'
    column 'Data 2'
  end
end

3.4 horizontal_rule

horizontal_rule 方法用于生成水平分隔线。它接受一个哈希参数：

horizontal_rule(char: '-', width: 100, color: 'red', bold: true)

3.5 vertical_spacing

vertical_spacing 方法用于生成垂直空白行。它接受一个整数参数：

vertical_spacing(2)

3.6 datetime

datetime 方法用于生成时间戳。它接受一个哈希参数：

datetime(align: 'center', width: 100, format: '%Y-%m-%d %H:%I:%S%p', color: 'blue', bold: true)

3.7 aligned

aligned 方法用于生成对齐的文本。它接受一个字符串和一个哈希参数：

aligned('Centered Text', align: 'center', width: 100, color: 'green', bold: true)

4. 项目安装方式

4.1 通过 Bundler 安装

在 Gemfile 中添加以下内容：

gem 'command_line_reporter', '>=3.0'

然后运行以下命令安装：

bundle install

4.2 直接安装

通过 RubyGems 直接安装：

gem install command_line_reporter

通过以上步骤，你可以轻松安装并使用 CommandLineReporter 来生成格式化的命令行报告。