holidays 2.2.0 → 3.0.0

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

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../../test_helper'
+
+require 'holidays/definition/repository/proc_cache'
+
+class ProcCacheRepoTests < Test::Unit::TestCase
+  def setup
+    @subject = Holidays::Definition::Repository::ProcCache.new
+  end
+
+  def test_lookup_stores_and_returns_result_of_function_if_it_is_not_present
+    function = lambda { |year| Date.civil(year, 2, 1) - 1 }
+    year = 2015
+
+    assert_equal(Date.civil(year, 1, 31), @subject.lookup(function, year))
+  end
+
+  #FIXME This test stinks. I don't know how to show that the second invocation
+  #      doesn't call the function. In rspec I could just do an expect().not_to
+  #      but it doesn't seem like Mocha can do that? I'm punting.
+  def test_lookup_simply_returns_result_of_cache_if_present_after_first_call
+    function = lambda { |year| Date.civil(year, 2, 1) - 1 }
+    year = 2015
+
+    @subject.lookup(function, year)
+
+    assert_equal(Date.civil(year, 1, 31), @subject.lookup(function, year))
+  end
+end
+

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

@@ -0,0 +1,86 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../../test_helper'
+
+require 'holidays/definition/repository/regions'
+
+class RegionsRepoTests < Test::Unit::TestCase
+  def setup
+    @subject = Holidays::Definition::Repository::Regions.new
+  end
+
+  def test_all_returns_an_empty_array_if_just_initialize
+    assert_equal([], @subject.all)
+  end
+
+  def test_add_successfully_adds_a_region
+    @subject.add(:test)
+    assert_equal([:test], @subject.all)
+  end
+
+  def test_add_raises_error_if_symbol_not_provided
+    assert_raises ArgumentError do
+      @subject.add('not-a-symbol')
+    end
+  end
+
+  def test_add_raises_error_if_argument_is_nil
+    assert_raises ArgumentError do
+      @subject.add(nil)
+    end
+  end
+
+  def test_add_raises_error_if_any_region_is_not_a_symbol
+    assert_raises ArgumentError do
+      @subject.add([:test, 'not-a-symbol'])
+    end
+  end
+
+  def test_add_does_not_add_if_the_region_already_exists
+    @subject.add(:test)
+    @subject.add(:test)
+    assert_equal([:test], @subject.all)
+  end
+
+  def test_add_accepts_array_of_regions
+    @subject.add([:test, :test2])
+    assert_equal([:test, :test2], @subject.all)
+  end
+
+  def test_exists_returns_true_if_region_is_present
+    @subject.add(:test)
+    assert @subject.exists?(:test)
+  end
+
+  def tests_exists_returns_false_if_region_is_not_present
+    assert_equal(false, @subject.exists?(:something))
+  end
+
+  def test_exists_raises_error_if_invalid_argument
+    assert_raises ArgumentError do
+      @subject.exists?(nil)
+    end
+  end
+
+  def test_search_returns_empty_array_if_no_matches_found
+    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_"))
+  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_"))
+  end
+
+  def test_search_raises_error_if_prefix_is_not_a_string
+    assert_raises ArgumentError do
+      @subject.search(:sym)
+    end
+
+    assert_raises ArgumentError do
+      @subject.search(nil)
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../../test_helper'
+
+require 'holidays/definition/validator/region'
+
+class RegionValidatorTests < Test::Unit::TestCase
+  def setup
+    @regions_repo = mock()
+    @regions_repo.stubs(:exists?).returns(false)
+
+    @subject = Holidays::Definition::Validator::Region.new(@regions_repo)
+  end
+
+  def test_returns_true_if_region_exists_in_generated_files
+    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)
+    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)
+    assert_equal(false, @subject.valid?(:unknown_region))
+  end
+
+  def test_returns_false_if_region_is_not_a_symbol
+    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
+    assert(@subject.valid?(:gb_))
+  end
+
+  def test_returns_false_if_wildcard_region_is_invalid
+    assert_equal(false, @subject.valid?(:somethingweird_))
+  end
+end

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

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../../test_helper'
+
+require 'holidays/option/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()
+
+    @region_validator = mock()
+    @region_validator.stubs(:valid?).returns(true)
+
+    @subject = Holidays::Option::Context::ParseOptions.new(
+      @regions_repo,
+      @region_validator,
+    )
+  end
+
+  def test_returns_observed_true_if_options_contains_observed_flag
+    @regions_repo.expects(:exists?).returns(false)
+    regions, observed, informal = @subject.call([:ca, :observed])
+    assert_equal(true, observed)
+  end
+
+  def test_returns_observed_false_if_options_contains_observed_flag
+    @regions_repo.expects(:exists?).returns(false)
+    regions, observed, informal = @subject.call([:ca])
+    assert_equal(false, observed)
+  end
+
+  def test_returns_informal_true_if_options_contains_informal_flag
+    @regions_repo.expects(:exists?).returns(false)
+    regions, observed, informal = @subject.call([:ca, :informal])
+    assert_equal(true, informal)
+  end
+
+  def test_returns_informal_false_if_options_contains_informal_flag
+    @regions_repo.expects(:exists?).returns(false)
+    regions, observed, informal = @subject.call([:ca])
+    assert_equal(false, informal)
+  end
+
+  def test_returns_any_if_no_regions_are_provided
+    regions, observed, informal = @subject.call(:informal)
+    assert_equal([:any], regions)
+  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])
+
+    regions, observed, informal = @subject.call([:ch_])
+    assert_equal(false, regions.include?(:ch_))
+  end
+
+  def test_raises_error_if_regions_are_invalid
+    @region_validator.stubs(:valid?).returns(false)
+
+    assert_raise Holidays::UnknownRegionError do
+      @subject.call([:unknown_region])
+    end
+  end
+end

data/test/holidays/test_date_calculator_factory.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'holidays/date_calculator_factory'
+
+class DateCalculatorFactoryTests < Test::Unit::TestCase
+  def setup
+    @subject = Holidays::DateCalculatorFactory
+  end
+
+  def test_day_of_month_calculator
+    assert @subject.day_of_month_calculator.is_a?(Holidays::DateCalculator::DayOfMonth)
+  end
+
+  def test_weekend_modifier
+    assert @subject.weekend_modifier.is_a?(Holidays::DateCalculator::WeekendModifier)
+  end
+
+  def test_easter_calculator
+    assert @subject.easter_calculator.is_a?(Holidays::DateCalculator::Easter)
+  end
+end

data/test/holidays/test_definition_factory.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'holidays/definition_factory'
+
+class DefinitionFactoryTests < Test::Unit::TestCase
+  def test_definition_file_parser
+    assert Holidays::DefinitionFactory.file_parser.is_a?(Holidays::Definition::Context::Generator)
+  end
+
+  def test_definition_source_generator
+    assert Holidays::DefinitionFactory.source_generator.is_a?(Holidays::Definition::Context::Generator)
+  end
+
+  def test_definition_merger
+    assert Holidays::DefinitionFactory.merger.is_a?(Holidays::Definition::Context::Merger)
+  end
+
+  def test_holidays_by_month_repository
+    assert Holidays::DefinitionFactory.holidays_by_month_repository.is_a?(Holidays::Definition::Repository::HolidaysByMonth)
+  end
+
+  def test_regions_repository
+    assert Holidays::DefinitionFactory.regions_repository.is_a?(Holidays::Definition::Repository::Regions)
+  end
+
+  def test_cache_repository
+    assert Holidays::DefinitionFactory.cache_repository.is_a?(Holidays::Definition::Repository::Cache)
+  end
+
+  def test_proc_cache_repository
+    assert Holidays::DefinitionFactory.proc_cache_repository.is_a?(Holidays::Definition::Repository::ProcCache)
+  end
+
+end

data/test/holidays/test_option_factory.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'holidays/option_factory'
+
+class OptionFactoryTests < Test::Unit::TestCase
+  def test_parse_options_factory
+    assert Holidays::OptionFactory.parse_options.is_a?(Holidays::Option::Context::ParseOptions)
+  end
+end

data/test/holidays/test_use_case_factory.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'holidays/use_case_factory'
+
+class UseCaseFactoryTests < Test::Unit::TestCase
+  def test_between_factory
+    assert Holidays::UseCaseFactory.between.is_a?(Holidays::UseCase::Context::Between)
+  end
+
+  def test_dates_driver_builder_factory
+    assert Holidays::UseCaseFactory.dates_driver_builder.is_a?(Holidays::UseCase::Context::DatesDriverBuilder)
+  end
+end

data/test/holidays/use_case/context/test_between.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../../test_helper'
+
+require 'holidays/use_case/context/between'
+
+#TODO These tests need love. This is the heart of the holiday logic and I'm only
+# now starting to tear bits and pieces of it apart to untangle it. This is a start
+# but definitely needs more coverage.
+class BetweenTests < Test::Unit::TestCase
+  def setup
+    @holidays_by_month_repo = mock()
+    @day_of_month_calculator = mock()
+    @proc_cache_repo = mock()
+
+    @subject = Holidays::UseCase::Context::Between.new(
+      @holidays_by_month_repo,
+      @day_of_month_calculator,
+      @proc_cache_repo,
+    )
+
+    @start_date = Date.civil(2015, 1, 1)
+    @end_date = Date.civil(2015, 1, 1)
+    @dates_driver = {2015 => [0, 1, 2], 2014 => [0, 12]}
+    @regions = [:us]
+    @observed = false
+    @informal = false
+  end
+
+  def test_returns_error_if_start_date_is_missing
+    assert_raise ArgumentError do
+      @subject.call(nil, @end_date, @dates_driver, @regions, @observed, @informal)
+    end
+  end
+
+  def test_returns_error_if_end_date_is_missing
+    assert_raise ArgumentError do
+      @subject.call(@start_date, nil, @dates_driver, @regions, @observed, @informal)
+    end
+  end
+
+  def test_returns_error_if_driver_hash_is_nil
+    assert_raise ArgumentError do
+      @subject.call(@start_date, @end_date, nil, @regions, @observed, @informal)
+    end
+  end
+
+  def test_returns_error_if_driver_hash_is_empty
+    assert_raise ArgumentError do
+      @subject.call(@start_date, @end_date, {}, @regions, @observed, @informal)
+    end
+  end
+
+  def test_returns_error_if_driver_hash_has_empty_months_array
+    assert_raise ArgumentError do
+      @subject.call(@start_date, @end_date, {2015 => nil}, @regions, @observed, @informal)
+    end
+
+    assert_raise ArgumentError do
+      @subject.call(@start_date, @end_date, {2015 => []}, @regions, @observed, @informal)
+    end
+
+    assert_raise ArgumentError do
+      @subject.call(@start_date, @end_Date, {2015 => [1], 2016 => [1], 2017 => []}, @regions, @observed, @informal)
+    end
+  end
+
+  def test_returns_error_if_regions_are_missing_or_empty
+    assert_raise ArgumentError do
+      @subject.call(@start_date, @end_date, @dates_driver, nil, @observed, @informal)
+    end
+
+    assert_raise ArgumentError do
+      @subject.call(@start_date, @end_date, @dates_driver, [], @observed, @informal)
+    end
+  end
+end

data/test/holidays/use_case/context/test_dates_driver_builder.rb

@@ -0,0 +1,91 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../../test_helper'
+
+require 'holidays/use_case/context/dates_driver_builder'
+
+class DatesDriverBuilderTests < Test::Unit::TestCase
+  def setup
+    @subject = Holidays::UseCase::Context::DatesDriverBuilder.new
+  end
+
+  def test_returns_appropriately_formatted_hash
+    start_date = Date.civil(2015, 1, 1)
+    end_date = Date.civil(2015, 1, 31)
+
+    dates_driver = @subject.call(start_date, end_date)
+
+    assert(dates_driver.is_a?(Hash))
+
+    dates_driver.each do |year, months|
+      assert(year.is_a?(Integer))
+      assert(months.is_a?(Array))
+    end
+  end
+
+  def test_all_years_always_contains_variable_month
+    start_date = Date.civil(2010, 1, 1)
+    end_date = Date.civil(2020, 1, 1)
+
+    dates_driver = @subject.call(start_date, end_date)
+
+    assert(dates_driver[2010].include?(0))
+    assert(dates_driver[2011].include?(0))
+    assert(dates_driver[2012].include?(0))
+    assert(dates_driver[2013].include?(0))
+    assert(dates_driver[2014].include?(0))
+    assert(dates_driver[2015].include?(0))
+    assert(dates_driver[2016].include?(0))
+    assert(dates_driver[2017].include?(0))
+    assert(dates_driver[2018].include?(0))
+    assert(dates_driver[2019].include?(0))
+    assert(dates_driver[2020].include?(0))
+  end
+
+  def test_january_includes_february
+    dates_driver = @subject.call(Date.civil(2015, 1, 1), Date.civil(2015, 1, 1))
+
+    assert(dates_driver[2015].include?(1))
+    assert(dates_driver[2015].include?(2))
+  end
+
+  def test_january_includes_previous_year_december
+    dates_driver = @subject.call(Date.civil(2015, 1, 1), Date.civil(2015, 1, 1))
+
+    assert(dates_driver[2015].include?(1))
+    assert(dates_driver[2014].include?(12))
+  end
+
+  def test_december_includes_november
+    dates_driver = @subject.call(Date.civil(2015, 12, 1), Date.civil(2015, 12, 1))
+
+    assert(dates_driver[2015].include?(12))
+    assert(dates_driver[2015].include?(11))
+  end
+
+  def test_december_includes_next_year_january
+    dates_driver = @subject.call(Date.civil(2015, 12, 1), Date.civil(2015, 12, 1))
+
+    assert(dates_driver[2015].include?(12))
+    assert(dates_driver[2016].include?(1))
+  end
+
+  def test_middle_months_include_border_months
+    dates_driver = @subject.call(Date.civil(2015, 5, 1), Date.civil(2015, 5, 1))
+    assert(dates_driver[2015].include?(4))
+    assert(dates_driver[2015].include?(5))
+    assert(dates_driver[2015].include?(6))
+
+    dates_driver = @subject.call(Date.civil(2015, 10, 1), Date.civil(2015, 10, 1))
+    assert(dates_driver[2015].include?(9))
+    assert(dates_driver[2015].include?(10))
+    assert(dates_driver[2015].include?(11))
+
+    dates_driver = @subject.call(Date.civil(2015, 3, 1), Date.civil(2015, 7, 1))
+    assert(dates_driver[2015].include?(2))
+    assert(dates_driver[2015].include?(3))
+    assert(dates_driver[2015].include?(4))
+    assert(dates_driver[2015].include?(5))
+    assert(dates_driver[2015].include?(6))
+    assert(dates_driver[2015].include?(7))
+    assert(dates_driver[2015].include?(8))
+  end
+end