holidays 4.6.0 → 4.7.0

data/lib/generated_definitions/lu.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module Holidays
+  # This file is generated by the Ruby Holidays gem.
+  #
+  # Definitions loaded: definitions/lu.yaml
+  #
+  # To use the definitions in this file, load it right after you load the
+  # Holiday gem:
+  #
+  #   require 'holidays'
+  #   require 'generated_definitions/lu'
+  #
+  # All the definitions are available at https://github.com/holidays/holidays
+  module LU # :nodoc:
+    def self.defined_regions
+      [:lu]
+    end
+
+    def self.holidays_by_month
+      {
+              0 => [{:function => "easter(year)", :function_arguments => [:year], :function_modifier => 1, :name => "Ouschterméindeg", :regions => [:lu]},
+            {:function => "easter(year)", :function_arguments => [:year], :function_modifier => 39, :name => "Christi Himmelfaart", :regions => [:lu]},
+            {:function => "easter(year)", :function_arguments => [:year], :function_modifier => 49, :name => "Péngschtméindeg", :regions => [:lu]}],
+      1 => [{:mday => 1, :name => "Neijoerschdag", :regions => [:lu]}],
+      6 => [{:mday => 23, :name => "Nationalfeierdag", :regions => [:lu]}],
+      8 => [{:mday => 15, :name => "Léiffrawëschdag", :regions => [:lu]}],
+      11 => [{:mday => 1, :name => "Allerhellgen", :regions => [:lu]}],
+      12 => [{:mday => 25, :name => "Chrëschtdag", :regions => [:lu]},
+            {:mday => 26, :name => "Stiefesdag", :regions => [:lu]}]
+      }
+    end
+
+    def self.custom_methods
+      {
+        
+      }
+    end
+  end
+end

data/lib/generated_definitions/my.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module Holidays
+  # This file is generated by the Ruby Holidays gem.
+  #
+  # Definitions loaded: definitions/my.yaml
+  #
+  # To use the definitions in this file, load it right after you load the
+  # Holiday gem:
+  #
+  #   require 'holidays'
+  #   require 'generated_definitions/my'
+  #
+  # All the definitions are available at https://github.com/holidays/holidays
+  module MY # :nodoc:
+    def self.defined_regions
+      [:my]
+    end
+
+    def self.holidays_by_month
+      {
+              1 => [{:mday => 1, :observed => "to_weekday_if_weekend(date)", :observed_arguments => [:date], :name => "New Year's Day", :regions => [:my]}],
+      5 => [{:mday => 1, :name => "Labour Day", :regions => [:my]}],
+      6 => [{:mday => 4, :observed => "to_weekday_if_weekend(date)", :observed_arguments => [:date], :name => "Agong's Birthday", :regions => [:my]}],
+      8 => [{:mday => 31, :observed => "to_weekday_if_weekend(date)", :observed_arguments => [:date], :name => "Independence Day", :regions => [:my]}],
+      9 => [{:mday => 16, :observed => "to_weekday_if_weekend(date)", :observed_arguments => [:date], :name => "Malaysia Day", :regions => [:my]}],
+      12 => [{:mday => 25, :observed => "to_weekday_if_weekend(date)", :observed_arguments => [:date], :name => "Christmas Day", :regions => [:my]}]
+      }
+    end
+
+    def self.custom_methods
+      {
+        
+      }
+    end
+  end
+end

data/lib/generated_definitions/north_america.rb

@@ -79,7 +79,7 @@ module Holidays
             {:mday => 12, :type => :informal, :name => "Día de la Raza", :regions => [:mx]},
             {:wday => 1, :week => 2, :name => "Columbus Day", :regions => [:us]},
             {:mday => 31, :type => :informal, :name => "Halloween", :regions => [:us, :ca]}],
-      11 => [{:mday => 11, :name => "Remembrance Day", :regions => [:ca]},
+      11 => [{:mday => 11, :name => "Remembrance Day", :regions => [:ca_ab, :ca_sk, :ca_bc, :ca_pe, :ca_nf, :ca_nt, :ca_nu, :ca_nb, :ca_yk]},
             {:mday => 1, :type => :informal, :name => "Todos los Santos", :regions => [:mx]},
             {:mday => 2, :type => :informal, :name => "Los Fieles Difuntos", :regions => [:mx]},
             {:wday => 1, :week => 3, :name => "Día de la Revolución", :regions => [:mx]},
@@ -116,7 +116,7 @@ year % 4 == 1 ? 20 : nil
 },
 
 "day_after_thanksgiving(year)" => Proc.new { |year|
-Holidays::DateCalculatorFactory.day_of_month_calculator.call(year, 11, 4, 4) + 1
+Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 11, 4, 4) + 1
 },
 
 

data/lib/generated_definitions/scandinavia.rb

@@ -125,7 +125,7 @@ module Holidays
 date = Date.civil(year,4,18)
 if date.wday < 4
   date += (4 - date.wday)
-else date
+else
   date += (11 - date.wday)
 end
 date

data/lib/generated_definitions/ups.rb

@@ -32,7 +32,7 @@ module Holidays
     def self.custom_methods
       {
         "day_after_thanksgiving(year)" => Proc.new { |year|
-Holidays::DateCalculatorFactory.day_of_month_calculator.call(year, 11, 4, 4) + 1
+Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 11, 4, 4) + 1
 },
 
 

data/lib/generated_definitions/us.rb

@@ -52,7 +52,7 @@ year % 4 == 1 ? 20 : nil
 },
 
 "day_after_thanksgiving(year)" => Proc.new { |year|
-Holidays::DateCalculatorFactory.day_of_month_calculator.call(year, 11, 4, 4) + 1
+Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, 11, 4, 4) + 1
 },
 
 

data/lib/holidays.rb

@@ -3,10 +3,9 @@ $:.unshift File.dirname(__FILE__)
 
 require 'date'
 require 'digest/md5'
-require 'holidays/definition_factory'
-require 'holidays/date_calculator_factory'
-require 'holidays/option_factory'
-require 'holidays/use_case_factory'
+require 'holidays/factory/definition'
+require 'holidays/factory/date_calculator'
+require 'holidays/factory/finder'
 require 'holidays/errors'
 require 'holidays/load_all_definitions'
 
@@ -57,19 +56,6 @@ module Holidays
   FULL_DEFINITIONS_PATH = File.expand_path(File.dirname(__FILE__) + "/#{DEFINITIONS_PATH}")
 
   class << self
-    # Get all holidays on a given date.
-    #
-    # [<tt>date</tt>]     A Date object.
-    # [<tt>:options</tt>] One or more region symbols, <tt>:informal</tt> and/or <tt>:observed</tt>.
-    #
-    # Returns an array of hashes or nil. See Holidays#between for the output
-    # format.
-    #
-    # Also available via Date#holidays.
-    def on(date, *options)
-      between(date, date, options)
-    end
-
     # Does the given work-week have any holidays?
     #
     # [<tt>date</tt>]   A Date object.
@@ -87,6 +73,19 @@ module Holidays
       between(start_date, end_date, options).empty?
     end
 
+    # Get all holidays on a given date.
+    #
+    # [<tt>date</tt>]     A Date object.
+    # [<tt>:options</tt>] One or more region symbols, <tt>:informal</tt> and/or <tt>:observed</tt>.
+    #
+    # Returns an array of hashes or nil. See Holidays#between for the output
+    # format.
+    #
+    # Also available via Date#holidays.
+    def on(date, *options)
+      between(date, date, options)
+    end
+
     # Get all holidays occuring between two dates, inclusively.
     #
     # Returns an array of hashes or nil.
@@ -112,14 +111,11 @@ module Holidays
 
       start_date, end_date = get_date(start_date), get_date(end_date)
 
-      if cached_holidays = definition_cache_repository.find(start_date, end_date, options)
+      if cached_holidays = Factory::Definition.cache_repository.find(start_date, end_date, options)
         return cached_holidays
       end
 
-      regions, observed, informal = OptionFactory.parse_options.call(options)
-      date_driver_hash = UseCaseFactory.dates_driver_builder.call(start_date, end_date)
-
-      UseCaseFactory.between.call(start_date, end_date, date_driver_hash, regions, observed, informal)
+      Factory::Finder.between.call(start_date, end_date, options)
     end
 
     # Get next holidays occuring from date, inclusively.
@@ -150,30 +146,24 @@ module Holidays
       from_date = from_date.new_offset(0) + from_date.offset if from_date.respond_to?(:new_offset)
 
       from_date = get_date(from_date)
-      regions, observed, informal = OptionFactory.parse_options.call(options)
 
-      # This could be smarter but I don't have any evidence that just checking for
-      # the next 12 months will cause us issues. If it does we can implement something
-      # smarter here to check in smaller increments.
-      date_driver_hash = UseCaseFactory.dates_driver_builder.call(from_date, from_date >> 12)
-
-      UseCaseFactory.next_holiday.call(holidays_count, from_date, date_driver_hash, regions, observed, informal)
+      Factory::Finder.next_holiday.call(holidays_count, from_date, options)
     end
 
-    # Get all holidays occuring from date to end of year, inclusively. 
+    # Get all holidays occuring from date to end of year, inclusively.
     #
-    # Returns an array of hashes or nil. 
+    # Returns an array of hashes or nil.
     #
-    # Incoming arguments are below: 
+    # Incoming arguments are below:
     # [<tt>options</tt>]  One or more region symbols, <tt>:informal</tt> and/or <tt>:observed</tt>.
     # [<tt>from_date</tt>]    Ruby Date object. This is an optional param, defaulted today.
     #
     # ==== Example
     #   Date.today
     #   => Tue, 23 Feb 2016
-    # 
+    #
     #   regions = [:ca_on]
-    # 
+    #
     #   Holidays.year_holidays(regions)
     #   => [{:name=>"Good Friday",...},
     #       {name=>"Easter Sunday",...},
@@ -191,17 +181,9 @@ module Holidays
 
       # 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)
-      to_date = Date.new(from_date.year, 12, 31)
-      regions, observed, informal = OptionFactory.parse_options.call(options)
-
-      # This could be smarter but I don't have any evidence that just checking for
-      # the next 12 months will cause us issues. If it does we can implement something
-      # smarter here to check in smaller increments.
-      date_driver_hash = UseCaseFactory.dates_driver_builder.call(from_date, from_date >> 12)
 
-      UseCaseFactory.year_holiday.call(from_date, to_date, date_driver_hash, regions, observed, informal)
+      Factory::Finder.year_holiday.call(from_date, options)
     end
 
     # Allows a developer to explicitly calculate and cache holidays within a given period
@@ -209,7 +191,7 @@ module Holidays
       start_date, end_date = get_date(start_date), get_date(end_date)
       cache_data = between(start_date, end_date, *options)
 
-      definition_cache_repository.cache_between(start_date, end_date, cache_data, options)
+      Factory::Definition.cache_repository.cache_between(start_date, end_date, cache_data, options)
     end
 
     # Returns an array of symbols of all the available holiday regions.
@@ -219,13 +201,13 @@ module Holidays
 
     # Parses provided holiday definition file(s) and loads them so that they are immediately available.
     def load_custom(*files)
-      regions, rules_by_month, custom_methods, tests = DefinitionFactory.file_parser.parse_definition_files(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] = Holidays::DefinitionFactory.custom_method_proc_decorator.call(method_entity)
+        custom_methods[method_key] = Factory::Definition.custom_method_proc_decorator.call(method_entity)
       end
 
-      DefinitionFactory.merger.call(regions, rules_by_month, custom_methods)
+      Factory::Definition.merger.call(regions, rules_by_month, custom_methods)
 
       rules_by_month
     end
@@ -239,10 +221,6 @@ module Holidays
         Date.civil(date.year, date.mon, date.mday)
       end
     end
-
-    def definition_cache_repository
-      DefinitionFactory.cache_repository
-    end
   end
 end
 

data/lib/holidays/core_extensions/date.rb

@@ -49,7 +49,7 @@ module Holidays
 
       module ClassMethods
         def calculate_mday(year, month, week, wday)
-          Holidays::DateCalculatorFactory.day_of_month_calculator.call(year, month, week, wday)
+          Holidays::Factory::DateCalculator.day_of_month_calculator.call(year, month, week, wday)
         end
       end
     end

data/lib/holidays/definition/context/function_processor.rb

@@ -0,0 +1,86 @@
+require 'holidays/errors'
+
+module Holidays
+  module Definition
+    module Context
+      class FunctionProcessor
+        def initialize(custom_methods_repo, proc_result_cache_repo)
+          @custom_methods_repo = custom_methods_repo
+          @proc_result_cache_repo = proc_result_cache_repo
+        end
+
+        def call(year, month, day, func_id, desired_func_args, func_modifier = nil)
+          validate!(year, month, day, func_id, desired_func_args)
+
+          function = @custom_methods_repo.find(func_id)
+          raise Holidays::FunctionNotFound.new("Unable to find function with id '#{func_id}'") if function.nil?
+
+          calculate(year, month, function, parse_arguments(year, month, day, desired_func_args), func_modifier)
+        end
+
+        private
+
+        VALID_ARGUMENTS = [:year, :month, :day, :date]
+
+        def validate!(year, month, day, func_id, desired_func_args)
+          raise ArgumentError if desired_func_args.nil? || desired_func_args.empty?
+
+          desired_func_args.each do |name|
+            raise ArgumentError unless VALID_ARGUMENTS.include?(name)
+          end
+
+          raise ArgumentError if desired_func_args.include?(:year) && !year.is_a?(Integer)
+          raise ArgumentError if desired_func_args.include?(:month) && (month < 0 || month > 12)
+          raise ArgumentError if desired_func_args.include?(:day) && (day < 1 || day > 31)
+        end
+
+        def parse_arguments(year, month, day, target_args)
+          args = []
+
+          if target_args.include?(:year)
+            args << year
+          end
+
+          if target_args.include?(:month)
+            args << month
+          end
+
+          if target_args.include?(:day)
+            args << day
+          end
+
+          if target_args.include?(:date)
+            args << Date.civil(year, month, day)
+          end
+
+          args
+        end
+
+        def calculate(year, month, id, args, modifier)
+          result = @proc_result_cache_repo.lookup(id, *args)
+          if result.kind_of?(Date)
+            if modifier
+              result = result + modifier # NOTE: This could be a positive OR negative number.
+            end
+          elsif result.is_a?(Integer)
+            begin
+              result = Date.civil(year, month, result)
+            rescue ArgumentError
+              raise Holidays::InvalidFunctionResponse.new("invalid day response from custom method call resulting in invalid date. Result: '#{result}'")
+            end
+          elsif result.nil?
+            # Do nothing. This is because some functions can return 'nil' today.
+            # I want to change this and so rather than come up with a clean
+            # implementation I'll do this so we don't throw an error in this specific
+            # situation. This should be removed once we have changed the existing
+            # custom definition functions. See https://github.com/holidays/holidays/issues/204
+          else
+            raise Holidays::InvalidFunctionResponse.new("invalid response from custom method call, must be a 'date' or 'integer' representing the day. Result: '#{result}'")
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/holidays/definition/context/generator.rb

@@ -1,5 +1,12 @@
 require 'yaml'
 
+#FIXME This whole file is my next refactor target. We do wayyyyy too much by
+#      convention here. We need hard and fast rules and explicit errors when you
+#      try to parse something that isn't allowed. So if you are a dev recognize
+#      that a lot of the guard statements in here are to codify existing legacy
+#      logic. The fact is that we already require these guards, we just don't
+#      enforce it explicitly. Now we will. And by doing so things will begin
+#      to look very, very messy.
 module Holidays
   module Definition
     module Context
@@ -23,7 +30,7 @@ module Holidays
           files.each do |file|
             definition_file = YAML.load_file(file)
 
-            custom_methods = custom_method_parser.call(definition_file['methods'])
+            custom_methods = @custom_method_parser.call(definition_file['methods'])
 
             regions, rules_by_month = parse_month_definitions(definition_file['months'], custom_methods)
 
@@ -54,7 +61,7 @@ module Holidays
           # Build the custom methods string
           custom_method_string = ''
           custom_methods.each do |key, code|
-            custom_method_string << custom_method_source_decorator.call(code) + ",\n\n"
+            custom_method_string << @custom_method_source_decorator.call(code) + ",\n\n"
           end
 
           module_src = generate_module_src(module_name, files, regions, month_strings, custom_method_string)
@@ -65,8 +72,6 @@ module Holidays
 
         private
 
-        attr_reader :custom_method_parser, :custom_method_source_decorator, :custom_methods_repository
-
         #FIXME This should be a 'month_definitions_parser' like the above parser
         def parse_month_definitions(month_definitions, parsed_custom_methods)
           regions = []
@@ -83,9 +88,12 @@ module Holidays
                 end
 
                 rule[:regions] = rule[:regions].collect { |r| r.to_sym }
-
                 regions << rule[:regions]
 
+                if rule[:year_ranges]
+                  rule[:year_ranges] = clean_year_ranges(rule[:year_ranges])
+                end
+
                 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] and ex[:year_ranges] == rule[:year_ranges]
@@ -110,6 +118,23 @@ module Holidays
           [regions, rules_by_month]
         end
 
+        # In this case we end up parsing a range as "2006..2008" a string. This is codifying
+        # what we already do...today we parse as a string but when writing out to our final
+        # generated files it comes out as a range that Ruby interprets. This just puts it in stone
+        # what we want to do.
+        def clean_year_ranges(year_ranges)
+          year_ranges.collect do |year_range|
+            if year_range["between"]
+              range = year_range["between"]
+              if range.is_a?(String)
+                year_range["between"] = Range.new(*range.split("..").map(&:to_i))
+              end
+            end
+
+            year_range
+          end
+        end
+
         def parse_test_definitions(tests)
           test_strings = []
 
@@ -193,7 +218,7 @@ module Holidays
         # What we should do is ensure that all custom methods are loaded into the repo as soon as they are parsed
         # so we only have one place to look.
         def get_function_arguments(function_id, parsed_custom_methods)
-          if method = custom_methods_repository.find(function_id)
+          if method = @custom_methods_repository.find(function_id)
             method.parameters.collect { |arg| arg[1] }
           elsif method = parsed_custom_methods[function_id]
             method.arguments.collect { |arg| arg.to_sym }