Vegas 项目技术文档

1. 安装指南

安装步骤

1. 打开终端或命令行工具。
2. 输入以下命令以安装 Vegas 项目：

   sudo gem install vegas
   

3. 等待安装完成。

Windows 用户注意事项

在 Windows 系统上使用 Vegas 时，可能会遇到一些问题。虽然 Vegas 可以在 Windows 上运行，但某些功能可能不完全相同。例如，守护进程化和浏览器启动功能可以正常工作，但可能会出现重复消息。建议在 Windows 上运行 Vegas 应用时使用 -F（前台）标志。

如果遇到以下警告：

`expand_path': couldn't find HOME environment -- expanding `~/.vegas' (ArgumentError)

需要设置 HOME 路径：

c:\> set HOME=%HOMEPATH%

2. 项目的使用说明

基本使用

假设你有一个 Sinatra 应用，代码如下：

# /my_app.rb
require 'rubygems'
require 'sinatra/base'

class MyApp < Sinatra::Base
  get '/' do
    "This is my app"
  end
end

你可以使用 Vegas 将其转换为一个可执行的二进制文件：

# /usr/bin/env ruby
# /myapp
require File.expand_path(File.dirname(__FILE__) + '/my_app.rb')
require 'vegas'

Vegas::Runner.new(MyApp, 'my_app')

运行 ./my_app 后，Vegas 会：

• 找到合适的 Rack 处理器（如 thin、mongrel）
• 找到一个可用的端口
• 在浏览器中启动应用
• 将自身置于后台
• 写入一个 .pid 文件和一个 .url 文件

命令行选项

运行 ./my_app -h 或 ./my_app --help 可以查看可用的命令行选项。

自定义选项

你可以通过块添加特定于应用的选项：

Vegas::Runner.new(AppClass, 'app_name') do |runner, opts, app|
  # runner 是 Vegas::Runner 的实例
  # opts 是一个选项解析器对象
  # app 是你的应用类
end

3. 项目 API 使用文档

Vegas::Runner 类

Vegas::Runner 类是 Vegas 的核心类，用于将 Sinatra 应用转换为可执行的二进制文件。

方法

• new(app_class, app_name)：初始化一个新的 Vegas::Runner 实例。

  • app_class：Sinatra 应用类。
  • app_name：应用名称。

• run：运行应用。

示例

Vegas::Runner.new(MyApp, 'my_app').run

4. 项目安装方式

通过 RubyGems 安装

sudo gem install vegas

从 GitHub 安装

sudo gem install quirkey-vegas -s http://gems.github.com

下载源代码

可以从 GitHub 下载源代码：

git clone https://github.com/quirkey/vegas.git

许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。