revised_holidays 9.0.0

data/lib/holidays.rb

@@ -0,0 +1,130 @@
+## encoding: utf-8
+$:.unshift File.dirname(__FILE__)
+
+require 'date'
+require 'digest/md5'
+require 'holidays/factory/definition'
+require 'holidays/factory/date_calculator'
+require 'holidays/factory/finder'
+require 'holidays/errors'
+require 'holidays/load_all_definitions'
+
+module Holidays
+  WEEKS = {:first => 1, :second => 2, :third => 3, :fourth => 4, :fifth => 5, :last => -1, :second_last => -2, :third_last => -3}
+  MONTH_LENGTHS = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+  DAY_SYMBOLS = Date::DAYNAMES.collect { |n| n.downcase.intern }
+
+  DEFINITIONS_PATH = 'generated_definitions'
+  FULL_DEFINITIONS_PATH = File.expand_path(File.dirname(__FILE__) + "/#{DEFINITIONS_PATH}")
+
+  class << self
+    def any_holidays_during_work_week?(date, *options)
+      monday = date - (date.wday - 1)
+      friday = date + (5 - date.wday)
+
+      holidays = between(monday, friday, *options)
+
+      holidays && holidays.count > 0
+    end
+
+    def on(date, *options)
+      between(date, date, *options)
+    end
+
+    def between(start_date, end_date, *options)
+      raise ArgumentError unless start_date && end_date
+
+      # remove the timezone
+      start_date = start_date.new_offset(0) + start_date.offset if start_date.respond_to?(:new_offset)
+      end_date = end_date.new_offset(0) + end_date.offset if end_date.respond_to?(:new_offset)
+
+      start_date, end_date = get_date(start_date), get_date(end_date)
+
+      raise ArgumentError if end_date < start_date
+
+      if cached_holidays = Factory::Definition.cache_repository.find(start_date, end_date, options)
+        return cached_holidays
+      end
+
+      Factory::Finder.between.call(start_date, end_date, options)
+    end
+
+    #FIXME All other methods start with a date and require a date. For the next
+    #      major version bump we should take the opportunity to change this
+    #      signature to match, e.g. next_holidays(from_date, count, options)
+    def next_holidays(holidays_count, options, from_date = Date.today)
+      raise ArgumentError unless holidays_count
+      raise ArgumentError if options.empty?
+      raise ArgumentError unless options.is_a?(Array)
+
+      # remove the timezone
+      from_date = from_date.new_offset(0) + from_date.offset if from_date.respond_to?(:new_offset)
+
+      from_date = get_date(from_date)
+
+      Factory::Finder.next_holiday.call(holidays_count, from_date, options)
+    end
+
+    #FIXME All other methods start with a date and require a date. For the next
+    #      major version bump we should take the opportunity to change this
+    #      signature to match, e.g. year_holidays(from_date, options)
+    def year_holidays(options, from_date = Date.today)
+      raise ArgumentError if options.empty?
+      raise ArgumentError unless options.is_a?(Array)
+
+      # remove the timezone
+      from_date = from_date.new_offset(0) + from_date.offset if from_date.respond_to?(:new_offset)
+      from_date = get_date(from_date)
+
+      Factory::Finder.year_holiday.call(from_date, options)
+    end
+
+    def cache_between(start_date, end_date, *options)
+      start_date, end_date = get_date(start_date), get_date(end_date)
+      cache_data = between(start_date, end_date, *options)
+
+      Factory::Definition.cache_repository.cache_between(start_date, end_date, cache_data, options)
+    end
+
+    def available_regions
+      Holidays::REGIONS
+    end
+
+    def load_custom(*files)
+      regions, rules_by_month, custom_methods, _ = Factory::Definition.file_parser.parse_definition_files(files)
+
+      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)
+
+      rules_by_month
+    end
+
+    def load_all
+      path = FULL_DEFINITIONS_PATH + "/"
+
+      Dir.foreach(path) do |item|
+        next if item == '.' or item == '..'
+
+        target = path+item
+        next if File.extname(target) != '.rb'
+
+        require target
+      end
+    end
+
+    private
+
+    def get_date(date)
+      if date.respond_to?(:to_date)
+        date.to_date
+      else
+        Date.civil(date.year, date.mon, date.mday)
+      end
+    end
+  end
+end
+
+Holidays::LoadAllDefinitions.call

data/lib/revised_holidays.rb

@@ -0,0 +1 @@
+require 'holidays'

data/revised_holidays.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'holidays/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'revised_holidays'
+  gem.version       = Holidays::VERSION
+  gem.authors       = ['Alex Dunae', 'Phil Peble']
+  gem.email         = ['holidaysgem@gmail.com']
+  gem.homepage      = 'https://github.com/dabroz/holidays'
+  gem.description   = %q(A collection of Ruby methods to deal with statutory and other holidays. You deserve a holiday!)
+  gem.summary       = %q(A collection of Ruby methods to deal with statutory and other holidays.)
+  gem.metadata = {
+    'changelog_uri' => "https://github.com/dabroz/holidays/blob/master/CHANGELOG.md",
+    'source_code_uri' => 'https://github.com/dabroz/holidays',
+    'bug_tracker_uri' => 'https://github.com/dabroz/holidays/issues'
+  }
+  gem.files         = `git ls-files`.split("\n") - ['.gitignore', '.travis.yml']
+  gem.test_files    = gem.files.grep(/^test/)
+  gem.require_paths = ['lib']
+  gem.licenses      = ['MIT']
+  gem.required_ruby_version = '>= 2.4'
+  gem.add_development_dependency 'bundler', '~> 2'
+  gem.add_development_dependency 'rake', '~> 12'
+  gem.add_development_dependency 'simplecov', '~> 0.16'
+  gem.add_development_dependency 'test-unit', '~> 3'
+  gem.add_development_dependency 'mocha', '~> 1'
+  gem.add_development_dependency 'pry', '~> 0.12'
+end

data/test/coverage_report.rb

@@ -0,0 +1,26 @@
+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
+
+SimpleCov.add_filter [
+  # Apparently simplecov doesn't automatically filter 'spec' or 'test' so we
+  # have to do it manually.
+  'test',
+
+  # Only filtered because I tend to not see value in testing factories.
+  'lib/holidays/factory/',
+
+  # jruby coverage flips out here and doesn't count much of the large date
+  # arrays used by this class. This results in an extremely low reported
+  # coverage for this specific file but only in jruby, not other ruby versions.
+  # Since it obliterates coverage percentages I'll filter it until I can come
+  # up with a solution.
+  'lib/holidays/date_calculator/lunar_date.rb',
+]
+
+SimpleCov.coverage_dir 'reports/coverage'
+SimpleCov.start

data/test/data/test_custom_govt_holiday_defs.yaml

@@ -0,0 +1,5 @@
+months:
+  3:
+  - name: Yaaay Government Day
+    regions: [custom_multiple_files, custom_multiple_files_govt]
+    mday: 1

data/test/data/test_custom_informal_holidays_defs.yaml

@@ -0,0 +1,11 @@
+---
+months:
+  1:
+  - name: informal day with type as string
+    regions: [custom_informal]
+    mday: 1
+    type: informal
+  - name: informal day with type as symbol
+    regions: [custom_informal]
+    mday: 5
+    type: :informal

data/test/data/test_custom_year_range_holiday_defs.yaml

@@ -0,0 +1,31 @@
+months:
+  6:
+  - name: after_year
+    regions: [custom_year_range_file]
+    mday: 1
+    year_ranges:
+      from: 2016
+  - name: before_year
+    regions: [custom_year_range_file]
+    mday: 2
+    year_ranges:
+      until: 2017
+  - name: between_year
+    regions: [custom_year_range_file]
+    mday: 3
+    year_ranges:
+      between:
+        start: 2016
+        end: 2018
+  - name: limited_year
+    regions: [custom_year_range_file]
+    mday: 4
+    year_ranges:
+      limited: [2016,2018,2019]
+
+tests:
+  - given:
+      date: '2017-01-01'
+      regions: [custom_year_range_file]
+    expect:
+      name: "after_year"

data/test/data/test_invalid_region.rb

@@ -0,0 +1,15 @@
+module Holidays
+  module BAD_REGION_NAME
+    def self.defined_regions
+      [:test_region]
+    end
+
+    def self.holidays_by_month
+      {}
+    end
+
+    def self.custom_methods
+      {}
+    end
+  end
+end

data/test/data/test_multiple_custom_holiday_defs.yaml

@@ -0,0 +1,12 @@
+months:
+  10:
+  - name: Company Founding!
+    regions: [custom_multiple_files]
+    mday: 5
+
+tests:
+  - given:
+      date: "2013-10-5"
+      regions: ["custom_multiple_files"]
+    expect:
+      name: "Company Founding!"

data/test/data/test_multiple_regions_with_conflicts_region_1.yaml

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

data/test/data/test_multiple_regions_with_conflicts_region_2.yaml

@@ -0,0 +1,38 @@
+months:
+  0:
+  - name: With Function Modifier
+    regions: [multiple_with_conflict_2]
+    function: easter(year)
+    function_modifier: 64
+  - name: With Function Only Different Function Name
+    regions: [multiple_with_conflict_2]
+    function: conflict_custom_method_2(year)
+  - name: With Function Only Same Function Name
+    regions: [multiple_with_conflict_2]
+    function: conflict_custom_method_identical_name_between_regions(year)
+  - name: With Function Only Same Function Name - Region 2
+    regions: [multiple_with_conflict_2]
+    function: conflict_custom_method_identical_name_between_regions_but_different_holiday_names(year)
+  1:
+  - name: New Year's Day
+    regions: [multiple_with_conflict_2]
+    mday: 1
+    observed: to_tuesday_if_sunday_or_monday_if_saturday(date)
+  10:
+  - name: Testing Conflict Month 10
+    regions: [multiple_with_conflict_2]
+    mday: 7
+
+methods:
+  conflict_custom_method_2:
+    arguments: year
+    ruby: |
+      Date.civil(year, 12, 1)
+  conflict_custom_method_identical_name_between_regions:
+    arguments: year
+    ruby: |
+      Date.civil(year, 11, 1)
+  conflict_custom_method_identical_name_between_regions_but_different_holiday_names:
+    arguments: year
+    ruby: |
+      Date.civil(year, 11, 15)

data/test/data/test_region.rb

@@ -0,0 +1,15 @@
+module Holidays
+  module TEST_REGION
+    def self.defined_regions
+      [:test_region, :test_region2]
+    end
+
+    def self.holidays_by_month
+      {}
+    end
+
+    def self.custom_methods
+      {}
+    end
+  end
+end

data/test/data/test_single_custom_holiday_defs.yaml

@@ -0,0 +1,12 @@
+months:
+  6:
+  - name: Company Founding
+    regions: [custom_single_file]
+    mday: 20
+
+tests:
+  - given:
+      date: '2013-06-20'
+      regions: [custom_single_file]
+    expect:
+      name: "Company Founding"

data/test/data/test_single_custom_holiday_with_custom_procs.yaml

@@ -0,0 +1,28 @@
+months:
+  0:
+  - name: Custom Holiday
+    regions: [custom_single_file]
+    function: custom_method(year, month)
+    function_modifier: 5
+  6:
+  - name: Company Founding
+    regions: [custom_single_file]
+    mday: 20
+methods:
+  custom_method:
+    arguments: year, month
+    source: |
+      d = Date.civil(year, month, 1)
+      d + 2
+
+tests:
+  - given:
+      date: '2013-06-20'
+      regions: [custom_single_file]
+    expect:
+      name: "Company Founding"
+  - given:
+      date: '2015-01-01'
+      regions: [custom_single_file]
+    expect:
+      name: "Custom Holiday"

data/test/defs/test_defs_ar.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+# This file is generated by the Ruby Holiday gem.
+#
+# Definitions loaded: definitions/ar.yaml
+class ArDefinitionTests < Test::Unit::TestCase  # :nodoc:
+
+  def test_ar
+    assert_equal "Año Nuevo", (Holidays.on(Date.civil(2016, 1, 1), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Carnaval Lunes", (Holidays.on(Date.civil(2016, 2, 8), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Carnaval Martes", (Holidays.on(Date.civil(2016, 2, 9), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Carnaval Lunes", (Holidays.on(Date.civil(2017, 2, 27), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Carnaval Martes", (Holidays.on(Date.civil(2017, 2, 28), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Carnaval Lunes", (Holidays.on(Date.civil(2018, 2, 12), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Carnaval Martes", (Holidays.on(Date.civil(2018, 2, 13), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Día Nacional de la Memoria por la Verdad y la Justicia", (Holidays.on(Date.civil(2016, 3, 24), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Viernes Santo", (Holidays.on(Date.civil(2016, 3, 25), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Día del Veterano y de los Caídos en la Guerra de Malvinas", (Holidays.on(Date.civil(2016, 4, 2), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Día del Trabajador", (Holidays.on(Date.civil(2016, 5, 1), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Día de la Revolución de Mayo", (Holidays.on(Date.civil(2016, 5, 25), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Paso a la Inmortalidad del General Martín Miguel de Güemes", (Holidays.on(Date.civil(2020, 6, 15), [:ar], [:informal])[0] || {})[:name]
+assert_equal "Paso a la Inmortalidad del General Martín Miguel de Güemes", (Holidays.on(Date.civil(2021, 6, 21), [:ar], [:informal])[0] || {})[:name]
+
+    assert_nil (Holidays.on(Date.civil(2020, 6, 17), [:ar], [:informal])[0] || {})[:name]
+assert_nil (Holidays.on(Date.civil(2021, 6, 17), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Paso a la Inmortalidad del General Martín Miguel de Güemes", (Holidays.on(Date.civil(2016, 6, 20), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Día de la Independencia", (Holidays.on(Date.civil(2016, 7, 9), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Paso a la Inmortalidad del General José de San Martín", (Holidays.on(Date.civil(2016, 8, 15), [:ar], [:informal])[0] || {})[:name]
+assert_equal "Paso a la Inmortalidad del General José de San Martín", (Holidays.on(Date.civil(2020, 8, 17), [:ar], [:informal])[0] || {})[:name]
+assert_equal "Paso a la Inmortalidad del General José de San Martín", (Holidays.on(Date.civil(2021, 8, 16), [:ar], [:informal])[0] || {})[:name]
+
+    assert_nil (Holidays.on(Date.civil(2016, 8, 17), [:ar], [:informal])[0] || {})[:name]
+assert_nil (Holidays.on(Date.civil(2021, 8, 17), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Día del Respeto a la Diversidad Cultural", (Holidays.on(Date.civil(2016, 10, 10), [:ar], [:informal])[0] || {})[:name]
+assert_equal "Día del Respeto a la Diversidad Cultural", (Holidays.on(Date.civil(2021, 10, 11), [:ar], [:informal])[0] || {})[:name]
+
+    assert_nil (Holidays.on(Date.civil(2021, 10, 12), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Día de la Soberanía Nacional", (Holidays.on(Date.civil(2016, 11, 20), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Inmaculada Concepción de María", (Holidays.on(Date.civil(2016, 12, 8), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Feriado con fines turísticos", (Holidays.on(Date.civil(2016, 7, 8), [:ar], [:informal])[0] || {})[:name]
+assert_equal "Feriado con fines turísticos", (Holidays.on(Date.civil(2016, 12, 9), [:ar], [:informal])[0] || {})[:name]
+assert_equal "Feriado con fines turísticos", (Holidays.on(Date.civil(2021, 5, 24), [:ar], [:informal])[0] || {})[:name]
+assert_equal "Feriado con fines turísticos", (Holidays.on(Date.civil(2021, 10, 8), [:ar], [:informal])[0] || {})[:name]
+assert_equal "Feriado con fines turísticos", (Holidays.on(Date.civil(2021, 11, 22), [:ar], [:informal])[0] || {})[:name]
+
+    assert_equal "Navidad", (Holidays.on(Date.civil(2016, 12, 25), [:ar], [:informal])[0] || {})[:name]
+
+  end
+end

data/test/defs/test_defs_at.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+# This file is generated by the Ruby Holiday gem.
+#
+# Definitions loaded: definitions/at.yaml
+class AtDefinitionTests < Test::Unit::TestCase  # :nodoc:
+
+  def test_at
+    assert_equal "Neujahrstag", (Holidays.on(Date.civil(2009, 1, 1), [:at], [:informal])[0] || {})[:name]
+
+    assert_equal "Ostermontag", (Holidays.on(Date.civil(2009, 4, 13), [:at])[0] || {})[:name]
+
+    assert_equal "Christi Himmelfahrt", (Holidays.on(Date.civil(2009, 5, 21), [:at])[0] || {})[:name]
+
+    assert_equal "Pfingstmontag", (Holidays.on(Date.civil(2009, 6, 1), [:at])[0] || {})[:name]
+
+    assert_equal "Nationalfeiertag", (Holidays.on(Date.civil(2009, 10, 26), [:at], [:informal])[0] || {})[:name]
+
+    assert_equal "Mariä Empfängnis", (Holidays.on(Date.civil(2009, 12, 8), [:at], [:informal])[0] || {})[:name]
+
+    assert_equal "1. Weihnachtstag", (Holidays.on(Date.civil(2009, 12, 25), [:at], [:informal])[0] || {})[:name]
+
+    assert_equal "2. Weihnachtstag", (Holidays.on(Date.civil(2009, 12, 26), [:at], [:informal])[0] || {})[:name]
+
+    assert_nil (Holidays.on(Date.civil(2010, 5, 8), [:at])[0] || {})[:name]
+
+    assert_equal "Fronleichnam", (Holidays.on(Date.civil(2017, 6, 15), [:at])[0] || {})[:name]
+
+  end
+end