business 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2d2cb8f2fd7a20e32ebd77079819fd74a32e8d0
-  data.tar.gz: 9490bfa2e494111d15b3402b88ae0b4181ba8f51
+  metadata.gz: 251d7f3cf6dbd183f65412f3819a84c6eb567753
+  data.tar.gz: 33fe6680175dcadb13b726680ce7a6bc62a4656c
 SHA512:
-  metadata.gz: 565f7bcaa097777c83efbfaefb54e09ba96608f910fe4b823a1a14625419ba1177c87dfbbaf7d2566b847a75653669a65a0bf9730015e776ce69a780dff563e8
-  data.tar.gz: cde6cbeecffd912f1673b0174dd425ee2e43ab4ff8027d3124d19a0dcf5c6a43c45f358b80ea4387ef74aeb3af0b45d758693db91c365af603cc4633285fbf8c
+  metadata.gz: 310cf0ac1b4fa905d42909ad8918e98156ab6f9a5ae08062f0c859cea9c66d390bdc7f450cbe595630fc792b6889ea3cd4b1760f29b4ec7b6fd906627a292354
+  data.tar.gz: 569613ba3db4ff52c7f8c6e83acda495c37d75377d0c5d422ec29f4c68f79b2d75d6a1682c1c92fb45ed2ca2d4a3e1155a77ecb8afac2266c2425a2967eae738

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.4.0 - December 24, 2014
+
+- Add support for custom calendar load paths
+- Remove the 'sepa' calendar
+
+
 ## 1.3.0 - December 2, 2014
 
 - Add `Calendar#previous_business_day`

data/README.md

@@ -49,6 +49,17 @@ calendar.business_day?(Date.parse("Sunday, 8 June 2014"))
 # => false
 ```
 
+### Custom calendars
+
+To use a calendar you've written yourself, you need to add the directory it's
+stored in as an additional calendar load path:
+
+```ruby
+Business::Calendar.additional_load_paths = ['path/to/your/calendar/directory']
+```
+
+You can then load the calendar as normal.
+
 ### Business day arithmetic
 
 The `add_business_days` and `subtract_business_days` are used to perform
@@ -86,7 +97,6 @@ calendar.business_days_between(date, date + 7)
 # => 5
 ```
 
-
 ## But other libraries already do this
 
 Another gem, [business_time](https://github.com/bokmann/business_time), also

data/lib/business/calendar.rb

@@ -2,21 +2,34 @@ require 'yaml'
 
 module Business
   class Calendar
+    class << self
+      attr_accessor :additional_load_paths
+    end
+
+    def self.calendar_directories
+      directories = @additional_load_paths || []
+      directories + [File.join(File.dirname(__FILE__), 'data')]
+    end
+    private_class_method :calendar_directories
+
     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)
+      directory = calendar_directories.find do |dir|
+        File.exists?(File.join(dir, "#{calendar}.yml"))
+      end
+      raise "No such calendar '#{calendar}'" unless directory
+
+      yaml = YAML.load_file(File.join(directory, "#{calendar}.yml"))
       self.new(holidays: yaml['holidays'], working_days: yaml['working_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]
+      @lock.synchronize do
+        @cache ||= { }
+        unless @cache.include?(calendar)
+          @cache[calendar] = self.load(calendar)
+        end
+        @cache[calendar]
       end
     end
 

data/lib/business/version.rb

@@ -1,3 +1,3 @@
 module Business
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/calendar_spec.rb

@@ -21,6 +21,34 @@ describe Business::Calendar do
       it { is_expected.to be_a Business::Calendar }
     end
 
+    context "when given a calendar from a custom directory" do
+      before do
+        Business::Calendar.additional_load_paths = [
+          File.join(File.dirname(__FILE__), 'fixtures', 'calendars')
+        ]
+      end
+      after { Business::Calendar.additional_load_paths = nil }
+      subject { Business::Calendar.load("ecb") }
+
+      it "loads the yaml file" do
+        expect(YAML).to receive(:load_file) { |path|
+          expect(path).to match(/ecb\.yml$/)
+        }.and_return({})
+        subject
+      end
+
+      it { is_expected.to be_a Business::Calendar }
+
+      context "that also exists as a default calendar" do
+        subject { Business::Calendar.load("bacs") }
+
+        it "uses the custom calendar" do
+          expect(subject.business_day?(Date.parse("25th December 2014"))).
+            to eq(true)
+        end
+      end
+    end
+
     context "when given an invalid calendar" do
       subject { Business::Calendar.load("invalid-calendar") }
       specify { expect{ subject }.to raise_error }

data/spec/fixtures/calendars/bacs.yml

@@ -0,0 +1,9 @@
+working_days:
+  - monday
+  - tuesday
+  - wednesday
+  - thursday
+  - friday
+
+holidays:
+  - January 1st, 2015

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2014-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,11 +55,12 @@ files:
 - lib/business.rb
 - lib/business/calendar.rb
 - lib/business/data/bacs.yml
-- lib/business/data/sepa.yml
 - lib/business/data/target.yml
 - lib/business/data/weekdays.yml
 - lib/business/version.rb
 - spec/calendar_spec.rb
+- spec/fixtures/calendars/bacs.yml
+- spec/fixtures/calendars/ecb.yml
 homepage: https://github.com/gocardless/business
 licenses:
 - MIT
@@ -86,3 +87,5 @@ specification_version: 4
 summary: Date calculations based on business calendars
 test_files:
 - spec/calendar_spec.rb
+- spec/fixtures/calendars/bacs.yml
+- spec/fixtures/calendars/ecb.yml