business 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c69d99c21ef0905de463bc82315c5f3829f6c23
+  data.tar.gz: 2d333b66d2d26a1cd9664b7415033012ab898339
+SHA512:
+  metadata.gz: a020144ad1d875fe40df7dfd91d2cec5fe5623134921a40cc45669202bc0c76a43f98cde0f9cf1da3f8334eaabbb245823f8f542ac3a6985b3055b869e8c663e
+  data.tar.gz: c0ce8a9993aad1a8be8378ae9bdeb77368979be818ca1cca84ccf9ed2eddd0ba2811c81d03dbdfb072da3134e63c9abe75ce9a7ff6e96138105f606439725db7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in business.gemspec
+gemspec

data/README.md

@@ -0,0 +1,13 @@
+# BankTime
+
+Date calculations based on bank calendars
+
+## Usage
+
+```ruby
+calendar = BankTime::Calendar.load('bacs')
+date = Date.parse("2013-10-18")
+calendar.add_business_days(date, 1)
+# => 2013-10-21
+```
+

data/business.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'business/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "business"
+  spec.version       = Business::VERSION
+  spec.authors       = ["Harry Marr"]
+  spec.email         = ["engineering@gocardless.com"]
+  spec.description   = %q{Date calculations based on business calendars}
+  spec.summary       = %q{Date calculations based on business calendars}
+  spec.homepage      = "https://github.com/gocardless/business"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+end

data/lib/business.rb

@@ -0,0 +1 @@
+require 'business/calendar'

data/lib/business/calendar.rb

@@ -0,0 +1,156 @@
+require 'yaml'
+
+module Business
+  class Calendar
+    def self.load(calendar)
+      path = File.join(File.dirname(__FILE__), 'data', "#{calendar}.yml")
+      raise "No such calendar '#{calendar}'" unless File.exists?(path)
+      yaml = YAML.load_file(path)
+      self.new(holidays: yaml['holidays'], business_days: yaml['business_days'])
+    end
+
+    @lock = Mutex.new
+    def self.load_cached(calendar)
+       @lock.synchronize do
+          @cache ||= { }
+          unless @cache.include?(calendar)
+            @cache[calendar] = self.load(calendar)
+          end
+          @cache[calendar]
+      end
+    end
+
+    DAY_NAMES = %( mon tue wed thu fri sat sun )
+
+    attr_reader :business_days, :holidays
+
+    def initialize(config)
+      set_business_days(config[:business_days])
+      set_holidays(config[:holidays])
+    end
+
+    # Return true if the date given is a business day (typically that means a
+    # non-weekend day) and not a holiday.
+    def business_day?(date)
+      date = date.to_date
+      return false unless business_days.include?(date.strftime('%a').downcase)
+      return false if holidays.include?(date)
+      true
+    end
+
+    # Roll forward to the next business day. If the date given is a business
+    # day, that day will be returned. If the day given is a holiday or
+    # non-working day, the next non-holiday working day will be returned.
+    def roll_forward(date)
+      interval = date.is_a?(Date) ? 1 : 3600 * 24
+      date += interval until business_day?(date)
+      date
+    end
+
+    # Roll backward to the previous business day. If the date given is a
+    # business day, that day will be returned. If the day given is a holiday or
+    # non-working day, the previous non-holiday working day will be returned.
+    def roll_backward(date)
+      date -= day_interval_for(date) until business_day?(date)
+      date
+    end
+
+    # Roll forward to the next business day regardless of whether the given
+    # date is a business day or not.
+    def next_business_day(date)
+      begin
+        date += day_interval_for(date)
+      end until business_day?(date)
+      date
+    end
+
+    # Add a number of business days to a date. If a non-business day is given,
+    # counting will start from the next business day. So,
+    #   monday + 1 = tuesday
+    #   friday + 1 = monday
+    #   sunday + 1 = tuesday
+    def add_business_days(date, delta)
+      date = roll_forward(date)
+      delta.times do
+        begin
+          date += day_interval_for(date)
+        end until business_day?(date)
+      end
+      date
+    end
+
+    # Subtract a number of business days to a date. If a non-business day is
+    # given, counting will start from the previous business day. So,
+    #   friday - 1 = thursday
+    #   monday - 1 = friday
+    #   sunday - 1 = thursday
+    def subtract_business_days(date, delta)
+      date = roll_backward(date)
+      delta.times do
+        begin
+          date -= day_interval_for(date)
+        end until business_day?(date)
+      end
+      date
+    end
+
+    # Count the number of business days between two dates.
+    # This method counts from start of date1 to start of date2. So,
+    # business_days_between(mon, weds) = 2 (assuming no holidays)
+    def business_days_between(date1, date2)
+      date1, date2 = date1.to_date, date2.to_date
+
+      # To optimise this method we split the range into full weeks and a
+      # remaining period.
+      #
+      # We then calculate business days in the full weeks period by
+      # multiplying number of weeks by number of working days in a week and
+      # removing holidays one by one.
+
+      # For the remaining period, we just loop through each day and check
+      # whether it is a business day.
+
+      # Calculate number of full weeks and remaining days
+      num_full_weeks, remaining_days = (date2 - date1).to_i.divmod(7)
+
+      # First estimate for full week range based on # biz days in a week
+      num_biz_days = num_full_weeks * business_days.length
+
+      full_weeks_range = (date1...(date2 - remaining_days))
+      num_biz_days -= holidays.count do |holiday|
+        in_range = full_weeks_range.cover?(holiday)
+        # Only pick a holiday if its on a working day (e.g., not a weekend)
+        on_biz_day = business_days.include?(holiday.strftime('%a').downcase)
+        in_range && on_biz_day
+      end
+
+      remaining_range = (date2-remaining_days...date2)
+      # Loop through each day in remaining_range and count if a business day
+      num_biz_days + remaining_range.count { |a| business_day?(a) }
+    end
+
+    def day_interval_for(date)
+      date.is_a?(Date) ? 1 : 3600 * 24
+    end
+
+    # Internal method for assigning business days from a calendar config.
+    def set_business_days(business_days)
+      @business_days = (business_days || default_business_days).map do |day|
+        day.downcase.strip[0..2].tap do |normalised_day|
+          raise "Invalid day #{day}" unless DAY_NAMES.include?(normalised_day)
+        end
+      end
+    end
+
+    # Internal method for assigning holidays from a calendar config.
+    def set_holidays(holidays)
+      @holidays = (holidays || []).map { |holiday| Date.parse(holiday) }
+    end
+
+    # If no business days are provided in the calendar config, these are used.
+    def default_business_days
+      %w( mon tue wed thu fri )
+    end
+  end
+end
+

data/lib/business/data/bacs.yml

@@ -0,0 +1,25 @@
+business_days:
+  - monday
+  - tuesday
+  - wednesday
+  - thursday
+  - friday
+
+holidays:
+  - January 1st, 2013
+  - March 29th, 2013
+  - April 1st, 2013
+  - May 6th, 2013
+  - May 27th, 2013
+  - August 26th, 2013
+  - December 25th, 2013
+  - December 26th, 2013
+  - January 1st, 2014
+  - April 18th, 2014
+  - April 21st, 2014
+  - May 5th, 2014
+  - May 26th, 2014
+  - August 25th, 2014
+  - December 25th, 2014
+  - December 26th, 2014
+

data/lib/business/data/sepa.yml

@@ -0,0 +1,35 @@
+business_days:
+  - monday
+  - tuesday
+  - wednesday
+  - thursday
+  - friday
+
+holidays:
+  - January 1st, 2013
+  - March 29th, 2013
+  - April 1st, 2013
+  - May 1st, 2013
+  - May 9th, 2013
+  - May 20th, 2013
+  - May 30th, 2013
+  - October 3rd, 2013
+  - November 1st, 2013
+  - December 24th, 2013
+  - December 25th, 2013
+  - December 26th, 2013
+  - December 31st, 2013
+  - January 1st, 2014
+  - April 18th, 2014
+  - April 21st, 2014
+  - May 1st, 2014
+  - May 9th, 2014
+  - May 29th, 2014
+  - June 9th, 2014
+  - June 19th, 2014
+  - October 3rd, 2014
+  - November 1st, 2014
+  - December 24th, 2014
+  - December 25th, 2014
+  - December 26th, 2014
+  - December 31st, 2014

data/lib/business/data/weekdays.yml

@@ -0,0 +1,6 @@
+business_days:
+  - monday
+  - tuesday
+  - wednesday
+  - thursday
+  - friday

data/lib/business/version.rb

@@ -0,0 +1,3 @@
+module Business
+  VERSION = "0.1.0"
+end

data/spec/calendar_spec.rb

@@ -0,0 +1,408 @@
+require "business/calendar"
+require "time"
+
+describe Business::Calendar do
+  describe ".load" do
+    context "when given a valid calendar" do
+      subject { Business::Calendar.load("weekdays") }
+
+      it "loads the yaml file" do
+        YAML.should_receive(:load_file) do |path|
+          path.should match(/weekdays\.yml$/)
+        end.and_return({})
+        subject
+      end
+
+      it { should be_a Business::Calendar }
+    end
+
+    context "when given an invalid calendar" do
+      subject { Business::Calendar.load("invalid-calendar") }
+      specify { ->{ subject }.should raise_error }
+    end
+  end
+
+  describe "#set_business_days" do
+    let(:calendar) { Business::Calendar.new({}) }
+    let(:business_days) { [] }
+    subject { calendar.set_business_days(business_days) }
+
+    context "when given valid business days" do
+      let(:business_days) { %w( mon fri ) }
+      before { subject }
+
+      it "assigns them" do
+        calendar.business_days.should == business_days
+      end
+
+      context "that are unnormalised" do
+        let(:business_days) { %w( Monday Friday ) }
+        it "normalises them" do
+          calendar.business_days.should == %w( mon fri )
+        end
+      end
+    end
+
+    context "when given an invalid business day" do
+      let(:business_days) { %w( Notaday ) }
+      specify { ->{ subject }.should raise_exception }
+    end
+
+    context "when given nil" do
+      let(:business_days) { nil }
+      it "uses the default business days" do
+        calendar.business_days.should == calendar.default_business_days
+      end
+    end
+  end
+
+  describe "#set_holidays" do
+    let(:calendar) { Business::Calendar.new({}) }
+    let(:holidays) { [] }
+    before { calendar.set_holidays(holidays) }
+    subject { calendar.holidays }
+
+    context "when given valid business days" do
+      let(:holidays) { ["1st Jan, 2013"] }
+
+      it { should_not be_empty }
+
+      it "converts them to Date objects" do
+        subject.each { |h| h.should be_a Date }
+      end
+    end
+
+    context "when given nil" do
+      let(:holidays) { nil }
+      it { should be_empty }
+    end
+  end
+
+  # A set of examples that are supposed to work when given Date and Time
+  # objects. The implementation slightly differs, so i's worth running the
+  # tests for both Date *and* Time.
+  shared_examples "common" do
+    describe "#business_day?" do
+      let(:calendar) do
+        Business::Calendar.new(holidays: ["9am, Tuesday 1st Jan, 2013"])
+      end
+      subject { calendar.business_day?(day) }
+
+      context "when given a business day" do
+        let(:day) { date_class.parse("9am, Wednesday 2nd Jan, 2013") }
+        it { should be_true }
+      end
+
+      context "when given a non-business day" do
+        let(:day) { date_class.parse("9am, Saturday 5th Jan, 2013") }
+        it { should be_false }
+      end
+
+      context "when given a business day that is a holiday" do
+        let(:day) { date_class.parse("9am, Tuesday 1st Jan, 2013") }
+        it { should be_false }
+      end
+    end
+
+    describe "#roll_forward" do
+      let(:calendar) do
+        Business::Calendar.new(holidays: ["Tuesday 1st Jan, 2013"])
+      end
+      subject { calendar.roll_forward(date) }
+
+      context "given a business day" do
+        let(:date) { date_class.parse("Wednesday 2nd Jan, 2013") }
+        it { should == date }
+      end
+
+      context "given a non-business day" do
+        context "with a business day following it" do
+          let(:date) { date_class.parse("Tuesday 1st Jan, 2013") }
+          it { should == date + day_interval }
+        end
+
+        context "followed by another non-business day" do
+          let(:date) { date_class.parse("Saturday 5th Jan, 2013") }
+          it { should == date + 2 * day_interval }
+        end
+      end
+    end
+
+    describe "#roll_backward" do
+      let(:calendar) do
+        Business::Calendar.new(holidays: ["Tuesday 1st Jan, 2013"])
+      end
+      subject { calendar.roll_backward(date) }
+
+      context "given a business day" do
+        let(:date) { date_class.parse("Wednesday 2nd Jan, 2013") }
+        it { should == date }
+      end
+
+      context "given a non-business day" do
+        context "with a business day preceeding it" do
+          let(:date) { date_class.parse("Tuesday 1st Jan, 2013") }
+          it { should == date - day_interval }
+        end
+
+        context "preceeded by another non-business day" do
+          let(:date) { date_class.parse("Sunday 6th Jan, 2013") }
+          it { should == date - 2 * day_interval }
+        end
+      end
+    end
+
+    describe "#next_business_day" do
+      let(:calendar) do
+        Business::Calendar.new(holidays: ["Tuesday 1st Jan, 2013"])
+      end
+      subject { calendar.next_business_day(date) }
+
+      context "given a business day" do
+        let(:date) { date_class.parse("Wednesday 2nd Jan, 2013") }
+        it { should == date + day_interval }
+      end
+
+      context "given a non-business day" do
+        context "with a business day following it" do
+          let(:date) { date_class.parse("Tuesday 1st Jan, 2013") }
+          it { should == date + day_interval }
+        end
+
+        context "followed by another non-business day" do
+          let(:date) { date_class.parse("Saturday 5th Jan, 2013") }
+          it { should == date + 2 * day_interval }
+        end
+      end
+    end
+
+    describe "#add_business_days" do
+      let(:calendar) do
+        Business::Calendar.new(holidays: ["Tuesday 1st Jan, 2013"])
+      end
+      let(:delta) { 2 }
+      subject { calendar.add_business_days(date, delta) }
+
+      context "given a business day" do
+        context "and a period that includes only business days" do
+          let(:date) { date_class.parse("Wednesday 2nd Jan, 2013") }
+          it { should == date + delta * day_interval }
+        end
+
+        context "and a period that includes a weekend" do
+          let(:date) { date_class.parse("Friday 4th Jan, 2013") }
+          it { should == date + (delta + 2) * day_interval }
+        end
+
+        context "and a period that includes a holiday day" do
+          let(:date) { date_class.parse("Monday 31st Dec, 2012") }
+          it { should == date + (delta + 1) * day_interval }
+        end
+      end
+
+      context "given a non-business day" do
+        let(:date) { date_class.parse("Tuesday 1st Jan, 2013") }
+        it { should == date + (delta + 1) * day_interval }
+      end
+    end
+
+    describe "#subtract_business_days" do
+      let(:calendar) do
+        Business::Calendar.new(holidays: ["Thursday 3rd Jan, 2013"])
+      end
+      let(:delta) { 2 }
+      subject { calendar.subtract_business_days(date, delta) }
+
+      context "given a business day" do
+        context "and a period that includes only business days" do
+          let(:date) { date_class.parse("Wednesday 2nd Jan, 2013") }
+          it { should == date - delta * day_interval }
+        end
+
+        context "and a period that includes a weekend" do
+          let(:date) { date_class.parse("Monday 31st Dec, 2012") }
+          it { should == date - (delta + 2) * day_interval }
+        end
+
+        context "and a period that includes a holiday day" do
+          let(:date) { date_class.parse("Friday 4th Jan, 2013") }
+          it { should == date - (delta + 1) * day_interval }
+        end
+      end
+
+      context "given a non-business day" do
+        let(:date) { date_class.parse("Thursday 3rd Jan, 2013") }
+        it { should == date - (delta + 1) * day_interval }
+      end
+    end
+
+    describe "#business_days_between" do
+      let(:holidays) do
+        ["Thu 12/6/2014", "Wed 18/6/2014", "Fri 20/6/2014", "Sun 22/6/2014"]
+      end
+      let(:calendar) { Business::Calendar.new(holidays: holidays) }
+      subject { calendar.business_days_between(date_1, date_2) }
+
+
+      context "starting on a business day" do
+        let(:date_1) { date_class.parse("Mon 2/6/2014") }
+
+        context "ending on a business day" do
+          context "including only business days" do
+            let(:date_2) { date_class.parse("Thu 5/6/2014") }
+            it { should == 3 }
+          end
+
+          context "including only business days & weekend days" do
+            let(:date_2) { date_class.parse("Mon 9/6/2014") }
+            it { should == 5 }
+          end
+
+          context "including only business days & holidays" do
+            let(:date_1) { date_class.parse("Mon 9/6/2014") }
+            let(:date_2) { date_class.parse("Fri 13/6/2014") }
+            it { should == 3 }
+          end
+
+          context "including business, weekend days, and holidays" do
+            let(:date_2) { date_class.parse("Fri 13/6/2014") }
+            it { should == 8 }
+          end
+        end
+
+        context "ending on a weekend day" do
+          context "including only business days & weekend days" do
+            let(:date_2) { date_class.parse("Sun 8/6/2014") }
+            it { should == 5 }
+          end
+
+          context "including business, weekend days, and holidays" do
+            let(:date_2) { date_class.parse("Sat 14/6/2014") }
+            it { should == 9 }
+          end
+        end
+
+        context "ending on a holiday" do
+          context "including only business days & holidays" do
+            let(:date_1) { date_class.parse("Mon 9/6/2014") }
+            let(:date_2) { date_class.parse("Thu 12/6/2014") }
+            it { should == 3 }
+          end
+
+          context "including business, weekend days, and holidays" do
+            let(:date_2) { date_class.parse("Thu 12/6/2014") }
+            it { should == 8 }
+          end
+        end
+      end
+
+      context "starting on a weekend" do
+        let(:date_1) { date_class.parse("Sat 7/6/2014") }
+
+        context "ending on a business day" do
+
+          context "including only business days & weekend days" do
+            let(:date_2) { date_class.parse("Mon 9/6/2014") }
+            it { should == 0 }
+          end
+
+          context "including business, weekend days, and holidays" do
+            let(:date_2) { date_class.parse("Fri 13/6/2014") }
+            it { should == 3 }
+          end
+        end
+
+        context "ending on a weekend day" do
+          context "including only business days & weekend days" do
+            let(:date_2) { date_class.parse("Sun 8/6/2014") }
+            it { should == 0 }
+          end
+
+          context "including business, weekend days, and holidays" do
+            let(:date_2) { date_class.parse("Sat 14/6/2014") }
+            it { should == 4 }
+          end
+        end
+
+        context "ending on a holiday" do
+          context "including business, weekend days, and holidays" do
+            let(:date_2) { date_class.parse("Thu 12/6/2014") }
+            it { should == 3 }
+          end
+        end
+      end
+
+      context "starting on a holiday" do
+        let(:date_1) { date_class.parse("Thu 12/6/2014") }
+
+        context "ending on a business day" do
+
+          context "including only business days & holidays" do
+            let(:date_2) { date_class.parse("Fri 13/6/2014") }
+            it { should == 0 }
+          end
+
+          context "including business, weekend days, and holidays" do
+            let(:date_2) { date_class.parse("Thu 19/6/2014") }
+            it { should == 3 }
+          end
+        end
+
+        context "ending on a weekend day" do
+          context "including business, weekend days, and holidays" do
+            let(:date_2) { date_class.parse("Sun 15/6/2014") }
+            it { should == 1 }
+          end
+        end
+
+        context "ending on a holiday" do
+          context "including only business days & holidays" do
+            let(:date_1) { date_class.parse("Wed 18/6/2014") }
+            let(:date_2) { date_class.parse("Fri 20/6/2014") }
+            it { should == 1 }
+          end
+
+          context "including business, weekend days, and holidays" do
+            let(:date_2) { date_class.parse("Wed 18/6/2014") }
+            it { should == 3 }
+          end
+        end
+      end
+
+      context "if a calendar has a holiday on a non-working (weekend) day" do
+        context "for a range less than a week long" do
+          let(:date_1) { date_class.parse("Thu 19/6/2014") }
+          let(:date_2) { date_class.parse("Tue 24/6/2014") }
+          it { should == 2 }
+        end
+        context "for a range more than a week long" do
+          let(:date_1) { date_class.parse("Mon 16/6/2014") }
+          let(:date_2) { date_class.parse("Tue 24/6/2014") }
+          it { should == 4 }
+        end
+      end
+    end
+  end
+
+  context "(using Date objects)" do
+    let(:date_class) { Date }
+    let(:day_interval) { 1 }
+
+    it_behaves_like "common"
+  end
+
+  context "(using Time objects)" do
+    let(:date_class) { Time }
+    let(:day_interval) { 3600 * 24 }
+
+    it_behaves_like "common"
+  end
+
+  context "(using DateTime objects)" do
+    let(:date_class) { DateTime }
+    let(:day_interval) { 1 }
+
+    it_behaves_like "common"
+  end
+end
+

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: business
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry Marr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Date calculations based on business calendars
+email:
+- engineering@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- business.gemspec
+- lib/business.rb
+- lib/business/calendar.rb
+- lib/business/data/bacs.yml
+- lib/business/data/sepa.yml
+- lib/business/data/weekdays.yml
+- lib/business/version.rb
+- spec/calendar_spec.rb
+homepage: https://github.com/gocardless/business
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Date calculations based on business calendars
+test_files:
+- spec/calendar_spec.rb