ae_bank_days 0.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8c8214bf575247e58e212562fff3969e708b4d83f34b623a5878fdacce4aa6d
-  data.tar.gz: '093a90fecc21551047a56b4246f501a100c8a0bd57c487068dbbeeedce2e37da'
+  metadata.gz: 06f9983d00ce48e33b4a934f726e456d1eb37daec1355aad31cf605f9c5ef0bd
+  data.tar.gz: e3b17132d6696f57e38e2a1addac13d1ae4daa49fcb788dae5e553b66cec463f
 SHA512:
-  metadata.gz: da7ecfb9e25139e038024ab40c8532aa6fc168d4ed50504a75b89f92e71060702cd0282c7f3dd96738c65193e3696c6284afa5c0aa61cd930995a55b0dd198c9
-  data.tar.gz: 8266ce73655cb532dda19308adca0c0427a75a9cf657ed2f5bcb18ccc362785fd53e992bfb76122d3f9f1d21f690686c5680fbcb7bc9c896320c2445e2b7fc6c
+  metadata.gz: f43ac398011e018ece5207f6db467339a3b9255451627cad5cd5e970b3d08512d38c3ae9d09604ddf09d177a30febdbf98d7e5e5ba6ef8329c9122aea7424e8b
+  data.tar.gz: b0e66f75d0ea3c5ac6d39a7240e3a284af57968292e69a5b14dbfb1753273bc21a425ab9b67e0b8f5bcedffd8bc87a7d77cca0959b6944d0a3d75105087a4c00

data/Gemfile.lock

@@ -1,35 +1,35 @@
 PATH
   remote: .
   specs:
-    ae_bank_days (0.0.1)
-      activesupport (< 5.3)
-      holidays (~> 7.1)
+    ae_bank_days (1.2.0)
+      holidays (~> 8.3)
 
 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)
+    ansi (1.5.0)
+    builder (3.2.4)
+    holidays (8.3.0)
+    minitest (5.11.3)
+    minitest-reporters (1.3.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.11.2)
+    rake (12.3.3)
+    ruby-progressbar (1.10.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   ae_bank_days!
-  bundler (>= 1.10.4, < 2.1)
-  rake (~> 12.0)
+  bundler (>= 1.10.4, < 3)
+  minitest (>= 5.8)
+  minitest-reporters (>= 1.3)
+  mocha (>= 1.1)
+  rake (>= 12.0)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2019 AppFolio inc
+Copyright (c) 2019-2020 AppFolio inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -9,9 +9,9 @@ Simple utility to find the next banking day
 * 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.
+* 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.
 
 == Copyright
 
-Copyright © 2019 AppFolio.
+Copyright © 2019-2020 AppFolio.

data/Rakefile

@@ -2,13 +2,15 @@
 
 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

@@ -5,23 +5,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require '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.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              = 'http://github.com/appfolio/ae_bank_days'
   spec.required_ruby_version = ['>= 2.3.3', '< 2.7']
-  spec.licenses      = ['MIT']
+  spec.licenses              = ['MIT']
+  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.files         = Dir['**/*'].reject { |f| f[%r{^log/}] || f[%r{^pkg/}] }
-  spec.test_files    = spec.files.grep(%r{^(test)/})
-  spec.require_paths = ['lib']
+  spec.add_dependency('holidays', '~> 8.3')
 
-  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_development_dependency('bundler', ['>= 1.10.4', '< 3'])
+  spec.add_development_dependency('minitest', '>= 5.8')
+  spec.add_development_dependency('minitest-reporters', '>= 1.3')
+  spec.add_development_dependency('mocha', '>= 1.1')
+  spec.add_development_dependency('rake', '>= 12.0')
 end

data/lib/ae_bank_days.rb

@@ -1,36 +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
-    # second * minutes * days * years
-    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)
-        banking_day = date
-        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,40 @@
+# 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
+        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..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 = '0.0.1'
+  VERSION = '1.2.0'
 end

data/test/ae_bank_days/bank_day_helper_test.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module AeBankDays
+  class BankDayHelperTest < Minitest::Test
+    def test_bank_day__weekday
+      assert BankDayHelper.bank_day?(Date.civil(2017, 10, 3))
+    end
+
+    def test_bank_day__weekend
+      refute BankDayHelper.bank_day?(Date.civil(2017, 10, 14))
+    end
+
+    def test_bank_day__holiday
+      refute BankDayHelper.bank_day?(Date.civil(2017, 10, 9))
+    end
+
+    def test_bank_day__saturday_holiday_is_not_observed_on_friday
+      # The federal bank does not observe holidays that fall on Saturday on the preceding Friday as is common.
+      # This test makes sure that these dates are not accidentally marked as holidays.
+      # July 4, 2020 fell on a Saturday. The day before was a generally observed federal holiday, but it was still
+      # a banking day due to the federal banks holiday rules.
+      assert BankDayHelper.bank_day?(Date.civil(2020, 6, 3))
+    end
+
+    def test_next_banking_day__weekday
+      assert_equal Date.civil(2017, 10, 3), BankDayHelper.next_banking_day(Date.civil(2017, 10, 3))
+    end
+
+    def test_next_banking_day__weekday__extra_days
+      assert_equal Date.civil(2017, 10, 6), BankDayHelper.next_banking_day(Date.civil(2017, 10, 3), number_of_days: 3)
+    end
+
+    def test_next_banking_day__weekend
+      assert_equal Date.civil(2017, 10, 16), BankDayHelper.next_banking_day(Date.civil(2017, 10, 14))
+    end
+
+    def test_next_banking_day__weekend__extra_days
+      assert_equal Date.civil(2017, 10, 19), BankDayHelper.next_banking_day(Date.civil(2017, 10, 14), number_of_days: 3)
+    end
+
+    def test_next_banking_day__holiday
+      assert_equal Date.civil(2017, 10, 10), BankDayHelper.next_banking_day(Date.civil(2017, 10, 9))
+    end
+
+    def test_next_banking_day__holiday__extra_days
+      assert_equal Date.civil(2017, 10, 13), BankDayHelper.next_banking_day(Date.civil(2017, 10, 9), number_of_days: 3)
+    end
+
+    def test_previous_banking_day__weekday
+      assert_equal Date.civil(2017, 10, 3), BankDayHelper.previous_banking_day(Date.civil(2017, 10, 3))
+    end
+
+    def test_previous_banking_day__weekday__extra_days
+      assert_equal Date.civil(2017, 10, 3), BankDayHelper.previous_banking_day(Date.civil(2017, 10, 6), number_of_days: 3)
+    end
+
+    def test_previous_banking_day__weekend
+      assert_equal Date.civil(2017, 10, 13), BankDayHelper.previous_banking_day(Date.civil(2017, 10, 14))
+    end
+
+    def test_previous_banking_day__weekend__extra_days
+      assert_equal Date.civil(2017, 10, 10), BankDayHelper.previous_banking_day(Date.civil(2017, 10, 14), number_of_days: 3)
+    end
+
+    def test_previous_banking_day__holiday
+      assert_equal Date.civil(2017, 10, 6), BankDayHelper.previous_banking_day(Date.civil(2017, 10, 9))
+    end
+
+    def test_previous_banking_day__holiday__extra_days
+      assert_equal Date.civil(2017, 10, 3), BankDayHelper.previous_banking_day(Date.civil(2017, 10, 9), number_of_days: 3)
+    end
+  end
+end

data/test/ae_bank_days/date_extensions_test.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module AeBankDays
+  class DateExtensionsTest < Minitest::Test
+    def test_bank_day
+      date = Date.today
+      BankDayHelper.expects(:bank_day?).with(date).returns(true)
+
+      assert date.bank_day?
+    end
+
+    def test_next_banking_day
+      date = Date.today
+      new_date = date + 2
+      BankDayHelper.expects(:next_banking_day).with(date, number_of_days: 2).returns(new_date)
+
+      assert_equal new_date, date.next_banking_day(2)
+    end
+
+    def test_next_banking_day__default
+      date = Date.today
+      new_date = date + 2
+      BankDayHelper.expects(:next_banking_day).with(date, number_of_days: 0).returns(new_date)
+
+      assert_equal new_date, date.next_banking_day
+    end
+
+    def test_previous_banking_day
+      date = Date.today
+      new_date = date + 2
+      BankDayHelper.expects(:previous_banking_day).with(date, number_of_days: 2).returns(new_date)
+
+      assert_equal new_date, date.previous_banking_day(2)
+    end
+
+    def test_previous_banking_day__default
+      date = Date.today
+      new_date = date + 2
+      BankDayHelper.expects(:previous_banking_day).with(date, number_of_days: 0).returns(new_date)
+
+      assert_equal new_date, date.previous_banking_day
+    end
+  end
+end

data/test/ae_bank_days_test.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class AeBankDaysTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::AeBankDays::VERSION
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'ae_bank_days'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'mocha/setup'
+require 'time'
+
+MiniTest::Reporters.use!

metadata

@@ -1,78 +1,106 @@
 --- !ruby/object:Gem::Specification
 name: ae_bank_days
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - AppFolio
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: holidays
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '8.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '8.3'
 - !ruby/object:Gem::Dependency
-  name: holidays
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
-  type: :runtime
+        version: 1.10.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 1.10.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '5.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.4
-    - - "<"
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.4
-    - - "<"
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
-description: ''
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Gem for finding the next banking date
 email:
 - dev@appfolio.com
 executables: []
@@ -86,14 +114,19 @@ files:
 - Rakefile
 - 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
+- test/ae_bank_days/bank_day_helper_test.rb
+- test/ae_bank_days/date_extensions_test.rb
+- test/ae_bank_days_test.rb
+- test/test_helper.rb
 homepage: http://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
@@ -111,9 +144,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Gem for finding the next banking date
 test_files:
-- test/bank_day_helper_test.rb
+- test/ae_bank_days/bank_day_helper_test.rb
+- test/ae_bank_days/date_extensions_test.rb
+- test/ae_bank_days_test.rb
+- test/test_helper.rb

data/test/bank_day_helper_test.rb

@@ -1,42 +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__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__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
-  end
-end