business_day 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7eec67857ca22aefb1b20f5efe6a2d6c4b08e9fd4ab721cee016e2a038f819f
+  data.tar.gz: 1b210218ace3e18490d13a7467f33516adee9c2748419e1656873c66ddb6ff52
+SHA512:
+  metadata.gz: 9199b19412df4d0c13def585e3b64559655a5de1f2a26fc1c2ba7d91ad350fa2a4a90cc84c76b75b2b2e3754bcacf4a793e6e51c266ac248358dac652de262c8
+  data.tar.gz: 31762c435189f1b5e6ea5252653cbee52e95235b223313c7913e8a4c9b81e2746820db848a807b88fbe234aa646a21de61e52d788a101ae0812d0e7f0802ea43

data/.circleci/config.yml

@@ -0,0 +1,37 @@
+version: 2.1
+
+jobs:
+  test:
+    docker:
+      - image: circleci/ruby:<< parameters.ruby-version >>
+    parameters:
+      ruby-version:
+        type: string
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - bundle-v1-<< parameters.ruby-version >>-{{ checksum "business.gemspec" }}
+            - bundle-v1-<< parameters.ruby-version >>-
+      - run:
+          name: Install dependencies
+          command: bundle install --clean --no-cache --path vendor/bundle --jobs=4 --retry=3
+      - save_cache:
+          key: bundle-v1-<< parameters.ruby-version >>-{{ checksum "business.gemspec" }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: Run tests
+          command: bundle exec rspec
+      - run:
+          name: Run rubocop
+          command: bundle exec rubocop --parallel --extra-details --display-style-guide
+
+workflows:
+  default:
+    jobs:
+      - test:
+          name: Ruby << matrix.ruby-version >>
+          matrix:
+            parameters:
+              ruby-version: ["2.4.9", "2.5.8", "2.6.6", "2.7.1"]

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/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  gc_ruboconfig: rubocop.yml
+
+RSpec/NestedGroups:
+  Exclude:
+    - spec/business/calendar_spec.rb
+
+# Disabled as API uses set_holidays etc
+Naming/AccessorMethodName:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/CHANGELOG.md

@@ -0,0 +1,118 @@
+## 2.1.0 - June 8, 2020
+
+- Add seperate `working_day?` and `holiday?` methods to the calendar
+
+## 2.0.0 - May 4, 2020
+
+🚨 **BREAKING CHANGES** 🚨
+
+For more on the breaking changes that have been introduced in v2.0.0 please [see the readme](README.md#v200-breaking-changes).
+
+- Remove bundled calendars see [this pr](https://github.com/gocardless/business/pull/54) for more context. If you need to use any of the previously bundled calendars, [see here](https://github.com/gocardless/business/tree/b12c186ca6fd4ffdac85175742ff7e4d0a705ef4/lib/business/data)
+- `Business::Calendar.load_paths=` is now required
+
+## 1.18.0 - April 30, 2020
+
+### Note we have dropped support for Ruby < 2.4.x
+
+- Correct Danish public holidays
+
+## 1.17.1 - November 19, 2019
+
+- Change May Bank Holiday 2020 for UK (Bacs) - this was moved to the 8th.
+- Add 2020 holidays for PAD.
+
+## 1.17.0 - October 30, 2019
+
+- Add holiday calendar for France (Target(SEPA) + French bank holidays)
+
+## 1.16.1 - September 2, 2019
+
+- Fix holiday calendar for ACH U.S.
+
+## 1.16.0 - January 17, 2019
+
+- Add holiday calendar for ACH U.S.
+
+## 1.15.0 - October 24, 2018
+
+- Add holiday calendar for PAD Canada
+
+## 1.14.0 - July 18, 2018
+
+- Add holiday calendar for BECS New Zealand
+
+## 1.13.1 - June 22, 2018
+
+- Fix June's 2018 bank holidays for Bankgirot
+
+## 1.13.0 - April 17, 2018
+
+- Add support for specifying `extra_working_dates` (special dates that are "working days",
+  even though they are not one of the specified days, for example weekend dates
+  that are considered to be working days)
+
+## 1.12.0 - April 3, 2018
+
+- Add Betalingservice & BECS calendars up until 2020
+
+## 1.11.1 - December 20, 2017
+
+- Add 2017-2018 BECS holiday definitions
+
+## 1.11.0 - December 13, 2017
+
+- Handle properly calendar initialization by Date objects (not strings),
+  coming from both YAML config and initialize().
+
+
+## 1.10.0 - September 20, 2017
+
+- Add 2018-2019 Betalingsservice holiday definitions
+
+## 1.9.0 - August 23, 2017
+
+- Add 2017 Betalingsservice holiday definitions
+
+## 1.8.0 - February 13, 2017
+
+- Add 2018-2027 TARGET holiday defintions
+- Add 2018-2027 Bankgirot holiday defintions
+
+## 1.7.0 - January 18, 2017
+
+- Add 2018-2027 BACS holiday defintions
+
+## 1.6.0 - December 23, 2016
+
+- Add 2017 BACS holiday definitions
+- Add 2017 and 2018 TARGET holiday definitions
+
+## 1.5.0 - June 2, 2015
+
+- Add 2016 holiday definitions
+
+## 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`
+
+
+## 1.2.0 - November 15, 2014
+
+- Add TARGET calendar
+
+
+## 1.1.0 - September 30, 2014
+
+- Add 2015 holiday definitions
+
+
+## 1.0.0 - June 11, 2014
+
+- Initial public release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 GoCardless
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,196 @@
+# Business
+
+[![Gem version](https://badge.fury.io/rb/business.svg)](http://badge.fury.io/rb/business)
+[![CircleCI](https://circleci.com/gh/gocardless/business.svg?style=svg)](https://circleci.com/gh/gocardless/business)
+
+Date calculations based on business calendars.
+
+- [v2.0.0 breaking changes](#v200-breaking-changes)
+- [Getting Started](#getting-started)
+  - [Creating a calendar](#creating-a-calendar)
+  - [Using a calendar file](#use-a-calendar-file)
+- [Checking for business days](#checking-for-business-days)
+- [Business day arithmetic](#business-day-arithmetic)
+- [But other libraries already do this](#but-other-libraries-already-do-this)
+- [License & Contributing](#license--contributing)
+
+## v2.0.0 breaking changes
+
+We have removed the bundled calendars as of version 2.0.0, if you need the calendars that were included:
+
+- Download the calendars you wish to use from [v1.18.0](https://github.com/gocardless/business/tree/b12c186ca6fd4ffdac85175742ff7e4d0a705ef4/lib/business/data)
+- Place them in a suitable directory in your project, typically `lib/calendars`
+-  Add this directory path to your instance of `BusinessDay::Calendar` using the `load_paths` method.dd the directory to where you placed the yml files before you load the calendar
+
+```ruby
+BusinessDay::Calendar.load_paths = ["lib/calendars"] # your_project/lib/calendars/ contains bacs.yml
+BusinessDay::Calendar.load("bacs")
+```
+
+If you wish to stay on the last version that contained bundled calendars, pin `business` to `v1.18.0`
+
+```ruby
+# Gemfile
+gem "business", "v1.18.0"
+```
+
+## Getting started
+
+To install business, simply:
+
+```bash
+gem install business
+```
+
+If you are using a Gemfile:
+
+```ruby
+gem "business", "~> 2.0"
+```
+
+### Creating a calendar
+
+Get started with business by creating an instance of the calendar class, that accepts a hash that specifies which days of the week are considered working days, which days are holidays and which are extra working dates.
+
+```ruby
+calendar = BusinessDay::Calendar.new(
+  working_days: %w( mon tue wed thu fri ),
+  holidays: ["01/01/2014", "03/01/2014"]    # array items are either parseable date strings, or real Date objects
+  extra_working_dates: [nil], # Makes the calendar to consider a weekend day as a working day.
+)
+```
+
+### Use a calendar file
+
+Defining a calendar as a Ruby object may not be convenient, so we provide a way of defining these calendars as YAML. Below we will walk through the necessary [steps](#example-calendar) to build your first calendar. All keys are optional and will default to the following:
+
+Note: Elements of `holidays` and `extra_working_dates` may be either strings that `Date.parse()` [can understand](https://ruby-doc.org/stdlib-2.7.1/libdoc/date/rdoc/Date.html#method-c-parse), or `YYYY-MM-DD` (which is considered as a Date by Ruby YAML itself)[https://github.com/ruby/psych/blob/6ec6e475e8afcf7868b0407fc08014aed886ecf1/lib/psych/scalar_scanner.rb#L60].
+
+#### YAML file Structure
+
+```yml
+working_days: # Optional, default [Monday-Friday]
+  -
+holidays: # Optional, default: []  ie: "no holidays" assumed
+  -
+extra_working_dates: # Optional, default: [], ie: no changes in `working_days` will happen
+  -
+```
+
+#### Example calendar
+
+```yaml
+# lib/calendars/my_calendar.yml
+working_days:
+  - Monday
+  - Wednesday
+  - Friday
+holidays:
+  - 1st April 2020
+  - 2021-04-01
+extra_working_dates:
+  - 9th March 2020 # A Saturday
+```
+
+Ensure the calendar file is saved to a directory that will hold all your calendars, typically `lib/calendars`, then add this directory to your instance of `BusinessDay::Calendar` using the `load_paths` method before you call your calendar.
+
+`load_paths` also accepts an array of plain Ruby hashes with the format:
+
+```ruby
+  { "calendar_name" => { "working_days" => [] }
+```
+
+#### Example loading both a path and ruby hashes
+
+```ruby
+BusinessDay::Calendar.load_paths = [
+  "lib/calendars",
+  { "foo_calendar" => { "working_days" => ["monday"] } },
+  { "bar_calendar" => { "working_days" => ["sunday"] } },
+]
+```
+
+Now you can load the calendar by calling the `BusinessDay::Calendar.load(calendar_name)`. In order to avoid parsing the calendar file multiple times, there is a `BusinessDay::Calendar.load_cached(calendar_name)` method that caches the calendars by name after loading them.
+
+```ruby
+calendar = BusinessDay::Calendar.load("my_calendar") # lib/calendars/my_calendar.yml
+calendar = BusinessDay::Calendar.load("foo_calendar")
+# or
+calendar = BusinessDay::Calendar.load_cached("my_calendar")
+calendar = BusinessDay::Calendar.load_cached("foo_calendar")
+```
+
+## Checking for business days
+
+To check whether a given date is a business day (falls on one of the specified working days or working dates, and is not a holiday), use the `business_day?` method on `BusinessDay::Calendar`.
+
+```ruby
+calendar.business_day?(Date.parse("Monday, 9 June 2014"))
+# => true
+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 `BusinessDay::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.
+
+```ruby
+date = Date.parse("Thursday, 12 June 2014")
+calendar.add_business_days(date, 4).strftime("%A, %d %B %Y")
+# => "Wednesday, 18 June 2014"
+calendar.subtract_business_days(date, 4).strftime("%A, %d %B %Y")
+# => "Friday, 06 June 2014"
+```
+
+The `roll_forward` and `roll_backward` methods snap a date to a nearby business day. If provided with a business day, they will return that date. Otherwise, they will advance (forward for `roll_forward` and backward for `roll_backward`) until a business day is found.
+
+```ruby
+date = Date.parse("Saturday, 14 June 2014")
+calendar.roll_forward(date).strftime("%A, %d %B %Y")
+# => "Monday, 16 June 2014"
+calendar.roll_backward(date).strftime("%A, %d %B %Y")
+# => "Friday, 13 June 2014"
+```
+
+To count the number of business days between two dates, pass the dates to `business_days_between`. This method counts from start of the first date to start of the second date. So, assuming no holidays, there would be two business days between a Monday and a Wednesday.
+
+```ruby
+date = Date.parse("Saturday, 14 June 2014")
+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 exists for this purpose. We previously used business_time, but encountered several issues that prompted us to start business.
+
+Firstly, business_time works by monkey-patching `Date`, `Time`, and `FixNum`. While this enables syntax like `Time.now + 1.business_day`, it means that all configuration has to be global. GoCardless handles payments across several geographies, so being able to work with multiple working-day calendars is
+essential for us. Business provides a simple `Calendar` class, that is initialized with a configuration that specifies which days of the week are considered to be working days, and which dates are holidays.
+
+Secondly, business_time supports calculations on times as well as dates. For our purposes, date-based calculations are sufficient. Supporting time-based calculations as well makes the code significantly more complex. We chose to avoid this extra complexity by sticking solely to date-based mathematics.
+
+<p align="center"><img src="http://3.bp.blogspot.com/-aq4iOz2OZzs/Ty8xaQwMhtI/AAAAAAAABrM/-vn4tcRA9-4/s1600/daily-morning-awesomeness-243.jpeg" alt="I'm late for business" width="250"/></p>
+
+## License & Contributing
+- business is available as open source under the terms of the [MIT License](LICENSE).
+- Bug reports and pull requests are welcome on GitHub at https://github.com/gocardless/business.
+
+GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/about/jobs).
+
+## In this FORK
+Renamed the Business module to BusinessDay

data/business_day.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "business_day/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "business_day"
+  spec.version       = BusinessDay::VERSION
+  spec.authors       = ["Harry Marr"]
+  spec.email         = ["developers@gocardless.com"]
+  spec.summary       = "Date calculations based on business calendars"
+  spec.description   = "Date calculations based on business calendars"
+  spec.homepage      = "https://github.com/go-tandem/business_day"
+  spec.licenses      = ["MIT"]
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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 "gc_ruboconfig", "~> 2.24.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
+  spec.add_development_dependency "rubocop", "~> 1.10.0"
+end