biz 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f865f5197acf9cc026d7d77c15626a7d03a5e8c1
-  data.tar.gz: 5d150d70060e27513f373c3b32e96dbd0e4f68fc
+  metadata.gz: 33c5eb58e4e8d9ee6f5b42c071c99e8c8cf8ed5b
+  data.tar.gz: 05fdc0175b78e6147aaffcaea14d274955744a2d
 SHA512:
-  metadata.gz: a3eb38f1f622c23d1d1524ad053ae07bd789277d0a3b5b5a8bb42a2aef7453d8a976eed7878e97b8207861b0e58860d6a6e5950bc5507468e44ea62ba82c6e3e
-  data.tar.gz: 6871ae32bf137626682626e80f8f4ae115b162b1d7ac104ed1b615e0a3b06baa7979a3ea79ab5628d25c79b54d42910ddd415e28b2ce6e0bfc28de1a44b1a7fc
+  metadata.gz: c6556e0069a7f41c67a0cdf9d80f7886b622b2cc043ba6c65a1bb6201d65f6a39facc1a8073b5c4d612f0d2d152a05b72bdbd8d2183dfc40d4cfc98ff34c4fc1
+  data.tar.gz: b42dfdb7a0fbba2386b1fa13e45ced2314517ea8c35c9ec66873b5804c6ee7dea7b61f9c8ab03bbbf856428127a71e25ce9c9b7cc9eeb4718878536559e079c8

data/README.md

@@ -1,4 +1,5 @@
-# biz
+![biz](http://d26a57ydsghvgx.cloudfront.net/www/public/assets/images/bizlogo.png)
+
 [![Gem Version](https://badge.fury.io/rb/biz.svg)](http://badge.fury.io/rb/biz)
 [![Build Status](https://travis-ci.org/zendesk/biz.svg?branch=master)](https://travis-ci.org/zendesk/biz)
 [![Code Climate](https://codeclimate.com/github/zendesk/biz/badges/gpa.svg)](https://codeclimate.com/github/zendesk/biz)
@@ -75,6 +76,9 @@ Biz.time(30, :minutes).before(Time.utc(2015, 1, 1, 11, 45))
 # Find the time an amount of business time *after* a specified starting time
 Biz.time(2, :hours).after(Time.utc(2015, 12, 25, 9, 30))
 
+# Calculations can be performed in seconds, minutes, hours, or days
+Biz.time(1, :day).after(Time.utc(2015, 1, 8, 10))
+
 # Find the amount of business time between two times
 Biz.within(Time.utc(2015, 3, 7), Time.utc(2015, 3, 14)).in_seconds
 
@@ -89,9 +93,7 @@ which you can use to do your own custom calculations or just get a better idea
 of what's happening under the hood:
 
 ```ruby
-Biz.periods
-  .after(Time.utc(2015, 1, 10, 10))
-  .timeline.forward
+Biz.periods.after(Time.utc(2015, 1, 10, 10)).timeline
   .until(Time.utc(2015, 1, 17, 10)).to_a
 
 #=> [#<Biz::TimeSegment start_time=2015-01-10 18:00:00 UTC end_time=2015-01-10 22:00:00 UTC>,
@@ -102,8 +104,7 @@ Biz.periods
 #  #<Biz::TimeSegment start_time=2015-01-15 21:00:00 UTC end_time=2015-01-16 01:00:00 UTC>]
 
 Biz.periods
-  .before(Time.utc(2015, 5, 5, 12, 34, 57))
-  .timeline.backward
+  .before(Time.utc(2015, 5, 5, 12, 34, 57)).timeline
   .for(Biz::Duration.minutes(3_598)).to_a
 
 #=> [#<Biz::TimeSegment start_time=2015-05-05 07:00:00 UTC end_time=2015-05-05 12:34:57 UTC>,

data/lib/biz.rb

@@ -4,6 +4,7 @@ require 'forwardable'
 require 'set'
 
 require 'abstract_type'
+require 'clavius'
 require 'equalizer'
 require 'memoizable'
 require 'tzinfo'
@@ -13,8 +14,8 @@ module Biz
 
     extend Forwardable
 
-    def configure(&block)
-      Thread.current[:biz_schedule] = Schedule.new(&block)
+    def configure(&config)
+      Thread.current[:biz_schedule] = Schedule.new(&config)
     end
 
     delegate %i[
@@ -22,6 +23,8 @@ module Biz
       holidays
       time_zone
       periods
+      date
+      dates
       time
       within
       in_hours?
@@ -37,13 +40,12 @@ module Biz
   end
 end
 
-require 'biz/version'
-
 require 'biz/date'
 require 'biz/time'
 
 require 'biz/calculation'
 require 'biz/configuration'
+require 'biz/dates'
 require 'biz/day'
 require 'biz/day_of_week'
 require 'biz/day_time'
@@ -56,3 +58,4 @@ require 'biz/timeline'
 require 'biz/time_segment'
 require 'biz/week'
 require 'biz/week_time'
+require 'biz/version'

data/lib/biz/calculation/active.rb

@@ -2,19 +2,21 @@ module Biz
   module Calculation
     class Active
 
-      attr_reader :schedule,
-                  :time
-
       def initialize(schedule, time)
         @schedule = schedule
         @time     = time
       end
 
-      def active?
+      def result
         schedule.intervals.any? { |interval| interval.contains?(time) } &&
           schedule.holidays.none? { |holiday| holiday.contains?(time) }
       end
 
+      protected
+
+      attr_reader :schedule,
+                  :time
+
     end
   end
 end

data/lib/biz/calculation/duration_within.rb

@@ -2,10 +2,9 @@ module Biz
   module Calculation
     class DurationWithin < SimpleDelegator
 
-      def initialize(periods, calculation_period)
+      def initialize(schedule, calculation_period)
         super(
-          periods.after(calculation_period.start_time)
-            .timeline.forward
+          schedule.periods.after(calculation_period.start_time).timeline
             .until(calculation_period.end_time)
             .map(&:duration)
             .reduce(Duration.new(0), :+)

data/lib/biz/calculation/for_duration.rb

@@ -2,30 +2,104 @@ module Biz
   module Calculation
     class ForDuration
 
-      attr_reader :periods,
-                  :duration
+      UNITS = Set.new(%i[second seconds minute minutes hour hours day days])
 
-      def initialize(periods, duration)
-        unless duration.positive?
-          fail ArgumentError, 'Duration adjustment must be positive.'
+      include AbstractType
+
+      def self.with_unit(schedule, scalar, unit)
+        unless UNITS.include?(unit)
+          fail ArgumentError, 'The unit is not supported.'
         end
 
-        @periods  = periods
-        @duration = duration
+        send(unit, schedule, scalar)
+      end
+
+      def self.unit
+        name.split('::').last.downcase.to_sym
+      end
+
+      def initialize(schedule, scalar)
+        @schedule = schedule
+        @scalar   = scalar
       end
 
-      def before(time)
-        periods.before(time)
-          .timeline.backward
-          .for(duration).to_a
-          .last.start_time
+      abstract_method :before,
+                      :after
+
+      protected
+
+      attr_reader :schedule,
+                  :scalar
+
+      private
+
+      def unit
+        self.class.unit
       end
 
-      def after(time)
-        periods.after(time)
-          .timeline.forward
-          .for(duration).to_a
-          .last.end_time
+      [
+        *%i[second seconds minute minutes hour hours].map { |unit|
+          const_set(unit.to_s.capitalize,
+            Class.new(self) do
+              def before(time)
+                timeline(:before, time).last.start_time
+              end
+
+              def after(time)
+                timeline(:after, time).last.end_time
+              end
+
+              private
+
+              def timeline(direction, time)
+                schedule.periods.send(direction, time).timeline
+                  .for(duration).to_a
+              end
+
+              def duration
+                Duration.send(unit, scalar)
+              end
+            end
+          )
+        },
+        *%i[day days].map { |unit|
+          const_set(unit.to_s.capitalize,
+            Class.new(self) do
+              def before(time)
+                periods(:before, time).first.end_time
+              end
+
+              def after(time)
+                periods(:after, time).first.start_time
+              end
+
+              private
+
+              def periods(direction, time)
+                schedule.periods.send(direction, advanced_date(direction, time))
+              end
+
+              def advanced_date(direction, time)
+                schedule.in_zone.on_date(
+                  schedule.dates.days(scalar).send(direction, local(time)),
+                  day_time(time)
+                )
+              end
+
+              def day_time(time)
+                DayTime.from_time(local(time))
+              end
+
+              def local(time)
+                schedule.in_zone.local(time)
+              end
+            end
+          )
+        }
+      ].each do |unit_class|
+        define_singleton_method(unit_class.unit) { |schedule, scalar|
+          unit_class.new(schedule, scalar)
+        }
       end
 
     end

data/lib/biz/configuration.rb

@@ -4,7 +4,7 @@ module Biz
     include Memoizable
 
     def initialize
-      @raw = Raw.new.tap do |raw| yield raw end
+      @raw = Raw.new.tap do |raw| yield raw if block_given? end
     end
 
     def intervals
@@ -21,6 +21,10 @@ module Biz
       TZInfo::TimezoneProxy.new(raw.time_zone)
     end
 
+    def weekdays
+      raw.hours.keys.to_set
+    end
+
     protected
 
     attr_reader :raw
@@ -44,7 +48,8 @@ module Biz
     end
 
     memoize :intervals,
-            :holidays
+            :holidays,
+            :weekdays
 
     Raw = Struct.new(:hours, :holidays, :time_zone) do
       module Default

data/lib/biz/core_ext/date.rb

@@ -3,11 +3,7 @@ module Biz
     module Date
 
       def business_day?
-        Biz.periods
-          .after(Biz::Time.new(Biz.time_zone).on_date(self, DayTime.midnight))
-          .timeline.forward
-          .until(Biz::Time.new(Biz.time_zone).on_date(self, DayTime.endnight))
-          .any?
+        Biz.dates.active?(self)
       end
 
     end

data/lib/biz/core_ext/fixnum.rb

@@ -2,7 +2,7 @@ module Biz
   module CoreExt
     module Fixnum
 
-      %i[second seconds minute minutes hour hours].each do |unit|
+      Calculation::ForDuration::UNITS.each do |unit|
         define_method("business_#{unit}") { Biz.time(self, unit) }
       end
 

data/lib/biz/dates.rb

@@ -0,0 +1,14 @@
+module Biz
+  class Dates < SimpleDelegator
+
+    def initialize(schedule)
+      super(
+        Clavius::Schedule.new do |c|
+          c.weekdays = schedule.weekdays
+          c.excluded = schedule.holidays.map(&:date)
+        end
+      )
+    end
+
+  end
+end

data/lib/biz/day_time.rb

@@ -8,34 +8,38 @@ module Biz
 
     extend Forwardable
 
-    def self.from_hour(hour)
-      new(hour * Time::MINUTES_IN_HOUR)
-    end
-
-    def self.from_timestamp(timestamp)
-      timestamp.match(TIMESTAMP_PATTERN) { |match|
-        new(match[:hour].to_i * Time::MINUTES_IN_HOUR + match[:minute].to_i)
-      }
-    end
+    class << self
 
-    def self.midnight
-      MIDNIGHT
-    end
+      def from_time(time)
+        new(time.hour * Time::MINUTES_IN_HOUR + time.min)
+      end
 
-    def self.noon
-      NOON
-    end
+      def from_hour(hour)
+        new(hour * Time::MINUTES_IN_HOUR)
+      end
 
-    def self.endnight
-      ENDNIGHT
-    end
+      def from_timestamp(timestamp)
+        timestamp.match(TIMESTAMP_PATTERN) { |match|
+          new(match[:hour].to_i * Time::MINUTES_IN_HOUR + match[:minute].to_i)
+        }
+      end
 
-    class << self
+      def midnight
+        MIDNIGHT
+      end
 
       alias_method :am, :midnight
 
+      def noon
+        NOON
+      end
+
       alias_method :pm, :noon
 
+      def endnight
+        ENDNIGHT
+      end
+
     end
 
     attr_reader :day_minute

data/lib/biz/duration.rb

@@ -1,8 +1,6 @@
 module Biz
   class Duration
 
-    UNITS = Set.new(%i[second seconds minute minutes hour hours day days])
-
     include Equalizer.new(:seconds)
     include Comparable
 
@@ -10,14 +8,6 @@ module Biz
 
     class << self
 
-      def with_unit(scalar, unit)
-        unless UNITS.include?(unit)
-          fail ArgumentError, 'The unit is not supported.'
-        end
-
-        public_send(unit, scalar)
-      end
-
       def seconds(seconds)
         new(seconds)
       end
@@ -36,12 +26,6 @@ module Biz
 
       alias_method :hour, :hours
 
-      def days(days)
-        new(days * Time::DAY)
-      end
-
-      alias_method :day, :days
-
     end
 
     attr_reader :seconds
@@ -64,10 +48,6 @@ module Biz
       seconds / Time::HOUR
     end
 
-    def in_days
-      seconds / Time::DAY
-    end
-
     def +(other)
       self.class.new(seconds + other.seconds)
     end

data/lib/biz/holiday.rb

@@ -22,5 +22,7 @@ module Biz
       )
     end
 
+    alias_method :to_date, :date
+
   end
 end

data/lib/biz/periods.rb

@@ -1,8 +1,6 @@
 module Biz
   class Periods
 
-    attr_reader :schedule
-
     def initialize(schedule)
       @schedule = schedule
     end
@@ -15,6 +13,10 @@ module Biz
       Before.new(schedule, origin)
     end
 
+    protected
+
+    attr_reader :schedule
+
   end
 end
 

data/lib/biz/periods/abstract.rb

@@ -4,9 +4,6 @@ module Biz
 
       extend Forwardable
 
-      attr_reader :schedule,
-                  :origin
-
       def initialize(schedule, origin)
         @schedule = schedule
         @origin   = origin
@@ -20,6 +17,11 @@ module Biz
         Timeline.new(self)
       end
 
+      protected
+
+      attr_reader :schedule,
+                  :origin
+
       private
 
       def periods

data/lib/biz/periods/after.rb

@@ -2,6 +2,10 @@ module Biz
   class Periods
     class After < Abstract
 
+      def timeline
+        super.forward
+      end
+
       private
 
       def weeks

data/lib/biz/periods/before.rb

@@ -2,6 +2,10 @@ module Biz
   class Periods
     class Before < Abstract
 
+      def timeline
+        super.backward
+      end
+
       private
 
       def weeks

data/lib/biz/schedule.rb

@@ -3,40 +3,45 @@ module Biz
 
     extend Forwardable
 
-    def initialize(&block)
-      @configuration = Configuration.new(&block)
+    def initialize(&config)
+      @configuration = Configuration.new(&config)
     end
 
     delegate %i[
       intervals
       holidays
       time_zone
+      weekdays
     ] => :configuration
 
     def periods
       Periods.new(self)
     end
 
+    def dates
+      Dates.new(self)
+    end
+
+    alias_method :date, :dates
+
     def time(scalar, unit)
-      Calculation::ForDuration.new(
-        periods,
-        Duration.with_unit(scalar, unit)
-      )
+      Calculation::ForDuration.with_unit(self, scalar, unit)
     end
 
     def within(origin, terminus)
-      Calculation::DurationWithin.new(
-        periods,
-        TimeSegment.new(origin, terminus)
-      )
+      Calculation::DurationWithin.new(self, TimeSegment.new(origin, terminus))
     end
 
     def in_hours?(time)
-      Calculation::Active.new(self, time).active?
+      Calculation::Active.new(self, time).result
     end
 
     alias_method :business_hours?, :in_hours?
 
+    def in_zone
+      Time.new(time_zone)
+    end
+
     protected
 
     attr_reader :configuration

data/lib/biz/timeline.rb

@@ -1,8 +1,6 @@
 module Biz
   class Timeline
 
-    attr_reader :periods
-
     def initialize(periods)
       @periods = periods
     end
@@ -15,6 +13,10 @@ module Biz
       Backward.new(periods)
     end
 
+    protected
+
+    attr_reader :periods
+
   end
 end
 

data/lib/biz/timeline/abstract.rb

@@ -2,8 +2,6 @@ module Biz
   class Timeline
     class Abstract
 
-      attr_reader :periods
-
       def initialize(periods)
         @periods = periods.lazy
       end
@@ -36,6 +34,10 @@ module Biz
         end
       end
 
+      protected
+
+      attr_reader :periods
+
     end
   end
 end

data/lib/biz/timeline/backward.rb

@@ -2,6 +2,10 @@ module Biz
   class Timeline
     class Backward < Abstract
 
+      def backward
+        self
+      end
+
       private
 
       def occurred?(period, time)

data/lib/biz/timeline/forward.rb

@@ -2,6 +2,10 @@ module Biz
   class Timeline
     class Forward < Abstract
 
+      def forward
+        self
+      end
+
       private
 
       def occurred?(period, time)

data/lib/biz/version.rb

@@ -1,5 +1,5 @@
 module Biz
 
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biz
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Craig Little
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_type
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: clavius
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: equalizer
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +129,7 @@ files:
 - lib/biz/core_ext/fixnum.rb
 - lib/biz/core_ext/time.rb
 - lib/biz/date.rb
+- lib/biz/dates.rb
 - lib/biz/day.rb
 - lib/biz/day_of_week.rb
 - lib/biz/day_time.rb