ice_cube 项目技术文档

1. 安装指南

1.1 安装环境要求

• Ruby 版本：>= 0
• 推荐使用 ActiveSupport 以支持多时区（尤其是夏令时）。

1.2 安装步骤

1. 打开终端或命令行工具。
2. 运行以下命令安装 ice_cube gem：

   gem install ice_cube
   

2. 项目的使用说明

2.1 创建一个简单的计划

ice_cube 是一个用于处理重复事件（计划）的 Ruby 库。你可以通过简单的 Ruby 语法来定义复杂的重复规则。

示例：创建一个每月的计划

require 'ice_cube'

schedule = IceCube::Schedule.new
schedule.add_recurrence_rule(
  IceCube::Rule.monthly.day_of_month(15)
)

2.2 检查计划是否在某天发生

你可以使用 occurs_on? 方法来检查计划是否在某一天发生。

schedule.occurs_on?(Date.new(2023, 10, 15)) # 返回 true

2.3 获取计划的下一个发生时间

使用 next_occurrence 方法可以获取计划的下一个发生时间。

next_occurrence = schedule.next_occurrence
puts next_occurrence

3. 项目API使用文档

3.1 创建计划

• IceCube::Schedule.new(start_time = Time.now)：创建一个新的计划，start_time 是计划的开始时间。

3.2 添加重复规则

• add_recurrence_rule(rule)：向计划中添加一个重复规则。

示例：

schedule.add_recurrence_rule(IceCube::Rule.daily)

3.3 添加例外时间

• add_exception_time(time)：向计划中添加一个例外时间，该时间将不会被包含在计划中。

示例：

schedule.add_exception_time(Time.now + 1.day)

3.4 获取所有发生时间

• all_occurrences：获取计划的所有发生时间（仅适用于有限计划）。

示例：

occurrences = schedule.all_occurrences

3.5 检查计划是否在某时间发生

• occurs_at?(time)：检查计划是否在某特定时间发生。

示例：

schedule.occurs_at?(Time.now + 2.days)

3.6 获取下一个发生时间

• next_occurrence(from_time = Time.now)：获取从指定时间开始的下一个发生时间。

示例：

next_occurrence = schedule.next_occurrence

4. 项目安装方式

4.1 通过 RubyGems 安装

最简单的安装方式是通过 RubyGems 安装 ice_cube：

gem install ice_cube

4.2 在 Gemfile 中添加

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

gem 'ice_cube'

然后运行：

bundle install

4.3 手动安装

你也可以手动下载并安装 ice_cube gem：

1. 下载 ice_cube gem 文件。
2. 运行以下命令安装：

   gem install ice_cube-<version>.gem
   

通过以上步骤，你可以轻松安装并使用 ice_cube 来处理复杂的重复事件计划。