开源项目 `business_time` 使用教程

开源项目 business_time 使用教程

business_timeSupport for doing time math in business hours and days项目地址:https://gitcode.com/gh_mirrors/bu/business_time

1. 项目的目录结构及介绍

business_time 是一个用于处理工作日和非工作日的 Ruby 库。以下是其主要目录结构和介绍：

business_time/
├── lib/
│   ├── business_time/
│   │   ├── business_hours.rb
│   │   ├── business_days.rb
│   │   ├── config.rb
│   │   ├── time_extensions.rb
│   │   ├── version.rb
│   │   └── ...
│   └── business_time.rb
├── spec/
│   ├── business_time_spec.rb
│   ├── business_hours_spec.rb
│   ├── business_days_spec.rb
│   └── ...
├── Gemfile
├── Gemfile.lock
├── README.md
└── ...

• lib/：包含项目的核心代码。
  • business_time/：包含处理业务时间的各个模块。
    • business_hours.rb：处理业务小时的逻辑。
    • business_days.rb：处理业务日的逻辑。
    • config.rb：配置文件处理逻辑。
    • time_extensions.rb：时间扩展方法。
    • version.rb：版本信息。
  • business_time.rb：主文件，加载所有模块。
• spec/：包含测试文件。
• Gemfile：定义项目依赖。
• Gemfile.lock：依赖的锁定版本。
• README.md：项目说明文档。

2. 项目的启动文件介绍

business_time 的启动文件是 lib/business_time.rb。这个文件负责加载项目的所有核心模块，并初始化配置。以下是启动文件的主要内容：

require "business_time/version"
require "business_time/config"
require "business_time/time_extensions"
require "business_time/business_hours"
require "business_time/business_days"

module BusinessTime
  # 初始化配置
  Config.initialize
end

• require "business_time/version"：加载版本信息。
• require "business_time/config"：加载配置模块。
• require "business_time/time_extensions"：加载时间扩展方法。
• require "business_time/business_hours"：加载业务小时处理逻辑。
• require "business_time/business_days"：加载业务日处理逻辑。
• module BusinessTime：定义主模块，并初始化配置。

3. 项目的配置文件介绍

business_time 的配置文件是 lib/business_time/config.rb。这个文件定义了项目的配置选项，包括工作日开始时间、结束时间、节假日等。以下是配置文件的主要内容：

module BusinessTime
  module Config
    class << self
      attr_accessor :beginning_of_workday, :end_of_workday, :holidays

      def initialize
        @beginning_of_workday = "9:00 am"
        @end_of_workday = "5:00 pm"
        @holidays = []
      end

      def work_week=(days)
        @work_week = days.map { |day| day.downcase.to_sym }
      end

      def work_week
        @work_week ||= [:mon, :tue, :wed, :thu, :fri]
      end

      def with(options)
        old_config = {
          beginning_of_workday: @beginning_of_workday,
          end_of_workday: @end_of_workday,
          holidays: @holidays,
          work_week: @work_week
        }

        options.each do |key, value|
          send("#{key}=", value)
        end

        yield
      ensure
        old_config.each do |key, value|
          send("#{key}=", value)
        end
      end
    end
  end
end

• attr_accessor :beginning_of_workday, :end_of_workday, :holidays：定义可访问的配置属性。
• initialize：初始化

business_timeSupport for doing time math in business hours and days项目地址:https://gitcode.com/gh_mirrors/bu/business_time