biz 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27809869df3ee991371e2258e892863d22b5ad2e
-  data.tar.gz: 184a044cb47ccdb0437c5227da62bcbde65534aa
+  metadata.gz: e3d348e477f526c87601d6b59362fbb9e17b2dba
+  data.tar.gz: 83019f10ea87e74a41f317dd388dbe9d7ee204b6
 SHA512:
-  metadata.gz: 5f9fef46fd079453c482963e9e89b8ef9368451275f4626567b923119bf97c68af7cda4d44f73dcae27cf7f458aeabb980a9d6130dcd5c093beade3c32b48df4
-  data.tar.gz: f2f7dace5f2eb6b7baff6f6dc275afc7edb606e349ac7cddd7b32273ca3498434e137a1cb6b01ff3bc6d11a2b906baed602a81ac6eb003d1b2b3168b2da86c52
+  metadata.gz: c1c66c64493a052cc7d99aef3268cedb1691bbacde44f7cc731345a397e61627a7d589c789b071b7696add9585392ddbbe449cb61a185247e97a14bf6b8e055f
+  data.tar.gz: 523a4308dbda6e8e37d24d62474f70ed783b2d10ef65caabbb0047b0e21d3283d53d6b9678dff21ea46879968fd31d938aa74a272276c764b4dc6d2eb686421a

data/README.md

@@ -11,14 +11,15 @@ Time calculations using business hours.
 ## Features
 
 * Support for:
-  - Intervals spanning the entire day.
-  - Interday intervals and holidays.
   - Multiple intervals per day.
   - Multiple schedule configurations.
-* Second-level precision on all calculations.
-* Accurate handling of Daylight Saving Time.
+  - Intervals spanning the entire day.
+  - Holidays.
+  - Breaks (time-segment holidays).
+* Second-level calculation precision.
+* Seamless Daylight Saving Time handling.
 * Schedule intersection.
-* Thread-safe.
+* Thread safety.
 
 ## Anti-Features
 
@@ -51,12 +52,20 @@ Biz.configure do |config|
     sat: {'10:00' => '14:00'}
   }
 
+  config.breaks = {
+    Date.new(2006, 1, 2) => {'10:00' => '11:30'},
+    Date.new(2006, 1, 3) => {'14:15' => '14:30', '15:40' => '15:50'}
+  }
+
   config.holidays = [Date.new(2016, 1, 1), Date.new(2016, 12, 25)]
 
   config.time_zone = 'America/Los_Angeles'
 end
 ```
 
+Periods occurring on holidays are disregarded. Similarly, any segment of a
+period that overlaps with a break is treated as inactive.
+
 If global configuration isn't your thing, configure an instance instead:
 
 ```ruby
@@ -86,11 +95,19 @@ Biz.within(Time.utc(2015, 3, 7), Time.utc(2015, 3, 14)).in_seconds
 # Determine if a time is in business hours
 Biz.in_hours?(Time.utc(2015, 1, 10, 9))
 
-# Determine if a time is on a holiday
+# Determine if a time is during a break
+Biz.on_break?(Time.utc(2016, 6, 3))
+
+# Determine if a time is during a holiday
 Biz.on_holiday?(Time.utc(2014, 1, 1))
 ```
 
-Note that all returned times are in UTC.
+All returned times are in UTC.
+
+If a schedule will be configured with a large number of holidays and performance
+is a particular concern, it's recommended that holidays are filtered down to
+those relevant to the calculation(s) at hand before configuration to improve
+performance.
 
 By dropping down a level, you can get access to the underlying time segments,
 which you can use to do your own custom calculations or just get a better idea
@@ -136,6 +153,11 @@ schedule_1 = Biz::Schedule.new do |config|
     sat: {'11:00' => '14:30'}
   }
 
+  config.breaks = {
+    Date.new(2016, 6, 2) => {'09:00' => '10:30', '16:00' => '16:30'},
+    Date.new(2016, 6, 3) => {'12:15' => '12:45'}
+  }
+
   config.holidays = [Date.new(2016, 1, 1), Date.new(2016, 12, 25)]
 
   config.time_zone = 'Etc/UTC'
@@ -150,6 +172,11 @@ schedule_2 = Biz::Schedule.new do |config|
     thu: {'11:00' => '12:00', '13:00' => '14:00'}
   }
 
+  config.breaks = {
+    Date.new(2016, 6, 3) => {'13:30' => '14:00'},
+    Date.new(2016, 6, 4) => {'11:00' => '12:00'}
+  }
+
   config.holidays = [
     Date.new(2016, 1, 1),
     Date.new(2016, 7, 4),
@@ -163,8 +190,8 @@ schedule_1 & schedule_2
 ```
 
 The resulting schedule will be a combination of the two schedules: an
-intersection of the intervals, a union of the holidays, and the time zone of the
-first schedule.
+intersection of the intervals, a union of the breaks and holidays, and the time
+zone of the first schedule.
 
 For the above example, the resulting schedule would be equivalent to one with
 the following configuration:
@@ -178,6 +205,12 @@ Biz::Schedule.new do |config|
     thu: {'11:00' => '12:00', '13:00' => '14:00'}
   }
 
+  config.breaks = {
+    Date.new(2016, 6, 2) => {'09:00' => '10:30', '16:00' => '16:30'},
+    Date.new(2016, 6, 3) => {'12:15' => '12:45', '13:30' => '14:00'},
+    Date.new(2016, 6, 4) => {'11:00' => '12:00'}
+  }
+
   config.holidays = [
     Date.new(2016, 1, 1),
     Date.new(2016, 7, 4),
@@ -207,6 +240,8 @@ require 'biz/core_ext'
 
 Time.utc(2015, 8, 20, 9, 30).business_hours?
 
+Time.utc(2016, 6, 3, 12).on_break?
+
 Time.utc(2014, 1, 1, 12).on_holiday?
 
 Date.new(2015, 12, 10).business_day?

data/lib/biz.rb

@@ -25,6 +25,7 @@ module Biz
       within
       in_hours?
       business_hours?
+      on_break?
       on_holiday?
     ] => :schedule
 

data/lib/biz/calculation.rb

@@ -6,4 +6,5 @@ end
 require 'biz/calculation/active'
 require 'biz/calculation/duration_within'
 require 'biz/calculation/for_duration'
+require 'biz/calculation/on_break'
 require 'biz/calculation/on_holiday'

data/lib/biz/calculation/active.rb

@@ -8,7 +8,8 @@ module Biz
       end
 
       def result
-        schedule.intervals.any? { |interval| interval.contains?(time) } &&
+        schedule.intervals.any?   { |interval| interval.contains?(time) } &&
+          schedule.breaks.none?   { |break_| break_.contains?(time) } &&
           schedule.holidays.none? { |holiday| holiday.contains?(time) }
       end
 

data/lib/biz/calculation/on_break.rb

@@ -0,0 +1,21 @@
+module Biz
+  module Calculation
+    class OnBreak
+
+      def initialize(schedule, time)
+        @schedule = schedule
+        @time     = time
+      end
+
+      def result
+        schedule.breaks.any? { |break_| break_.contains?(time) }
+      end
+
+      protected
+
+      attr_reader :schedule,
+                  :time
+
+    end
+  end
+end

data/lib/biz/configuration.rb

@@ -21,6 +21,16 @@ module Biz
       end
     end
 
+    def breaks
+      @breaks ||= begin
+        raw
+          .breaks
+          .flat_map { |date, hours| break_periods(date, hours) }
+          .sort
+          .freeze
+      end
+    end
+
     def holidays
       @holidays ||= begin
         raw
@@ -41,12 +51,34 @@ module Biz
       @weekdays ||= raw.hours.keys.uniq.freeze
     end
 
+    def &(other)
+      self.class.new do |config|
+        config.hours     = Interval.to_hours(intersected_intervals(other))
+        config.breaks    = combined_breaks(other)
+        config.holidays  = [*raw.holidays, *other.raw.holidays].map(&:to_date)
+        config.time_zone = raw.time_zone
+      end
+    end
+
     protected
 
     attr_reader :raw
 
     private
 
+    def to_proc
+      proc do |config|
+        config.hours     = raw.hours
+        config.breaks    = raw.breaks
+        config.holidays  = raw.holidays
+        config.time_zone = raw.time_zone
+      end
+    end
+
+    def time
+      @time ||= Time.new(time_zone)
+    end
+
     def weekday_intervals(weekday, hours)
       hours.map { |start_timestamp, end_timestamp|
         Interval.new(
@@ -63,7 +95,33 @@ module Biz
       }
     end
 
-    Raw = Struct.new(:hours, :holidays, :time_zone) do
+    def break_periods(date, hours)
+      hours.map { |start_timestamp, end_timestamp|
+        TimeSegment.new(
+          time.on_date(date, DayTime.from_timestamp(start_timestamp)),
+          time.on_date(date, DayTime.from_timestamp(end_timestamp))
+        )
+      }
+    end
+
+    def intersected_intervals(other)
+      intervals.flat_map { |interval|
+        other
+          .intervals
+          .map { |other_interval| interval & other_interval }
+          .reject(&:empty?)
+      }
+    end
+
+    def combined_breaks(other)
+      Hash.new do |config, date| config.store(date, {}) end.tap do |combined|
+        [raw.breaks, other.raw.breaks].each do |configured|
+          configured.each do |date, breaks| combined[date].merge!(breaks) end
+        end
+      end
+    end
+
+    Raw = Struct.new(:hours, :breaks, :holidays, :time_zone) do
       module Default
         HOURS = {
           mon: {'09:00' => '17:00'},
@@ -73,6 +131,7 @@ module Biz
           fri: {'09:00' => '17:00'}
         }.freeze
 
+        BREAKS    = [].freeze
         HOLIDAYS  = [].freeze
         TIME_ZONE = 'Etc/UTC'.freeze
       end
@@ -81,6 +140,7 @@ module Biz
         super
 
         self.hours     ||= Default::HOURS
+        self.breaks    ||= Default::BREAKS
         self.holidays  ||= Default::HOLIDAYS
         self.time_zone ||= Default::TIME_ZONE
       end

data/lib/biz/core_ext/time.rb

@@ -5,6 +5,10 @@ module Biz
         Biz.in_hours?(self)
       end
 
+      def on_break?
+        Biz.on_break?(self)
+      end
+
       def on_holiday?
         Biz.on_holiday?(self)
       end

data/lib/biz/holiday.rb

@@ -1,6 +1,8 @@
 module Biz
   class Holiday
 
+    extend Forwardable
+
     include Comparable
 
     def initialize(date, time_zone)
@@ -8,15 +10,15 @@ module Biz
       @time_zone = time_zone
     end
 
-    def contains?(time)
-      date == Time.new(time_zone).local(time).to_date
-    end
+    delegate contains?: :to_time_segment
 
     def to_time_segment
-      TimeSegment.new(
-        Time.new(time_zone).on_date(date, DayTime.midnight),
-        Time.new(time_zone).on_date(date, DayTime.endnight)
-      )
+      @time_segment ||= begin
+        TimeSegment.new(
+          Time.new(time_zone).on_date(date, DayTime.midnight),
+          Time.new(time_zone).on_date(date, DayTime.endnight)
+        )
+      end
     end
 
     def <=>(other)

data/lib/biz/periods/abstract.rb

@@ -11,8 +11,6 @@ module Biz
         super(periods) do |yielder, period| yielder << period end
       end
 
-      delegate time_zone: :schedule
-
       def timeline
         Timeline::Proxy.new(self)
       end
@@ -28,21 +26,27 @@ module Biz
         weeks
           .lazy
           .flat_map { |week| business_periods(week) }
-          .select   { |business_period| relevant?(business_period) }
-          .map      { |business_period| business_period & boundary }
-          .reject   { |business_period|
-            schedule.holidays.any? { |holiday|
-              holiday.contains?(business_period.start_time)
-            }
-          }
+          .select   { |period| relevant?(period) }
+          .map      { |period| period & boundary }
+          .flat_map { |period| active_periods(period) }
+          .reject   { |period| on_holiday?(period) }
+          .reject(&:empty?)
       end
 
       def business_periods(week)
         intervals.lazy.map { |interval| interval.to_time_segment(week) }
       end
 
-      def intervals
-        schedule.intervals
+      def active_periods(period)
+        schedule.breaks.reduce([period]) { |periods, break_period|
+          periods.flat_map { |active_period| active_period / break_period }
+        }
+      end
+
+      def on_holiday?(period)
+        schedule.holidays.any? { |holiday|
+          holiday.contains?(period.start_time)
+        }
       end
 
     end

data/lib/biz/periods/after.rb

@@ -10,7 +10,7 @@ module Biz
 
       def weeks
         Range.new(
-          Week.since_epoch(Time.new(time_zone).local(origin)),
+          Week.since_epoch(schedule.in_zone.local(origin)),
           Week.since_epoch(Time.heat_death)
         )
       end
@@ -20,7 +20,11 @@ module Biz
       end
 
       def boundary
-        TimeSegment.after(origin)
+        @boundary ||= TimeSegment.after(origin)
+      end
+
+      def intervals
+        @intervals ||= schedule.intervals
       end
 
     end

data/lib/biz/periods/before.rb

@@ -10,7 +10,7 @@ module Biz
 
       def weeks
         Week
-          .since_epoch(Time.new(time_zone).local(origin))
+          .since_epoch(schedule.in_zone.local(origin))
           .downto(Week.since_epoch(Time.big_bang))
       end
 
@@ -18,12 +18,16 @@ module Biz
         origin > period.start_time
       end
 
+      def active_periods(*)
+        super.reverse
+      end
+
       def boundary
-        TimeSegment.before(origin)
+        @boundary ||= TimeSegment.before(origin)
       end
 
       def intervals
-        super.reverse
+        @intervals ||= schedule.intervals.reverse
       end
 
     end

data/lib/biz/schedule.rb

@@ -9,6 +9,7 @@ module Biz
 
     delegate %i[
       intervals
+      breaks
       holidays
       time_zone
       weekdays
@@ -36,38 +37,27 @@ module Biz
       Calculation::Active.new(self, time).result
     end
 
+    alias business_hours? in_hours?
+
+    def on_break?(time)
+      Calculation::OnBreak.new(self, time).result
+    end
+
     def on_holiday?(time)
       Calculation::OnHoliday.new(self, time).result
     end
 
-    alias business_hours? in_hours?
-
     def in_zone
       Time.new(time_zone)
     end
 
     def &(other)
-      self.class.new do |config|
-        config.hours     = Interval.to_hours(intersected_intervals(other))
-        config.holidays  = [*holidays, *other.holidays].map(&:to_date)
-        config.time_zone = time_zone.name
-      end
+      self.class.new(&(configuration & other.configuration))
     end
 
     protected
 
     attr_reader :configuration
 
-    private
-
-    def intersected_intervals(other)
-      intervals.flat_map { |interval|
-        other
-          .intervals
-          .map { |other_interval| interval & other_interval }
-          .reject(&:empty?)
-      }
-    end
-
   end
 end

data/lib/biz/time_segment.rb

@@ -32,7 +32,7 @@ module Biz
     end
 
     def contains?(time)
-      (start_time..end_time).cover?(time)
+      (start_time...end_time).cover?(time)
     end
 
     def &(other)
@@ -42,6 +42,13 @@ module Biz
       self.class.new(lower_bound, [lower_bound, upper_bound].max)
     end
 
+    def /(other)
+      [
+        self.class.new(start_time, other.start_time),
+        self.class.new(other.end_time, end_time)
+      ].reject(&:empty?).map { |potential| self & potential }
+    end
+
     def <=>(other)
       return unless other.is_a?(self.class)
 

data/lib/biz/version.rb

@@ -1,3 +1,3 @@
 module Biz
-  VERSION = '1.5.2'.freeze
+  VERSION = '1.6.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biz
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Craig Little
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clavius
@@ -81,6 +81,7 @@ files:
 - lib/biz/calculation/active.rb
 - lib/biz/calculation/duration_within.rb
 - lib/biz/calculation/for_duration.rb
+- lib/biz/calculation/on_break.rb
 - lib/biz/calculation/on_holiday.rb
 - lib/biz/configuration.rb
 - lib/biz/core_ext.rb