Business Time 项目技术文档

1. 安装指南

1.1 安装 Gem

要安装 business_time 这个 Gem，你可以使用以下命令：

gem install business_time

1.2 在 Rails 项目中使用

如果你在 Rails 项目中使用 business_time，可以通过以下命令生成配置文件：

rails generate business_time:config

这个命令会生成 ./config/business_time.yml 和 ./config/initializers/business_time.rb 文件，用于配置工作日的开始时间、结束时间以及节假日。

2. 项目的使用说明

2.1 基本用法

安装完成后，你可以在 Ruby 控制台中使用 business_time 提供的功能。以下是一些基本示例：

require 'business_time'

# 计算当前时间之后的业务小时
1.business_hour.from_now
4.business_hours.from_now
8.business_hours.from_now

# 计算当前时间之前的业务小时
1.business_hour.ago
4.business_hours.ago
8.business_hours.ago

# 计算当前时间之后的业务天数
1.business_day.from_now
4.business_days.from_now
8.business_days.from_now

# 计算当前时间之前的业务天数
1.business_day.ago
4.business_days.ago
8.business_days.ago

# 判断某天是否为工作日
Date.today.workday?
Date.parse("2015-12-09").workday?
Date.parse("2015-12-12").workday?

2.2 自定义业务时间

你可以调整工作日的开始和结束时间：

BusinessTime::Config.beginning_of_workday = "8:30 am"
BusinessTime::Config.end_of_workday = "5:30 pm"

或者临时覆盖配置：

BusinessTime::Config.with(beginning_of_workday: "8 am", end_of_workday: "6 pm") do
  1.business_hour.from_now
end

2.3 添加节假日

你可以添加不计算为工作日的节假日：

three_day_weekend = Date.parse("July 5th, 2010")
BusinessTime::Config.holidays << three_day_weekend

2.4 更改工作周

你可以更改工作周的定义：

BusinessTime::Config.work_week = [:sun, :mon, :tue, :wed, :thu]

2.5 计算业务时间

你可以计算两个时间之间的业务时间：

friday = Time.parse("December 24, 2010 15:00")
monday = Time.parse("December 27, 2010 11:00")
working_hours = friday.business_time_until(monday) # 9.hours

3. 项目API使用文档

3.1 计算业务时间

• 1.business_hour.from_now：计算当前时间之后的1个业务小时。
• 4.business_hours.from_now：计算当前时间之后的4个业务小时。
• 1.business_day.from_now：计算当前时间之后的1个业务天。
• Date.today.workday?：判断今天是否为工作日。

3.2 自定义配置

• BusinessTime::Config.beginning_of_workday = "8:30 am"：设置工作日的开始时间为8:30 am。
• BusinessTime::Config.end_of_workday = "5:30 pm"：设置工作日的结束时间为5:30 pm。
• BusinessTime::Config.with(beginning_of_workday: "8 am", end_of_workday: "6 pm") do ... end：临时覆盖工作时间的配置。

3.3 节假日管理

• BusinessTime::Config.holidays << holiday_date：添加节假日。
• BusinessTime::Config.work_week = [:sun, :mon, :tue, :wed, :thu]：更改工作周的定义。

3.4 计算业务时间间隔

• friday.business_time_until(monday)：计算两个时间之间的业务时间。
• friday.business_days_until(monday)：计算两个日期之间的业务天数。

4. 项目安装方式

4.1 通过 Gem 安装

gem install business_time

4.2 在 Rails 项目中生成配置文件

rails generate business_time:config

这个命令会生成配置文件，用于自定义工作时间和节假日。

---

通过以上文档，你应该能够顺利安装和使用 business_time 项目，并根据需要进行自定义配置。