Launchy 项目技术文档

1. 安装指南

1.1 使用 RubyGems 安装

Launchy 可以通过 RubyGems 进行安装。打开终端并运行以下命令：

gem install launchy

1.2 在 Gemfile 中添加

如果你使用的是 Ruby on Rails 或其他基于 Bundler 的项目，可以在 Gemfile 中添加以下行：

gem 'launchy'

然后运行 bundle install 来安装 Launchy。

2. 项目的使用说明

2.1 命令行使用

Launchy 可以在命令行中直接使用，用于打开指定的 URL。例如：

launchy https://www.ruby-lang.org/

你可以通过 launchy --help 查看更多命令行选项。

2.2 使用 BROWSER 环境变量

Launchy 支持通过 BROWSER 环境变量来指定浏览器。BROWSER 变量是一个以冒号（:）分隔的命令列表，Launchy 会依次尝试这些命令。你可以在命令中使用 %s 来表示 URL 的占位符。

例如，设置 BROWSER 变量如下：

export BROWSER=/usr/local/bin/firefox-bin -new-tab '%s':/usr/local/bin/google-chrome-stable

然后调用 Launchy.open("https://www.ruby-lang.org/")，Launchy 会依次尝试以下命令：

• /usr/local/bin/firefox-bin -new-tab 'https://www.ruby-lang.org'
• /usr/local/bin/google-chrome-stable https://www.ruby-lang.org

2.3 在 Capybara 测试中使用

在 Capybara 测试中，可以使用 save_and_open_page 方法来保存并打开当前页面。首先，确保你已经安装了 Capybara 和 Rspec for Rails。

在测试代码中插入 save_and_open_page，例如：

context "signin" do
  it "lets a user sign in" do
    visit root_path
    click_link signin_path
    save_and_open_page
    page.should have_content "Enter your login information"
  end
end

当 Rspec 运行时，Launchy 会自动打开保存的页面，便于调试。

3. 项目API使用文档

3.1 公共 API

Launchy 的公共 API 是 Launchy.open(uri, options = {})，支持以下选项：

• :debug：开启调试输出。
• :application：显式指定使用的应用程序类。
• :host_os：显式指定模拟的主机操作系统。
• :dry_run：不执行任何操作，仅打印将要执行的命令到标准输出。

3.2 示例

3.2.1 打开 URL

Launchy.open("https://www.ruby-lang.org")

3.2.2 使用错误处理块

uri = "https://www.ruby-lang.org"
Launchy.open(uri) do |exception|
  puts "Attempted to open #{uri} and failed because #{exception}"
end

4. 项目安装方式

Launchy 可以通过 RubyGems 安装，具体步骤如下：

1. 打开终端。
2. 运行以下命令：

gem install launchy

如果你使用的是 Bundler，可以在 Gemfile 中添加 gem 'launchy'，然后运行 bundle install。

通过以上步骤，你可以成功安装并使用 Launchy 项目。