holidays 1.0.8 → 1.1.0

data/data/index.yaml

@@ -9,6 +9,7 @@ defs:
   CA: ['ca.yaml', 'north_america_informal.yaml']
   CH: ['ch.yaml']
   CL: ['cl.yaml']
+  CR: ['cr.yaml']
   CZ: ['cz.yaml']
   DK: ['dk.yaml']
   DE: ['de.yaml']
@@ -16,6 +17,7 @@ defs:
   EL: ['el.yaml']
   ES: ['es.yaml']
   Federal_Reserve: ['federal_reserve.yaml']
+  Fed_Ex: ['fedex.yaml']
   FI: ['fi.yaml']
   FR: ['fr.yaml']
   GB: ['gb.yaml']

data/data/jp.yaml

@@ -1,11 +1,14 @@
 # Japanese holiday definitions for Ruby Holiday gem.
-# Reference: http://www.h3.dion.ne.jp/~sakatsu/holiday_topic.htm
+# Reference:
+#   - http://www.h3.dion.ne.jp/~sakatsu/holiday_topic.htm
+#   - http://www8.cao.go.jp/chosei/shukujitsu/gaiyou.html
 #
 # This definition can calculate current Japanese holidays,
 # don't compat with past changes of Japan Holiday Act.
 #
 # CHANGES:
 #  2010-12-25: Initial version by Tatsuki Sugiura <sugi@nemui.org>
+#  2014-11-09: Added substitute holiday by Yoshiyuki Hirano <yoshiyuki.hirano@henteco-labs.com>
 # 
 ---
 months:
@@ -17,6 +20,9 @@ months:
     regions: [jp]
     wday: 1
     week: 2
+  - name: 振替休日
+    regions: [jp]
+    function: jp_substitute_holiday(year, 1, 1)
   2:
   - name: 建国記念日
     regions: [jp]
@@ -176,6 +182,7 @@ tests: |
    Date.civil(2008,12,23) => '天皇誕生日',
    Date.civil(2010,3,22) => '振替休日',
    Date.civil(2008,11,24) => '振替休日',
+   Date.civil(2012,1,2) => '振替休日',
   }.each do |date, name|
      assert_equal name, (Holidays.on(date, :jp, :informal)[0] || {})[:name]
   end

data/lib/holidays.rb

@@ -3,6 +3,7 @@ $:.unshift File.dirname(__FILE__)
 
 require 'digest/md5'
 require 'date'
+require 'yaml'
 
 # == Region options
 # Holidays can be defined as belonging to one or more regions and sub regions.
@@ -311,6 +312,20 @@ module Holidays
     self.available(true).each { |path| require path }
   end
 
+  # Parses provided holiday definition file(s) and loads them so that they are immediately available.
+  def self.load_custom(*files)
+    regions, rules_by_month, custom_methods, tests = self.parse_definition_files(files)
+    merge_defs(regions, rules_by_month)
+  end
+
+  # Parses provided holiday definition file(s) and returns strings containing the generated module and test source
+  def self.parse_definition_files_and_return_source(module_name, *files)
+    regions, rules_by_month, custom_methods, tests = self.parse_definition_files(files)
+    module_src, test_src = self.generate_definition_source(module_name, files, regions, rules_by_month, custom_methods, tests)
+
+    return module_src, test_src
+  end
+
 private
   # Returns [(arr)regions, (bool)observed, (bool)informal]
   def self.parse_options(*options) # :nodoc:
@@ -423,6 +438,210 @@ private
     @@proc_cache[proc_key] = function.call(year) unless @@proc_cache[proc_key]
     @@proc_cache[proc_key]
   end
+
+  def self.parse_definition_files(files)
+    raise ArgumentError, "Must have at least one file to parse" if files.empty?
+
+    all_regions = []
+    all_rules_by_month = {}
+    all_custom_methods = {}
+    all_tests = []
+
+    files.flatten!
+
+    files.each do |file|
+      definition_file = YAML.load_file(file)
+
+      regions, rules_by_month = self.parse_month_definitions(definition_file['months'])
+
+      all_regions << regions.flatten
+
+      all_rules_by_month.merge!(rules_by_month) { |month, existing, new|
+        existing << new
+        existing.flatten!
+      }
+
+      custom_methods = self.parse_method_definitions(definition_file['methods'])
+      all_custom_methods.merge!(custom_methods)
+
+      all_tests << self.parse_test_definitions(definition_file['tests'])
+    end
+
+    all_regions.flatten!.uniq!
+
+    [all_regions, all_rules_by_month, all_custom_methods, all_tests]
+  end
+
+  def self.parse_month_definitions(month_definitions)
+    regions = []
+    rules_by_month = {}
+
+    if month_definitions
+      month_definitions.each do |month, definitions|
+        rules_by_month[month] = [] unless rules_by_month[month]
+        definitions.each do |definition|
+          rule = {}
+
+          definition.each do |key, val|
+            rule[key.to_sym] = val
+          end
+
+          rule[:regions] = rule[:regions].collect { |r| r.to_sym }
+
+          regions << rule[:regions]
+
+          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]
+              ex[:regions] << rule[:regions].flatten
+              exists = true
+            end
+          end
+
+          unless exists
+            rules_by_month[month] << rule
+          end
+        end
+      end
+    end
+
+    [regions, rules_by_month]
+  end
+
+  def self.parse_method_definitions(methods)
+    custom_methods = {}
+
+    if methods
+      methods.each do |name, code|
+        custom_methods[name] = code
+      end
+    end
+
+    custom_methods
+  end
+
+  def self.parse_test_definitions(tests)
+    test_strings = []
+
+    if tests
+      test_strings << tests
+    end
+
+    test_strings
+  end
+
+  def self.generate_definition_source(module_name, files, regions, rules_by_month, custom_methods, tests)
+    month_strings = self.generate_month_definition_strings(rules_by_month)
+
+    # Build the custom methods string
+    custom_method_string = ''
+    custom_methods.each do |key, code|
+      custom_method_string << code + "\n\n"
+    end
+
+    module_src = self.generate_module_src(module_name, files, regions, month_strings, custom_method_string)
+    test_src = self.generate_test_src(module_name, files, tests)
+
+    return module_src, test_src || ''
+  end
+
+  def self.generate_month_definition_strings(rules_by_month)
+    month_strings = []
+
+    rules_by_month.each do |month, rules|
+      month_string = "      #{month.to_s} => ["
+      rule_strings = []
+      rules.each do |rule|
+        string = '{'
+        if rule[:mday]
+          string << ":mday => #{rule[:mday]}, "
+        elsif rule[:function]
+          string << ":function => lambda { |year| Holidays.#{rule[:function]} }, "
+          string << ":function_id => \"#{rule[:function].to_s}\", "
+        else
+          string << ":wday => #{rule[:wday]}, :week => #{rule[:week]}, "
+        end
+
+        if rule[:observed]
+          string << ":observed => lambda { |date| Holidays.#{rule[:observed]}(date) }, "
+          string << ":observed_id => \"#{rule[:observed].to_s}\", "
+        end
+
+        if rule[:type]
+          string << ":type => :#{rule[:type]}, "
+        end
+
+        # shouldn't allow the same region twice
+        string << ":name => \"#{rule[:name]}\", :regions => [:" + rule[:regions].uniq.join(', :') + "]}"
+        rule_strings << string
+      end
+      month_string << rule_strings.join(",\n            ") + "]"
+      month_strings << month_string
+    end
+
+    return month_strings
+  end
+
+  def self.generate_module_src(module_name, files, regions, month_strings, custom_methods)
+    module_src = ""
+
+    module_src =<<-EOM
+# encoding: utf-8
+module Holidays
+  # This file is generated by the Ruby Holidays gem.
+  #
+  # Definitions loaded: #{files.join(', ')}
+  #
+  # To use the definitions in this file, load it right after you load the
+  # Holiday gem:
+  #
+  #   require 'holidays'
+  #   require 'holidays/#{module_name.to_s.downcase}'
+  #
+  # All the definitions are available at https://github.com/alexdunae/holidays
+  module #{module_name.to_s.upcase} # :nodoc:
+    def self.defined_regions
+      [:#{regions.join(', :')}]
+    end
+
+    def self.holidays_by_month
+      {
+        #{month_strings.join(",\n")}
+      }
+    end
+  end
+
+#{custom_methods}
+end
+
+Holidays.merge_defs(Holidays::#{module_name.to_s.upcase}.defined_regions, Holidays::#{module_name.to_s.upcase}.holidays_by_month)
+  EOM
+
+    return module_src
+  end
+
+  def self.generate_test_src(module_name, files, tests)
+    unless tests.empty?
+      test_src = ""
+
+      test_src =<<-EndOfTests
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+# This file is generated by the Ruby Holiday gem.
+#
+# Definitions loaded: #{files.join(', ')}
+class #{module_name.to_s.capitalize}DefinitionTests < Test::Unit::TestCase  # :nodoc:
+
+  def test_#{module_name.to_s.downcase}
+#{tests.join("\n\n")}
+  end
+end
+      EndOfTests
+    end
+
+    return test_src
+  end
 end
 
 # === Extending Ruby's Date class with the Holidays gem

data/lib/holidays/MANIFEST

@@ -9,6 +9,7 @@ The following definition files are included in this installation:
 * holidays/ca
 * holidays/ch
 * holidays/cl
+* holidays/cr
 * holidays/cz
 * holidays/de
 * holidays/dk
@@ -16,6 +17,7 @@ The following definition files are included in this installation:
 * holidays/el
 * holidays/es
 * holidays/europe
+* holidays/fed_ex
 * holidays/federal_reserve
 * holidays/fi
 * holidays/fr

data/lib/holidays/ar.rb

@@ -4,7 +4,7 @@ module Holidays
   #
   # Definitions loaded: data/ar.yaml
   #
-  # To use the definitions in this file, load it right after you load the 
+  # To use the definitions in this file, load it right after you load the
   # Holiday gem:
   #
   #   require 'holidays'

data/lib/holidays/at.rb

@@ -4,7 +4,7 @@ module Holidays
   #
   # Definitions loaded: data/at.yaml
   #
-  # To use the definitions in this file, load it right after you load the 
+  # To use the definitions in this file, load it right after you load the
   # Holiday gem:
   #
   #   require 'holidays'

data/lib/holidays/au.rb

@@ -4,7 +4,7 @@ module Holidays
   #
   # Definitions loaded: data/au.yaml
   #
-  # To use the definitions in this file, load it right after you load the 
+  # To use the definitions in this file, load it right after you load the
   # Holiday gem:
   #
   #   require 'holidays'
@@ -13,18 +13,19 @@ module Holidays
   # All the definitions are available at https://github.com/alexdunae/holidays
   module AU # :nodoc:
     def self.defined_regions
-      [:au, :au_nsw, :au_vic, :au_qld, :au_nt, :au_act, :au_sa, :au_qld_brisbane, :au_tas, :au_wa]
+      [:au, :au_nsw, :au_vic, :au_qld, :au_nt, :au_act, :au_sa, :au_qld_brisbane, :au_qld_cairns, :au_tas, :au_tas_south, :au_wa, :au_tas_north]
     end
 
     def self.holidays_by_month
       {
               0 => [{:function => lambda { |year| Holidays.easter(year)-2 }, :function_id => "easter(year)-2", :name => "Good Friday", :regions => [:au]},
-            {:function => lambda { |year| Holidays.easter(year)-1 }, :function_id => "easter(year)-1", :name => "Easter Saturday", :regions => [:au_nsw, :au_vic, :au_qld, :au_nt, :au_act, :au_sa, :au_qld_brisbane]},
+            {:function => lambda { |year| Holidays.easter(year)-1 }, :function_id => "easter(year)-1", :name => "Easter Saturday", :regions => [:au_nsw, :au_vic, :au_qld, :au_nt, :au_act, :au_sa, :au_qld_brisbane, :au_qld_cairns]},
             {:function => lambda { |year| Holidays.easter(year) }, :function_id => "easter(year)", :name => "Easter Sunday", :regions => [:au_nsw]},
             {:function => lambda { |year| Holidays.easter(year)+1 }, :function_id => "easter(year)+1", :name => "Easter Monday", :regions => [:au]},
             {:function => lambda { |year| Holidays.easter(year)+2 }, :function_id => "easter(year)+2", :name => "Easter Monday", :regions => [:au_tas]}],
       1 => [{:mday => 1, :observed => lambda { |date| Holidays.to_monday_if_weekend(date) }, :observed_id => "to_monday_if_weekend", :name => "New Year's Day", :regions => [:au]},
             {:mday => 26, :observed => lambda { |date| Holidays.to_monday_if_weekend(date) }, :observed_id => "to_monday_if_weekend", :name => "Australia Day", :regions => [:au]}],
+      2 => [{:wday => 1, :week => 2, :name => "Royal Hobart Regatta", :regions => [:au_tas_south]}],
       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]}],
@@ -34,10 +35,17 @@ module Holidays
       6 => [{:wday => 1, :week => 1, :name => "Foundation Day", :regions => [:au_wa]},
             {:wday => 1, :week => 2, :name => "Queen's Birthday", :regions => [:au_act, :au_nsw, :au_sa, :au_qld, :au_tas, :au_nt, :au_vic]},
             {:mday => 6, :type => :informal, :name => "Queensland Day", :regions => [:au_qld]}],
+      7 => [{:wday => 5, :week => 3, :name => "Cairns Show", :regions => [:au_qld_cairns]}],
       8 => [{:wday => 3, :week => -3, :name => "Ekka", :regions => [:au_qld_brisbane]}],
+      9 => [{:wday => 1, :week => -1, :name => "Queen's Birthday", :regions => [:au_wa]},
+            {:wday => 1, :week => -1, :name => "Family & Community Day", :regions => [:au_act]}],
       10 => [{:wday => 1, :week => 1, :name => "Labour Day", :regions => [:au_act, :au_nsw, :au_sa]},
             {:function => lambda { |year| Holidays.qld_labour_day_october(year) }, :function_id => "qld_labour_day_october(year)", :observed => lambda { |date| Holidays.to_monday_if_weekend(date) }, :observed_id => "to_monday_if_weekend", :name => "Labour Day", :regions => [:au_qld]},
-            {:function => lambda { |year| Holidays.qld_queens_bday_october(year) }, :function_id => "qld_queens_bday_october(year)", :observed => lambda { |date| Holidays.to_monday_if_weekend(date) }, :observed_id => "to_monday_if_weekend", :name => "Queen's Birthday", :regions => [:au_qld]}],
+            {:function => lambda { |year| Holidays.qld_queens_bday_october(year) }, :function_id => "qld_queens_bday_october(year)", :observed => lambda { |date| Holidays.to_monday_if_weekend(date) }, :observed_id => "to_monday_if_weekend", :name => "Queen's Birthday", :regions => [:au_qld]},
+            {:function => lambda { |year| Holidays.hobart_show_day(year) }, :function_id => "hobart_show_day(year)", :name => "Royal Hobart Show", :regions => [:au_tas_south]}],
+      11 => [{:function => lambda { |year| Holidays.g20_day_2014_only(year) }, :function_id => "g20_day_2014_only(year)", :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]}],
       12 => [{:mday => 25, :observed => lambda { |date| Holidays.to_monday_if_weekend(date) }, :observed_id => "to_monday_if_weekend", :name => "Christmas Day", :regions => [:au]},
             {:mday => 26, :observed => lambda { |date| Holidays.to_weekday_if_boxing_weekend(date) }, :observed_id => "to_weekday_if_boxing_weekend", :name => "Boxing Day", :regions => [:au]}]
       }
@@ -65,6 +73,21 @@ def self.qld_labour_day_october(year)
 end
 
 
+# http://www.justice.qld.gov.au/fair-and-safe-work/industrial-relations/public-holidays/dates
+# G20 day in brisbane, in 2014, on november 14
+def self.g20_day_2014_only(year)
+  year == 2014 ? 14 : nil
+end
+
+
+# http://worksafe.tas.gov.au/__data/assets/pdf_file/0008/287036/Public_Holidays_2014.pdf
+# The Thursday before the fourth Saturday in October. 
+def self.hobart_show_day(year)
+  fourth_sat_in_oct = Date.civil(year, 10, Date.calculate_mday(year, 10, 4, :saturday))
+  fourth_sat_in_oct - 2 # the thursday before
+end
+
+
 
 end
 

data/lib/holidays/be.rb

@@ -4,7 +4,7 @@ module Holidays
   #
   # Definitions loaded: data/be.yaml
   #
-  # To use the definitions in this file, load it right after you load the 
+  # To use the definitions in this file, load it right after you load the
   # Holiday gem:
   #
   #   require 'holidays'

data/lib/holidays/br.rb

@@ -4,7 +4,7 @@ module Holidays
   #
   # Definitions loaded: data/br.yaml
   #
-  # To use the definitions in this file, load it right after you load the 
+  # To use the definitions in this file, load it right after you load the
   # Holiday gem:
   #
   #   require 'holidays'

data/lib/holidays/ca.rb

@@ -4,7 +4,7 @@ module Holidays
   #
   # Definitions loaded: data/ca.yaml, data/north_america_informal.yaml
   #
-  # To use the definitions in this file, load it right after you load the 
+  # To use the definitions in this file, load it right after you load the
   # Holiday gem:
   #
   #   require 'holidays'
@@ -13,7 +13,7 @@ module Holidays
   # All the definitions are available at https://github.com/alexdunae/holidays
   module CA # :nodoc:
     def self.defined_regions
-      [:ca, :ca_qc, :ca_ab, :ca_on, :ca_sk, :ca_mb, :ca_bc, :ca_nf, :ca_nt, :ca_nu, :ca_ns, :ca_yk, :us]
+      [:ca, :ca_qc, :ca_ab, :ca_on, :ca_sk, :ca_mb, :ca_ns, :ca_pe, :ca_bc, :ca_nf, :ca_nt, :ca_nu, :ca_nb, :ca_yk, :us]
     end
 
     def self.holidays_by_month
@@ -25,6 +25,8 @@ module Holidays
             {:mday => 2, :name => "New Year's", :regions => [:ca_qc]}],
       2 => [{:wday => 1, :week => 3, :name => "Family Day", :regions => [:ca_ab, :ca_on, :ca_sk]},
             {:wday => 1, :week => 3, :name => "Louis Riel Day", :regions => [:ca_mb]},
+            {:wday => 1, :week => 3, :name => "Nova Scotia Heritage Day", :regions => [:ca_ns]},
+            {:wday => 1, :week => 3, :name => "Islander Day", :regions => [:ca_pe]},
             {:wday => 1, :week => 2, :name => "BC Family Day", :regions => [:ca_bc]},
             {:mday => 2, :type => :informal, :name => "Groundhog Day", :regions => [:us, :ca]},
             {:mday => 14, :type => :informal, :name => "Valentine's Day", :regions => [:us, :ca]}],
@@ -45,7 +47,8 @@ module Holidays
             {:wday => 1, :week => 1, :name => "Saskatchewan Day", :regions => [:ca_sk]},
             {:wday => 1, :week => 1, :name => "Heritage Day", :regions => [:ca_ab]},
             {:wday => 1, :week => 1, :name => "Natal Day", :regions => [:ca_ns]},
-            {:wday => 1, :week => 1, :name => "Civic Holiday", :regions => [:ca_on]},
+            {:wday => 1, :week => 1, :name => "Civic Holiday", :regions => [:ca_on, :ca_nt, :ca_nu, :ca_pe]},
+            {:wday => 1, :week => 1, :name => "New Brunswick Day", :regions => [:ca_nb]},
             {:wday => 1, :week => 3, :name => "Discovery Day", :regions => [:ca_yk]}],
       9 => [{:wday => 1, :week => 1, :name => "Labour Day", :regions => [:ca]}],
       10 => [{:wday => 1, :week => 2, :name => "Thanksgiving", :regions => [:ca]},