holidays 5.4.0 → 5.5.0

data/test/holidays/finder/context/test_parse_options.rb

@@ -2,81 +2,150 @@ require File.expand_path(File.dirname(__FILE__)) + '/../../../test_helper'
 
 require 'holidays/finder/context/parse_options'
 
-#TODO This set of tests need love. Since the class itself requires actual
-#     definition files we have real defs in here, meaning that these tests
-#     could break if a definition is removed/changed.
-#     Also, there are no actual tests that the files are actually required.
-#     We need a mechanism to load things from the defs and then BOOM. We can test
-#     that this mechanism is called.
 class ParseOptionsTests < Test::Unit::TestCase
   def setup
     @regions_repo = mock()
+    @regions_repo.stubs(:loaded?).returns(false)
 
     @region_validator = mock()
     @region_validator.stubs(:valid?).returns(true)
 
-    # As mentioned above, this set of tests is NOT isolated. We need
-    # the real merger code here.
-    @definition_merger = Holidays::Factory::Definition.merger
+    @definition_loader = mock()
+    @definition_loader.stubs(:call)
 
     @subject = Holidays::Finder::Context::ParseOptions.new(
       @regions_repo,
       @region_validator,
-      @definition_merger,
+      @definition_loader,
     )
   end
 
   def test_returns_observed_true_if_options_contains_observed_flag
-    @regions_repo.expects(:exists?).returns(false)
+    @regions_repo.expects(:parent_region_lookup).with(:ca).returns(:ca)
     observed = @subject.call([:ca, :observed])[1]
     assert_equal(true, observed)
   end
 
-  def test_returns_observed_false_if_options_contains_observed_flag
-    @regions_repo.expects(:exists?).returns(false)
+  def test_returns_observed_false_if_options_does_not_contain_observed_flag
+    @regions_repo.expects(:parent_region_lookup).with(:ca).returns(:ca)
     observed = @subject.call([:ca])[1]
     assert_equal(false, observed)
   end
 
   def test_returns_informal_true_if_options_contains_informal_flag
-    @regions_repo.expects(:exists?).returns(false)
+    @regions_repo.expects(:parent_region_lookup).with(:ca).returns(:ca)
     informal = @subject.call([:ca, :informal])[2]
     assert_equal(true, informal)
   end
 
-  def test_returns_informal_false_if_options_contains_informal_flag
-    @regions_repo.expects(:exists?).returns(false)
+  def test_returns_informal_false_if_options_does_not_contain_informal_flag
+    @regions_repo.expects(:parent_region_lookup).with(:ca).returns(:ca)
     informal = @subject.call([:ca])[2]
     assert_equal(false, informal)
   end
 
-  def test_returns_any_if_no_regions_are_provided
-    regions = @subject.call(:informal)[0]
-    assert_equal([:any], regions)
+  def test_raises_error_if_regions_are_invalid
+    @region_validator.stubs(:valid?).returns(false)
+
+    assert_raise Holidays::InvalidRegion do
+      @subject.call([:unknown_region])
+    end
   end
 
-  def test_wildcard_regions_are_removed_if_found
-    @regions_repo.expects(:exists?).with(:ch).returns(true)
-    @regions_repo.expects(:exists?).with(:ch_zh).returns(true)
-    @regions_repo.expects(:search).with('ch_').returns([:ch_zh])
+  def test_wildcards_load_appropriate_regions
+    @definition_loader.expects(:call).with(:ch).returns([:ch, :ch_zh])
+
+    regions = @subject.call([:ch_]).first
 
-    regions = @subject.call([:ch_])[0]
+    assert_equal([:ch, :ch_zh], regions)
     assert_equal(false, regions.include?(:ch_))
   end
 
-  def test_raises_error_if_regions_are_invalid
-    @region_validator.stubs(:valid?).returns(false)
+  def test_does_nothing_if_region_is_already_loaded_and_is_parent
+    @regions_repo.expects(:parent_region_lookup).with(:test).returns(nil)
+    regions = @subject.call([:test]).first
+    assert_equal([:test], regions)
+  end
 
-    assert_raise Holidays::InvalidRegion do
-      @subject.call([:unknown_region])
-    end
+  def test_does_nothing_if_region_is_already_loaded_and_is_parent_but_is_custom
+    @regions_repo.expects(:parent_region_lookup).with(:custom_region).returns(nil)
+    @regions_repo.expects(:loaded?).with(:custom_region).returns(true)
+
+    regions = @subject.call([:custom_region]).first
+    assert_equal([:custom_region], regions)
   end
 
-  def test_raises_error_if_regions_contain_malicious_directory_changes
-    @region_validator.stubs(:valid?).returns(false)
+  def test_has_parent_loads_parent_region
+    @regions_repo.expects(:parent_region_lookup).with(:subregion).returns(:parent)
+    @regions_repo.expects(:loaded?).with(:parent).returns(false)
+    @definition_loader.expects(:call).with(:parent).returns([:parent, :subregion])
 
-    assert_raise Holidays::InvalidRegion do
-      @subject.call(["../../test"])
+    regions = @subject.call([:subregion]).first
+    assert_equal([:subregion], regions)
+  end
+
+  def test_has_parent_already_loaded_does_not_load_again
+    @regions_repo.expects(:parent_region_lookup).with(:subregion).returns(:parent)
+    @regions_repo.expects(:loaded?).with(:parent).returns(false)
+    @definition_loader.expects(:call).with(:parent).returns([:parent, :subregion])
+
+    regions = @subject.call([:subregion]).first
+    assert_equal([:subregion], regions)
+  end
+
+  def test_cannot_load_region_prefix_for_wildcard_raises_error
+    @definition_loader.expects(:call).with(:ch).raises(LoadError)
+    assert_raises Holidays::UnknownRegionError do
+      @subject.call([:ch_])
     end
   end
+
+  def test_cannot_load_region_not_wildcard_raises_error
+    @regions_repo.expects(:parent_region_lookup).with(:ch).returns(:ch)
+    @definition_loader.expects(:call).with(:ch).raises(LoadError)
+    assert_raises Holidays::UnknownRegionError do
+      @subject.call([:ch])
+    end
+  end
+
+  def test_region_with_multiple_underscores_load_correctly
+    @regions_repo.expects(:parent_region_lookup).with(:subregion_with_underscores).returns(:parent)
+    @regions_repo.expects(:loaded?).with(:parent).returns(false)
+    @definition_loader.expects(:call).with(:parent).returns([:parent, :subregion_with_underscores])
+
+    regions = @subject.call([:subregion_with_underscores]).first
+    assert_equal([:subregion_with_underscores], regions)
+  end
+
+  def test_blank_region_should_load_all_regions_available
+    @regions_repo.expects(:all_generated).returns([:region1, :region2])
+    @regions_repo.expects(:loaded?).with(:region1).returns(false)
+    @regions_repo.expects(:loaded?).with(:region2).returns(true)
+    @regions_repo.expects(:parent_region_lookup).with(:region1).returns(:region2)
+    @definition_loader.expects(:call).with(:region2)
+
+    regions = @subject.call.first
+    assert_equal([:region1, :region2], regions)
+  end
+
+  def test_special_any_region_should_load_all_regions_available
+    @regions_repo.expects(:all_generated).returns([:region1, :region2])
+    @regions_repo.expects(:loaded?).with(:region1).returns(false)
+    @regions_repo.expects(:loaded?).with(:region2).returns(true)
+    @regions_repo.expects(:parent_region_lookup).with(:region1).returns(:region2)
+    @definition_loader.expects(:call).with(:region2)
+
+    regions = @subject.call(:any).first
+    assert_equal([:region1, :region2], regions)
+  end
+
+  # This is a legacy thing...we currently have this in the code and...I don't fully
+  # understand why. I don't want to remove it as part of this refactor.
+  def test_load_north_america_if_regions_include_us
+    @regions_repo.expects(:parent_region_lookup).with(:us).returns(nil)
+    @definition_loader.expects(:call).with(:north_america)
+
+    regions = @subject.call([:us]).first
+    assert_equal([:us], regions)
+  end
 end

data/test/holidays/finder/context/test_search.rb

@@ -15,13 +15,6 @@ class FinderSearchTests < Test::Unit::TestCase
     @custom_method_repo = mock()
     @proc_cache_repo = mock()
 
-    @subject = Holidays::Finder::Context::Search.new(
-      @holidays_by_month_repo,
-      @custom_method_processor,
-      @day_of_month_calculator,
-      @rules,
-    )
-
     @start_date = Date.civil(2015, 1, 1)
     @end_date = Date.civil(2015, 1, 1)
     @dates_driver = {2015 => [1]}
@@ -31,6 +24,13 @@ class FinderSearchTests < Test::Unit::TestCase
     @holidays_by_month_repo.expects(:find_by_month).at_most_once.returns([:mday => 1, :name => "Test", :regions=>@regions])
     @in_region_rule.expects(:call).at_most_once.returns(true)
     @year_range_rule.expects(:call).at_most_once.returns(false)
+
+    @subject = Holidays::Finder::Context::Search.new(
+      @holidays_by_month_repo,
+      @custom_method_processor,
+      @day_of_month_calculator,
+      @rules,
+    )
   end
 
   def test_raises_error_if_dates_driver_is_empty
@@ -85,9 +85,7 @@ class FinderSearchTests < Test::Unit::TestCase
 
     returned_date = Date.civil(2015, 3, 10)
     @custom_method_processor.expects(:call).with(
-      2015,
-      1,
-      1,
+      {:year => 2015, :month => 1, :day => 1, :region => :us},
       "func-id",
       [:year],
       1,
@@ -109,9 +107,7 @@ class FinderSearchTests < Test::Unit::TestCase
     @holidays_by_month_repo.expects(:find_by_month).at_most_once.returns([:mday => 1, :name => "Test", :regions=> @regions, :function => "func-id", :function_arguments => [:year], :function_modifier => 1])
 
     @custom_method_processor.expects(:call).with(
-      2015,
-      1,
-      1,
+      {:year => 2015, :month => 1, :day => 1, :region => :us},
       "func-id",
       [:year],
       1,
@@ -171,9 +167,7 @@ class FinderSearchTests < Test::Unit::TestCase
     @holidays_by_month_repo.expects(:find_by_month).at_most_once.returns([:mday => 8, :name => "Test", :type => :observed, :observed => "SOME_OBSERVED_FUNC_ID", :regions=>@regions])
 
     @custom_method_processor.expects(:call).with(
-      2015,
-      1,
-      8,
+      {:year => 2015, :month => 1, :day => 8, :region => :us},
       "SOME_OBSERVED_FUNC_ID",
       [:date],
     ).returns(Date.civil(2015, 10, 1))
@@ -200,4 +194,39 @@ class FinderSearchTests < Test::Unit::TestCase
       @subject.call(@dates_driver, @regions, @options)
     )
   end
+
+  # This is a specific scenario but it COULD happen in our current flow. The goal: any date
+  # manipulation that occurs for a specific holiday should have no impact on other holidays.
+  def test_returns_expected_result_if_custom_method_modifies_month_when_multiple_holidays_found
+    @in_region_rule.expects(:call).twice.returns(true)
+    @holidays_by_month_repo.expects(:find_by_month).at_most_once.returns(
+      [
+        {:mday => 14, :name => "Test", :function => "func-id", :function_arguments => [:year], :regions => @regions},
+        {:mday => 14, :name => "Test2", :regions => @regions},
+      ]
+    )
+
+    @custom_method_processor.expects(:call).with(
+      {:year => 2015, :month => 1, :day => 14, :region => :us},
+      "func-id",
+      [:year],
+      nil,
+    ).returns(Date.civil(2015, 3, 14))
+
+    assert_equal(
+      [
+        {
+          :date => Date.civil(2015, 3, 14),
+          :name => "Test",
+          :regions => [:us],
+        },
+        {
+          :date => Date.civil(2015, 1, 14),
+          :name => "Test2",
+          :regions => [:us],
+        }
+      ],
+      @subject.call(@dates_driver, @regions, @options)
+    )
+  end
 end

data/test/integration/test_available_regions.rb

@@ -18,6 +18,6 @@ class AvailableRegionsTests < Test::Unit::TestCase
   # This test might fail if we add new regions. Since this is an integration test
   # I am fine with that!
   def test_available_regions_returns_correct_number_of_regions
-    assert_equal 295, Holidays.available_regions.count
+    assert_equal 170, Holidays.available_regions.count
   end
 end

data/test/integration/test_custom_year_range_holidays.rb

@@ -39,5 +39,4 @@ class CustomYearRangeHolidaysTest < Test::Unit::TestCase
     assert_equal [], Holidays.on(Date.civil(2016,6,5), :custom_year_range_file)
     assert_not_equal [], Holidays.on(Date.civil(2017,6,5), :custom_year_range_file)
   end
-
 end

data/test/integration/test_holidays.rb

@@ -218,13 +218,13 @@ class HolidaysTests < Test::Unit::TestCase
     holidays = Holidays.between(Date.civil(2008,5,1), Date.civil(2008,5,31), :ca)
     assert_equal 1, holidays.length
 
-    # Should return Victoria Da and National Patriotes Day.
+    ## Should return Victoria Da and National Patriotes Day.
     holidays = Holidays.between(Date.civil(2008,5,1), Date.civil(2008,5,31), :ca_qc)
     assert_equal 2, holidays.length
 
     # Should return Victoria Day and National Patriotes Day.
     holidays = Holidays.between(Date.civil(2008,5,1), Date.civil(2008,5,31), :ca_)
-    assert_equal 2, holidays.length
+    assert_equal 3, holidays.length
   end
 
   def test_sub_regions_holiday_next
@@ -293,6 +293,6 @@ class HolidaysTests < Test::Unit::TestCase
 
   def test_load_all
     Holidays.load_all
-    assert_equal 295, Holidays.available_regions.count
+    assert_equal 170, Holidays.available_regions.count
   end
 end

data/test/integration/test_multiple_regions.rb

@@ -14,7 +14,6 @@ class MultipleRegionsTests < Test::Unit::TestCase
     h = Holidays.on(Date.civil(2008,5,9), :gb_)
     assert_equal 'Liberation Day', (h[0] || {})[:name]
 
-
     h = Holidays.on(Date.civil(2008,5,9), :je)
     assert_equal 'Liberation Day', h[0][:name]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: holidays
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Alex Dunae
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,13 +184,16 @@ files:
 - lib/holidays/core_extensions/time.rb
 - lib/holidays/date_calculator/day_of_month.rb
 - lib/holidays/date_calculator/easter.rb
+- lib/holidays/date_calculator/lunar_date.rb
 - lib/holidays/date_calculator/weekend_modifier.rb
 - lib/holidays/definition/context/function_processor.rb
 - lib/holidays/definition/context/generator.rb
+- lib/holidays/definition/context/load.rb
 - lib/holidays/definition/context/merger.rb
 - lib/holidays/definition/decorator/custom_method_proc.rb
 - lib/holidays/definition/decorator/custom_method_source.rb
 - lib/holidays/definition/entity/custom_method.rb
+- lib/holidays/definition/generator/regions.rb
 - lib/holidays/definition/parser/custom_method.rb
 - lib/holidays/definition/repository/cache.rb
 - lib/holidays/definition/repository/custom_methods.rb
@@ -216,7 +219,9 @@ files:
 - test/coverage_report.rb
 - test/data/test_custom_govt_holiday_defs.yaml
 - test/data/test_custom_year_range_holiday_defs.yaml
+- test/data/test_invalid_region.rb
 - test/data/test_multiple_custom_holiday_defs.yaml
+- test/data/test_region.rb
 - test/data/test_single_custom_holiday_defs.yaml
 - test/data/test_single_custom_holiday_with_custom_procs.yaml
 - test/defs/test_defs_ar.rb
@@ -285,12 +290,15 @@ files:
 - test/holidays/date_calculator/test_day_of_month.rb
 - test/holidays/date_calculator/test_easter_gregorian.rb
 - test/holidays/date_calculator/test_easter_julian.rb
+- test/holidays/date_calculator/test_lunar_date.rb
 - test/holidays/date_calculator/test_weekend_modifier.rb
 - test/holidays/definition/context/test_function_processor.rb
 - test/holidays/definition/context/test_generator.rb
+- test/holidays/definition/context/test_load.rb
 - test/holidays/definition/context/test_merger.rb
 - test/holidays/definition/decorator/test_custom_method_proc.rb
 - test/holidays/definition/decorator/test_custom_method_source.rb
+- test/holidays/definition/generator/test_regions.rb
 - test/holidays/definition/parser/test_custom_method.rb
 - test/holidays/definition/repository/test_cache.rb
 - test/holidays/definition/repository/test_custom_methods.rb
@@ -339,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A collection of Ruby methods to deal with statutory and other holidays.
@@ -347,7 +355,9 @@ test_files:
 - test/coverage_report.rb
 - test/data/test_custom_govt_holiday_defs.yaml
 - test/data/test_custom_year_range_holiday_defs.yaml
+- test/data/test_invalid_region.rb
 - test/data/test_multiple_custom_holiday_defs.yaml
+- test/data/test_region.rb
 - test/data/test_single_custom_holiday_defs.yaml
 - test/data/test_single_custom_holiday_with_custom_procs.yaml
 - test/defs/test_defs_ar.rb
@@ -416,12 +426,15 @@ test_files:
 - test/holidays/date_calculator/test_day_of_month.rb
 - test/holidays/date_calculator/test_easter_gregorian.rb
 - test/holidays/date_calculator/test_easter_julian.rb
+- test/holidays/date_calculator/test_lunar_date.rb
 - test/holidays/date_calculator/test_weekend_modifier.rb
 - test/holidays/definition/context/test_function_processor.rb
 - test/holidays/definition/context/test_generator.rb
+- test/holidays/definition/context/test_load.rb
 - test/holidays/definition/context/test_merger.rb
 - test/holidays/definition/decorator/test_custom_method_proc.rb
 - test/holidays/definition/decorator/test_custom_method_source.rb
+- test/holidays/definition/generator/test_regions.rb
 - test/holidays/definition/parser/test_custom_method.rb
 - test/holidays/definition/repository/test_cache.rb
 - test/holidays/definition/repository/test_custom_methods.rb