business 2.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31ba206f257f17ef5bdfa3c60e9e81f2e5e2e71436a701513643f90e783d844d
-  data.tar.gz: bda97edfe037b2f509b4d037d46a39b89c5ed96130872c6e090da461c6783418
+  metadata.gz: b251f5b883fe268c312d1d85b129f20244ca8729a427784f8e5c0b87681ff646
+  data.tar.gz: '05779798d8c21739f31a604b6e46c063f62189b0a7e0a1064e674c1c5fbe9278'
 SHA512:
-  metadata.gz: 07576b028c3b7c31fd5be9fc1c1588b31b76b629d6381c73566a828db6add04ee47f7f24091274ef55c0441666551922a35b97ccbb112224fe85d3bf24865dd0
-  data.tar.gz: 81aae610dd327487aa95b11b04b12d5d909f3296c36a2d49ff9147dc1a2276b4e024fffe2fe5cb8fa072a60b2a667d7b5f0cf207e919e2bc796d6693d01a731a
+  metadata.gz: 7d117a929340ee63c4978d6a0869e3e99fb585c002ac609a9d12d047aee7a96f75fc04f7a03bda894591348d23a3d3f43a32c1e33366d2bdb77d2ce9481c7e21
+  data.tar.gz: b2b9acd515306f0460e3e48aa89a0c0296b8bd9eebf9a4b51a4a3731fd94b7096ca521fd50db9ace4ba97bbcb7bb24e17cc6d38c488e6855bc8b34c1d0cd982f

data/.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 jobs:
   test:
     docker:
-      - image: circleci/ruby:<< parameters.ruby-version >>
+      - image: cimg/ruby:<< parameters.ruby-version >>
     parameters:
       ruby-version:
         type: string
@@ -23,6 +23,9 @@ jobs:
       - run:
           name: Run tests
           command: bundle exec rspec
+      - run:
+          name: Run rubocop
+          command: bundle exec rubocop --parallel --extra-details --display-style-guide
 
 workflows:
   default:
@@ -31,4 +34,4 @@ workflows:
           name: Ruby << matrix.ruby-version >>
           matrix:
             parameters:
-              ruby-version: ["2.4.9", "2.5.8", "2.6.6", "2.7.1"]
+              ruby-version: ["2.6.7", "2.7.3", "3.0.1", "3.1.0"]

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.rubocop.yml

@@ -0,0 +1,16 @@
+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
+
+Style/HashSyntax:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.1
+3.1.0

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## Upcoming
+
+## 2.3.0 - Jan 31, 2022
+
+- Added permitted classes to YAML's `safe_load` #112 - thanks @attack
+- Removed support for Ruby 2.4, 2.5
+
+## 2.2.1 - March 9, 2021
+
+- Fix regression on `Calendar#new` #83 - thanks @ineu!
+
+## 2.2.0 - March 4, 2021
+
+- Add `Business::Calendar#name` - thanks @mattmcf!
+
+## 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/Gemfile

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

data/README.md

@@ -23,7 +23,7 @@ We have removed the bundled calendars as of version 2.0.0, if you need the calen
 -  Add this directory path to your instance of `Business::Calendar` using the `load_paths` method.dd the directory to where you placed the yml files before you load the calendar
 
 ```ruby
-Business::Calendar.load_paths("lib/calendars") # your_project/lib/calendars/ contains bacs.yml
+Business::Calendar.load_paths = ["lib/calendars"] # your_project/lib/calendars/ contains bacs.yml
 Business::Calendar.load("bacs")
 ```
 
@@ -52,10 +52,13 @@ gem "business", "~> 2.0"
 
 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.
 
+Additionally each calendar instance can be given a name. This can come in handy if you use multiple calendars.
+
 ```ruby
 calendar = Business::Calendar.new(
+  name: 'my calendar',
   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
+  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.
 )
 ```
@@ -131,6 +134,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/business.gemspec

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

data/lib/business/calendar.rb

@@ -1,8 +1,13 @@
-require 'yaml'
-require 'date'
+# frozen_string_literal: true
+
+require "yaml"
+require "date"
+require "pathname"
 
 module Business
   class Calendar
+    VALID_KEYS = %w[holidays working_days extra_working_dates].freeze
+
     class << self
       attr_accessor :load_paths
     end
@@ -13,60 +18,73 @@ module Business
     private_class_method :calendar_directories
 
     def self.load(calendar_name)
-      data = calendar_directories.detect do |path|
-        if path.is_a?(Hash)
-          break path[calendar_name] if path[calendar_name]
-        else
-          next unless File.exists?(File.join(path, "#{calendar_name}.yml"))
+      data = find_calendar_data(calendar_name)
+      raise "No such calendar '#{calendar_name}'" unless data
 
-          break YAML.load_file(File.join(path, "#{calendar_name}.yml"))
-        end
+      unless (data.keys - VALID_KEYS).empty?
+        raise "Only valid keys are: #{VALID_KEYS.join(', ')}"
       end
 
-      raise "No such calendar '#{calendar_name}'" unless data
+      new(
+        name: calendar_name,
+        holidays: data["holidays"],
+        working_days: data["working_days"],
+        extra_working_dates: data["extra_working_dates"],
+      )
+    end
 
-      valid_keys = %w(holidays working_days extra_working_dates)
+    def self.find_calendar_data(calendar_name)
+      calendar_directories.detect do |path|
+        if path.is_a?(Hash)
+          break path[calendar_name] if path[calendar_name]
+        else
+          calendar_path = Pathname.new(path).join("#{calendar_name}.yml")
+          next unless calendar_path.exist?
 
-      unless (data.keys - valid_keys).empty?
-        raise "Only valid keys are: #{valid_keys.join(', ')}"
+          break YAML.safe_load(calendar_path.read, permitted_classes: [Date])
+        end
       end
-
-      self.new(
-        holidays: data['holidays'],
-        working_days: data['working_days'],
-        extra_working_dates: data['extra_working_dates'],
-      )
     end
 
     @lock = Mutex.new
     def self.load_cached(calendar)
       @lock.synchronize do
-        @cache ||= { }
-        unless @cache.include?(calendar)
-          @cache[calendar] = self.load(calendar)
-        end
+        @cache ||= {}
+        @cache[calendar] = self.load(calendar) unless @cache.include?(calendar)
         @cache[calendar]
       end
     end
 
     DAY_NAMES = %( mon tue wed thu fri sat sun )
 
-    attr_reader :holidays, :working_days, :extra_working_dates
+    attr_reader :name, :holidays, :working_days, :extra_working_dates
+
+    def initialize(name: nil, extra_working_dates: nil, working_days: nil, holidays: nil)
+      @name = name
+      set_extra_working_dates(extra_working_dates)
+      set_working_days(working_days)
+      set_holidays(holidays)
 
-    def initialize(config)
-      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
@@ -88,19 +106,19 @@ module Business
     # 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
+      loop do
         date += day_interval_for(date)
-      end until business_day?(date)
-      date
+        break date if business_day?(date)
+      end
     end
 
     # Roll backward to the previous business day regardless of whether the given
     # date is a business day or not.
     def previous_business_day(date)
-      begin
+      loop do
         date -= day_interval_for(date)
-      end until business_day?(date)
-      date
+        break date if business_day?(date)
+      end
     end
 
     # Add a number of business days to a date. If a non-business day is given,
@@ -111,9 +129,10 @@ module Business
     def add_business_days(date, delta)
       date = roll_forward(date)
       delta.times do
-        begin
+        loop do
           date += day_interval_for(date)
-        end until business_day?(date)
+          break date if business_day?(date)
+        end
       end
       date
     end
@@ -126,9 +145,10 @@ module Business
     def subtract_business_days(date, delta)
       date = roll_backward(date)
       delta.times do
-        begin
+        loop do
           date -= day_interval_for(date)
-        end until business_day?(date)
+          break date if business_day?(date)
+        end
       end
       date
     end
@@ -137,7 +157,8 @@ module Business
     # 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
+      date1 = date1.to_date
+      date2 = date2.to_date
 
       # To optimise this method we split the range into full weeks and a
       # remaining period.
@@ -159,11 +180,11 @@ module Business
       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 = working_days.include?(holiday.strftime('%a').downcase)
+        on_biz_day = working_days.include?(holiday.strftime("%a").downcase)
         in_range && on_biz_day
       end
 
-      remaining_range = (date2-remaining_days...date2)
+      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
@@ -179,9 +200,12 @@ module Business
           raise "Invalid day #{day}" unless DAY_NAMES.include?(normalised_day)
         end
       end
-      extra_working_dates_names = @extra_working_dates.map { |d| d.strftime("%a").downcase }
+      extra_working_dates_names = @extra_working_dates.map do |d|
+        d.strftime("%a").downcase
+      end
       return if (extra_working_dates_names & @working_days).none?
-      raise ArgumentError, 'Extra working dates cannot be on working days'
+
+      raise ArgumentError, "Extra working dates cannot be on working days"
     end
 
     def parse_dates(dates)
@@ -191,8 +215,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)
@@ -201,7 +223,7 @@ module Business
 
     # If no working days are provided in the calendar config, these are used.
     def default_working_days
-      %w( mon tue wed thu fri )
+      %w[mon tue wed thu fri]
     end
   end
 end

data/lib/business/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Business
-  VERSION = "2.0.0"
+  VERSION = "2.3.0"
 end

data/lib/business.rb

@@ -1 +1,3 @@
-require 'business/calendar'
+# frozen_string_literal: true
+
+require "business/calendar"