biz 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29c21b59e6fde3b429ebf855ccebec03742d0619
-  data.tar.gz: 8adbadda565386c89c078b146a69ccbf0e45972f
+  metadata.gz: f865f5197acf9cc026d7d77c15626a7d03a5e8c1
+  data.tar.gz: 5d150d70060e27513f373c3b32e96dbd0e4f68fc
 SHA512:
-  metadata.gz: 171eb369d1f45cba0e0e7e8a8d3c8d19043b18b25830f900df21030fc2b7c110c2d97d9ebcada7cb927ad704a961a0c1bcf532c56c5f630d09e9623e823607c8
-  data.tar.gz: 7a5ae606a3ce3bed526007dab290e301271ad5eb1829c485984b70d35bb78533e3477180e4e01807a9acc1bf63f9239ae13a5f034fcdb3389c4d7dcea1652b21
+  metadata.gz: a3eb38f1f622c23d1d1524ad053ae07bd789277d0a3b5b5a8bb42a2aef7453d8a976eed7878e97b8207861b0e58860d6a6e5950bc5507468e44ea62ba82c6e3e
+  data.tar.gz: 6871ae32bf137626682626e80f8f4ae115b162b1d7ac104ed1b615e0a3b06baa7979a3ea79ab5628d25c79b54d42910ddd415e28b2ce6e0bfc28de1a44b1a7fc

data/README.md

@@ -1,16 +1,21 @@
 # biz
-[![Build Status](https://magnum.travis-ci.com/zendesk/biz.svg?token=FPvAz1WHPkjgRp2szEGq&branch=master)](https://magnum.travis-ci.com/zendesk/biz)
-[![Code Climate](https://codeclimate.com/repos/54ac74216956802dc40027d6/badges/591180c7fa5da2a8aa3d/gpa.svg)](https://codeclimate.com/repos/54ac74216956802dc40027d6/feed)
-[![Test Coverage](https://codeclimate.com/repos/54ac74216956802dc40027d6/badges/591180c7fa5da2a8aa3d/coverage.svg)](https://codeclimate.com/repos/54ac74216956802dc40027d6/feed)
+[![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)
+[![Test Coverage](https://codeclimate.com/github/zendesk/biz/badges/coverage.svg)](https://codeclimate.com/github/zendesk/biz)
+[![Dependency Status](https://gemnasium.com/zendesk/biz.svg)](https://gemnasium.com/zendesk/biz)
 
 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.
-* Support for intervals spanning any period of the day, including the entirety.
-* Support for interday intervals and holidays.
 * Thread-safe.
 
 ## Anti-Features
@@ -36,7 +41,7 @@ Or install it yourself as:
 
 ```ruby
 Biz.configure do |config|
-  config.business_hours = {
+  config.hours = {
     mon: {'09:00' => '17:00'},
     tue: {'00:00' => '24:00'},
     wed: {'09:00' => '17:00'},
@@ -58,6 +63,9 @@ Biz::Schedule.new do |config|
 end
 ```
 
+Note that times must be specified in 24-hour clock format and time zones
+must be [IANA identifiers](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+
 ## Usage
 
 ```ruby
@@ -71,7 +79,41 @@ Biz.time(2, :hours).after(Time.utc(2015, 12, 25, 9, 30))
 Biz.within(Time.utc(2015, 3, 7), Time.utc(2015, 3, 14)).in_seconds
 
 # Determine if a time is in business hours
-Biz.business_hours?(Time.utc(2015, 1, 10, 9))
+Biz.in_hours?(Time.utc(2015, 1, 10, 9))
+```
+
+Note that all returned times are in UTC.
+
+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
+of what's happening under the hood:
+
+```ruby
+Biz.periods
+  .after(Time.utc(2015, 1, 10, 10))
+  .timeline.forward
+  .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>,
+#  #<Biz::TimeSegment start_time=2015-01-12 17:00:00 UTC end_time=2015-01-13 01:00:00 UTC>,
+#  #<Biz::TimeSegment start_time=2015-01-13 08:00:00 UTC end_time=2015-01-14 08:00:00 UTC>,
+#  #<Biz::TimeSegment start_time=2015-01-14 17:00:00 UTC end_time=2015-01-15 01:00:00 UTC>,
+#  #<Biz::TimeSegment start_time=2015-01-15 17:00:00 UTC end_time=2015-01-15 20:00:00 UTC>,
+#  #<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
+  .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>,
+#  #<Biz::TimeSegment start_time=2015-05-04 16:00:00 UTC end_time=2015-05-05 00:00:00 UTC>,
+#  #<Biz::TimeSegment start_time=2015-05-02 17:00:00 UTC end_time=2015-05-02 21:00:00 UTC>,
+#  #<Biz::TimeSegment start_time=2015-04-30 20:00:00 UTC end_time=2015-05-01 00:00:00 UTC>,
+#  #<Biz::TimeSegment start_time=2015-04-30 16:00:00 UTC end_time=2015-04-30 19:00:00 UTC>,
+#  #<Biz::TimeSegment start_time=2015-04-29 16:00:00 UTC end_time=2015-04-30 00:00:00 UTC>,
+#  #<Biz::TimeSegment start_time=2015-04-28 07:00:00 UTC end_time=2015-04-29 07:00:00 UTC>,
+#  #<Biz::TimeSegment start_time=2015-04-27 20:36:57 UTC end_time=2015-04-28 00:00:00 UTC>]
 ```
 
 ## Core Extensions
@@ -114,12 +156,17 @@ To open a console with the gem and sample schedule loaded:
 
     script/console
 
+## Alternatives
+
+* [`business_time`](https://github.com/bokmann/business_time)
+* [`working_hours`](https://github.com/Intrepidd/working_hours)
+
 ## Copyright and license
 
 Copyright 2015 Zendesk
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License.
+this gem except in compliance with the License.
 
 You may obtain a copy of the License at
 http://www.apache.org/licenses/LICENSE-2.0.

data/lib/biz.rb

@@ -24,6 +24,7 @@ module Biz
       periods
       time
       within
+      in_hours?
       business_hours?
     ] => :schedule
 

data/lib/biz/calculation/duration_within.rb

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

data/lib/biz/calculation/for_duration.rb

@@ -2,27 +2,27 @@ module Biz
   module Calculation
     class ForDuration
 
-      attr_reader :schedule,
+      attr_reader :periods,
                   :duration
 
-      def initialize(schedule, duration)
+      def initialize(periods, duration)
         unless duration.positive?
           fail ArgumentError, 'Duration adjustment must be positive.'
         end
 
-        @schedule = schedule
+        @periods  = periods
         @duration = duration
       end
 
       def before(time)
-        schedule.periods.before(time)
+        periods.before(time)
           .timeline.backward
           .for(duration).to_a
           .last.start_time
       end
 
       def after(time)
-        schedule.periods.after(time)
+        periods.after(time)
           .timeline.forward
           .for(duration).to_a
           .last.end_time

data/lib/biz/configuration.rb

@@ -8,7 +8,7 @@ module Biz
     end
 
     def intervals
-      raw.business_hours.flat_map { |weekday, hours|
+      raw.hours.flat_map { |weekday, hours|
         weekday_intervals(weekday, hours)
       }.sort_by(&:start_time)
     end
@@ -46,28 +46,30 @@ module Biz
     memoize :intervals,
             :holidays
 
-    Raw = Struct.new(:business_hours, :holidays, :time_zone) do
+    Raw = Struct.new(:hours, :holidays, :time_zone) do
       module Default
 
-        BUSINESS_HOURS = {
+        HOURS = {
           mon: {'09:00' => '17:00'},
           tue: {'09:00' => '17:00'},
           wed: {'09:00' => '17:00'},
           thu: {'09:00' => '17:00'},
           fri: {'09:00' => '17:00'}
         }
-        HOLIDAYS       = []
-        TIME_ZONE      = 'Etc/UTC'
+        HOLIDAYS  = []
+        TIME_ZONE = 'Etc/UTC'
 
       end
 
       def initialize(*)
         super
 
-        self.business_hours ||= Default::BUSINESS_HOURS
-        self.holidays       ||= Default::HOLIDAYS
-        self.time_zone      ||= Default::TIME_ZONE
+        self.hours     ||= Default::HOURS
+        self.holidays  ||= Default::HOLIDAYS
+        self.time_zone ||= Default::TIME_ZONE
       end
+
+      alias_method :business_hours=, :hours=
     end
 
   end

data/lib/biz/core_ext/time.rb

@@ -3,7 +3,7 @@ module Biz
     module Time
 
       def business_hours?
-        Biz.business_hours?(self)
+        Biz.in_hours?(self)
       end
 
     end

data/lib/biz/schedule.rb

@@ -18,17 +18,25 @@ module Biz
     end
 
     def time(scalar, unit)
-      Calculation::ForDuration.new(self, Duration.with_unit(scalar, unit))
+      Calculation::ForDuration.new(
+        periods,
+        Duration.with_unit(scalar, unit)
+      )
     end
 
     def within(origin, terminus)
-      Calculation::DurationWithin.new(self, TimeSegment.new(origin, terminus))
+      Calculation::DurationWithin.new(
+        periods,
+        TimeSegment.new(origin, terminus)
+      )
     end
 
-    def business_hours?(time)
+    def in_hours?(time)
       Calculation::Active.new(self, time).active?
     end
 
+    alias_method :business_hours?, :in_hours?
+
     protected
 
     attr_reader :configuration

data/lib/biz/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biz
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Craig Little
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-17 00:00:00.000000000 Z
+date: 2015-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_type
@@ -140,7 +140,7 @@ files:
 - lib/biz/week_time/start.rb
 homepage: https://github.com/zendesk/biz
 licenses:
-- Copyright Zendesk. All Rights Reserved.
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -150,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="