commercial 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1625934e30d3bbff95fac940c7a12766c5c43a665ef88280f5d0eab1998cadea
+  data.tar.gz: 98e5ee5230a3b0ad15feb98ab38b4c3d4c2a4dffd9c273acdc07482610032340
+SHA512:
+  metadata.gz: 4975c5b58483ada85a2a7e07b0ce3462a8360b34ff39022c9c2c96071da89acbed29e1be028d33976492cd5a179615a3ce3b8c870b631f7677f4e0feae3e1424
+  data.tar.gz: 93105d5fee8884185aa7f2438ff43c956a4f46613fda199409f2864572228feeb6ce80733983bab6946f84910690de5d9ad802b339d17ab62097f9e1dcc37fd0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 William T. Nelson
+
+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,99 @@
+# Commercial
+
+Ruby gem for checking business days based on the United States [federal holiday](https://www.opm.gov/policy-data-oversight/pay-leave/federal-holidays/) schedule.
+
+Dates from 1971 onwards are supported.
+
+## Usage
+
+Check if a date is a commercial day (not a weekend or federal holiday):
+
+```ruby
+require "commercial"
+
+date = Date.new(2025, 7, 4)       # Independence Day
+Commercial::US.commercial?(date)  # => false
+
+date = Date.new(2025, 7, 5)       # Saturday
+Commercial::US.commercial?(date)  # => false
+
+date = Date.new(2025, 7, 7)       # Monday
+Commercial::US.commercial?(date)  # => true
+
+# Defaults to `Date.today`
+Commercial::US.commercial?        # => true/false
+```
+
+### Including the module
+
+Include the module to call methods directly:
+
+```ruby
+include Commercial::US
+commercial?(Date.today)                 # => true/false
+```
+
+Or in a more functional style:
+
+```ruby
+class HolidayChecker
+  extend Commercial::US
+end
+HolidayChecker.commercial?(Date.today)  # => true/false
+```
+
+### Checking holidays
+
+You can also check for specific holidays or use the general `.federal_holiday?` method:
+
+```ruby
+# Check if a date is a weekend
+Commercial::US.weekend?(Date.new(2025, 7, 5))             # => true (Saturday)
+
+# Check if a date is any federal holiday
+Commercial::US.federal_holiday?(Date.new(2025, 7, 4))     # => true
+
+# Check for specific holidays
+Commercial::US.independence_day?(Date.new(2025, 7, 4))    # => true
+Commercial::US.christmas_day?(Date.new(2025, 12, 25))     # => true
+Commercial::US.thanksgiving_day?(Date.new(2025, 11, 27))  # => true
+```
+
+### Public methods
+
+All methods accept an optional `Date` parameter, which defaults to `Date.today` if not specified:
+
+- `.commercial?(date)` returns true if date is a business day (not weekend or holiday)
+- `.weekend?(date)` returns true if date is Saturday or Sunday
+- `.federal_holiday?(date)` returns true if date is any federal holiday
+- `.new_years_day?(date)` January 1st (or observed)
+- `.martin_luther_king_day?(date)` third Monday of January (observed since 1986)
+- `.washingtons_birthday?(date)` third Monday of February
+- `.memorial_day?(date)` last Monday of May
+- `.juneteenth?(date)` June 19 (or observed, federal holiday since 2021)
+- `.independence_day?(date)` July 4 (or observed)
+- `.labor_day?(date)` first Monday of September
+- `.columbus_day?(date)` second Monday of October
+- `.thanksgiving_day?(date)` fourth Thursday of November
+- `.christmas_day?(date)` December 25 (or observed)
+
+## Type signatures
+
+This gem includes [RBS](https://github.com/ruby/rbs) type signatures in the `sig/` directory. These provide static type information for type checkers like [Steep](https://github.com/soutaro/steep) and enable better IDE support.
+
+To validate the signatures:
+```bash
+rbs -I sig -r date validate
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [github.com/wtn/commercial](https://github.com/wtn/commercial).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/commercial/us.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require "date"
+
+module Commercial
+  module US
+    module_function
+
+    # Check if a given date is a commercial banking day (not a weekend or federal holiday)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is a commercial banking day
+    def commercial?(date = Date.today)
+      !weekend?(date) && !federal_holiday?(date)
+    end
+
+    # Check if date is a US federal holiday
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is a federal holiday
+    def federal_holiday?(date)
+      date.year < 1971 and raise ArgumentError, "year #{date.year} not supported"
+      new_years_day?(date) \
+        || martin_luther_king_day?(date) \
+        || washingtons_birthday?(date) \
+        || memorial_day?(date) \
+        || juneteenth?(date) \
+        || independence_day?(date) \
+        || labor_day?(date) \
+        || columbus_day?(date) \
+        || thanksgiving_day?(date) \
+        || christmas_day?(date)
+    end
+
+    # New Year's Day (January 1st, or first Monday of January if on weekend)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is New Year's Day or its observance
+    def new_years_day?(date)
+      return true if date.month == 1 && date.day == 1 && !weekend?(date)
+
+      # If Jan 1 is on Saturday, observed on previous Friday (Dec 31)
+      # If Jan 1 is on Sunday, observed on next Monday (Jan 2)
+      if date.month == 1 && date.day == 2 && date.monday?
+        jan_1 = Date.new(date.year, 1, 1)
+        return jan_1.sunday?
+      end
+
+      # Check if this is Dec 31 and Jan 1 is Saturday
+      if date.month == 12 && date.day == 31 && date.friday?
+        jan_1_next_year = Date.new(date.year + 1, 1, 1)
+        return jan_1_next_year.saturday?
+      end
+
+      false
+    end
+
+    # Martin Luther King Day (third Monday of January)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is Martin Luther King Day
+    def martin_luther_king_day?(date)
+      date.year >= 1986 && date.month == 1 && date.monday? && nth_weekday_of_month?(date, 3)
+    end
+
+    # Washington's Birthday (third Monday of February)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is Washington's Birthday
+    def washingtons_birthday?(date)
+      date.month == 2 && date.monday? && nth_weekday_of_month?(date, 3)
+    end
+
+    # Memorial Day (last Monday of May)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is Memorial Day
+    def memorial_day?(date)
+      date.month == 5 && date.monday? && last_weekday_of_month?(date)
+    end
+
+    # Juneteenth (June 19, or nearest Monday or Friday if on a weekend)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is Juneteenth or its observance
+    def juneteenth?(date)
+      return false if date.year < 2021
+      return true if date.month == 6 && date.day == 19 && !weekend?(date)
+
+      # If June 19 is on Saturday, observed on Friday (June 18)
+      if date.month == 6 && date.day == 18 && date.friday?
+        june_19 = Date.new(date.year, 6, 19)
+        return june_19.saturday?
+      end
+
+      # If June 19 is on Sunday, observed on Monday (June 20)
+      if date.month == 6 && date.day == 20 && date.monday?
+        june_19 = Date.new(date.year, 6, 19)
+        return june_19.sunday?
+      end
+
+      false
+    end
+
+    # Independence Day (July 4, or July 3rd if on Saturday, July 5th if on Sunday)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is Independence Day or its observance
+    def independence_day?(date)
+      return true if date.month == 7 && date.day == 4 && !weekend?(date)
+
+      # If July 4 is on Saturday, observed on Friday (July 3)
+      if date.month == 7 && date.day == 3 && date.friday?
+        july_4 = Date.new(date.year, 7, 4)
+        return july_4.saturday?
+      end
+
+      # If July 4 is on Sunday, observed on Monday (July 5)
+      if date.month == 7 && date.day == 5 && date.monday?
+        july_4 = Date.new(date.year, 7, 4)
+        return july_4.sunday?
+      end
+
+      false
+    end
+
+    # Labor Day (First Monday of September)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is Labor Day
+    def labor_day?(date)
+      date.month == 9 && date.monday? && nth_weekday_of_month?(date, 1)
+    end
+
+    # Columbus Day (second Monday of October)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is Columbus Day
+    def columbus_day?(date)
+      date.month == 10 && date.monday? && nth_weekday_of_month?(date, 2)
+    end
+
+    # Thanksgiving Day (Fourth Thursday of November)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is Thanksgiving Day
+    def thanksgiving_day?(date)
+      date.month == 11 && date.thursday? && nth_weekday_of_month?(date, 4)
+    end
+
+    # Christmas Day (December 25th, or December 24th if on Saturday, December 26th if on Sunday)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is Christmas Day or its observance
+    def christmas_day?(date)
+      return true if date.month == 12 && date.day == 25 && !weekend?(date)
+
+      # If Dec 25 is on Saturday, observed on Friday (Dec 24)
+      if date.month == 12 && date.day == 24 && date.friday?
+        dec_25 = Date.new(date.year, 12, 25)
+        return dec_25.saturday?
+      end
+
+      # If Dec 25 is on Sunday, observed on Monday (Dec 26)
+      if date.month == 12 && date.day == 26 && date.monday?
+        dec_25 = Date.new(date.year, 12, 25)
+        return dec_25.sunday?
+      end
+
+      false
+    end
+
+    # Check if date is a weekend (Saturday or Sunday)
+    # @param date [Date] the date to check
+    # @return [Boolean] true if the date is a weekend
+    def weekend?(date)
+      date.saturday? || date.sunday?
+    end
+
+    class << self
+      private
+
+      # Check if date is the nth occurrence of its weekday in the month
+      # e.g., is this the 3rd Monday of the month?
+      def nth_weekday_of_month?(date, n)
+        # Calculate which occurrence this is
+        # Day 1-7 is 1st, 8-14 is 2nd, 15-21 is 3rd, 22-28 is 4th
+        occurrence = ((date.day - 1) / 7) + 1
+        occurrence == n
+      end
+
+      # Check if date is the last occurrence of its weekday in the month
+      def last_weekday_of_month?(date)
+        # Check if adding 7 days would put us in the next month
+        next_week = date + 7
+        next_week.month != date.month
+      end
+    end
+  end
+end

data/lib/commercial/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Commercial
+  VERSION = "0.1.0"
+end

data/lib/commercial.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "commercial/version"
+require_relative "commercial/us"
+
+module Commercial
+  class Error < StandardError; end
+end

data/sig/commercial.rbs

@@ -0,0 +1,31 @@
+module Commercial
+  VERSION: String
+
+  module US
+    def self.commercial?: (?Date date) -> bool
+
+    def self.weekend?: (?Date date) -> bool
+
+    def self.federal_holiday?: (?Date date) -> bool
+
+    def self.new_years_day?: (Date date) -> bool
+
+    def self.martin_luther_king_day?: (Date date) -> bool
+
+    def self.washingtons_birthday?: (Date date) -> bool
+
+    def self.memorial_day?: (Date date) -> bool
+
+    def self.juneteenth?: (Date date) -> bool
+
+    def self.independence_day?: (Date date) -> bool
+
+    def self.labor_day?: (Date date) -> bool
+
+    def self.columbus_day?: (Date date) -> bool
+
+    def self.thanksgiving_day?: (Date date) -> bool
+
+    def self.christmas_day?: (Date date) -> bool
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: commercial
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William T. Nelson
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- 35801+wtn@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/commercial.rb
+- lib/commercial/us.rb
+- lib/commercial/version.rb
+- sig/commercial.rbs
+homepage: https://github.com/wtn/commercial
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/wtn/commercial
+  source_code_uri: https://github.com/wtn/commercial
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: US commercial dates
+test_files: []