business_time 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dc74d9cffafd72acce648d07bdceed471344dfd
-  data.tar.gz: 6394c590be260dddde6c2738090cf00c03060368
+  metadata.gz: f2f2a3838d12a29f3825e56dfb6d3d588ad88dc9
+  data.tar.gz: ca0ec6507d0587296d85375f6a0c25caf2ff8654
 SHA512:
-  metadata.gz: c0321b6695f50318379b00423f54aca445eb53a5b1c2ee9b1ba1a164a442f4090c56bd6a541a00e3b527bc80ab4f0ba139e407aa6f12e84b445afe7958885692
-  data.tar.gz: 633875c242cb89ae62ec2d9e2361ff16e7b2b91ad5216c7b2198f36d1631eaa4f33f502b86f4d13b05ba5fc77e34c76c398706d403c70024f84cef17c0940834
+  metadata.gz: a8afbc63ea4ed9c3b96bd967079144b3eef20b2b592d1fd33e9e65df379eb49af8ba7570bf18f57033c02a442755829cebbdbd926d960676780d49e24cfade27
+  data.tar.gz: 9c8bc1f7392c4e191bd61a1609fe8568e9131a915721a77678d3c8f8977f193284a9bf04a4632a74f035de1a5d8c4b252767b6ddb8295df232d2da3fda2481a5

data/README.rdoc

@@ -166,6 +166,16 @@ Timezone relative date handling gets more and more complicated every time you lo
 
 == Releases
 
+0.9.0 - PR#143 - performance improvements on hour date calculations
+        PR#144 - new feature - Fiscal date methods.
+		
+0.8.0 - Ruby 2.4 compatibility 4/1/2017 (yes, this is the same as 0.9.0)
+        I released the 2.4 upgrade separately than the other new features
+		so that people have an upgrade path to 2.4 without mixing in new
+		features.
+        Forces a particular date format for Regex
+		A small change to include the version number in the project itself.
+		
 0.7.6 - Fixed a defect where timezone was not preserved when dealing with beginning_or_workday and end_of_workday.
         Thanks bazzargh.
         
@@ -220,6 +230,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-2017 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/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
@@ -42,9 +59,17 @@ module BusinessTime
       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
@@ -55,13 +80,13 @@ module BusinessTime
     # by saying
     #   BusinessTime::Config.beginning_of_workday = "8:30 am"
     # someplace in the initializers of your application.
-    threadsafe_cattr_accessor :beginning_of_workday
+    threadsafe_cattr_reader :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
+    threadsafe_cattr_reader :end_of_workday
 
     # You can set this yourself, either by the load method below, or
     # by saying
@@ -79,18 +104,20 @@ 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
       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
@@ -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:

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

data/lib/business_time/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business_time
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - bokmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,6 +111,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