business 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31ba206f257f17ef5bdfa3c60e9e81f2e5e2e71436a701513643f90e783d844d
-  data.tar.gz: bda97edfe037b2f509b4d037d46a39b89c5ed96130872c6e090da461c6783418
+  metadata.gz: c1e6ab03fc3769877d942e77c54647175c8b8554e016fb8c2fb491c4596db07d
+  data.tar.gz: e76c9f5de45c78dc790866d841da5eb234ea8d308e8ba9c9d292b01eb49cb182
 SHA512:
-  metadata.gz: 07576b028c3b7c31fd5be9fc1c1588b31b76b629d6381c73566a828db6add04ee47f7f24091274ef55c0441666551922a35b97ccbb112224fe85d3bf24865dd0
-  data.tar.gz: 81aae610dd327487aa95b11b04b12d5d909f3296c36a2d49ff9147dc1a2276b4e024fffe2fe5cb8fa072a60b2a667d7b5f0cf207e919e2bc796d6693d01a731a
+  metadata.gz: 4c416c3a2845f6ea9b5016d173a8e30b0308a57021c163ad996407e20dae627d5fe10542f30e43fbf4d4e994b4fb99f967c7fb86842eedac89529e81698e5727
+  data.tar.gz: 0c163bd5dc87ff5246022b63e472829924ad9c41468287ef811e700d5b52e503278301c02968c0602933bca8d633d176a2ed90a36be332e590712b68ea4d8ea7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.0 - June 8, 2020
+
+- Add seperate `working_day?` and `holiday?` methods to the calendar
+
 ## 2.0.0 - May 4, 2020
 
 🚨 **BREAKING CHANGES** 🚨

data/README.md

@@ -131,6 +131,20 @@ calendar.business_day?(Date.parse("Sunday, 8 June 2014"))
 # => false
 ```
 
+More specifically you can check if a given `business_day?` is either a `working_day?` or a `holiday?` using methods on `Business::Calendar`.
+
+```ruby
+# Assuming "Monday, 9 June 2014" is a holiday
+calendar.working_day?(Date.parse("Monday, 9 June 2014"))
+# => true
+calendar.holiday?(Date.parse("Monday, 9 June 2014"))
+# => true
+# Monday is a working day, but we have a holiday so it's not
+# a business day
+calendar.business_day?(Date.parse("Monday, 9 June 2014"))
+# => false
+```
+
 ## Business day arithmetic
 
 The `add_business_days` and `subtract_business_days` are used to perform business day arithmetic on dates.

data/lib/business/calendar.rb

@@ -57,16 +57,26 @@ module Business
       set_extra_working_dates(config[:extra_working_dates])
       set_working_days(config[:working_days])
       set_holidays(config[:holidays])
+
+      unless (@holidays & @extra_working_dates).none?
+        raise ArgumentError, 'Holidays cannot be extra working dates'
+      end
     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 true if extra_working_dates.include?(date)
-      return false unless working_days.include?(date.strftime('%a').downcase)
-      return false if holidays.include?(date)
-      true
+      working_day?(date) && !holiday?(date)
+    end
+
+    def working_day?(date) 
+      date = date.to_date
+      extra_working_dates.include?(date) || working_days.include?(date.strftime('%a').downcase)
+    end
+
+    def holiday?(date) 
+      holidays.include?(date.to_date)
     end
 
     # Roll forward to the next business day. If the date given is a business
@@ -191,8 +201,6 @@ module Business
     # Internal method for assigning holidays from a calendar config.
     def set_holidays(holidays)
       @holidays = parse_dates(holidays)
-      return if (@holidays & @extra_working_dates).none?
-      raise ArgumentError, 'Holidays cannot be extra working dates'
     end
 
     def set_extra_working_dates(extra_working_dates)

data/lib/business/version.rb

@@ -1,3 +1,3 @@
 module Business
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/calendar_spec.rb

@@ -202,6 +202,62 @@ describe Business::Calendar do
       end
     end
 
+    describe "#working_day?" do
+      let(:calendar) do
+        Business::Calendar.new(holidays: ["9am, Tuesday 1st Jan, 2013"],
+                               extra_working_dates: ["9am, Sunday 6th Jan, 2013"])
+      end
+      subject { calendar.working_day?(day) }
+
+      context "when given a working day" do
+        let(:day) { date_class.parse("9am, Wednesday 2nd Jan, 2013") }
+        it { is_expected.to be_truthy }
+      end
+
+      context "when given a non-working day" do
+        let(:day) { date_class.parse("9am, Saturday 5th Jan, 2013") }
+        it { is_expected.to be_falsey }
+      end
+
+      context "when given a working day that is a holiday" do
+        let(:day) { date_class.parse("9am, Tuesday 1st Jan, 2013") }
+        it { is_expected.to be_truthy }
+      end
+
+      context "when given a non-business day that is a working date" do
+        let(:day) { date_class.parse("9am, Sunday 6th Jan, 2013") }
+        it { is_expected.to be_truthy }
+      end
+    end
+
+    describe "#holiday?" do
+      let(:calendar) do
+        Business::Calendar.new(holidays: ["9am, Tuesday 1st Jan, 2013"],
+                               extra_working_dates: ["9am, Sunday 6th Jan, 2013"])
+      end
+      subject { calendar.holiday?(day) }
+
+      context "when given a working day that is not a holiday" do
+        let(:day) { date_class.parse("9am, Wednesday 2nd Jan, 2013") }
+        it { is_expected.to be_falsey }
+      end
+
+      context "when given a non-working day that is not a holiday day" do
+        let(:day) { date_class.parse("9am, Saturday 5th Jan, 2013") }
+        it { is_expected.to be_falsey }
+      end
+
+      context "when given a day that is a holiday" do
+        let(:day) { date_class.parse("9am, Tuesday 1st Jan, 2013") }
+        it { is_expected.to be_truthy }
+      end
+
+      context "when given a non-business day that is no a holiday" do
+        let(:day) { date_class.parse("9am, Sunday 6th Jan, 2013") }
+        it { is_expected.to be_falsey }
+      end
+    end
+
     describe "#roll_forward" do
       let(:calendar) do
         Business::Calendar.new(holidays: ["Tuesday 1st Jan, 2013"])

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: business
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Harry Marr
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-06-08 00:00:00.000000000 Z
@@ -64,7 +64,7 @@ homepage: https://github.com/gocardless/business
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Date calculations based on business calendars
 test_files: