Hammertime 项目技术文档

1. 安装指南

1.1 环境要求

• Ruby 版本：2.0 及以上
• 操作系统：支持主流操作系统（Windows、macOS、Linux）

1.2 安装步骤

1. 打开终端或命令行工具。
2. 使用 gem 命令安装 Hammertime：

   gem install hammertime
   

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

   gem list hammertime
   

2. 项目的使用说明

2.1 基本使用

Hammertime 是一个交互式错误控制台，类似于 Lisp 和 Smalltalk 环境中的错误控制台。它允许开发者在代码运行时捕获异常，并提供多种处理选项。

2.1.1 示例代码

以下是一个简单的示例，展示了如何使用 Hammertime：

require 'hammertime'

$broken = true

def faulty_method
  raise "Oh no!" if $broken
end

3.times do |n|
  puts "Attempt (#{n+1}/3)"
  begin
    faulty_method
    puts "No error raised"
  rescue => error
    puts "Error raised: #{error.inspect}"
  end
end

2.1.2 错误处理菜单

当程序抛出异常时，Hammertime 会显示一个菜单，提供多种处理选项：

=== Stop! Hammertime. ===
An error has occurred at example.rb:6:in `faulty_method'
The error is: #<RuntimeError: Oh no!>
1. Continue (process the exception normally)
2. Ignore (proceed without raising an exception)
3. Permit by type (don't ask about future errors of this type)
4. Permit by line (don't ask about future errors raised from this point)
5. Backtrace (show the call stack leading up to the error)
6. Debug (start a debugger)
7. Console (start an IRB session)
What now?

2.2 处理选项说明

• Continue: 继续处理异常，程序将按照正常流程处理异常。
• Ignore: 忽略异常，程序将继续执行而不抛出异常。
• Permit by type: 允许特定类型的异常不再提示。
• Permit by line: 允许从特定行抛出的异常不再提示。
• Backtrace: 显示导致异常的调用栈。
• Debug: 启动调试器。
• Console: 启动 IRB 会话，允许在异常发生时进行交互式调试。

3. 项目API使用文档

3.1 核心API

• require 'hammertime': 引入 Hammertime 库。
• raise: 抛出异常，Hammertime 会捕获并显示处理菜单。

3.2 处理选项API

• Continue: 继续处理异常。
• Ignore: 忽略异常。
• Permit by type: 允许特定类型的异常不再提示。
• Permit by line: 允许从特定行抛出的异常不再提示。
• Backtrace: 显示调用栈。
• Debug: 启动调试器。
• Console: 启动 IRB 会话。

4. 项目安装方式

4.1 通过 RubyGems 安装

使用以下命令安装 Hammertime：

gem install hammertime

4.2 手动安装

1. 从 GitHub 下载 Hammertime 源码。
2. 解压源码包。
3. 进入解压后的目录，运行以下命令进行安装：

   ruby setup.rb
   

5. 已知问题

• Hammertime 无法拦截从本地代码抛出的异常。

6. 未来计划

• 更好的 IRB 集成，支持“重试”选项。
• 在异常发生点启动控制台或调试器。
• 增加测试用例。

7. 版权信息

Copyright (c) 2010 Avdi Grimm. 详情请参阅 LICENSE 文件。