business_time 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7dc74d9cffafd72acce648d07bdceed471344dfd
-  data.tar.gz: 6394c590be260dddde6c2738090cf00c03060368
+SHA256:
+  metadata.gz: cb1621dd19416fb58fba1a2dcaff32e65542e29e18d09fdea0a9d7dca621f132
+  data.tar.gz: ef8f7a0816e6e1df588a3e14424894b397df07e4217718594dd109c6c2bc4aaf
 SHA512:
-  metadata.gz: c0321b6695f50318379b00423f54aca445eb53a5b1c2ee9b1ba1a164a442f4090c56bd6a541a00e3b527bc80ab4f0ba139e407aa6f12e84b445afe7958885692
-  data.tar.gz: 633875c242cb89ae62ec2d9e2361ff16e7b2b91ad5216c7b2198f36d1631eaa4f33f502b86f4d13b05ba5fc77e34c76c398706d403c70024f84cef17c0940834
+  metadata.gz: fa4d68c497aa80d701692dc5182837603e8cd66cdef810298fb727f29b65d5c92b22da9b3ce5a6f1c5e4533551b3de1b4a7591931c1f68dc3c0e1dde8b62dd66
+  data.tar.gz: a62611ad7ac045fa795a98eaca9fed77a86725bc09a87e4941290ad2f7bda3a3851756fc22d609b802fadfc122440945f58f6bc240140bcd6bc19c0b21820ecf

data/README.rdoc

@@ -1,6 +1,6 @@
 = business_time
 
-{<img src="https://secure.travis-ci.org/bokmann/business_time.png" />}[http://travis-ci.org/bokmann/business_time]
+{<img src="https://github.com/bokmann/business_time/workflows/CI/badge.svg" />}[https://github.com/bokmann/business_time/actions?query=workflow%3ACI]
 
 ActiveSupport gives us some great helpers so we can do things like:
 
@@ -42,7 +42,7 @@ I needed this, but taking into account business hours/days and holidays.
     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?
@@ -164,22 +164,6 @@ Timezone relative date handling gets more and more complicated every time you lo
     # BusinessTime::Config.holidays << holiday[:date].next_week if !holiday[:date].weekday?
   end
 
-== Releases
-
-0.7.6 - Fixed a defect where timezone was not preserved when dealing with beginning_or_workday and end_of_workday.
-        Thanks bazzargh.
-        
-0.7.2 - 0.7.5 - many pull requests from contributors, and a changelog was not adequately kept.  I regret that.
-                git blame is your friend for diagnosing these dark days.
-                
-0.7.1 - fixing a multithreaded issue, upgrading some dependencies, loosening the dependency on TZInfo
-
-0.7.0 - major maintenance upgrade on the process of constructing the gem, testing the gem, and updating dependencies.
-        the api has not changed.
-
-
-0.6.2 - rchady pointed out that issue #14 didn't appear to be released.  This fixes that, as well as confirms that all tests run as expected on Ruby 2.0.0p195
-
 == Contributors
  * David Bock  http://github.com/bokmann
  * Enrico Bianco  http://github.com/enricob
@@ -220,6 +204,20 @@ Timezone relative date handling gets more and more complicated every time you lo
   need the baggage.
 
 
+== A note on stability and change
+
+Sometimes people ask me why this gem doesn't release more often.  My opinions on that are best discussed in person in a friendly discussion, but I'll attempt some of that here.
+
+First, a big part of the reason is that the projects I do use this gem on are happy with it's current functionality.  It is 'suitable for the purpose' for which I released it, and as such, maintenance I do on this gem is a gift to the community.
+
+Second, out of the ~1.3 million downloads (according to rubygems.org), the number of real 'issues' with this gem have been minimal.  Most of the issues that are opened are really people with slightly different requirements than I have regarding whether 'off hours' work counts as the previous or the next business day, a disagreement on the semantics of days vs. hours, etc.  I take care to try to explain these choices in the open issues, but to my mind, they aren't true issues if it's just a difference of opinion.  Even so, I'll gladly accept pull requests that resolve this difference of opinion as a configuration option... just don't expect me to do your job for you.  I've already given you 90% of what you need.
+
+Third, a business time gem is, well, relevant to businesses.  Many businesses don't move quickly.  My government clients move even more slowly.  Stability is favored in these environments.
+
+Fourth, new features can wait.  To the person that adds them they can be mission critical, but with modern packaging processes, they can use their version without waiting for their changes to be included in the upstream version.  Their changes don't break your code.
+
+I'm proud of the work in this gem; the stability is a big part of that.  This gem has lived longer than many others that have attempted to do the same thing.  I expect it to be here chugging away when Ruby has become the next COBOL.
+
 == Copyright
 
-Copyright (c) 2010-2016 bokmann. See LICENSE for details.
+Copyright (c) 2010-2021 bokmann. See LICENSE for details.

data/lib/business_time.rb

@@ -4,6 +4,7 @@ require 'active_support/time'
 require 'time'
 require 'yaml'
 
+require 'business_time/parsed_time'
 require 'business_time/version'
 require 'business_time/config'
 require 'business_time/business_hours'

data/lib/business_time/business_days.rb

@@ -17,7 +17,29 @@ module BusinessTime
     end
 
     def after(time = Time.current)
-      days = @days
+      non_negative_days? ? calculate_after(time, @days) : calculate_before(time, -@days)
+    end
+
+    alias_method :from_now, :after
+    alias_method :since, :after
+
+    def before(time = Time.current)
+      non_negative_days? ? calculate_before(time, @days) : calculate_after(time, -@days)
+    end
+
+    alias_method :ago, :before
+    alias_method :until, :before
+
+    private
+
+    def non_negative_days?
+      @days >= 0
+    end
+
+    def calculate_after(time, days)
+      if (time.is_a?(Time) || time.is_a?(DateTime)) && !time.workday?
+        time = Time.beginning_of_workday(time)
+      end
       while days > 0 || !time.workday?
         days -= 1 if time.workday?
         time += 1.day
@@ -30,11 +52,10 @@ module BusinessTime
       time
     end
 
-    alias_method :from_now, :after
-    alias_method :since, :after
-
-    def before(time = Time.current)
-      days = @days
+    def calculate_before(time, days)
+      if (time.is_a?(Time) || time.is_a?(DateTime)) && !time.workday?
+        time = Time.beginning_of_workday(time)
+      end
       while days > 0 || !time.workday?
         days -= 1 if time.workday?
         time -= 1.day
@@ -48,8 +69,5 @@ module BusinessTime
       end
       time
     end
-
-    alias_method :ago, :before
-    alias_method :until, :before
   end
 end

data/lib/business_time/business_hours.rb

@@ -24,9 +24,24 @@ module BusinessTime
     end
 
     def after(time)
+      non_negative_hours? ? calculate_after(time, @hours) : calculate_before(time, -@hours)
+    end
+    alias_method :since, :after
+
+    def before(time)
+      non_negative_hours? ? calculate_before(time, @hours) : calculate_after(time, -@hours)
+    end
+
+    private
+
+    def non_negative_hours?
+      @hours >= 0
+    end
+
+    def calculate_after(time, hours)
       after_time = Time.roll_forward(time)
       # Step through the hours, skipping over non-business hours
-      @hours.times do
+      hours.times do
         after_time = after_time + 1.hour
 
         if after_time.hour == 0 && after_time.min == 0 && after_time.sec == 0
@@ -44,12 +59,11 @@ module BusinessTime
       end
       after_time
     end
-    alias_method :since, :after
 
-    def before(time)
+    def calculate_before(time, hours)
       before_time = Time.roll_backward(time)
       # Step through the hours, skipping over non-business hours
-      @hours.times do
+      hours.times do
         before_time = before_time - 1.hour
 
         if before_time.hour == 0 && before_time.min == 0 && before_time.sec == 0

data/lib/business_time/config.rb

@@ -7,16 +7,33 @@ module BusinessTime
   # manually, or with a yaml file and the load method.
   class Config
     DEFAULT_CONFIG = {
-      holidays:              [],
-      beginning_of_workday:  '9:00 am',
-      end_of_workday:        '5:00 pm',
+      holidays:              SortedSet.new,
+      beginning_of_workday:  ParsedTime.parse('9:00 am'),
+      end_of_workday:        ParsedTime.parse('5:00 pm'),
       work_week:             %w(mon tue wed thu fri),
       work_hours:            {},
       work_hours_total:      {},
       _weekdays:             nil,
+      fiscal_month_offset:   10,
     }
 
     class << self
+      def beginning_of_workday=(time)
+        config[:beginning_of_workday] = ParsedTime.parse(time)
+      end
+
+      def end_of_workday=(time)
+        config[:end_of_workday] = ParsedTime.parse(time)
+      end
+
+      def work_hours=(work_hours)
+        work_hours.each_with_object(config[:work_hours] = {}) do |(day, hours), c|
+          c[day] = hours.map do |time|
+            ParsedTime.parse(time)
+          end
+        end
+      end
+
       private
 
       def config
@@ -30,44 +47,40 @@ module BusinessTime
       end
 
       def local_config
-        Thread.current[:business_time_local_config]
+        local_config_stack.last
       end
 
       def local_config=(config)
-        Thread.current[:business_time_local_config] = config
+        local_config_stack.last.replace(config)
+      end
+
+      def local_config_stack
+        Thread.current[:business_time_local_config] ||= []
       end
 
       def local_config?
-        !local_config.nil?
+        !local_config_stack.empty?
       end
 
       def threadsafe_cattr_accessor(name)
+        threadsafe_cattr_reader(name)
+        threadsafe_cattr_setter(name)
+      end
+
+      def threadsafe_cattr_reader(name)
         define_singleton_method name do
           config[name]
         end
+      end
+
+      def threadsafe_cattr_setter(name)
         define_singleton_method "#{name}=" do |value|
           config[name] = value
         end
       end
     end
 
-    # You can set this yourself, either by the load method below, or
-    # by saying
-    #   BusinessTime::Config.beginning_of_workday = "8:30 am"
-    # someplace in the initializers of your application.
-    threadsafe_cattr_accessor :beginning_of_workday
-
-    # You can set this yourself, either by the load method below, or
-    # by saying
-    #   BusinessTime::Config.end_of_workday = "5:30 pm"
-    # someplace in the initializers of your application.
-    threadsafe_cattr_accessor :end_of_workday
-
-    # You can set this yourself, either by the load method below, or
-    # by saying
-    #   BusinessTime::Config.work_week = [:sun, :mon, :tue, :wed, :thu]
-    # someplace in the initializers of your application.
-    threadsafe_cattr_accessor :work_week
+    threadsafe_cattr_reader :work_week
 
     # You can set this yourself, either by the load method below, or
     # by saying
@@ -79,23 +92,33 @@ module BusinessTime
     # and end_of_workday. Keys will be added ad weekdays.
     # Example:
     #    {:mon => ["9:00","17:00"],:tue => ["9:00","17:00"].....}
-    threadsafe_cattr_accessor :work_hours
+    threadsafe_cattr_reader :work_hours
 
     # total work hours for a day. Never set, always calculated.
     threadsafe_cattr_accessor :work_hours_total
 
     threadsafe_cattr_accessor :_weekdays # internal
 
+    threadsafe_cattr_accessor :fiscal_month_offset
+
     class << self
+      # You can set this yourself, either by the load method below, or
+      # by saying
+      #   BusinessTime::Config.end_of_workday = "5:30 pm"
+      # someplace in the initializers of your application.
       def end_of_workday(day=nil)
         if day
           wday = work_hours[int_to_wday(day.wday)]
-          wday ? (wday.last =~ /^0{1,2}\:0{1,2}$/ ? "23:59:59" : wday.last) : config[:end_of_workday]
+          wday ? (wday.last == ParsedTime.new(0, 0) ? ParsedTime.new(23, 59, 59) : wday.last) : config[:end_of_workday]
         else
           config[:end_of_workday]
         end
       end
 
+      # You can set this yourself, either by the load method below, or
+      # by saying
+      #   BusinessTime::Config.beginning_of_workday = "8:30 am"
+      # someplace in the initializers of your application.
       def beginning_of_workday(day=nil)
         if day
           wday = work_hours[int_to_wday(day.wday)]
@@ -105,6 +128,10 @@ module BusinessTime
         end
       end
 
+      # You can set this yourself, either by the load method below, or
+      # by saying
+      #   BusinessTime::Config.work_week = [:sun, :mon, :tue, :wed, :thu]
+      # someplace in the initializers of your application.
       def work_week=(days)
         config[:work_week] = days
         self._weekdays = nil
@@ -113,10 +140,11 @@ module BusinessTime
       def weekdays
         return _weekdays unless _weekdays.nil?
 
-        self._weekdays = (!work_hours.empty? ? work_hours.keys : work_week).each_with_object([]) do |day_name, days|
-          day_num = wday_to_int(day_name)
-          days << day_num unless day_num.nil?
-        end
+        days = (!work_hours.empty? ? work_hours.keys : work_week).map do |day_name|
+          wday_to_int(day_name)
+        end.compact
+
+        self._weekdays = SortedSet.new(days)
       end
 
       # loads the config data from a yaml file written as:
@@ -145,11 +173,11 @@ module BusinessTime
       end
 
       def with(config)
-        self.local_config = config().dup
+        local_config_stack.push(config().dup)
         config.each { |k,v| send("#{k}=", v) } # calculations are done on setting
         yield
       ensure
-        self.local_config = nil
+        local_config_stack.pop
       end
 
       def default_config
@@ -168,8 +196,8 @@ module BusinessTime
       end
 
       def reset
-        self.config       = default_config
-        self.local_config = nil
+        local_config_stack.clear
+        self.config = default_config
       end
 
       def deep_dup(object)

data/lib/business_time/core_ext/date.rb

@@ -13,4 +13,49 @@ class Date
       (self...to_date).select(&:workday?)
     end
   end
+
+  # Adapted from:
+  # https://github.com/activewarehouse/activewarehouse/blob/master/lib/active_warehouse/core_ext/time/calculations.rb
+
+  def week
+    cyw = ((yday - 1) / 7) + 1
+    cyw = 52 if cyw == 53
+    cyw
+  end
+
+  def quarter
+    ((month - 1) / 3) + 1
+  end
+
+  def fiscal_month_offset
+    BusinessTime::Config.fiscal_month_offset
+  end
+
+  def fiscal_year_week
+    fyw = ((fiscal_year_yday - 1) / 7) + 1
+    fyw = 52 if fyw == 53
+    fyw
+  end
+
+  def fiscal_year_month
+    shifted_month = month - (fiscal_month_offset - 1)
+    shifted_month += 12 if shifted_month <= 0
+    shifted_month
+  end
+
+  def fiscal_year_quarter
+    ((fiscal_year_month - 1) / 3) + 1
+  end
+
+  def fiscal_year
+    month >= fiscal_month_offset ? year + 1 : year
+  end
+
+  def fiscal_year_yday
+    offset_days = 0
+    1.upto(fiscal_month_offset - 1) { |m| offset_days += ::Time.days_in_month(m, year) }
+    shifted_year_day = yday - offset_days
+    shifted_year_day += 365 if shifted_year_day <= 0
+    shifted_year_day
+  end
 end

data/lib/business_time/parsed_time.rb

@@ -0,0 +1,34 @@
+module BusinessTime
+  class ParsedTime
+    include Comparable
+
+    attr_reader :hour, :min, :sec
+
+    def initialize(hour, min = 0, sec = 0)
+      @hour = hour
+      @min = min
+      @sec = sec
+    end
+
+    def self.parse(time_or_string)
+      if time_or_string.is_a?(String)
+        time = Time.parse(time_or_string)
+      else
+        time = time_or_string
+      end
+      new(time.hour, time.min, time.sec)
+    end
+
+    def to_s
+      "#{hour}:#{min}:#{sec}"
+    end
+
+    def -(other)
+      (hour - other.hour) * 3600 + (min - other.min) * 60 + sec - other.sec
+    end
+
+    def <=>(other)
+      [hour, min, sec] <=> [other.hour, other.min, other.sec]
+    end
+  end
+end

data/lib/business_time/time_extensions.rb

@@ -17,7 +17,7 @@ module BusinessTime
       # Note: It pretends that this day is a workday whether or not it really is a
       # workday.
       def end_of_workday(day)
-        end_of_workday = Time.parse(BusinessTime::Config.end_of_workday(day))
+        end_of_workday = BusinessTime::Config.end_of_workday(day)
         change_business_time(day,end_of_workday.hour,end_of_workday.min,end_of_workday.sec)
       end
 
@@ -26,7 +26,7 @@ module BusinessTime
       # Note: It pretends that this day is a workday whether or not it really is a
       # workday.
       def beginning_of_workday(day)
-        beginning_of_workday = Time.parse(BusinessTime::Config.beginning_of_workday(day))
+        beginning_of_workday = BusinessTime::Config.beginning_of_workday(day)
         change_business_time(day,beginning_of_workday.hour,beginning_of_workday.min,beginning_of_workday.sec)
       end
 
@@ -116,15 +116,15 @@ module BusinessTime
         if hours = BusinessTime::Config.work_hours[day]
           BusinessTime::Config.work_hours_total[day] ||= begin
             hours_last = hours.last
-            if hours_last == '00:00'
-              (Time.parse('23:59') - Time.parse(hours.first)) + 1.minute
+            if hours_last == ParsedTime.new(0, 0)
+              (ParsedTime.new(23, 59) - hours.first) + 1.minute
             else
-              Time.parse(hours_last) - Time.parse(hours.first)
+              hours_last - hours.first
             end
           end
         else
           BusinessTime::Config.work_hours_total[:default] ||= begin
-            Time.parse(BusinessTime::Config.end_of_workday) - Time.parse(BusinessTime::Config.beginning_of_workday)
+            BusinessTime::Config.end_of_workday - BusinessTime::Config.beginning_of_workday
           end
         end
       end
@@ -169,5 +169,30 @@ module BusinessTime
     def during_business_hours?
       self.workday? && self.to_i.between?(Time.beginning_of_workday(self).to_i, Time.end_of_workday(self).to_i)
     end
+
+    def consecutive_workdays
+      workday? ? consecutive_days { |date| date.workday? } : []
+    end
+
+    def consecutive_non_working_days
+      !workday? ? consecutive_days { |date| !date.workday? } : []
+    end
+
+    private
+
+    def consecutive_days
+      days = []
+      date = self + 1.day
+      while yield(date)
+        days << date
+        date += 1.day
+      end
+      date = self - 1.day
+      while yield(date)
+        days << date
+        date -= 1.day
+      end
+      (days << self).sort
+    end
   end
 end

data/lib/business_time/version.rb

@@ -1,3 +1,3 @@
 module BusinessTime
-  VERSION = "0.8.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: business_time
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - bokmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorted_set
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +125,7 @@ files:
 - lib/business_time/core_ext/date.rb
 - lib/business_time/core_ext/integer.rb
 - lib/business_time/core_ext/time.rb
+- lib/business_time/parsed_time.rb
 - lib/business_time/time_extensions.rb
 - lib/business_time/version.rb
 - lib/generators/business_time/config_generator.rb
@@ -121,7 +136,7 @@ homepage: https://github.com/bokmann/business_time
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,9 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: Support for doing time math in business hours and days
 test_files: []