holidays 9.1.1 → 9.2.0

data/lib/holidays/finder/context/search.rb

@@ -24,14 +24,19 @@ module Holidays
                   next unless @rules[:year_range].call(year, h[:year_ranges])
                 end
 
-                date = build_date(year, month, h)
-                next unless date
-
-                if observed_set?(options) && h[:observed]
-                  date = build_observed_date(date, regions, h)
+                dates = if h[:function]
+                  custom_holidays(year, month, h, regions)
+                else
+                  date = build_date(year, month, h, regions)
+                  date ? [date] : []
                 end
 
-                holidays << {:date => date, :name => h[:name], :regions => h[:regions]}
+                dates.each do |d|
+                  if observed_set?(options) && h[:observed]
+                    d = build_observed_date(d, regions, h)
+                  end
+                  holidays << {:date => d, :name => h[:name], :regions => h[:regions]}
+                end
               end
             end
           end
@@ -68,36 +73,50 @@ module Holidays
           options && options.include?(:observed) == true
         end
 
-        def build_date(year, month, h)
-          if h[:function]
-            holiday = custom_holiday(year, month, h)
-            #FIXME The result should always be present, see https://github.com/holidays/holidays/issues/204 for more information
-            current_month = holiday&.month
-            current_day = holiday&.mday
-          else
-            current_month = month
-            current_day = h[:mday] || @day_of_month_calculator.call(year, month, h[:week], h[:wday])
-          end
+        def build_date(year, month, h, queried_regions)
+          current_month = month
+          current_day = h[:mday] || @day_of_month_calculator.call(year, month, h[:week], h[:wday])
 
           # Silently skip bad mdays
           #TODO Should we be doing something different here? We have no concept of logging right now. Maybe we should add it?
           Date.civil(year, current_month, current_day) rescue nil
         end
 
-        def custom_holiday(year, month, h)
-          @custom_method_processor.call(
-            #FIXME This seems like a bug, we seem to expect the day in here in the au defs?
-            build_custom_method_input(year, month, h[:mday], h[:regions]),
-            h[:function], h[:function_arguments], h[:function_modifier],
-          )
+        def custom_holidays(year, month, h, queried_regions)
+          effective_regions = queried_regions & h[:regions]
+          effective_regions = [queried_regions.first] if effective_regions.empty?
+
+          effective_regions.each_with_object([]) do |region, dates|
+            result = @custom_method_processor.call(
+              { year: year, month: month, day: h[:mday], region: region },
+              h[:function], h[:function_arguments], h[:function_modifier],
+            )
+
+            #FIXME The result should always be present, see https://github.com/holidays/holidays/issues/204 for more information
+            next if result.nil?
+
+            date = Date.civil(year, result.month, result.mday) rescue nil
+            dates << date if date
+          end.uniq
         end
 
-        def build_custom_method_input(year, month, day, regions)
+        # When the queried region is :any (or no holiday_regions are provided), fall back
+        # to the holiday's own first region. Otherwise use the first queried region that
+        # also appears in the holiday's region list so that region-specific function
+        # implementations resolve correctly even when a holiday definition is shared across
+        # multiple regions.
+        def build_custom_method_input(year, month, day, queried_regions, holiday_regions = nil)
+          effective_region = if holiday_regions.nil? || queried_regions.include?(:any)
+            queried_regions.first
+          else
+            (queried_regions & holiday_regions).first || holiday_regions.first
+          end
+
           {
             year: year,
             month: month,
             day: day,
-            region: regions.first, #FIXME This isn't ideal but will work for our current use case...
+            region: effective_region,
           }
         end
 

data/lib/holidays/version.rb

@@ -1,3 +1,3 @@
 module Holidays
-  VERSION = '9.1.1'
+  VERSION = '9.2.0'
 end

data/lib/holidays.rb

@@ -42,9 +42,8 @@ module Holidays
 
       raise ArgumentError if end_date < start_date
 
-      if cached_holidays = Factory::Definition.cache_repository.find(start_date, end_date, options)
-        return cached_holidays
-      end
+      cached_holidays = Factory::Definition.cache_repository.find(start_date, end_date, options)
+      return cached_holidays unless cached_holidays.nil?
 
       Factory::Finder.between.call(start_date, end_date, options)
     end
@@ -93,11 +92,17 @@ module Holidays
     def load_custom(*files)
       regions, rules_by_month, custom_methods, _ = Factory::Definition.file_parser.parse_definition_files(files)
 
+      # Capture source code before converting entities to Procs so the merger
+      # can detect genuine conflicts (same name, different logic).
+      method_sources = custom_methods.each_with_object({}) do |(key, entity), h|
+        h[key] = entity.source
+      end
+
       custom_methods.each do |method_key, method_entity|
         custom_methods[method_key] = Factory::Definition.custom_method_proc_decorator.call(method_entity)
       end
 
-      Factory::Definition.merger.call(regions, rules_by_month, custom_methods)
+      Factory::Definition.merger.call(regions, rules_by_month, custom_methods, method_sources)
 
       rules_by_month
     end

data/test/coverage_report.rb

@@ -1,10 +1,8 @@
 require 'simplecov'
 
-# For reasons I don't understand jruby implementations report lower coverage
-# than other ruby versions. Ruby 2.5.3, for instance, is at 92%.
-#
-# We set the floor based on jruby so that all automated tests pass on Travis CI.
-SimpleCov.minimum_coverage 89
+# JRuby coverage reporting is inaccurate without --debug mode, resulting in
+# artificially low numbers. Skip the minimum coverage check under JRuby.
+SimpleCov.minimum_coverage 90 unless RUBY_PLATFORM == 'java' || RUBY_PATCHLEVEL == -1 || ENV['SMOKE_TEST'] || ENV['CONTRACT_TEST']
 
 SimpleCov.add_filter [
   # Apparently simplecov doesn't automatically filter 'spec' or 'test' so we

data/test/data/test_date_transform_conflict_region_1.yaml

@@ -0,0 +1,14 @@
+months:
+  1:
+  - name: Weekend Holiday
+    regions: [date_transform_conflict_1]
+    mday: 1
+    function: to_nearest_upcoming_weekend_day(date)
+
+methods:
+  to_nearest_upcoming_weekend_day:
+    arguments: date
+    ruby: |
+      days_until = (6 - date.wday) % 7
+      days_until = 7 if days_until == 0
+      date + days_until

data/test/data/test_date_transform_conflict_region_2.yaml

@@ -0,0 +1,14 @@
+months:
+  1:
+  - name: Weekend Holiday
+    regions: [date_transform_conflict_2]
+    mday: 1
+    function: to_nearest_upcoming_weekend_day(date)
+
+methods:
+  to_nearest_upcoming_weekend_day:
+    arguments: date
+    ruby: |
+      days_until = (7 - date.wday) % 7
+      days_until = 7 if days_until == 0
+      date + days_until

data/test/defs/test_defs_europe.rb

@@ -413,7 +413,7 @@ class EuropeDefinitionTests < Test::Unit::TestCase  # :nodoc:
 
     assert_equal "Ascension", (Holidays.on(Date.civil(2007, 5, 17), [:fr])[0] || {})[:name]
 
-    assert_equal "Pentecôte", (Holidays.on(Date.civil(2007, 5, 27), [:fr])[0] || {})[:name]
+    assert_nil (Holidays.on(Date.civil(2007, 5, 27), [:fr])[0] || {})[:name]
 
     assert_equal "Fête nationale", (Holidays.on(Date.civil(2007, 7, 14), [:fr])[0] || {})[:name]
 
@@ -427,11 +427,11 @@ class EuropeDefinitionTests < Test::Unit::TestCase  # :nodoc:
 
     assert_nil (Holidays.on(Date.civil(2007, 4, 8), [:fr])[0] || {})[:name]
 
-    assert_nil (Holidays.on(Date.civil(2007, 5, 28), [:fr])[0] || {})[:name]
+    assert_equal "Lundi de Pentecôte", (Holidays.on(Date.civil(2007, 5, 28), [:fr])[0] || {})[:name]
 
     assert_equal "Pâques", (Holidays.on(Date.civil(2007, 4, 8), [:fr], [:informal])[0] || {})[:name]
 
-    assert_equal "Lundi de Pentecôte", (Holidays.on(Date.civil(2007, 5, 28), [:fr], [:informal])[0] || {})[:name]
+    assert_equal "Pentecôte", (Holidays.on(Date.civil(2007, 5, 27), [:fr], [:informal])[0] || {})[:name]
 
     assert_equal "Saint-Étienne", (Holidays.on(Date.civil(2017, 12, 26), [:fr_a, :fr_m], [:informal])[0] || {})[:name]
 
@@ -575,6 +575,10 @@ class EuropeDefinitionTests < Test::Unit::TestCase  # :nodoc:
 
     assert_equal "Bank Holiday for the Coronation of King Charles III", (Holidays.on(Date.civil(2023, 5, 8), [:gb])[0] || {})[:name]
 
+    assert_equal "Easter Monday", (Holidays.on(Date.civil(2016, 3, 28), [:gb_con])[0] || {})[:name]
+
+    assert_equal "Bank Holiday", (Holidays.on(Date.civil(2016, 8, 29), [:gb_con])[0] || {})[:name]
+
     assert_nil (Holidays.on(Date.civil(2024, 5, 8), [:gb])[0] || {})[:name]
 
     assert_nil (Holidays.on(Date.civil(2022, 5, 8), [:gb])[0] || {})[:name]

data/test/defs/test_defs_fr.rb

@@ -17,7 +17,7 @@ class FrDefinitionTests < Test::Unit::TestCase  # :nodoc:
 
     assert_equal "Ascension", (Holidays.on(Date.civil(2007, 5, 17), [:fr])[0] || {})[:name]
 
-    assert_equal "Pentecôte", (Holidays.on(Date.civil(2007, 5, 27), [:fr])[0] || {})[:name]
+    assert_nil (Holidays.on(Date.civil(2007, 5, 27), [:fr])[0] || {})[:name]
 
     assert_equal "Fête nationale", (Holidays.on(Date.civil(2007, 7, 14), [:fr])[0] || {})[:name]
 
@@ -31,11 +31,11 @@ class FrDefinitionTests < Test::Unit::TestCase  # :nodoc:
 
     assert_nil (Holidays.on(Date.civil(2007, 4, 8), [:fr])[0] || {})[:name]
 
-    assert_nil (Holidays.on(Date.civil(2007, 5, 28), [:fr])[0] || {})[:name]
+    assert_equal "Lundi de Pentecôte", (Holidays.on(Date.civil(2007, 5, 28), [:fr])[0] || {})[:name]
 
     assert_equal "Pâques", (Holidays.on(Date.civil(2007, 4, 8), [:fr], [:informal])[0] || {})[:name]
 
-    assert_equal "Lundi de Pentecôte", (Holidays.on(Date.civil(2007, 5, 28), [:fr], [:informal])[0] || {})[:name]
+    assert_equal "Pentecôte", (Holidays.on(Date.civil(2007, 5, 27), [:fr], [:informal])[0] || {})[:name]
 
     assert_equal "Saint-Étienne", (Holidays.on(Date.civil(2017, 12, 26), [:fr_a, :fr_m], [:informal])[0] || {})[:name]
 

data/test/defs/test_defs_gb.rb

@@ -147,6 +147,10 @@ class GbDefinitionTests < Test::Unit::TestCase  # :nodoc:
 
     assert_equal "Bank Holiday for the Coronation of King Charles III", (Holidays.on(Date.civil(2023, 5, 8), [:gb])[0] || {})[:name]
 
+    assert_equal "Easter Monday", (Holidays.on(Date.civil(2016, 3, 28), [:gb_con])[0] || {})[:name]
+
+    assert_equal "Bank Holiday", (Holidays.on(Date.civil(2016, 8, 29), [:gb_con])[0] || {})[:name]
+
     assert_nil (Holidays.on(Date.civil(2024, 5, 8), [:gb])[0] || {})[:name]
 
     assert_nil (Holidays.on(Date.civil(2022, 5, 8), [:gb])[0] || {})[:name]

data/test/defs/test_defs_il.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+# This file is generated by the Ruby Holiday gem.
+#
+# Definitions loaded: definitions/il.yaml
+class IlDefinitionTests < Test::Unit::TestCase  # :nodoc:
+
+  def test_il
+    assert_equal "Exodus from Egypt", (Holidays.on(Date.civil(2024, 3, 23), [:il])[0] || {})[:name]
+
+    assert_equal "Exodus from Egypt (day 7)", (Holidays.on(Date.civil(2023, 3, 12), [:il])[0] || {})[:name]
+
+    assert_equal "Independence Day", (Holidays.on(Date.civil(2025, 4, 1), [:il])[0] || {})[:name]
+
+    assert_equal "Thanksgiving", (Holidays.on(Date.civil(2026, 4, 22), [:il])[0] || {})[:name]
+
+    assert_equal "Thanksgiving (day 2)", (Holidays.on(Date.civil(2024, 5, 13), [:il])[0] || {})[:name]
+
+    assert_equal "Jewish New Year", (Holidays.on(Date.civil(2023, 9, 16), [:il])[0] || {})[:name]
+
+    assert_equal "2nd New Year's Day", (Holidays.on(Date.civil(2025, 9, 24), [:il])[0] || {})[:name]
+
+    assert_equal "Day of Atonement", (Holidays.on(Date.civil(2026, 9, 21), [:il])[0] || {})[:name]
+
+    assert_equal "Feast of Tabernacles", (Holidays.on(Date.civil(2024, 10, 17), [:il])[0] || {})[:name]
+
+    assert_equal "Rejoicing of the Torah", (Holidays.on(Date.civil(2025, 10, 15), [:il])[0] || {})[:name]
+
+    assert_nil (Holidays.on(Date.civil(2024, 7, 9), [:il])[0] || {})[:name]
+
+    assert_nil (Holidays.on(Date.civil(2026, 8, 15), [:il])[0] || {})[:name]
+
+  end
+end

data/test/defs/test_defs_mc.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+# This file is generated by the Ruby Holiday gem.
+#
+# Definitions loaded: definitions/mc.yaml
+class McDefinitionTests < Test::Unit::TestCase  # :nodoc:
+
+  def test_mc
+    assert_equal "Jour de l'an", (Holidays.on(Date.civil(2026, 1, 1), [:mc])[0] || {})[:name]
+
+    assert_equal "Sainte Dévote", (Holidays.on(Date.civil(2026, 1, 27), [:mc])[0] || {})[:name]
+
+    assert_equal "Lundi de Pâques", (Holidays.on(Date.civil(2026, 4, 6), [:mc])[0] || {})[:name]
+
+    assert_equal "Fête du Travail", (Holidays.on(Date.civil(2026, 5, 1), [:mc])[0] || {})[:name]
+
+    assert_equal "Ascension", (Holidays.on(Date.civil(2026, 5, 14), [:mc])[0] || {})[:name]
+
+    assert_equal "Lundi de Pentecôte", (Holidays.on(Date.civil(2026, 5, 25), [:mc])[0] || {})[:name]
+
+    assert_equal "Fête Dieu", (Holidays.on(Date.civil(2026, 6, 4), [:mc])[0] || {})[:name]
+
+    assert_equal "Assomption", (Holidays.on(Date.civil(2026, 8, 15), [:mc])[0] || {})[:name]
+
+    assert_equal "Toussaint", (Holidays.on(Date.civil(2026, 11, 1), [:mc])[0] || {})[:name]
+
+    assert_equal "Fête du Prince", (Holidays.on(Date.civil(2026, 11, 19), [:mc])[0] || {})[:name]
+
+    assert_equal "Immaculée Conception", (Holidays.on(Date.civil(2026, 12, 8), [:mc])[0] || {})[:name]
+
+    assert_equal "Noël", (Holidays.on(Date.civil(2026, 12, 25), [:mc])[0] || {})[:name]
+
+    assert_equal "Immaculée Conception", (Holidays.on(Date.civil(2024, 12, 8), [:mc])[0] || {})[:name]
+
+    assert_equal "Immaculée Conception", (Holidays.on(Date.civil(2024, 12, 9), [:mc], [:observed])[0] || {})[:name]
+
+    assert_equal "Toussaint", (Holidays.on(Date.civil(2026, 11, 1), [:mc])[0] || {})[:name]
+
+    assert_equal "Toussaint", (Holidays.on(Date.civil(2026, 11, 2), [:mc], [:observed])[0] || {})[:name]
+
+  end
+end

data/test/defs/test_defs_northamerica.rb

@@ -443,7 +443,12 @@ assert_equal "Confederate Memorial Day", (Holidays.on(Date.civil(2026, 4, 27), [
 assert_nil (Holidays.on(Date.civil(2021, 4, 26), [:us])[0] || {})[:name]
 
     assert_equal "State Holiday", (Holidays.on(Date.civil(2015, 4, 20), [:us_ga])[0] || {})[:name]
-assert_equal "State Holiday", (Holidays.on(Date.civil(2021, 4, 26), [:us_ga])[0] || {})[:name]
+
+    assert_equal "State Holiday", (Holidays.on(Date.civil(2020, 4, 10), [:us_ga])[0] || {})[:name]
+assert_equal "State Holiday", (Holidays.on(Date.civil(2021, 4, 2), [:us_ga])[0] || {})[:name]
+assert_equal "State Holiday", (Holidays.on(Date.civil(2022, 4, 15), [:us_ga])[0] || {})[:name]
+
+    assert_nil (Holidays.on(Date.civil(2021, 4, 26), [:us_ga])[0] || {})[:name]
 
     assert_equal "Arbor Day", (Holidays.on(Date.civil(2017, 4, 28), [:us_ne])[0] || {})[:name]
 assert_equal "Arbor Day", (Holidays.on(Date.civil(2025, 4, 25), [:us_ne])[0] || {})[:name]

data/test/defs/test_defs_us.rb

@@ -163,7 +163,12 @@ assert_equal "Confederate Memorial Day", (Holidays.on(Date.civil(2026, 4, 27), [
 assert_nil (Holidays.on(Date.civil(2021, 4, 26), [:us])[0] || {})[:name]
 
     assert_equal "State Holiday", (Holidays.on(Date.civil(2015, 4, 20), [:us_ga])[0] || {})[:name]
-assert_equal "State Holiday", (Holidays.on(Date.civil(2021, 4, 26), [:us_ga])[0] || {})[:name]
+
+    assert_equal "State Holiday", (Holidays.on(Date.civil(2020, 4, 10), [:us_ga])[0] || {})[:name]
+assert_equal "State Holiday", (Holidays.on(Date.civil(2021, 4, 2), [:us_ga])[0] || {})[:name]
+assert_equal "State Holiday", (Holidays.on(Date.civil(2022, 4, 15), [:us_ga])[0] || {})[:name]
+
+    assert_nil (Holidays.on(Date.civil(2021, 4, 26), [:us_ga])[0] || {})[:name]
 
     assert_equal "Arbor Day", (Holidays.on(Date.civil(2017, 4, 28), [:us_ne])[0] || {})[:name]
 assert_equal "Arbor Day", (Holidays.on(Date.civil(2025, 4, 25), [:us_ne])[0] || {})[:name]

data/test/e2e/README.md

@@ -0,0 +1,52 @@
+# End-to-end tests
+
+End-user behavioral checks against the **real upstream definitions** in
+`/definitions`. These tests load actual region data and assert specific
+holiday names, dates, counts, and observed-date behavior, the kinds of
+expectations a consumer of the gem would care about.
+
+## Purpose
+
+These tests verify that the full pipeline, from upstream YAML through
+generation through gem processing to the public API, produces the results
+an end user expects for real-world regions. They complement fixture-based
+integration tests by catching content regressions in the gem's interaction
+with real definitions.
+
+## E2E tests vs. integration vs. smoke
+
+- **Smoke** (`test/smoke/`): only asserts nothing crashes. Run from the
+  upstream `holidays/definitions` CI.
+- **Integration** (`test/integration/`): verifies gem-wide behavior using
+  controlled fixture YAMLs. Stable across definitions changes.
+- **E2E** (this directory): verifies end-user-perceived behavior using real
+  upstream definitions. Expected to break when upstream definitions change,
+  on purpose.
+
+## Important
+
+These tests are tightly coupled to the contents of `/definitions`. When you
+update the definitions submodule and an upstream change shifts a holiday name,
+date, or count, the corresponding e2e test must be updated to match. That is
+working as intended: the test is the gem's record of what end users see, so
+updating it is part of accepting the upstream change.
+
+This directory is **not** run by the upstream `holidays/definitions` CI. Doing
+so would create a dependency loop where the definitions repo cannot ship a
+legitimate content change without also updating tests in this repo first.
+
+## What belongs here
+
+- Tests that assert specific holidays exist on specific dates for specific
+  regions using real definitions (e.g. `:ca` returns "Labour Day" on Sept 1, 2008).
+- Tests of observed-date behavior against real region rules.
+- Tests of sub-region inheritance, wildcards (`:ca_`), `:any`, and cross-region
+  conflicts using real data.
+- Region-count or holiday-count assertions for specific year/region combinations.
+
+## What does NOT belong here
+
+- Tests that don't depend on real definitions content. Those belong in
+  `integration/` (with fixtures) or `smoke/` (structural only).
+- Tests of a single file or class in isolation. Those are unit tests and
+  belong next to the code they cover.

data/test/e2e/data/test_multiple_regions_with_conflicts_region_3.yaml

@@ -0,0 +1,38 @@
+months:
+  0:
+  - name: With Function Modifier
+    regions: [multiple_with_conflict_3]
+    function: easter(year)
+    function_modifier: 70
+  - name: With Function Only Different Function Name
+    regions: [multiple_with_conflict_3]
+    function: conflict_custom_method_3(year)
+  - name: With Function Only Same Function Name
+    regions: [multiple_with_conflict_3]
+    function: conflict_custom_method_identical_name_between_regions(year)
+  - name: With Function Only Same Function Name - Region 3
+    regions: [multiple_with_conflict_3]
+    function: conflict_custom_method_identical_name_between_regions_but_different_holiday_names(year)
+  1:
+  - name: New Year's Day
+    regions: [multiple_with_conflict_3]
+    mday: 1
+    observed: to_monday_if_weekend(date)
+  10:
+  - name: Testing Conflict Month 10
+    regions: [multiple_with_conflict_3]
+    mday: 9
+
+methods:
+  conflict_custom_method_3:
+    arguments: year
+    ruby: |
+      Date.civil(year, 4, 1)
+  conflict_custom_method_identical_name_between_regions:
+    arguments: year
+    ruby: |
+      Date.civil(year, 3, 1)
+  conflict_custom_method_identical_name_between_regions_but_different_holiday_names:
+    arguments: year
+    ruby: |
+      Date.civil(year, 3, 15)

data/test/{integration → e2e}/test_holidays.rb

@@ -237,7 +237,8 @@ class HolidaysTests < Test::Unit::TestCase
   end
 
   def test_load_all
-    Holidays.load_all
-    assert_equal 286, Holidays.available_regions.count
+    assert_nothing_raised do
+      Holidays.load_all
+    end
   end
 end