holidays 9.2.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5df9d7c9191d51eb57d3d62573ea4ad0b606d8edf9e0d8f0c8e77ad980c69cc
-  data.tar.gz: c78ba3585823a7ec2ec21634216c39d8b3eb6170d9209131664c6a0f169ff61b
+  metadata.gz: 4046bc784338ea2145744c92c8e288a4fddf9aad2ad072a9f82718644d5486bf
+  data.tar.gz: a4b5b4ebba6f915bdf4fa9293cc3a2dc57d3206377b22693473372fdcecfe540
 SHA512:
-  metadata.gz: 0a2960e5d509413c28be78a5d21e42d06176d2311577604673b5f9465efb8d13c86a05df2d39ed0d51207d1178d23f1c3e3c865b85693720c5f95ef073d487f5
-  data.tar.gz: f436525c1aa5d8230ef1a88ab29c09addc15e5f68e55fe8ba735b3129bd1296bdc6bd67913cd5e77bbe2efd89f1fd544f3b0a7e725da67dbdd7851916c82b38f
+  metadata.gz: 6081748d62b3e64344ed7b70d8a966c46c6608d3e459a89946ab73f029379589e3184177323b76b6c872118b3609372ac82dfe448f2fd13eca80e746f473e827
+  data.tar.gz: d45a5c3020248e82fc40d73c12753e8eb85c7ef70c4a8569f59c8e069da8b7ec76ca1e449cbbb9100bea2e91354c6223f8f9a93a1365f2795e8029b97322fee0

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Ruby Holidays Gem CHANGELOG
 
+## 10.0.0
+
+* Drop support for Ruby 3.2. Supported versions are now 3.3, 3.4, 4.0, and ruby-head.
+* Update to [v7.0.0 definitions](https://github.com/holidays/definitions/releases/tag/v7.0.0). Please see the changelog for the definition details.
+* Bump tested JRuby from 10.0.4.0 to 10.0.5.0
+* Raise an `ArgumentError` during definition parsing when a `function` or `observed` rule references an unknown method ([#333](https://github.com/holidays/holidays/issues/333))
+* Fix bug ([#352](https://github.com/holidays/holidays/issues/352)) where holidays with the same name and region that differed only by their function modifier were merged into a single entry, dropping one of the dates
+* Document that `tests` stanzas in custom definition files loaded via `load_custom` are not run at runtime ([#304](https://github.com/holidays/holidays/issues/304))
+
 ## 9.2.0
 
 * Update to [v6.1.1 definitions](https://github.com/holidays/definitions/releases/tag/v6.1.1). Please see the changelog for the definition details.

data/README.md

@@ -4,6 +4,8 @@ Functionality to deal with holidays in Ruby.
 
 Extends Ruby's built-in Date and Time classes and supports custom holiday definition lists.
 
+All holiday definitions are maintained in the [holidays/definitions](https://github.com/holidays/definitions) repository. By default this gem returns statutory (formally government-defined) holidays. Culturally recognized but non-statutory holidays (such as Valentine's Day) are available via the `:informal` option. See the [definitions syntax guide](https://github.com/holidays/definitions/blob/master/doc/SYNTAX.md#formalinformal) for details on how holidays are classified.
+
 ## Installation
 
 ```
@@ -14,11 +16,10 @@ gem install holidays
 
 This gem is tested with the following ruby versions:
 
-  * 3.2
   * 3.3
   * 3.4
   * 4.0
-  * JRuby 10.0.4.0
+  * JRuby 10.0.5.0
 
 ## Semver
 
@@ -65,6 +66,35 @@ You can leave off 'regions' to get holidays for any region in our [definitions](
    ]
 ```
 
+#### Wildcard regions
+
+A region ending in an underscore (e.g. `:au_`, `:ca_`) is a *wildcard*. It matches the
+parent country region **and all of its sub-regions** in a single call:
+
+```ruby
+Holidays.on(Date.new(2017, 3, 13), :au_)
+=> [{:name=>"Eight Hours Day", :regions=>[:au_tas],...},
+    {:name=>"Labour Day", :regions=>[:au_vic],...},
+    {:name=>"March Public Holiday", :regions=>[:au_sa],...},
+    {:name=>"Canberra Day", :regions=>[:au_act],...}]
+```
+
+The same date queried with the plain `:au` region returns nothing, because none of
+those holidays are observed nation-wide:
+
+```ruby
+Holidays.on(Date.new(2017, 3, 13), :au)
+=> []
+```
+
+Use a wildcard when you want "this country and every sub-region it defines" without
+listing each sub-region explicitly.
+
+Note that a wildcard always collapses to the **top-level** country region. The portion
+between the country prefix and the trailing underscore is ignored, so `:au_vic_` behaves
+identically to `:au_` (it loads every Australian sub-region, not just Victoria's). There
+is currently no way to wildcard-match only the children of a sub-region.
+
 #### Checking a date range
 
 Get all holidays during the month of July 2008 in Canada and the US:
@@ -236,6 +266,12 @@ Holidays.load_custom(
 )
 ```
 
+Note that any `tests:` stanzas in a custom definition file are ignored by
+`load_custom`. Tests are only executed at build time for definitions contributed
+to the [definitions repository](https://github.com/holidays/definitions), where
+`rake generate` turns them into the test suite. There is no runtime mechanism to
+run the tests embedded in a custom file loaded on the fly.
+
 ## Extending Ruby's Date and Time classes
 
 ### Date

data/lib/generated_definitions/au.rb

@@ -24,19 +24,20 @@ module Holidays
       3 => [{:wday => 1, :week => 1, :name => "Labour Day", :regions => [:au_wa]},
             {:wday => 1, :week => 2, :name => "Eight Hours Day", :regions => [:au_tas]},
             {:wday => 1, :week => 2, :name => "Labour Day", :regions => [:au_vic]},
-            {:function => "march_pub_hol_sa(year)", :function_arguments => [:year], :name => "March Public Holiday", :regions => [:au_sa]},
+            {:function => "march_pub_hol_sa(year)", :function_arguments => [:year], :year_ranges => { :from => 2006 },:name => "March Public Holiday", :regions => [:au_sa]},
             {:wday => 1, :week => 2, :name => "Canberra Day", :regions => [:au_act]}],
       4 => [{:mday => 25, :name => "ANZAC Day", :regions => [:au, :au_vic]},
             {:mday => 25, :observed => "to_monday_if_sunday(date)", :observed_arguments => [:date], :name => "ANZAC Day", :regions => [:au_qld, :au_nt, :au_act, :au_sa]},
             {:mday => 25, :observed => "to_monday_if_weekend(date)", :observed_arguments => [:date], :name => "ANZAC Day", :regions => [:au_wa]}],
-      5 => [{:function => "qld_labour_day_may(year)", :function_arguments => [:year], :name => "Labour Day", :regions => [:au_qld]},
+      5 => [{:function => "qld_labour_day_may(year)", :function_arguments => [:year], :year_ranges => { :until => 2012 },:name => "Labour Day", :regions => [:au_qld]},
+            {:function => "qld_labour_day_may(year)", :function_arguments => [:year], :year_ranges => { :from => 2016 },:name => "Labour Day", :regions => [:au_qld]},
             {:wday => 1, :week => 1, :name => "May Day", :regions => [:au_nt]},
-            {:function => "may_pub_hol_sa(year)", :function_arguments => [:year], :name => "May Public Holiday", :regions => [:au_sa]},
+            {:function => "may_pub_hol_sa(year)", :function_arguments => [:year], :year_ranges => { :until => 2005 },:name => "May Public Holiday", :regions => [:au_sa]},
             {:mday => 27, :function => "to_nearest_monday_after(date)", :function_arguments => [:date], :year_ranges => { :from => 2018 },:name => "Reconciliation Day", :regions => [:au_act]}],
       6 => [{:wday => 1, :week => 1, :name => "Western Australia Day", :regions => [:au_wa]},
             {:wday => 1, :week => 2, :year_ranges => { :until => 2022 },:name => "Queen's Birthday", :regions => [:au_act, :au_nsw, :au_sa, :au_tas, :au_nt, :au_vic]},
             {:wday => 1, :week => 2, :year_ranges => { :from => 2023 },:name => "King's Birthday", :regions => [:au_act, :au_nsw, :au_sa, :au_tas, :au_nt, :au_vic]},
-            {:function => "qld_queens_birthday_june(year)", :function_arguments => [:year], :name => "Queen's Birthday", :regions => [:au_qld]},
+            {:function => "qld_queens_birthday_june(year)", :function_arguments => [:year], :year_ranges => { :until => 2015 },:name => "Queen's Birthday", :regions => [:au_qld]},
             {:mday => 6, :type => :informal, :name => "Queensland Day", :regions => [:au_qld]}],
       7 => [{:wday => 5, :week => 3, :name => "Cairns Show", :regions => [:au_qld_cairns]}],
       8 => [{:function => "qld_brisbane_ekka_holiday(year)", :function_arguments => [:year], :name => "Ekka", :regions => [:au_qld_brisbane]}],
@@ -46,11 +47,12 @@ module Holidays
             {:wday => 1, :week => -1, :year_ranges => { :until => 2017 },:name => "Family & Community Day", :regions => [:au_act]}],
       10 => [{:function => "afl_grand_final(year)", :function_arguments => [:year], :name => "Friday before the AFL Grand Final", :regions => [:au_vic]},
             {:wday => 1, :week => 1, :name => "Labour Day", :regions => [:au_act, :au_nsw, :au_sa]},
-            {:function => "qld_labour_day_october(year)", :function_arguments => [:year], :observed => "to_monday_if_weekend(date)", :observed_arguments => [:date], :name => "Labour Day", :regions => [:au_qld]},
-            {:function => "qld_queens_bday_october(year)", :function_arguments => [:year], :year_ranges => { :until => 2022 },:observed => "to_monday_if_weekend(date)", :observed_arguments => [:date], :name => "Queen's Birthday", :regions => [:au_qld]},
+            {:function => "qld_labour_day_october(year)", :function_arguments => [:year], :year_ranges => { :between => 2013..2015 },:observed => "to_monday_if_weekend(date)", :observed_arguments => [:date], :name => "Labour Day", :regions => [:au_qld]},
+            {:mday => 1, :year_ranges => { :limited => [2012] },:observed => "to_monday_if_weekend(date)", :observed_arguments => [:date], :name => "Queen's Birthday", :regions => [:au_qld]},
+            {:function => "qld_queens_bday_october(year)", :function_arguments => [:year], :year_ranges => { :between => 2016..2022 },:observed => "to_monday_if_weekend(date)", :observed_arguments => [:date], :name => "Queen's Birthday", :regions => [:au_qld]},
             {:function => "qld_kings_bday_october(year)", :function_arguments => [:year], :year_ranges => { :from => 2023 },:observed => "to_monday_if_weekend(date)", :observed_arguments => [:date], :name => "King's Birthday", :regions => [:au_qld]},
             {:function => "hobart_show_day(year)", :function_arguments => [:year], :name => "Royal Hobart Show", :regions => [:au_tas_south]}],
-      11 => [{:function => "g20_day_2014_only(year)", :function_arguments => [:year], :name => "G20 Day", :regions => [:au_qld_brisbane]},
+      11 => [{:mday => 14, :year_ranges => { :limited => [2014] },:name => "G20 Day", :regions => [:au_qld_brisbane]},
             {:wday => 1, :week => 1, :name => "Recreation Day", :regions => [:au_tas_north]},
             {:wday => 2, :week => 1, :name => "Melbourne Cup Day", :regions => [:au_vic_melbourne]}],
       12 => [{:mday => 25, :observed => "to_tuesday_if_sunday_or_monday_if_saturday(date)", :observed_arguments => [:date], :name => "Christmas Day", :regions => [:au_qld, :au_nsw, :au_act, :au_tas, :au_wa, :au_vic, :au_nt]},
@@ -85,43 +87,23 @@ end
 },
 
 "qld_queens_bday_october(year)" => Proc.new { |year|
-if year >= 2016
-  Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 10, 1, 1)
-elsif year == 2012
-  1
-else
-  nil
-end
+Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 10, 1, 1)
 },
 
 "qld_kings_bday_october(year)" => Proc.new { |year|
-if year >= 2023
-  Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 10, 1, 1)
-else
-  nil
-end
+Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 10, 1, 1)
 },
 
 "qld_queens_birthday_june(year)" => Proc.new { |year|
-if year <= 2015
-  Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 6, 2, 1)
-end
+Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 6, 2, 1)
 },
 
 "qld_labour_day_may(year)" => Proc.new { |year|
-if year < 2013 || year >= 2016
-  Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 5, 1, 1)
-end
+Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 5, 1, 1)
 },
 
 "qld_labour_day_october(year)" => Proc.new { |year|
-if year >= 2013 && year < 2016
-  Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 10, 1, 1)
-end
-},
-
-"g20_day_2014_only(year)" => Proc.new { |year|
-year == 2014 ? 14 : nil
+Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 10, 1, 1)
 },
 
 "hobart_show_day(year)" => Proc.new { |year|
@@ -130,19 +112,11 @@ fourth_sat_in_oct - 2 # the thursday before
 },
 
 "march_pub_hol_sa(year)" => Proc.new { |year|
-if year < 2006
-  nil
-else
-  Date.civil(year, 3, Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 3, :second, :monday))
-end
+Date.civil(year, 3, Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 3, :second, :monday))
 },
 
 "may_pub_hol_sa(year)" => Proc.new { |year|
-if year >= 2006
-  nil
-else
-  Date.civil(year, 5, Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 5, :third, :monday))
-end
+Date.civil(year, 5, Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 5, :third, :monday))
 },
 
 "qld_brisbane_ekka_holiday(year)" => Proc.new { |year|

data/lib/generated_definitions/europe.rb

@@ -194,8 +194,8 @@ module Holidays
             {:mday => 1, :name => "Nieuwjaarsdag", :regions => [:nl]},
             {:mday => 1, :name => "Nyttårsdag", :regions => [:no]},
             {:mday => 1, :name => "Nowy Rok", :regions => [:pl]},
-            {:function => "pl_trzech_kroli(year)", :function_arguments => [:year], :name => "Objawienie Pańskie (święto Trzech Króli)", :regions => [:pl]},
-            {:function => "pl_trzech_kroli_informal(year)", :function_arguments => [:year], :type => :informal, :name => "Objawienie Pańskie (święto Trzech Króli)", :regions => [:pl]},
+            {:mday => 6, :year_ranges => { :from => 2011 },:name => "Objawienie Pańskie (święto Trzech Króli)", :regions => [:pl]},
+            {:mday => 6, :year_ranges => { :until => 2010 },:type => :informal, :name => "Objawienie Pańskie (święto Trzech Króli)", :regions => [:pl]},
             {:mday => 21, :type => :informal, :name => "Dzień Babci", :regions => [:pl]},
             {:mday => 22, :type => :informal, :name => "Dzień Dziadka", :regions => [:pl]},
             {:mday => 1, :name => "Ano Novo", :regions => [:pt]},
@@ -629,14 +629,6 @@ when 2028
 end
 },
 
-"pl_trzech_kroli(year)" => Proc.new { |year|
-year >= 2011 ? 6 : nil
-},
-
-"pl_trzech_kroli_informal(year)" => Proc.new { |year|
-year < 2011 ? 6 : nil
-},
-
 
       }
     end

data/lib/generated_definitions/lu.rb

@@ -14,7 +14,7 @@ module Holidays
       {
                 0 => [{:function => "easter(year)", :function_arguments => [:year], :function_modifier => 1, :name => "Ouschterméindeg", :regions => [:lu]},
             {:function => "easter(year)", :function_arguments => [:year], :function_modifier => 39, :name => "Christi Himmelfaart", :regions => [:lu]},
-            {:function => "easter(year)", :function_arguments => [:year], :function_modifier => 49, :name => "Péngschtméindeg", :regions => [:lu]}],
+            {:function => "easter(year)", :function_arguments => [:year], :function_modifier => 50, :name => "Péngschtméindeg", :regions => [:lu]}],
       1 => [{:mday => 1, :name => "Neijoerschdag", :regions => [:lu]}],
       5 => [{:mday => 1, :name => "Dag vun der Aarbecht", :regions => [:lu]},
             {:mday => 9, :year_ranges => { :from => 2019 },:name => "Europadag", :regions => [:lu]}],

data/lib/generated_definitions/nz.rb

@@ -32,7 +32,7 @@ module Holidays
       10 => [{:wday => 1, :week => 1, :observed => "previous_friday(date)", :observed_arguments => [:date], :name => "Hawke's bay Anniversary Day", :regions => [:nz_hb]},
             {:wday => 1, :week => 4, :name => "Labour Day", :regions => [:nz]},
             {:wday => 1, :week => 4, :observed => "next_week(date)", :observed_arguments => [:date], :name => "Marlborough Anniversary Day", :regions => [:nz_mb]}],
-      11 => [{:wday => 5, :week => 2, :name => "Canterbury Anniversary Day", :regions => [:nz_ca]},
+      11 => [{:function => "nz_canterbury_anniversary(year)", :function_arguments => [:year], :name => "Canterbury Anniversary Day", :regions => [:nz_ca]},
             {:mday => 30, :observed => "closest_monday(date)", :observed_arguments => [:date], :name => "Chatham Island Anniversary Day", :regions => [:nz_ch]}],
       12 => [{:mday => 1, :observed => "closest_monday(date)", :observed_arguments => [:date], :name => "Westland Anniversary Day", :regions => [:nz_wl]},
             {:mday => 25, :observed => "to_monday_if_weekend(date)", :observed_arguments => [:date], :name => "Christmas Day", :regions => [:nz]},
@@ -61,6 +61,14 @@ date - 3
 date + 7
 },
 
+"nz_canterbury_anniversary(year)" => Proc.new { |year|
+date = Date.civil(year, 11, 1)
+date += 1 until date.tuesday?
+date += 1
+date += 1 until date.friday?
+date + 7
+},
+
 "matariki(year)" => Proc.new { |year|
 @matariki_dates ||= {
 '2022' => Date.civil(2022, 6, 24),

data/lib/generated_definitions/pl.rb

@@ -24,8 +24,8 @@ module Holidays
             {:function => "easter(year)", :function_arguments => [:year], :function_modifier => 49, :name => "Zesłanie Ducha Świętego (Zielone Świątki)", :regions => [:pl]},
             {:function => "easter(year)", :function_arguments => [:year], :function_modifier => 60, :name => "Uroczystość Najświętszego Ciała i Krwi Pańskiej (Boże Ciało)", :regions => [:pl]}],
       1 => [{:mday => 1, :name => "Nowy Rok", :regions => [:pl]},
-            {:function => "pl_trzech_kroli(year)", :function_arguments => [:year], :name => "Objawienie Pańskie (święto Trzech Króli)", :regions => [:pl]},
-            {:function => "pl_trzech_kroli_informal(year)", :function_arguments => [:year], :type => :informal, :name => "Objawienie Pańskie (święto Trzech Króli)", :regions => [:pl]},
+            {:mday => 6, :year_ranges => { :from => 2011 },:name => "Objawienie Pańskie (święto Trzech Króli)", :regions => [:pl]},
+            {:mday => 6, :year_ranges => { :until => 2010 },:type => :informal, :name => "Objawienie Pańskie (święto Trzech Króli)", :regions => [:pl]},
             {:mday => 21, :type => :informal, :name => "Dzień Babci", :regions => [:pl]},
             {:mday => 22, :type => :informal, :name => "Dzień Dziadka", :regions => [:pl]}],
       2 => [{:mday => 2, :type => :informal, :name => "Ofiarowanie Pańskie (Matki Boskiej Gromnicznej)", :regions => [:pl]},
@@ -58,15 +58,7 @@ module Holidays
 
     def self.custom_methods
       {
-          "pl_trzech_kroli(year)" => Proc.new { |year|
-year >= 2011 ? 6 : nil
-},
-
-"pl_trzech_kroli_informal(year)" => Proc.new { |year|
-year < 2011 ? 6 : nil
-},
-
-
+          
       }
     end
   end

data/lib/holidays/definition/context/function_processor.rb

@@ -74,11 +74,10 @@ module Holidays
               raise Holidays::InvalidFunctionResponse.new("invalid day response from custom method call resulting in invalid date. Result: '#{result}'")
             end
           elsif result.nil?
-            # Do nothing. This is because some functions can return 'nil' today.
-            # I want to change this and so rather than come up with a clean
-            # implementation I'll do this so we don't throw an error in this specific
-            # situation. This should be removed once we have changed the existing
-            # custom definition functions. See https://github.com/holidays/holidays/issues/204
+            # nil is a valid return value meaning the calculation determined that no
+            # holiday exists on this date. For example, jp_substitute_holiday returns
+            # nil when the original holiday does not fall on a Sunday (no substitute
+            # needed), and us_inauguration_day returns nil when year % 4 != 1.
           else
             raise Holidays::InvalidFunctionResponse.new("invalid response from custom method call, must be a 'date' or 'integer' representing the day. Result: '#{result}'")
           end

data/lib/holidays/definition/context/generator.rb

@@ -110,7 +110,7 @@ module Holidays
 
                 exists = false
                 rules_by_month[month].each do |ex|
-                  if ex[:name] == rule[:name] and ex[:wday] == rule[:wday] and ex[:mday] == rule[:mday] and ex[:week] == rule[:week] and ex[:type] == rule[:type] and ex[:function] == rule[:function] and ex[:observed] == rule[:observed] and ex[:year_ranges] == rule[:year_ranges]
+                  if ex[:name] == rule[:name] and ex[:wday] == rule[:wday] and ex[:mday] == rule[:mday] and ex[:week] == rule[:week] and ex[:type] == rule[:type] and ex[:function] == rule[:function] and ex[:function_modifier] == rule[:function_modifier] and ex[:observed] == rule[:observed] and ex[:year_ranges] == rule[:year_ranges]
                     ex[:regions] << rule[:regions].flatten
                     exists = true
                   end
@@ -201,6 +201,8 @@ module Holidays
             method.parameters.collect { |arg| arg[1] }
           elsif method = parsed_custom_methods[function_id]
             method.arguments.collect { |arg| arg.to_sym }
+          else
+            raise ArgumentError, "Unknown function '#{function_id}'. It must either be a built-in method or be defined in the 'methods' section of a definition file."
           end
         end
       end

data/lib/holidays/version.rb

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