holidays 5.2.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6d31623329597545a952074f25ebce282d0fe5e
-  data.tar.gz: aeac59f19f9daf945edcf3570edbfe655a582c75
+  metadata.gz: 48d40a353408c8718766db07f2d93af0919ee634
+  data.tar.gz: 7c048aa0dbd4d88aebe9de8911813a335f518c7a
 SHA512:
-  metadata.gz: 7dbddcad5a4c32ec56bd0dee354fe6323752c8205f147a6b935d9723050eb590df5c15c18caaea97ec812617f850b181581046c5d06882552b969d51458b6588
-  data.tar.gz: 73ada22bfbca45a7adafa80ecbaeb44ba9c330b6eab55b6edbe5ccaadaee9ef0edf351834e23bf7cf3f5d4caebd716299348f917275db01b0431ddea79968f74
+  metadata.gz: 272e786897df3caf4fbdf2031cfc920493705f61f6d411547d5714f15e613756d50f37a514abedec0e27902c510d4d37ae3313c60e69ccee89998db657c069c2
+  data.tar.gz: d24f51fa3bc7f7668bf67956f3a2aad2ab213f235ea8ac716f8cd08910a82d4cb684f205d9b328f23b602647cbed1215eb5371ab19a67daa1be71104fe3bd6cd

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Ruby Holidays Gem CHANGELOG
 
+## 5.2.1
+
+* Fix caching (i.e. calls to `cache_between`) to...you know, actually cache correctly and give
+  performance improvements. Thanks to https://github.com/AnotherJoSmith for the fix!
+
 ## 5.2.0
 
 * Point to latest (v1.2.0 of definitions)

data/README.md

@@ -153,6 +153,15 @@ Or find end of month for given date (requires 'Time' extensions as well):
     d.end_of_month
     => #<Date: 2016-08-31 ((2457632j,0s,0n),+0s,2299161j)>
 
+
+### Caching Holiday Lookups
+
+If you are checking holidays regularly you can cache your results for improved performance. Run this before looking up a holiday (eg. in an initializer):
+
+    Holidays.cache_between(Time.now, 2.years.from_now, :ca, :us, :observed)
+
+Holidays for the regions specified within the dates specified will be pre-calculated and stored in-memory. Future lookups will be much faster.
+
 ### How to contribute
 
 See our [contribution guidelines](CONTRIBUTING.md) for information on how to help out!

data/lib/holidays.rb

@@ -29,7 +29,7 @@ module Holidays
     end
 
     def on(date, *options)
-      between(date, date, options)
+      between(date, date, *options)
     end
 
     def between(start_date, end_date, *options)

data/lib/holidays/definition/repository/cache.rb

@@ -6,14 +6,14 @@ module Holidays
           reset!
         end
 
-        def cache_between(start_date, end_date, cache_data, *options)
+        def cache_between(start_date, end_date, cache_data, options)
           raise ArgumentError unless cache_data
 
           @cache_range[options] = start_date..end_date
           @cache[options] = cache_data
         end
 
-        def find(start_date, end_date, *options)
+        def find(start_date, end_date, options)
           if range = @cache_range[options]
             if range.begin <= start_date && range.end >= end_date
               return @cache[options].select do |holiday|

data/lib/holidays/version.rb

@@ -1,3 +1,3 @@
 module Holidays
-  VERSION = '5.2.0'
+  VERSION = '5.2.1'
 end

data/test/integration/test_holidays.rb

@@ -269,17 +269,17 @@ class HolidaysTests < Test::Unit::TestCase
     cache_data = Holidays.between(start_date, end_date, :ca, :informal)
     options = [:ca, :informal]
 
-    Holidays::Factory::Definition.cache_repository.expects(:cache_between).with(start_date, end_date, cache_data, options)
-
     Holidays.cache_between(Date.civil(2008,3,21), Date.civil(2008,3,25), :ca, :informal)
 
-    # Test that cache has been set and it returns the same as before
-    assert_equal 1, Holidays.on(Date.civil(2008, 3, 21), :ca, :informal).length
-    assert_equal 1, Holidays.on(Date.civil(2008, 3, 24), :ca, :informal).length
-
     # Test that correct results are returned outside the cache range, and with no caching
     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
+
+    Holidays::Factory::Finder.expects(:between).never # Make sure cache is hit for two next call
+
+    # Test that cache has been set and it returns the same as before
+    assert_equal 1, Holidays.on(Date.civil(2008, 3, 21), :ca, :informal).length
+    assert_equal 1, Holidays.on(Date.civil(2008, 3, 24), :ca, :informal).length
   end
 
   def test_load_all

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: holidays
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.2.1
 platform: ruby
 authors:
 - Alex Dunae
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-23 00:00:00.000000000 Z
+date: 2016-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler