holidays 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0583fff25d319bc53a85cb10ec309c8ad39496fd
-  data.tar.gz: 9ee50ee21c0b476609d97d7e0b2c68682741389a
+  metadata.gz: cb0c1c87e82d392d31c5281d907e58bbe6573683
+  data.tar.gz: 7ffb3aa2717b7727898810687778f0df10ec235f
 SHA512:
-  metadata.gz: 3ef3930fca96668d9514dbac18bd907b7e198a81592977dabc30d20b095225cd7e1d7cc9a673d27ddf44bb31b5312332325700c9efbbedd2bb084e5456764140
-  data.tar.gz: 3d7dee33d38a31f68b11fe0ebd138c16beb2c4c0ea469d3eb7b0586993d1b614f0d822c97adfd3763ded3cb6bd2633363b2373f9d68d182b6bc3885fe5eba79a
+  metadata.gz: 7f5373bd6b450b42b4a9bb28338c028faecc3a3aea2c52146cd092fbf5ee6b2a144cf00450a5ddd430532737c46c1da590f387e45ddcfb2ca6584903844b4b53
+  data.tar.gz: cbaeda3492a457b84d3f2d0d19a8080539fbdf3068aa722e8593a42597897fddf767ba2bbb2668bc2a5a42c254e2f3ae1ad69a36362e9c2f52f925429bda6d90

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Ruby Holidays Gem CHANGELOG
 
+## 4.5.0
+
+* Add `Holidays.year_holidays` method to obtain all holidays occuring from date to end of year, inclusively (thanks to https://github.com/jonathanpike)
+
 ## 4.4.0
 
 * Add Peruvian holiday definitions (https://github.com/Xosmond)

data/README.md

@@ -72,6 +72,22 @@ To find and return the next holidays occurring from date, inclusively:
 
 Will default to `Date.today` if no date is provided.
 
+To find all holidays occuring from date to end of year, inclusively:
+
+    Holidays.year_holidays([:ca_on], Date.civil(2016, 2, 23))
+    => [{:name=>"Good Friday",...},
+        {name=>"Easter Sunday",...},
+        {:name=>"Victoria Day",...},
+        {:name=>"Canada Day",...},
+        {:name=>"Civic Holiday",...},
+        {:name=>"Labour Day",...},
+        {:name=>"Thanksgiving",...},
+        {:name=>"Remembrance Day",...},
+        {:name=>"Christmas Day",...},
+        {:name=>"Boxing Day",...}]
+
+Will default to `Date.today` if no date is provided.
+
 ### Loading Custom Definitions on the fly
 
 Load custom definitions file on the fly and use them immediately.

data/lib/holidays.rb

@@ -160,6 +160,50 @@ module Holidays
       UseCaseFactory.next_holiday.call(holidays_count, from_date, date_driver_hash, regions, observed, informal)
     end
 
+    # Get all holidays occuring from date to end of year, inclusively. 
+    #
+    # Returns an array of hashes or nil. 
+    #
+    # 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",...},
+    #       {:name=>"Victoria Day",...},
+    #       {:name=>"Canada Day",...},
+    #       {:name=>"Civic Holiday",...},
+    #       {:name=>"Labour Day",...},
+    #       {:name=>"Thanksgiving",...},
+    #       {:name=>"Remembrance Day",...},
+    #       {:name=>"Christmas Day",...},
+    #       {:name=>"Boxing Day",...}]
+    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)
+      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)
+    end
+
     # Allows a developer to explicitly calculate and cache holidays within a given period
     def cache_between(start_date, end_date, *options)
       start_date, end_date = get_date(start_date), get_date(end_date)

data/lib/holidays/core_extensions/date.rb

@@ -29,6 +29,24 @@ module Holidays
         holidays && !holidays.empty?
       end
 
+      # Returns a new Date where one or more of the elements have been changed according to the +options+ parameter.
+      # The +options+ parameter is a hash with a combination of these keys: <tt>:year</tt>, <tt>:month</tt>, <tt>:day</tt>.
+      #
+      #   Date.new(2007, 5, 12).change(day: 1)               # => Date.new(2007, 5, 1)
+      #   Date.new(2007, 5, 12).change(year: 2005, month: 1) # => Date.new(2005, 1, 12)
+      def change(options)
+        ::Date.new(
+          options.fetch(:year, year),
+          options.fetch(:month, month),
+          options.fetch(:day, day)
+        )
+      end
+
+      def end_of_month
+        last_day = ::Time.days_in_month( self.month, self.year )
+        change(:day => last_day)
+      end
+
       module ClassMethods
         def calculate_mday(year, month, week, wday)
           Holidays::DateCalculatorFactory.day_of_month_calculator.call(year, month, week, wday)

data/lib/holidays/core_extensions/time.rb

@@ -0,0 +1,23 @@
+module Holidays
+  module CoreExtensions
+    module Time
+      def self.included(base)
+        base.extend ClassMethods
+      end
+     
+      module ClassMethods
+        COMMON_YEAR_DAYS_IN_MONTH = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+
+        # Returns the number of days in the given month.
+        # If no year is specified, it will use the current year.
+        def days_in_month(month, year = current.year)
+          if month == 2 && ::Date.gregorian_leap?(year)
+            29
+          else
+            COMMON_YEAR_DAYS_IN_MONTH[month]
+          end
+        end
+      end 
+    end
+  end
+end

data/lib/holidays/use_case/context/year_holiday.rb

@@ -0,0 +1,51 @@
+module Holidays
+  module UseCase
+    module Context
+      class YearHoliday
+        include ContextCommon
+
+        def initialize(holidays_by_month_repo, day_of_month_calculator, custom_methods_repo, proc_result_cache_repo)
+          @holidays_by_month_repo = holidays_by_month_repo
+          @day_of_month_calculator = day_of_month_calculator
+          @custom_methods_repo = custom_methods_repo
+          @proc_result_cache_repo = proc_result_cache_repo
+        end
+
+        def call(from_date, to_date, dates_driver, regions, observed, informal)
+          validate!(from_date, to_date, dates_driver, regions)
+          holidays = []
+          ret_holidays = []
+
+          ret_holidays = make_date_array(dates_driver, regions, observed, informal)
+          ret_holidays.each do |holiday|
+            if holiday[:date] >= from_date && holiday[:date] <= to_date
+              holidays << holiday
+            end
+          end
+
+          holidays.sort{|a, b| a[:date] <=> b[:date] }
+        end
+
+        private
+
+        attr_reader :holidays_by_month_repo,
+                    :day_of_month_calculator,
+                    :custom_methods_repo,
+                    :proc_result_cache_repo
+
+        def validate!(from_date, to_date, dates_driver, regions)
+          raise ArgumentError unless from_date
+          raise ArgumentError unless to_date
+
+          raise ArgumentError if dates_driver.nil? || dates_driver.empty?
+
+          dates_driver.each do |year, months|
+            raise ArgumentError if months.nil? || months.empty?
+          end
+
+          raise ArgumentError if regions.nil? || regions.empty?
+        end
+      end
+    end
+  end
+end

data/lib/holidays/use_case_factory.rb

@@ -2,6 +2,7 @@ require 'holidays/use_case/context/context_common'
 require 'holidays/use_case/context/between'
 require 'holidays/use_case/context/next_holiday'
 require 'holidays/use_case/context/dates_driver_builder'
+require 'holidays/use_case/context/year_holiday'
 
 module Holidays
   class UseCaseFactory
@@ -23,6 +24,15 @@ module Holidays
         )
       end
 
+      def year_holiday
+        UseCase::Context::YearHoliday.new(
+          DefinitionFactory.holidays_by_month_repository,
+          DateCalculatorFactory.day_of_month_calculator,
+          DefinitionFactory.custom_methods_repository,
+          DefinitionFactory.proc_result_cache_repository,
+        )
+      end
+
       def dates_driver_builder
         UseCase::Context::DatesDriverBuilder.new
       end

data/lib/holidays/version.rb

@@ -1,3 +1,3 @@
 module Holidays
-  VERSION = '4.4.0'
+  VERSION = '4.5.0'
 end

data/test/holidays/core_extensions/test_date_time.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../test_helper'
+
+require 'holidays/core_extensions/date'
+require 'holidays/core_extensions/time'
+
+class Date
+  include Holidays::CoreExtensions::Date
+end
+
+class Time 
+  include Holidays::CoreExtensions::Time
+end 
+
+class CoreExtensionDateTimeTests < Test::Unit::TestCase
+  def setup
+    @date = Date.civil(2008,1,1)
+  end
+
+  def test_change_method 
+    actual = @date.change(day: 5)
+    assert_equal Date.civil(2008,1,5), actual
+
+    actual = @date.change(year: 2016)
+    assert_equal Date.civil(2016,1,1), actual
+
+    actual = @date.change(month: 5)
+    assert_equal Date.civil(2008,5,1), actual
+
+    actual = @date.change(year: 2015, month: 5, day: 3)
+    assert_equal Date.civil(2015,5,3), actual
+  end 
+
+  def test_end_of_month_method
+    # Works for month with 31 days
+    actual = @date.end_of_month 
+    assert_equal Date.civil(2008,1,31), actual
+
+    # Works for month with 30 days
+    actual = Date.civil(2008,9,5).end_of_month
+    assert_equal Date.civil(2008,9,30), actual
+
+    # Works for leap year
+    actual = Date.civil(2016,2,1).end_of_month
+    assert_equal = Date.civil(2016,2,29), actual
+  end
+
+  def test_days_in_month_method
+    # Works for month with 31 days
+    actual = Time.days_in_month(1, 2008)
+    assert_equal 31, actual
+
+    # Works for month with 30 days
+    actual = Time.days_in_month(9, 2008)
+    assert_equal 30, actual
+
+    # Works for leap year
+    actual = Time.days_in_month(2, 2016)
+    assert_equal 29, actual
+  end    
+end 

data/test/test_helper.rb

@@ -11,12 +11,17 @@ require 'mocha/test_unit'
 require 'date'
 require 'holidays'
 require 'holidays/core_extensions/date'
+require 'holidays/core_extensions/time'
 
 # Loads core extension for use in various definition tests as necessary
 class Date
   include Holidays::CoreExtensions::Date
 end
 
+class Time
+  include Holidays::CoreExtensions::Time
+end 
+
 module Holidays
   # Test region used for generating a holiday on Date.today
   module Test # :nodoc:

data/test/test_holidays.rb

@@ -139,6 +139,61 @@ class HolidaysTests < Test::Unit::TestCase
     end
   end
 
+  def test_year_holidays
+    # Should return 10 holidays from February 23 to December 31
+    holidays = Holidays.year_holidays([:ca_on], Date.civil(2016, 2, 23))
+    assert_equal 10, holidays.length
+
+    # Must have options (Regions)
+    assert_raises ArgumentError do 
+      Holidays.year_holidays([], Date.civil(2016, 2, 23))
+    end 
+
+    # Options must be in the form of an array.  
+    assert_raises ArgumentError do 
+      Holidays.year_holidays(:ca_on, Date.civil(2016, 2, 23))
+    end 
+  end 
+
+  def test_year_holidays_with_specified_year
+    # Should return all 12 holidays for 2016 in Ontario, Canada
+    holidays = Holidays.year_holidays([:ca_on], Date.civil(2016, 1, 1))
+    assert_equal 12, holidays.length
+
+    # Should return all 12 holidays for 2016 in Australia
+    holidays = Holidays.year_holidays([:au], Date.civil(2016, 1, 1))
+    assert_equal 5, holidays.length
+  end 
+
+  def test_year_holidays_without_specified_year 
+    # Gets holidays for current year from today's date
+    holidays = Holidays.year_holidays([:ca_on])
+    assert_equal holidays.first[:date].year, Date.today.year
+  end 
+
+  def test_year_holidays_feb_29_on_non_leap_year
+    # Should throw argument error for invalid date
+    assert_raises ArgumentError do 
+      Holidays.year_holidays([:ca_on], Date.civil(2015, 2, 29))
+    end
+  end 
+
+  def test_year_holidays_random_years
+    # Should be 1 less holiday, as Family day didn't exist in Ontario in 1990
+    holidays = Holidays.year_holidays([:ca_on], Date.civil(1990, 1, 1))
+    assert_equal 11, holidays.length
+
+    # Family day still didn't exist in 2000
+    holidays = Holidays.year_holidays([:ca_on], Date.civil(2000, 1, 1))
+    assert_equal 11, holidays.length
+
+    holidays = Holidays.year_holidays([:ca_on], Date.civil(2020, 1, 1))
+    assert_equal 12, holidays.length
+
+    holidays = Holidays.year_holidays([:ca_on], Date.civil(2050, 1, 1))
+    assert_equal 12, holidays.length
+  end 
+
   def test_sub_regions
     # Should return Victoria Day.
     holidays = Holidays.between(Date.civil(2008,5,1), Date.civil(2008,5,31), :ca)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: holidays
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Alex Dunae
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-18 00:00:00.000000000 Z
+date: 2016-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -230,6 +230,7 @@ files:
 - lib/generated_definitions/za.rb
 - lib/holidays.rb
 - lib/holidays/core_extensions/date.rb
+- lib/holidays/core_extensions/time.rb
 - lib/holidays/date_calculator/day_of_month.rb
 - lib/holidays/date_calculator/easter.rb
 - lib/holidays/date_calculator/weekend_modifier.rb
@@ -256,6 +257,7 @@ files:
 - lib/holidays/use_case/context/context_common.rb
 - lib/holidays/use_case/context/dates_driver_builder.rb
 - lib/holidays/use_case/context/next_holiday.rb
+- lib/holidays/use_case/context/year_holiday.rb
 - lib/holidays/use_case_factory.rb
 - lib/holidays/version.rb
 - test/data/test_custom_govt_holiday_defs.yaml
@@ -320,6 +322,7 @@ files:
 - test/defs/test_defs_vi.rb
 - test/defs/test_defs_za.rb
 - test/holidays/core_extensions/test_date.rb
+- test/holidays/core_extensions/test_date_time.rb
 - 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
@@ -437,6 +440,7 @@ test_files:
 - test/defs/test_defs_vi.rb
 - test/defs/test_defs_za.rb
 - test/holidays/core_extensions/test_date.rb
+- test/holidays/core_extensions/test_date_time.rb
 - 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