holidays 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7ac864cf9a702e79f70f0781f4a9f0739a7909c
-  data.tar.gz: b2f694914ebcf0cd36a7e5b531fd3cc3a9aec3b3
+  metadata.gz: 77b3290ef77ac73e4c81a51e2d74b2b68ef60533
+  data.tar.gz: f72a5fde80cdbfd9162900fd3d136a19021ae813
 SHA512:
-  metadata.gz: 2478e61ae75f0d08de0b50c1d7f7a8ec214efc2a919fae11f86866a1fa8c9834b322cef0728fa754fffa32470282ebec807fbe97844e6cb3f911bbb50db3792a
-  data.tar.gz: 01d5ff2c9345147b92c6f13fa7c009f52dfb7939f9c133da9ba36878c6164c957e1ddea81a56a9b31eeaf4cf0bf4cbb0b4199274a9b6027fcade5551a6b941e0
+  metadata.gz: e31642097c28e4b700ec95fe24ee45130df17293024068bddd78f574501b65dced6c5dc54c86eb53c27ecd4e5eff802830b6db216f51443fbcd34ac1813fe2c5
+  data.tar.gz: e8277aacc33b835caa5b7404f9e348ac5533355fb99113b596a20081c0a64714c677a30ce478ab156cb2b58e92fc5d63c26d042a080132baffdeb9318405c818

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Ruby Holidays Gem CHANGELOG
 
+## 5.1.0
+
+* Add `load_all` method to `Holidays` namespace to preload all definitions (i.e. no lazy loading)
+* Fix issue-234: correctly load available regions so there is no error on `Holidays.available_regions` call
+
 ## 5.0.0
 
 * Remove support for jruby 1.7 (this is the main reason for the major semver bump)

data/lib/holidays.rb

@@ -9,44 +9,6 @@ require 'holidays/factory/finder'
 require 'holidays/errors'
 require 'holidays/load_all_definitions'
 
-# == Region options
-# Holidays can be defined as belonging to one or more regions and sub regions.
-# The Holidays#on, Holidays#between, Date#holidays and Date#holiday? methods
-# each allow you to specify a specific region.
-#
-# There are several different ways that you can specify a region:
-#
-# [<tt>:region</tt>]
-#   By region. For example, return holidays in the Canada with <tt>:ca</tt>.
-# [<tt>:region_</tt>]
-#   By region and sub regions. For example, return holidays in Germany
-#   and all its sub regions with <tt>:de_</tt>.
-# [<tt>:region_sub</tt>]
-#   By sub region. Return national holidays in Spain plus holidays in Spain's
-#   Valencia region with <tt>:es_v</tt>.
-# [<tt>:any</tt>]
-#   Any region.  Return holidays from any loaded region.
-#
-#
-# You can load all the available holiday definition sets by running
-#   Holidays.load_all
-# == Other options
-# [<tt>:observed</tt>]    Return holidays on the day they are observed (e.g. on a Monday if they fall on a Sunday).
-# [<tt>:informal</tt>]    Include informal holidays (e.g. Valentine's Day)
-#
-# == Examples
-# Return all holidays in the <tt>:ca</tt> and <tt>:us</tt> regions on the day that they are
-# observed.
-#
-#   Holidays.between(from, to, :ca, :us, :observed)
-#
-# Return all holidays in <tt>:ca</tt> and any <tt>:ca</tt> sub-region.
-#
-#   Holidays.between(from, to, :ca_)
-#
-# Return all holidays in <tt>:ca_bc</tt> sub-region (which includes the <tt>:ca</tt>), including informal holidays.
-#
-#   Holidays.between(from, to, :ca_bc, :informal)
 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]
@@ -56,13 +18,6 @@ module Holidays
   FULL_DEFINITIONS_PATH = File.expand_path(File.dirname(__FILE__) + "/#{DEFINITIONS_PATH}")
 
   class << self
-    # Does the given work-week have any holidays?
-    #
-    # [<tt>date</tt>]   A Date object.
-    # [<tt>:options</tt>] One or more region symbols, and/or <tt>:informal</tt>. Automatically includes <tt>:observed</tt>. If you don't want this, pass <tt>:no_observed</tt>
-    #
-    # The given Date can be any day of the week.
-    # Returns true if any holidays fall on Monday - Friday of the given week.
     def any_holidays_during_work_week?(date, *options)
       days_to_monday = date.wday - 1
       days_to_friday = 5 - date.wday
@@ -73,35 +28,10 @@ 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.
-    #
-    # Each holiday is returned as a hash with the following fields:
-    # [<tt>start_date</tt>]  Ruby Date object.
-    # [<tt>end_date</tt>]    Ruby Date object.
-    # [<tt>options</tt>]     One or more region symbols, <tt>:informal</tt> and/or <tt>:observed</tt>.
-    #
-    # ==== Example
-    #   from = Date.civil(2008,7,1)
-    #   to   = Date.civil(2008,7,31)
-    #
-    #   Holidays.between(from, to, :ca, :us)
-    #   => [{:name => 'Canada Day', :regions => [:ca]...}
-    #       {:name => 'Independence Day'', :regions => [:us], ...}]
     def between(start_date, end_date, *options)
       raise ArgumentError unless start_date && end_date
 
@@ -118,25 +48,6 @@ module Holidays
       Factory::Finder.between.call(start_date, end_date, options)
     end
 
-    # Get next holidays occuring from date, inclusively.
-    #
-    # Returns an array of hashes or nil.
-    #
-    # Incoming arguments are below:
-    # [<tt>holidays_count</tt>]  Ruby Numeric object. This is the number of holidays to return
-    # [<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 = [:us, :informal]
-    #
-    #   Holidays.next_holidays(3, regions)
-    #   => [{:name => "St. Patrick's Day",...},
-    #       {:name => "Good Friday",...},
-    #       {:name => "Easter Sunday",...}]
     def next_holidays(holidays_count, options, from_date = Date.today)
       raise ArgumentError unless holidays_count
       raise ArgumentError if options.empty?
@@ -150,31 +61,6 @@ module Holidays
       Factory::Finder.next_holiday.call(holidays_count, from_date, options)
     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)
@@ -186,7 +72,6 @@ module Holidays
       Factory::Finder.year_holiday.call(from_date, options)
     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)
       cache_data = between(start_date, end_date, *options)
@@ -194,12 +79,11 @@ module Holidays
       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.
     def available_regions
+      require "#{DEFINITIONS_PATH}/REGIONS"
       Holidays::REGIONS
     end
 
-    # 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, _ = Factory::Definition.file_parser.parse_definition_files(files)
 
@@ -212,6 +96,19 @@ module Holidays
       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)

data/lib/holidays/version.rb

@@ -1,3 +1,3 @@
 module Holidays
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end

data/test/integration/README.md

@@ -2,7 +2,7 @@
 
 These tests are dependent on the files in /definitions (and, by proxy, /lib/generated_definitions).
 It is possible that these tests will break because of 'unrelated' definition changes. The code
-behind these changes could still be good but since the defintions changed we could see failures.
+behind these changes could still be good but since the definitions changed we could see failures.
 
 These are not unit tests. This is not testing whether specific internal code is working. These are
 tests from the consumer perspective. You must recognize that this could fail because of code

data/test/integration/test_available_regions.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+class AvailableRegionsTests < Test::Unit::TestCase
+  def setup
+    @date = Date.civil(2008,1,1)
+  end
+
+  def test_available_regions_returns_array
+    assert Holidays.available_regions.is_a?(Array)
+  end
+
+  def test_available_regions_returns_array_of_symbols
+    Holidays.available_regions.each do |r|
+      assert r.is_a?(Symbol)
+    end
+  end
+
+  # This test might fail if we add new regions. Since this is an integration test
+  # I am fine with that!
+  def test_available_regions_returns_correct_number_of_regions
+    assert_equal 294, Holidays.available_regions.count
+  end
+end

data/test/integration/test_holidays.rb

@@ -281,4 +281,9 @@ class HolidaysTests < Test::Unit::TestCase
     assert_equal 1, Holidays.on(Date.civil(2035,1,1), :ca, :informal).length
     assert_equal 1, Holidays.on(Date.civil(2035,1,1), :us).length
   end
+
+  def test_load_all
+    Holidays.load_all
+    assert_equal 294, Holidays.available_regions.count
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: holidays
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Alex Dunae
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-24 00:00:00.000000000 Z
+date: 2016-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -310,6 +310,7 @@ files:
 - test/holidays/finder/rules/test_year_range.rb
 - test/integration/README.md
 - test/integration/test_all_regions.rb
+- test/integration/test_available_regions.rb
 - test/integration/test_custom_holidays.rb
 - test/integration/test_custom_year_range_holidays.rb
 - test/integration/test_holidays.rb
@@ -439,6 +440,7 @@ test_files:
 - test/holidays/finder/rules/test_year_range.rb
 - test/integration/README.md
 - test/integration/test_all_regions.rb
+- test/integration/test_available_regions.rb
 - test/integration/test_custom_holidays.rb
 - test/integration/test_custom_year_range_holidays.rb
 - test/integration/test_holidays.rb