RAutomation 技术文档

1. 安装指南

Windows

在 Windows 系统上安装 RAutomation 非常简单，只需执行以下命令：

gem install rautomation

RAutomation 提供了多种适配器，包括：

• :win_32：直接使用 Windows API 进行自动化（默认适配器）。
• :ms_uia：实验性适配器。
• :autoit：使用 AutoIt 进行自动化（已弃用）。

注意：如果使用 AutoIt 适配器，首次运行时可能需要管理员权限，尤其是之前未安装过 AutoIt 的情况下。

Linux 和 OS X

RAutomation 目前主要支持 Windows 平台，但如果你熟悉如何在 Linux 或 OS X 上自动化窗口和控件，可以通过创建新的适配器来扩展支持。具体步骤请参考“如何创建新适配器？”部分。

其他操作系统

如果你使用的操作系统不在上述列表中，并且你熟悉如何在该系统上自动化窗口和控件，可以通过创建新的适配器来扩展支持。具体步骤请参考“如何创建新适配器？”部分。

2. 项目使用说明

RAutomation 是一个用于自动化 Windows 窗口及其控件的小型且易于使用的库，主要用于自动化测试。它提供了用户友好的 API，灵感来自于 Watir。

基本使用示例

以下是一个简单的使用示例，展示了如何使用 RAutomation 来操作窗口和控件：

require "rautomation"

# 创建一个窗口对象，匹配部分标题
window = RAutomation::Window.new(:title => /part of the title/i)

# 检查窗口是否存在
window.exists? # => true

# 获取窗口标题
window.title # => "blah blah part Of the title blah"

# 获取窗口文本内容
window.text # => "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec ultricies..."

# 设置文本框内容
window.text_field(:class => "Edit", :index => 0).set "hello, world!"

# 查找并点击按钮
button = window.button(:value => "&Save")
button.exists? # => true
button.click

# 获取所有窗口并打印它们的句柄
all_windows = RAutomation::Window.windows
all_windows.each {|window| puts window.hwnd}

# 获取当前窗口的所有子窗口
windows = window.windows
puts windows.size # => 2
windows.map &:title # => ["part of the title 1", "part of the title 2"]

# 获取指定标题的子窗口
window.windows(:title => /part of other title/i) # => 所有匹配指定标题的窗口

# 获取并打印所有按钮的值
window.buttons.each {|button| puts button.value}

# 获取并打印指定值的按钮
window.buttons(:value => /some value/i).each {|button| puts button.value}

# 使用 AutoIt 适配器创建窗口对象
window2 = RAutomation::Window.new(:title => "Other Title", :adapter => :autoit)

# 使用 AutoIt 的内部方法关闭窗口
window2.WinClose("[TITLE:Other Title]")

更多用法

更多详细的使用方法可以参考 RAutomation 的文档。

3. 项目 API 使用文档

RAutomation 提供了丰富的 API，用于操作 Windows 窗口及其控件。以下是一些常用的 API 示例：

窗口操作

• RAutomation::Window.new(options)：创建一个新的窗口对象，options 可以包含 :title、:adapter 等参数。
• window.exists?：检查窗口是否存在。
• window.title：获取窗口的标题。
• window.text：获取窗口的文本内容。
• window.windows(options)：获取当前窗口的所有子窗口，options 可以包含 :title 等参数。

控件操作

• window.text_field(options)：获取文本框控件，options 可以包含 :class、:index 等参数。
• text_field.set(value)：设置文本框的内容。
• window.button(options)：获取按钮控件，options 可以包含 :value 等参数。
• button.exists?：检查按钮是否存在。
• button.click：点击按钮。

适配器

RAutomation 支持多种适配器，包括 :win_32、:ms_uia 和 :autoit。可以通过 :adapter 参数指定适配器。

4. 项目安装方式

RAutomation 的安装方式非常简单，只需在终端中执行以下命令：

gem install rautomation

安装完成后，你可以在 Ruby 脚本中通过 require "rautomation" 来使用 RAutomation。

适配器选择

RAutomation 支持多种适配器，默认使用 :win_32 适配器。你可以通过 :adapter 参数指定其他适配器，例如：

window = RAutomation::Window.new(:title => "Other Title", :adapter => :autoit)

创建新适配器

如果你需要在其他平台上使用 RAutomation，可以通过创建新的适配器来扩展支持。具体步骤如下：

1. 克隆项目并创建一个新的适配器文件。
2. 在 lib/rautomation/adapter 目录下创建适配器的入口文件。
3. 在 lib/rautomation/adapter/helper.rb 中添加 autoload 语句。
4. 创建适配器的具体代码目录，并复制 button.rb、text_field.rb 和 window.rb 文件。
5. 在 spec/spec_helper 中添加适配器的测试数据。
6. 使用环境变量 RAUTOMATION_ADAPTER 指定适配器。
7. 编写代码并进行测试，确保尽可能多的公共 API 被满足。
8. 提交 Pull Request。

通过以上步骤，你可以为 RAutomation 添加对新平台的支持。