Boson 项目技术文档

1. 安装指南

1.1 系统要求

• Ruby 版本 >= 1.9.2
• 支持所有主流 Ruby 版本

1.2 安装步骤

1. 使用 gem 命令安装 Boson：

   gem install boson
   

2. 如果你使用的是较旧版本的 Boson，建议阅读升级文档以了解新版本的改动：

   gem install boson
   

3. 安装完成后，可以通过以下命令验证安装是否成功：

   boson --version
   

2. 项目的使用说明

2.1 基本概念

Boson 是一个模块化的命令/任务框架，具有丰富的插件支持。它与 Rake 和 Thor 不同之处在于：

• 可以在 irb 和命令行中使用。
• 自动生成视图（通过 Hirb）。
• 允许库以纯 Ruby 编写。

2.2 示例执行文件

以下是一个简单的 Boson 执行文件示例：

#!/usr/bin/env ruby
require 'boson/runner'

class CowRunner < Boson::Runner
  option :urgent, type: :boolean
  def say(text, options={})
    text.capitalize! if options[:urgent]
    puts text
  end

  def moo
    puts "MOOOO"
  end
end

CowRunner.start

你可以通过以下命令执行：

$ cow say hungry
hungry
$ cow moo
MOOOO
$ cow say hungry -urgent
HUNGRY

2.3 与 Thor 的对比

Boson 与 Thor 相比有以下优势：

• 支持插件扩展。
• 命令易于测试。
• 支持自定义选项类型。
• 自动生成子命令的使用说明。
• 没有命令名称的黑名单。

3. 项目API使用文档

3.1 核心API

Boson 的核心 API 主要包括以下几个类和模块：

• Boson::Runner：用于定义和执行命令的基类。
• Boson::Options：用于处理命令选项。
• Boson::BareRunner：提供了一个最小化的 Runner 实现。

3.2 插件API

Boson 的插件 API 允许第三方库通过扩展核心类来添加功能。例如，可以通过扩展 Boson::BareRunner 来修改启动行为：

module Boson
  module CustomStartUp
    def start(*)
      super
      # 自定义启动逻辑
    end
  end
end

Boson::BareRunner.extend Boson::CustomStartUp

3.3 自定义命令和选项

你可以通过以下方式添加自定义命令和全局选项：

class Boson::DefaultCommandsRunner
  desc "whoomp"
  def whoomp
    puts "WHOOMP there it is!"
  end
end

Boson::Runner::GLOBAL_OPTIONS.update(
  verbose: {type: :boolean, desc: "Verbose description of loading libraries"}
)

4. 项目安装方式

4.1 通过 Gem 安装

使用 gem 命令安装 Boson：

gem install boson

4.2 手动安装

1. 从 GitHub 下载项目源码：

   git clone https://github.com/cldwalker/boson.git
   

2. 进入项目目录并安装依赖：

   cd boson
   bundle install
   

3. 安装 Boson：

   rake install
   

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