Ledger Web 技术文档

本文档将详细介绍如何安装、使用和配置 Ledger Web 项目，以及如何通过其 API 进行操作。

1. 安装指南

在开始安装之前，请确保您的系统中已安装 PostgreSQL 9.0 或更高版本。

安装步骤：

$ gem install ledger_web
$ createdb ledger

创建数据库后，您可以通过以下命令启动 Ledger Web：

$ ledger_web

启动成功后，使用浏览器打开 http://localhost:9090，您可以看到一些示例报告。

2. 项目使用说明

Ledger Web 是一个基于 Web 的报告系统，它使用 PostgreSQL 作为后端数据库，并与 Ledger 命令行会计系统配合使用。

配置

Ledger Web 的配置非常简单。创建一个名为 ~/.ledger_web/config.rb 的文件，内容如下：

LedgerWeb::Config.new do |config|
  config.set :database_url, "postgres://localhost/ledger"
end

:database_url 应指向您的数据库实例。它可以不是本地的，但配置的用户需要能够修改模式。还有许多其他设置可以配置：

• :index_report 是 Ledger Web 在首次打开时将浏览器重定向到的报告。默认为 :help
• :port 是 Ledger Web 将运行在其上的端口。默认为 9090
• :ledger_file 是 Ledger Web 将读取的文件。默认为环境变量 LEDGER_FILE
• :ledger_bin_path 是 ledger 二进制文件的路径。默认在 PATH 中查找

编写报告

报告只是存储在 ~/.ledger_web/reports 目录中的 HTML ERB 文件。Ledger Web 提供了一些有用的辅助方法，让您能够轻松定义 SQL 查询。以下是一个报告示例：

<% @query = query do %>
select
    xtn_month,
    account,
    sum(amount)
from
    ledger
where
    (account ~ 'Income'
    or account ~ 'Expenses')
    and xtn_date between :from and :to
group by
    xtn_month,
    account
<% end %>
<%= table @query %>

query 辅助方法接受一个 SQL 块并返回一个 LedgerWeb::Report 实例。它可以接受一些选项：

• :pivot 是要透视的列的名称。
• :pivot_sort_order 指定透视列的排序方式。可以是 asc 或 desc。默认为 asc。

Ledger Web 使用 Twitter Bootstrap 进行格式化，因此您可以使用任何您想要的方式来格式化您的报告。

table 辅助方法接受一个由 query 辅助方法产生的查询和一些选项，并构建一个 HTML 表格。它还可以接受一个 :links 选项，它将表格中的值链接化。以下是一个例子：

:links => {"Account" => "/reports/register?account=:1"}

这表示 Account 列中的每个值将被一个 <a> 标签包围，指向 /reports/register?account=:1，其中 :1 将被该特定行的第一列的值替换。

3. 项目 API 使用文档

Ledger Web 提供了一个简单的 API，您可以通过它在不同的报告之间进行链接。以下是 API 的基本使用方法：

• 使用 :links 选项在报告中创建链接。
• 链接模板可以使用 :1 表示列值，:title 表示列标题。

4. 项目安装方式

Ledger Web 可以通过以下步骤进行安装：

1. 确保系统已安装 PostgreSQL 9.0 或更高版本。
2. 使用 gem install ledger_web 命令安装 Ledger Web。
3. 创建一个名为 ledger 的 PostgreSQL 数据库。
4. 使用 ledger_web 命令启动 Ledger Web。
5. 打开浏览器，访问 http://localhost:9090。

以上是 Ledger Web 的基本安装和使用方法。通过自定义配置和编写报告，您可以根据需要创建各种会计报告。