Rails Models Reverse Engineering 技术文档

1. 安装指南

Rmre 是一个用于为遗留数据库创建 Ruby on Rails ActiveRecord 模型的实用工具。你可以通过以下命令安装 Rmre：

gem install rmre

2. 项目的使用说明

Rmre 的使用非常简单，只需在命令行中运行以下命令：

rmre -a mysql2 -d my_database -u my_username -p my_password -o /path/where/models/will/be/created

该命令将根据指定的数据库连接信息，生成相应的 ActiveRecord 模型文件，并将其保存到指定的输出目录中。

2.1 获取帮助

如果你需要查看所有可用的命令行选项，可以运行以下命令：

rmre --help

或

rmre -h

2.2 MS SQL 选项

对于 MS SQL 数据库，你可以使用以下选项来设置 ODBC 特定的参数：

• -m 或 --mode：必须设置为 ODBC。
• -n 或 --dsn：数据源名称。

2.3 通用选项

• 输出目录可以通过以下选项设置：

  -o /path/to/target/directory
  

  或

  --out /path/to/target/directory
  

  如果未指定输出目录，Rmre 将在启动目录中创建模型文件。

• 你可以通过以下选项过滤需要生成模型的表：

  -i ec_,vi_
  

  或

  --include ic_,vi_
  

  这将仅生成以 ec_ 或 vi_ 开头的表的模型。

3. 项目API使用文档

3.1 配置文件生成

Rmre 支持通过配置文件来设置数据库连接和输出路径，而不是通过命令行选项。你可以通过以下命令生成示例配置文件：

rmre -o /tmp/test -f

这将生成两个文件：/tmp/test/rmre_db.rb 和 /tmp/test/rmre_db.yml。

3.2 配置文件示例

生成的配置文件 rmre_db.yml 示例如下：

---
:db:
  :username: ''
  :password: ''
  :port:
  :timeout: 5000
  :adapter: adapter_name
  :database: db_name
:out_path: /tmp/test

你可以根据需要修改配置文件中的值，然后通过以下命令启动 Rmre：

rmre -f /tmp/test/rmre_db.yml

3.3 自定义词形变化

如果表名不符合 Rails 命名约定，Rmre 允许在配置文件中定义额外的词形变化规则，以正确转换表名。例如：

:inflections:
- :plural:
  - (.*)_des$
  - \1_des
  :singular:
  - (.*)_des$
  - \1_des
- :plural:
  - (.*)_fis$
  - rmre_\1_d
  :singular:
  - (.*)_fis$
  - rmre_\1_d

4. 项目安装方式

Rmre 可以通过 RubyGems 安装，安装命令如下：

gem install rmre

安装完成后，你可以通过命令行使用 Rmre 来生成 ActiveRecord 模型。