ae_bank_days 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01e5531a35c63eae2105cf384eaa798054a373cb5c178ff4e7eed08689d6b473
-  data.tar.gz: 8e4a1ae4e93cfa286c4a1705b50f947c39febc33915ea63c9808472d290c477e
+  metadata.gz: af37f7836eec42406fe3a2c1c86f3079f0b3ee95261020e770a8b3aa960ce524
+  data.tar.gz: 50fe48b765afdb9f3675934b157d809490b74985ce74e3a1fdd52428f28ccd9c
 SHA512:
-  metadata.gz: 23e9526aa06096f527a363f269cb39df391cab9d233ca20407e41de0dbf8afeff89d1ebc727968e592dd6ec009770766ac8d95af7838c3c527a0b12a23afd9bd
-  data.tar.gz: c175d76b81a001be7a8b1b105d5c76a58bd4aa6b08e48ffd090aa91f9b7d2274597e8f2a4bd905d4457625d1a932c6311736967b2deb4007f0a2ae4550a0b41d
+  metadata.gz: 7a9b58a38b414c355268fcd982e232e216d4c8fe0ade9da1a6218e1c41e8cca852e3bcf6ae6b1d6cdae8013400006735eda668378237398ebc9016a7cfd7da79
+  data.tar.gz: c4fc232b7874a6d4c6be98c6860e189f7ab156821b61d3eb56b57371384b07acb96934c299fbd24268cebb46d8900e45242fabd43a76f80fe461fd5b11b81357

data/Gemfile

@@ -1,5 +1,13 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source 'https://rubygems.org' do
+  gem 'appraisal', '>= 2.3', '< 3'
+  gem 'bundler', '>= 1.10.4', '< 3'
+  gem 'minitest', '>= 5.8', '< 6'
+  gem 'minitest-reporters', '>= 1.4', '< 2'
+  gem 'mocha', '>= 1.11', '< 2'
+  gem 'rake', '>= 13', '< 14'
+  gem 'simplecov', '>= 0.18', '< 1', group: :test, require: false
+end
 
 gemspec

data/README.md

@@ -0,0 +1,25 @@
+# AeBankDays
+
+Simple utility to find the next banking day
+
+## Running Tests
+
+Use the appraisal gem to test different versions of Ruby to ensure changes are compatible. Run them with the
+following command with the different versions of Ruby set:
+
+`bundle exec appraisal rake test`
+
+For a more detailed output that includes total coverage use:
+
+`WITH_COVERAGE=true bundle exec rake test`
+
+## Contributing to AeBankDays
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so it doesn't break in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise
+necessary, that is fine, but please isolate to its own commit so it can be cherry-picked around.

data/Rakefile

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-require 'rubygems'
 require 'bundler'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
+
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |test|

data/ae_bank_days.gemspec

@@ -1,27 +1,23 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ae_bank_days/version'
+require_relative 'lib/ae_bank_days/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'ae_bank_days'
-  spec.version       = AeBankDays::VERSION
-  spec.authors       = ['AppFolio']
-  spec.email         = ['dev@appfolio.com']
-  spec.summary       = 'Gem for finding the next banking date'
-  spec.description   = ''
-  spec.homepage      = 'http://github.com/appfolio/ae_bank_days'
-  spec.required_ruby_version = ['>= 2.3.3', '< 2.7']
-  spec.licenses      = ['MIT']
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.name                  = 'ae_bank_days'
+  spec.version               = AeBankDays::VERSION
+  spec.platform              = Gem::Platform::RUBY
+  spec.authors               = ['AppFolio']
+  spec.email                 = ['dev@appfolio.com']
+  spec.summary               = 'Gem for finding the next banking date'
+  spec.description           = spec.summary
+  spec.homepage              = 'https://github.com/appfolio/ae_bank_days'
+  spec.required_ruby_version = '>= 2.3.3'
+  spec.licenses              = ['MIT']
+  spec.files                 = Dir['**/*'].select { |f| f[%r{^(lib/|Gemfile$|Rakefile|README.md|.*gemspec)}] }
+  spec.test_files            = spec.files.grep(%r{^(test)/})
+  spec.require_paths         = ['lib']
 
-  spec.files         = Dir['**/*'].reject { |f| f[%r{^log/}] || f[%r{^pkg/}] }
-  spec.test_files    = spec.files.grep(%r{^(test)/})
-  spec.require_paths = ['lib']
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.add_dependency 'activesupport', '< 5.3'
-  spec.add_dependency 'holidays', '~> 7.1'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'bundler', ['>= 1.10.4', '< 2.1']
+  spec.add_dependency('holidays', '~> 8.3')
 end

data/lib/ae_bank_days.rb

@@ -1,49 +1,11 @@
 # frozen_string_literal: true
 
-require 'ae_bank_days/version'
+require 'date'
 require 'holidays'
-require 'active_support'
-require 'active_support/core_ext/time'
-require 'active_support/core_ext/integer/time'
 
 module AeBankDays
-  class BankDayHelper
-    ten_years_from_now = Time.now + 10.years
-    HOLIDAYS = Holidays.between(Date.civil(2014, 1, 1), ten_years_from_now, :federalreserve, :observed).map do |holiday|
-      holiday[:date]
-    end
-
-    class << self
-      def bank_day?(day)
-        date = day.to_date
-        weekday?(date) && !HOLIDAYS.include?(date)
-      end
-
-      def next_banking_day(date, number_of_days: 0)
-        banking_day = date
-        number_of_days.times do
-          banking_day += 1 until bank_day?(banking_day)
-          banking_day += 1
-        end
-        banking_day += 1 until bank_day?(banking_day)
-        banking_day
-      end
-
-      def previous_banking_day(date, number_of_days: 0)
-        banking_day = date
-        number_of_days.times do
-          banking_day -= 1 until bank_day?(banking_day)
-          banking_day -= 1
-        end
-        banking_day -= 1 until bank_day?(banking_day)
-        banking_day
-      end
-
-      private
-
-      def weekday?(day)
-        [1, 2, 3, 4, 5].include? day.wday
-      end
-    end
-  end
+  autoload :BankDayHelper, 'ae_bank_days/bank_day_helper'
+  autoload :DateExtensions, 'ae_bank_days/date_extensions'
 end
+
+Date.send :include, AeBankDays::DateExtensions

data/lib/ae_bank_days/bank_day_helper.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module AeBankDays
+  class BankDayHelper
+    class << self
+      Holidays.cache_between(Date.today.prev_year, Date.today.next_year(10), :federalreservebanks, :observed)
+
+      def bank_day?(day)
+        date = day.to_date
+        weekday?(date) && Holidays.on(date, :federalreservebanks, :observed).empty?
+      end
+
+      def next_banking_day(date, number_of_days: 0)
+        banking_day = date.to_date
+        banking_day += 1
+        number_of_days.times do
+          banking_day = current_or_next_banking_day(banking_day)
+          banking_day += 1
+        end
+
+        current_or_next_banking_day(banking_day)
+      end
+
+      def previous_banking_day(date, number_of_days: 0)
+        banking_day = date.to_date
+        banking_day -= 1
+        number_of_days.times do
+          banking_day = current_or_previous_banking_day(banking_day)
+          banking_day -= 1
+        end
+
+        current_or_previous_banking_day(banking_day)
+      end
+
+      def current_or_previous_banking_day(day)
+        date = day.to_date
+        date -= 1 until bank_day?(date)
+        date
+      end
+
+      def current_or_next_banking_day(day)
+        date = day.to_date
+        date += 1 until bank_day?(date)
+        date
+      end
+
+      private
+
+      def weekday?(day)
+        (1..5).include?(day.wday)
+      end
+    end
+  end
+end

data/lib/ae_bank_days/date_extensions.rb

@@ -0,0 +1,15 @@
+module AeBankDays
+  module DateExtensions
+    def bank_day?
+      BankDayHelper.bank_day?(self)
+    end
+
+    def next_banking_day(n = 0)
+      BankDayHelper.next_banking_day(self, number_of_days: n)
+    end
+
+    def previous_banking_day(n = 0)
+      BankDayHelper.previous_banking_day(self, number_of_days: n)
+    end
+  end
+end

data/lib/ae_bank_days/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AeBankDays
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,78 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: ae_bank_days
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - AppFolio
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2021-01-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: holidays
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.10.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.10.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-description: ''
+        version: '8.3'
+description: Gem for finding the next banking date
 email:
 - dev@appfolio.com
 executables: []
@@ -80,21 +32,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
-- ae_bank_days-1.0.0.gem
 - ae_bank_days.gemspec
 - lib/ae_bank_days.rb
+- lib/ae_bank_days/bank_day_helper.rb
+- lib/ae_bank_days/date_extensions.rb
 - lib/ae_bank_days/version.rb
-- test/bank_day_helper_test.rb
-homepage: http://github.com/appfolio/ae_bank_days
+homepage: https://github.com/appfolio/ae_bank_days
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,18 +53,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.3.3
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Gem for finding the next banking date
-test_files:
-- test/bank_day_helper_test.rb
+test_files: []

data/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ae_bank_days (1.0.0)
-      activesupport (< 5.3)
-      holidays (~> 7.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    concurrent-ruby (1.1.5)
-    holidays (7.1.0)
-    i18n (1.7.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.13.0)
-    rake (12.3.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  ae_bank_days!
-  bundler (>= 1.10.4, < 2.1)
-  rake (~> 12.0)
-
-BUNDLED WITH
-   2.0.2

data/LICENSE.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2019 AppFolio inc
-
-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.rdoc

@@ -1,17 +0,0 @@
-= ae_bank_days
-
-Simple utility to find the next banking day
-
-== Contributing to ae_bank_days
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright © 2019 AppFolio.

data/test/bank_day_helper_test.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require 'minitest/autorun'
-require 'ae_bank_days'
-
-module AeBankDays
-  class BankDayHelperTest < ActiveSupport::TestCase
-    def test_constant
-      refute AeBankDays::BankDayHelper::HOLIDAYS.empty?
-    end
-
-    def test_bank_day__weekday
-      time = Time.parse('2017-10-03 14:30:45 -0500')
-      assert AeBankDays::BankDayHelper.bank_day?(time.to_date)
-    end
-
-    def test_bank_day__weekend
-      time = Time.parse('2017-10-14 14:30:45 -0500')
-      refute AeBankDays::BankDayHelper.bank_day?(time.to_date)
-    end
-
-    def test_bank_day__holiday
-      time = Time.parse('2017-10-09 14:30:45 -0500')
-      refute AeBankDays::BankDayHelper.bank_day?(time.to_date)
-    end
-
-    def test_next_banking_day__weekday
-      time = Time.parse('2017-10-03 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-03'), AeBankDays::BankDayHelper.next_banking_day(time.to_date)
-    end
-
-    def test_next_banking_day__weekday__extra_days
-      time = Time.parse('2017-10-03 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-06'), AeBankDays::BankDayHelper.next_banking_day(time.to_date, number_of_days: 3)
-    end
-
-    def test_next_banking_day__weekend
-      time = Time.parse('2017-10-14 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-16'), AeBankDays::BankDayHelper.next_banking_day(time.to_date)
-    end
-
-    def test_next_banking_day__weekend__extra_days
-      time = Time.parse('2017-10-14 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-19'), AeBankDays::BankDayHelper.next_banking_day(time.to_date, number_of_days: 3)
-    end
-
-    def test_next_banking_day__holiday
-      time = Time.parse('2017-10-09 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-10'), AeBankDays::BankDayHelper.next_banking_day(time.to_date)
-    end
-
-    def test_next_banking_day__holiday__extra_days
-      time = Time.parse('2017-10-09 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-13'), AeBankDays::BankDayHelper.next_banking_day(time.to_date, number_of_days: 3)
-    end
-
-    def test_previous_banking_day__weekday
-      time = Time.parse('2017-10-03 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-03'), AeBankDays::BankDayHelper.previous_banking_day(time.to_date)
-    end
-
-    def test_previous_banking_day__weekday__extra_days
-      time = Time.parse('2017-10-06 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-03'), AeBankDays::BankDayHelper.previous_banking_day(time.to_date, number_of_days: 3)
-    end
-
-    def test_previous_banking_day__weekend
-      time = Time.parse('2017-10-14 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-13'), AeBankDays::BankDayHelper.previous_banking_day(time.to_date)
-    end
-
-    def test_previous_banking_day__weekend__extra_days
-      time = Time.parse('2017-10-14 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-10'), AeBankDays::BankDayHelper.previous_banking_day(time.to_date, number_of_days: 3)
-    end
-
-    def test_previous_banking_day__holiday
-      time = Time.parse('2017-10-09 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-06'), AeBankDays::BankDayHelper.previous_banking_day(time.to_date)
-    end
-
-    def test_previous_banking_day__holiday__extra_days
-      time = Time.parse('2017-10-09 14:30:45 -0500')
-      assert_equal Date.parse('2017-10-03'), AeBankDays::BankDayHelper.previous_banking_day(time.to_date, number_of_days: 3)
-    end
-  end
-end