⏰ 一款现代的 Ruby 宝石,可用于计算与工作时间相关的时间。
A modern ruby gem allowing to do time calculation with working hours.
Compatible and tested with:
3.1, 3.2, 3.3, 4.0, JRuby 9.47.x, 8.xGemfile:
gem 'working_hours'…The working hours configuration is thread safe and consists of a hash defining working periods for each day, a time zone and a list of days off. You can set it once, for example in a initializer for rails:
# Configure working hours
WorkingHours::Config.working_hours = {
:tue => {'09:00' => '12:00', '13:00' => '17:00'},
:wed => {'09:00' => '12:00', '13:00' => '17:00'},
:thu => {'09:00' => '12:00', '13:00' => '17:00'},
:fri => {'09:00' => '12:00', '13:00' => '17:05:30'},
:sat => {'19:00' => '24:00'}
}
# Configure timezone (uses activesupport, defaults to UTC)
WorkingHours::Config.time_zone = 'Paris'
# Configure holidays
WorkingHours::Config.holidays = [Date.new(2014, 12, 31)]Or you can set it for the duration of a block with the with_config method, this is particularly useful with around_filter:
WorkingHours::Config.with_config(working_hours: {mon:{'09:00' => '18:00'}}, holidays: [], time_zone: 'Paris') do
# Intense calculations
endwith_config uses keyword arguments, you can pass all or some of the supported arguments :
working_hoursholidaystime_zoneSometimes you need to configure different working hours as a one-off, e.g. the working day might end earlier on Christmas Eve.
You can configure this with the holiday_hours option, either as an override on the existing working hours, or as a set of hours that are being worked on a holiday day.
If any hours are set for a calendar day in holiday_hours, then the working_hours for that day will be ignored, and only the entries in holiday_hours taken into consideration.
# Configure holiday hours
WorkingHours::Config.holiday_hours = {Date.new(2020, 12, 24) => {'09:00' => '12:00', '13:00' => '15:00'}}If the configuration is erroneous, an WorkingHours::InvalidConfiguration exception will be raised containing the appropriate error message.
You can also access the error code in case you want to implement custom behavior or changing one specific message, e.g:
rescue WorkingHours::InvalidConfiguration => e
if e.error_code == :empty
raise StandardError.new "Config is required"
end
raise e
endCore extensions (monkey patching to add methods on Time, Date, Numbers, etc.) are handy but not appreciated by everyone. WorkingHours can also be used without any monkey patching:
…If you want to use working hours only inside a specific class or module, you can include its computation methods like this:
require 'working_hours/module'
class Order
include WorkingHours
def shipping_date_estimate
Duration.new(2, :days).since(payment_received_at)
end
def payment_delay
working_days_between(created_at, payment_received_at)
end
endThis gem uses a simple but efficient approach in dealing with timezones. When you define your working hours you have to choose a timezone associated with it (in the config example, the working hours are in Paris time). Then, any time used in calculation will be converted to this timezone first, so you don't have to worry if your times are local or UTC as long as they are correct :)
There is a gem called business_time already available to do this kind of computation and it was of great help to us. But we decided to start another one because business_time is suffering from a few bugs and inconsistencies. It also lacks essential features to us (like working minutes computation).
Another gem called biz was released after working_hours to bring some alternative.
git checkout -b my-new-feature)git commit -am 'Add some feature')git push origin my-new-feature)暂无开放 Issues,或尚未同步最近议题。