holidays 5.4.0 → 5.5.0

data/test/holidays/definition/context/test_generator.rb

@@ -91,7 +91,7 @@ class GeneratorTests < Test::Unit::TestCase
     regions, rules_by_month, custom_methods, tests = @generator.parse_definition_files(files)
     module_src = @generator.generate_definition_source("test", files, regions, rules_by_month, custom_methods, tests)[0]
 
-    expected_module_src = "# encoding: utf-8\nmodule Holidays\n  # This file is generated by the Ruby Holidays gem.\n  #\n  # Definitions loaded: test/data/test_single_custom_holiday_defs.yaml\n  #\n  # To use the definitions in this file, load it right after you load the\n  # Holiday gem:\n  #\n  #   require 'holidays'\n  #   require 'generated_definitions/test'\n  #\n  # All the definitions are available at https://github.com/holidays/holidays\n  module TEST # :nodoc:\n    def self.defined_regions\n      [:custom_single_file]\n    end\n\n    def self.holidays_by_month\n      {\n              6 => [{:mday => 20, :name => \"Company Founding\", :regions => [:custom_single_file]}]\n      }\n    end\n\n    def self.custom_methods\n      {\n        \n      }\n    end\n  end\nend\n"
+    expected_module_src = "# encoding: utf-8\nmodule Holidays\n  # This file is generated by the Ruby Holidays gem.\n  #\n  # Definitions loaded: test/data/test_single_custom_holiday_defs.yaml\n  #\n  # All the definitions are available at https://github.com/holidays/holidays\n  module TEST # :nodoc:\n    def self.defined_regions\n      [:custom_single_file]\n    end\n\n    def self.holidays_by_month\n      {\n              6 => [{:mday => 20, :name => \"Company Founding\", :regions => [:custom_single_file]}]\n      }\n    end\n\n    def self.custom_methods\n      {\n        \n      }\n    end\n  end\nend\n"
 
     assert_equal expected_module_src, module_src
   end
@@ -158,7 +158,7 @@ class GeneratorTests < Test::Unit::TestCase
 
     regions, rules_by_month, custom_methods, tests = @generator.parse_definition_files(files)
     module_src = @generator.generate_definition_source("test", files, regions, rules_by_month, custom_methods, tests)[0]
-    expected_module_src = "# encoding: utf-8\nmodule Holidays\n  # This file is generated by the Ruby Holidays gem.\n  #\n  # Definitions loaded: test/data/test_custom_year_range_holiday_defs.yaml\n  #\n  # To use the definitions in this file, load it right after you load the\n  # Holiday gem:\n  #\n  #   require 'holidays'\n  #   require 'generated_definitions/test'\n  #\n  # All the definitions are available at https://github.com/holidays/holidays\n  module TEST # :nodoc:\n    def self.defined_regions\n      [:custom_year_range_file]\n    end\n\n    def self.holidays_by_month\n      {\n              6 => [{:mday => 1,  :year_ranges => [{:after => 2016}],:name => \"after_year\", :regions => [:custom_year_range_file]},\n            {:mday => 2,  :year_ranges => [{:before => 2017}],:name => \"before_year\", :regions => [:custom_year_range_file]},\n            {:mday => 3,  :year_ranges => [{:between => 2016..2018}],:name => \"between_year\", :regions => [:custom_year_range_file]},\n            {:mday => 4,  :year_ranges => [{:limited => [2016, 2018, 2019]}],:name => \"limited_year\", :regions => [:custom_year_range_file]},\n            {:mday => 5,  :year_ranges => [{:before => 2015},{:after => 2017}],:name => \"multiple_conditions\", :regions => [:custom_year_range_file]}]\n      }\n    end\n\n    def self.custom_methods\n      {\n        \n      }\n    end\n  end\nend\n"
+    expected_module_src = "# encoding: utf-8\nmodule Holidays\n  # This file is generated by the Ruby Holidays gem.\n  #\n  # Definitions loaded: test/data/test_custom_year_range_holiday_defs.yaml\n  #\n  # All the definitions are available at https://github.com/holidays/holidays\n  module TEST # :nodoc:\n    def self.defined_regions\n      [:custom_year_range_file]\n    end\n\n    def self.holidays_by_month\n      {\n              6 => [{:mday => 1,  :year_ranges => [{:after => 2016}],:name => \"after_year\", :regions => [:custom_year_range_file]},\n            {:mday => 2,  :year_ranges => [{:before => 2017}],:name => \"before_year\", :regions => [:custom_year_range_file]},\n            {:mday => 3,  :year_ranges => [{:between => 2016..2018}],:name => \"between_year\", :regions => [:custom_year_range_file]},\n            {:mday => 4,  :year_ranges => [{:limited => [2016, 2018, 2019]}],:name => \"limited_year\", :regions => [:custom_year_range_file]},\n            {:mday => 5,  :year_ranges => [{:before => 2015},{:after => 2017}],:name => \"multiple_conditions\", :regions => [:custom_year_range_file]}]\n      }\n    end\n\n    def self.custom_methods\n      {\n        \n      }\n    end\n  end\nend\n"
 
     assert_equal expected_module_src, module_src
   end
@@ -173,7 +173,7 @@ class GeneratorTests < Test::Unit::TestCase
     regions, rules_by_month, custom_methods, tests = @generator.parse_definition_files(files)
     module_src = @generator.generate_definition_source("test", files, regions, rules_by_month, custom_methods, tests)[0]
 
-    expected_module_src = "# encoding: utf-8\nmodule Holidays\n  # This file is generated by the Ruby Holidays gem.\n  #\n  # Definitions loaded: test/data/test_single_custom_holiday_with_custom_procs.yaml\n  #\n  # To use the definitions in this file, load it right after you load the\n  # Holiday gem:\n  #\n  #   require 'holidays'\n  #   require 'generated_definitions/test'\n  #\n  # All the definitions are available at https://github.com/holidays/holidays\n  module TEST # :nodoc:\n    def self.defined_regions\n      [:custom_single_file]\n    end\n\n    def self.holidays_by_month\n      {\n              0 => [{:function => \"custom_method(year, month)\", :function_arguments => [:year, :month], :function_modifier => 5, :name => \"Custom Holiday\", :regions => [:custom_single_file]}],\n      6 => [{:mday => 20, :name => \"Company Founding\", :regions => [:custom_single_file]}]\n      }\n    end\n\n    def self.custom_methods\n      {\n        \"custom_method(year, month)\" => Proc.new { |year, month|\nsource_stuff\n},\n\n\n      }\n    end\n  end\nend\n"
+    expected_module_src = "# encoding: utf-8\nmodule Holidays\n  # This file is generated by the Ruby Holidays gem.\n  #\n  # Definitions loaded: test/data/test_single_custom_holiday_with_custom_procs.yaml\n  #\n  # All the definitions are available at https://github.com/holidays/holidays\n  module TEST # :nodoc:\n    def self.defined_regions\n      [:custom_single_file]\n    end\n\n    def self.holidays_by_month\n      {\n              0 => [{:function => \"custom_method(year, month)\", :function_arguments => [:year, :month], :function_modifier => 5, :name => \"Custom Holiday\", :regions => [:custom_single_file]}],\n      6 => [{:mday => 20, :name => \"Company Founding\", :regions => [:custom_single_file]}]\n      }\n    end\n\n    def self.custom_methods\n      {\n        \"custom_method(year, month)\" => Proc.new { |year, month|\nsource_stuff\n},\n\n\n      }\n    end\n  end\nend\n"
 
     assert_equal expected_module_src, module_src
   end

data/test/holidays/definition/context/test_load.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../../test_helper'
+
+require 'holidays/definition/context/load'
+
+class LoadTests < Test::Unit::TestCase
+  def setup
+    @definition_merger = mock()
+    full_definitions_path = File.expand_path(File.dirname(__FILE__)) + '/../../../data'
+
+    @subject = Holidays::Definition::Context::Load.new(
+      @definition_merger,
+      full_definitions_path,
+    )
+  end
+
+  def test_region_is_found_and_loaded_and_merged
+    @definition_merger.expects(:call).with([:test_region, :test_region2], {}, {})
+    @subject.call(:test_region)
+  end
+
+  def test_region_file_not_found
+    assert_raises Holidays::UnknownRegionError do
+      @subject.call(:unknown)
+    end
+  end
+
+  def test_region_can_be_loaded_but_file_is_invalid
+    assert_raises Holidays::UnknownRegionError do
+      @subject.call(:test_invalid_region)
+    end
+  end
+
+  def test_returns_list_of_loaded_regions
+    @definition_merger.expects(:call).with([:test_region, :test_region2], {}, {})
+    assert_equal([:test_region, :test_region2], @subject.call(:test_region))
+  end
+end

data/test/holidays/definition/generator/test_regions.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../../test_helper'
+
+require 'holidays/definition/generator/regions'
+
+class GeneratorRegionsTests < Test::Unit::TestCase
+  def setup
+    @generator = Holidays::Definition::Generator::Regions.new
+  end
+
+  def test_generates_regions_single_region_multiple_subregions
+    regions = {:region1 => [:test, :test2]}
+    expected = <<-EOE
+# encoding: utf-8
+module Holidays
+  REGIONS = [:test, :test2]
+
+  PARENT_REGION_LOOKUP = {:test=>:region1, :test2=>:region1}
+end
+EOE
+
+    assert_equal expected, @generator.call(regions)
+  end
+
+  def test_generates_regions_multiple_regions_single_unique_subregions
+    regions = {:region1 => [:test], :region2 => [:test2]}
+    expected = <<-EOE
+# encoding: utf-8
+module Holidays
+  REGIONS = [:test, :test2]
+
+  PARENT_REGION_LOOKUP = {:test=>:region1, :test2=>:region2}
+end
+EOE
+
+    assert_equal expected, @generator.call(regions)
+  end
+
+  def test_generates_regions_multiple_regions_multiple_overlapping_subregions
+    regions = {:region1 => [:test], :region2 => [:test, :test2], :region3 => [:test3, :test]}
+    expected = <<-EOE
+# encoding: utf-8
+module Holidays
+  REGIONS = [:test, :test2, :test3]
+
+  PARENT_REGION_LOOKUP = {:test=>:region1, :test2=>:region2, :test3=>:region3}
+end
+EOE
+
+    assert_equal expected, @generator.call(regions)
+  end
+
+  def test_generates_regions_multiple_regions_multiple_overlapping_subregions_complex
+    regions = {
+      :region1 => [:test],
+      :region2 => [:test, :test2],
+      :region3 => [:test3, :test],
+      :region4 => [:test4, :test2],
+      :region5 => [:test4, :test5, :test3],
+      :region6 => [:test4, :test6, :test],
+    }
+
+    expected = <<-EOE
+# encoding: utf-8
+module Holidays
+  REGIONS = [:test, :test2, :test3, :test4, :test5, :test6]
+
+  PARENT_REGION_LOOKUP = {:test=>:region1, :test2=>:region2, :test3=>:region3, :test4=>:region4, :test5=>:region5, :test6=>:region6}
+end
+EOE
+
+    assert_equal expected, @generator.call(regions)
+  end
+
+  def test_returns_error_if_regions_is_empty
+    regions = {}
+
+    assert_raises ArgumentError do
+      @generator.call(regions)
+    end
+  end
+
+  def test_returns_error_if_regions_is_not_a_hash
+    regions = "invalid"
+
+    assert_raises ArgumentError do
+      @generator.call(regions)
+    end
+  end
+
+  def test_returns_error_if_regions_is_nil
+    regions = nil
+
+    assert_raises ArgumentError do
+      @generator.call(regions)
+    end
+  end
+end

data/test/holidays/definition/repository/test_cache.rb

@@ -7,30 +7,71 @@ class CacheRepoTests < Test::Unit::TestCase
     @subject = Holidays::Definition::Repository::Cache.new
   end
 
+  def test_find_supports_overlapping_holidays
+    start_date = Date.civil(2015, 1, 1)
+    end_date = Date.civil(2015, 7, 1)
+    cache_data = [
+      {:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day A", :regions=>[:us]},
+      {:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day B", :regions=>[:us]}
+    ]
+    options = :us
+
+    @subject.cache_between(start_date, end_date, cache_data, options)
+
+    assert_equal(cache_data, @subject.find(start_date, start_date, options))
+    assert_equal(cache_data, @subject.find(start_date, end_date, options))
+  end
+
+  def test_cache_returns_empty_array_no_holidays_are_found
+    start_date = Date.civil(2015, 1, 1)
+    end_date = Date.civil(2015, 7, 1)
+    cache_data = [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
+    options = :us
+
+    @subject.cache_between(start_date, end_date, cache_data, options)
+
+    assert_empty(@subject.find(Date.civil(2015, 1, 2), Date.civil(2015, 1, 2), options))
+    assert_empty(@subject.find(Date.civil(2015, 1, 2), Date.civil(2015, 1, 3), options))
+  end
+
+  def test_cache_returns_empty_array_when_cache_is_empty
+    start_date = Date.civil(2015, 1, 1)
+    end_date = Date.civil(2015, 7, 1)
+    cache_data = []
+    options = :us
+
+    @subject.cache_between(start_date, end_date, cache_data, options)
+
+    assert_empty(@subject.find(Date.civil(2015, 1, 2), Date.civil(2015, 1, 2), options))
+    assert_empty(@subject.find(Date.civil(2015, 1, 2), Date.civil(2015, 1, 3), options))
+  end
+
   def test_find_returns_correct_cache_data
     start_date = Date.civil(2015, 1, 1)
-    end_date = Date.civil(2015, 1, 1)
-    cache_data =  [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
+    end_date = Date.civil(2015, 7, 1)
+    cache_data = [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
     options = :us
     @subject.cache_between(start_date, end_date, cache_data, options)
 
+    assert_equal(cache_data, @subject.find(start_date, start_date, options))
     assert_equal(cache_data, @subject.find(start_date, end_date, options))
   end
 
   def test_find_returns_nil_if_no_match_is_found
     start_date = Date.civil(2015, 1, 1)
     end_date = Date.civil(2015, 1, 1)
-    cache_data =  [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
+    cache_data = [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
     options = :us
     @subject.cache_between(start_date, end_date, cache_data, options)
 
     assert_nil(@subject.find(Date.civil(2015, 7, 1), Date.civil(2015, 12, 1), options))
+    assert_nil(@subject.find(Date.civil(2015, 7, 1), Date.civil(2015, 12, 1), options))
   end
 
   def test_cache_between_returns_error_if_dates_are_missing
     start_date = Date.civil(2015, 1, 1)
     end_date = Date.civil(2015, 1, 1)
-    cache_data =  [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
+    cache_data = [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
     options = :us
 
     assert_raise ArgumentError do
@@ -45,7 +86,7 @@ class CacheRepoTests < Test::Unit::TestCase
   def test_cache_between_returns_error_if_dates_are_invalid
     start_date = Date.civil(2015, 1, 1)
     end_date = Date.civil(2015, 1, 1)
-    cache_data =  [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
+    cache_data = [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
     options = :us
 
     assert_raise ArgumentError do
@@ -70,7 +111,7 @@ class CacheRepoTests < Test::Unit::TestCase
   def test_reset_clears_cache
     start_date = Date.civil(2015, 1, 1)
     end_date = Date.civil(2015, 1, 1)
-    cache_data =  [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
+    cache_data = [{:date=>Date.civil(2015, 1, 1), :name=>"New Year's Day", :regions=>[:us]}]
     options = :us
     @subject.cache_between(start_date, end_date, cache_data, options)
 

data/test/holidays/definition/repository/test_proc_result_cache.rb

@@ -40,6 +40,13 @@ class ProcResultCacheRepoTests < Test::Unit::TestCase
     assert_equal(Date.civil(2015, 1, 31), @subject.lookup(function, function_argument))
   end
 
+  def test_lookup_accepts_symbol_as_function_argument
+    function = lambda { |symbol| symbol }
+    function_argument = :test
+
+    assert_equal(:test, @subject.lookup(function, function_argument))
+  end
+
   def test_accepts_multiple_arguments_for_functions
     function = lambda { |year, month, day| Date.civil(year, month, day) + 1 }
     year = 2016

data/test/holidays/definition/repository/test_regions.rb

@@ -4,16 +4,22 @@ require 'holidays/definition/repository/regions'
 
 class RegionsRepoTests < Test::Unit::TestCase
   def setup
-    @subject = Holidays::Definition::Repository::Regions.new
+    @all_generated_regions = [:parent, :subregion, :subregion_with_underscores, :region1, :region2]
+    @parent_region_lookup = {
+      :subregion => :parent,
+      :subregion_with_underscores => :parent,
+    }
+
+    @subject = Holidays::Definition::Repository::Regions.new(@all_generated_regions, @parent_region_lookup)
   end
 
-  def test_all_returns_an_empty_array_if_just_initialize
-    assert_equal([], @subject.all)
+  def test_all_loaded_returns_an_empty_array_if_just_initialize
+    assert_equal([], @subject.all_loaded)
   end
 
   def test_add_successfully_adds_a_region
     @subject.add(:test)
-    assert_equal([:test], @subject.all)
+    assert_equal([:test], @subject.all_loaded)
   end
 
   def test_add_raises_error_if_symbol_not_provided
@@ -37,50 +43,62 @@ class RegionsRepoTests < Test::Unit::TestCase
   def test_add_does_not_add_if_the_region_already_exists
     @subject.add(:test)
     @subject.add(:test)
-    assert_equal([:test], @subject.all)
+    assert_equal([:test], @subject.all_loaded)
   end
 
   def test_add_accepts_array_of_regions
     @subject.add([:test, :test2])
-    assert_equal([:test, :test2], @subject.all)
+    assert_equal([:test, :test2], @subject.all_loaded)
   end
 
   def test_exists_returns_true_if_region_is_present
     @subject.add(:test)
-    assert @subject.exists?(:test)
+    assert @subject.loaded?(:test)
   end
 
   def tests_exists_returns_false_if_region_is_not_present
-    assert_equal(false, @subject.exists?(:something))
+    assert_equal(false, @subject.loaded?(:something))
   end
 
   def test_exists_raises_error_if_invalid_argument
     assert_raises ArgumentError do
-      @subject.exists?(nil)
+      @subject.loaded?(nil)
     end
   end
 
   def test_search_returns_empty_array_if_no_matches_found
-    assert_equal([], @subject.search("something"))
+    assert_equal([], @subject.search(:something))
   end
 
   def test_search_returns_matches_on_prefix
     @subject.add([:another_region, :test_region])
-    assert_equal([:test_region], @subject.search("test_"))
+    assert_equal([:test_region], @subject.search(:test_))
   end
 
   def test_search_returns_multiple_matches_on_prefix
     @subject.add([:another_region, :test_region, :test_region2])
-    assert_equal([:test_region, :test_region2], @subject.search("test_"))
+    assert_equal([:test_region, :test_region2], @subject.search(:test_))
   end
 
   def test_search_raises_error_if_prefix_is_not_a_string
     assert_raises ArgumentError do
-      @subject.search(:sym)
+      @subject.search("string")
     end
 
     assert_raises ArgumentError do
       @subject.search(nil)
     end
   end
+
+  def test_all_generated_returns_value_from_initializer
+    assert_equal(@all_generated_regions, @subject.all_generated)
+  end
+
+  def test_parent_region_lookup_returns_region_if_it_exists
+    assert_equal(@parent_region_lookup[:subregion], @subject.parent_region_lookup(:subregion))
+  end
+
+  def test_parent_region_lookup_returns_nil_if_does_not_exist_in_lookup
+    assert_nil(@subject.parent_region_lookup(:parent))
+  end
 end

data/test/holidays/definition/validator/test_custom_method.rb

@@ -37,6 +37,11 @@ class CustomMethodValidatorTests < Test::Unit::TestCase
     assert @subject.valid?(m)
   end
 
+  def test_valid_returns_true_with_region_argument
+    m = {:name => "good_method", :arguments => "region", :source => "source"}
+    assert @subject.valid?(m)
+  end
+
   def test_valid_returns_true_multiple_arguments_with_whitespace
     m = {:name => "good_method", :arguments => "year        ,          month", :source => "source"}
     assert @subject.valid?(m)

data/test/holidays/definition/validator/test_region.rb

@@ -5,26 +5,24 @@ require 'holidays/definition/validator/region'
 class RegionValidatorTests < Test::Unit::TestCase
   def setup
     @regions_repo = mock()
-    @regions_repo.stubs(:exists?).returns(false)
+    @regions_repo.stubs(:loaded?).returns(false)
+    @regions_repo.stubs(:all_generated).returns([])
 
     @subject = Holidays::Definition::Validator::Region.new(@regions_repo)
   end
 
-  def test_returns_true_if_region_exists_in_generated_files
+  def test_returns_true_if_region_loaded_in_generated_files
+    @regions_repo.expects(:all_generated).returns([:us])
     assert(@subject.valid?(:us))
-    assert(@subject.valid?(:federal_reserve))
-    assert(@subject.valid?(:ecb_target))
-    assert(@subject.valid?(:gb))
-    assert(@subject.valid?(:jp))
   end
 
   def test_returns_true_if_region_is_in_regions_repository
-    @regions_repo.expects(:exists?).with(:custom).returns(true)
+    @regions_repo.expects(:loaded?).with(:custom).returns(true)
     assert(@subject.valid?(:custom))
   end
 
   def test_returns_false_if_region_does_not_exist_in_generated_files_or_regions_repo
-    @regions_repo.expects(:exists?).with(:unknown_region).returns(false)
+    @regions_repo.expects(:loaded?).with(:unknown_region).returns(false)
     assert_equal(false, @subject.valid?(:unknown_region))
   end
 
@@ -32,15 +30,12 @@ class RegionValidatorTests < Test::Unit::TestCase
     assert_equal(false, @subject.valid?('not-a-symbol'))
   end
 
-  def test_returns_true_if_subregion
-    assert(@subject.valid?(:ca_qc))
-  end
-
   def test_returns_true_if_region_is_any
     assert(@subject.valid?(:any))
   end
 
   def test_returns_true_if_wildcard_region_is_valid
+    @regions_repo.expects(:all_generated).returns([:gb])
     assert(@subject.valid?(:gb_))
   end
 

data/test/holidays/factory/test_date_calculator.rb

@@ -24,4 +24,9 @@ class DateCalculatorFactoryTests < Test::Unit::TestCase
     @subject = @subject::Easter::Julian
     assert @subject.easter_calculator.is_a?(Holidays::DateCalculator::Easter::Julian)
   end
+
+  def test_lunar_date
+    assert @subject.lunar_date.is_a?(Holidays::DateCalculator::LunarDate)
+    assert @subject.lunar_date.respond_to?('to_solar')
+  end
 end

data/test/holidays/factory/test_definition.rb

@@ -50,4 +50,13 @@ class DefinitionFactoryTests < Test::Unit::TestCase
   def test_function_processor
     assert Holidays::Factory::Definition.function_processor.is_a?(Holidays::Definition::Context::FunctionProcessor)
   end
+
+  def test_regions_generator
+    assert Holidays::Factory::Definition.regions_generator.is_a?(Holidays::Definition::Generator::Regions)
+  end
+
+  def test_definitions_loader
+    assert Holidays::Factory::Definition.loader.is_a?(Holidays::Definition::Context::Load)
+  end
+
 end