biz 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ed9d4ce91d53a0f30a134390760ffcf9e7ac335
-  data.tar.gz: b0d3f931a675c643e350d41f5305d43d1938ad5c
+  metadata.gz: 29c21b59e6fde3b429ebf855ccebec03742d0619
+  data.tar.gz: 8adbadda565386c89c078b146a69ccbf0e45972f
 SHA512:
-  metadata.gz: 59e13d60fa485c816607922bdafa26093c182f9f2609fdfca481e617afdfcd54bab2b2355015f3f6c342183c19fb72e164ecfd6d9f0dadd5e46e16c9fd3aa1b5
-  data.tar.gz: 2d0de21b4a82ec4e5f0eec132bf6533c2eba3b6eb575baf2f8a07f098cc3e6941021185f10a68a9996b73ecd956262a9bb210784b1beece02bf741bb37c25ab8
+  metadata.gz: 171eb369d1f45cba0e0e7e8a8d3c8d19043b18b25830f900df21030fc2b7c110c2d97d9ebcada7cb927ad704a961a0c1bcf532c56c5f630d09e9623e823607c8
+  data.tar.gz: 7a5ae606a3ce3bed526007dab290e301271ad5eb1829c485984b70d35bb78533e3477180e4e01807a9acc1bf63f9239ae13a5f034fcdb3389c4d7dcea1652b21

data/README.md

@@ -1,14 +1,28 @@
-# Biz
+# 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)
 
-TODO: Write a gem description
+Time calculations using business hours.
+
+## Features
+
+* 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
+
+* No dependency on ActiveSupport.
+* No monkey patching by default.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'biz'
-```
+    gem 'biz'
 
 And then execute:
 
@@ -18,14 +32,99 @@ Or install it yourself as:
 
     $ gem install biz
 
+## Configuration
+
+```ruby
+Biz.configure do |config|
+  config.business_hours = {
+    mon: {'09:00' => '17:00'},
+    tue: {'00:00' => '24:00'},
+    wed: {'09:00' => '17:00'},
+    thu: {'09:00' => '12:00', '13:00' => '17:00'},
+    sat: {'10:00' => '14:00'}
+  }
+
+  config.holidays = [Date.new(2014, 1, 1), Date.new(2014, 12, 25)]
+
+  config.time_zone = 'America/Los_Angeles'
+end
+```
+
+If global configuration isn't your thing, configure an instance instead:
+
+```ruby
+Biz::Schedule.new do |config|
+  # ...
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Find the time an amount of business time *before* a specified starting time
+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))
+
+# Find the amount of business time between two times
+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))
+```
+
+## Core Extensions
+
+Optional extensions to core classes (`Date`, `Fixnum`, and `Time`) are available
+for additional expressiveness:
+
+```ruby
+require 'biz/core_ext'
+
+75.business_seconds.after(Time.utc(2015, 3, 5, 12, 30))
+
+30.business_minutes.before(Time.utc(2015, 1, 1, 11, 45))
+
+5.business_hours.after(Time.utc(2015, 4, 7, 8, 20))
+
+Time.utc(2015, 8, 20, 9, 30).business_hours?
+
+Date.new(2015, 12, 10).business_day?
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/biz/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Pull requests are welcome, but consider asking for a feature or bug fix first
+through the issue tracker. When contributing code, please squash sloppy commits
+aggressively and follow [Tim Pope's guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+for commit messages.
+
+There are a number of ways to get started after cloning the repository.
+
+To set up your environment:
+
+    script/bootstrap
+
+To run the spec suite:
+
+    script/spec
+
+To open a console with the gem and sample schedule loaded:
+
+    script/console
+
+## 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.
+
+You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0.
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

data/lib/biz.rb

@@ -1,5 +1,57 @@
-require "biz/version"
+require 'date'
+require 'delegate'
+require 'forwardable'
+require 'set'
+
+require 'abstract_type'
+require 'equalizer'
+require 'memoizable'
+require 'tzinfo'
 
 module Biz
-  # Your code goes here...
+  class << self
+
+    extend Forwardable
+
+    def configure(&block)
+      Thread.current[:biz_schedule] = Schedule.new(&block)
+    end
+
+    delegate %i[
+      intervals
+      holidays
+      time_zone
+      periods
+      time
+      within
+      business_hours?
+    ] => :schedule
+
+    private
+
+    def schedule
+      Thread.current[:biz_schedule] or fail 'Biz has not been configured.'
+    end
+
+  end
 end
+
+require 'biz/version'
+
+require 'biz/date'
+require 'biz/time'
+
+require 'biz/calculation'
+require 'biz/configuration'
+require 'biz/day'
+require 'biz/day_of_week'
+require 'biz/day_time'
+require 'biz/duration'
+require 'biz/holiday'
+require 'biz/interval'
+require 'biz/periods'
+require 'biz/schedule'
+require 'biz/timeline'
+require 'biz/time_segment'
+require 'biz/week'
+require 'biz/week_time'

data/lib/biz/calculation.rb

@@ -0,0 +1,8 @@
+module Biz
+  module Calculation
+  end
+end
+
+require 'biz/calculation/for_duration'
+require 'biz/calculation/duration_within'
+require 'biz/calculation/active'

data/lib/biz/calculation/active.rb

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

data/lib/biz/calculation/duration_within.rb

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

data/lib/biz/calculation/for_duration.rb

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

data/lib/biz/configuration.rb

@@ -0,0 +1,74 @@
+module Biz
+  class Configuration
+
+    include Memoizable
+
+    def initialize
+      @raw = Raw.new.tap do |raw| yield raw end
+    end
+
+    def intervals
+      raw.business_hours.flat_map { |weekday, hours|
+        weekday_intervals(weekday, hours)
+      }.sort_by(&:start_time)
+    end
+
+    def holidays
+      raw.holidays.map { |date| Holiday.new(date, time_zone) }
+    end
+
+    def time_zone
+      TZInfo::TimezoneProxy.new(raw.time_zone)
+    end
+
+    protected
+
+    attr_reader :raw
+
+    private
+
+    def weekday_intervals(weekday, hours)
+      hours.map { |start_timestamp, end_timestamp|
+        Interval.new(
+          WeekTime.start(
+            DayOfWeek.from_symbol(weekday).start_minute +
+              DayTime.from_timestamp(start_timestamp).day_minute
+          ),
+          WeekTime.end(
+            DayOfWeek.from_symbol(weekday).start_minute +
+              DayTime.from_timestamp(end_timestamp).day_minute
+          ),
+          time_zone
+        )
+      }
+    end
+
+    memoize :intervals,
+            :holidays
+
+    Raw = Struct.new(:business_hours, :holidays, :time_zone) do
+      module Default
+
+        BUSINESS_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'
+
+      end
+
+      def initialize(*)
+        super
+
+        self.business_hours ||= Default::BUSINESS_HOURS
+        self.holidays       ||= Default::HOLIDAYS
+        self.time_zone      ||= Default::TIME_ZONE
+      end
+    end
+
+  end
+end

data/lib/biz/core_ext.rb

@@ -0,0 +1,12 @@
+module Biz
+  module CoreExt
+  end
+end
+
+require 'biz/core_ext/date'
+require 'biz/core_ext/fixnum'
+require 'biz/core_ext/time'
+
+Date.class_eval   do include Biz::CoreExt::Date   end
+Fixnum.class_eval do include Biz::CoreExt::Fixnum end
+Time.class_eval   do include Biz::CoreExt::Time   end

data/lib/biz/core_ext/date.rb

@@ -0,0 +1,15 @@
+module Biz
+  module CoreExt
+    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?
+      end
+
+    end
+  end
+end

data/lib/biz/core_ext/fixnum.rb

@@ -0,0 +1,11 @@
+module Biz
+  module CoreExt
+    module Fixnum
+
+      %i[second seconds minute minutes hour hours].each do |unit|
+        define_method("business_#{unit}") { Biz.time(self, unit) }
+      end
+
+    end
+  end
+end

data/lib/biz/core_ext/time.rb

@@ -0,0 +1,11 @@
+module Biz
+  module CoreExt
+    module Time
+
+      def business_hours?
+        Biz.business_hours?(self)
+      end
+
+    end
+  end
+end

data/lib/biz/date.rb

@@ -0,0 +1,11 @@
+module Biz
+  class Date
+
+    EPOCH = ::Date.new(2006, 1, 1)
+
+    def self.from_day(day)
+      EPOCH + day
+    end
+
+  end
+end

data/lib/biz/day.rb

@@ -0,0 +1,51 @@
+module Biz
+  class Day
+
+    include Comparable
+
+    extend Forwardable
+
+    def self.from_date(date)
+      new((date - Date::EPOCH).to_i)
+    end
+
+    def self.from_time(time)
+      from_date(time.to_date)
+    end
+
+    class << self
+
+      alias_method :since_epoch, :from_time
+
+    end
+
+    attr_reader :day
+
+    delegate %i[
+      to_s
+      to_i
+      to_int
+    ] => :day
+
+    def initialize(day)
+      @day = Integer(day)
+    end
+
+    def to_date
+      Date.from_day(day)
+    end
+
+    def coerce(other)
+      [self.class.new(other), self]
+    end
+
+    protected
+
+    def <=>(other)
+      return nil unless other.respond_to?(:to_i)
+
+      day <=> other.to_i
+    end
+
+  end
+end