holidays 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6ab4b51615aa61fac469c01fb99d7d94ad6d876
-  data.tar.gz: 4ee8ff425142c2e74de1ca88784679af0a0c99a5
+  metadata.gz: 858b7ca8ee12adf0ca16bd039b094ac5b396592b
+  data.tar.gz: 6dea8e8c8abc0ecb1e1983a932aa8877c60544ef
 SHA512:
-  metadata.gz: e430c6651f9fd96b2c5ec24fccc1e3f8ac93d11e7726e5f6d4c9265296cfd2ad4bc41da5b629f93d883f0ef05f90471f5a37215585747d76d89be708ad78d259
-  data.tar.gz: e586b641f155808fbfd03ce5a0af6207a890aa55c7fbb514be390e6082110a894d1fa69f82af44ac999b80bca568298c18468227646ff46a49dbc3a8e86d33c9
+  metadata.gz: 9be91c59476aebe6cb91da7ab7c2a7003d0286e2e723c4853f804e62f96b33681bdc2797fe73170dfbd67a659725e2ee34c28717d9da30b0fbc6c523dde90716
+  data.tar.gz: 51a8a704f91f3966ecba80796a02d3087db3966afa8a59f492a9efe7ef272f2f00bf98154fde2dd4ff1b7149506d9ef198ba01163f211ac69f6bea650d890aa9

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Ruby Holidays Gem CHANGELOG
 
+## 1.2.0
+
+* Remove inauguration day from USA Federal Reserve definitions (https://github.com/aripollak)
+* Add caching functionality for date ranges (https://github.com/ndbroadbent & https://github.com/ghiculescu)
+
 ## 1.1.0
 
 * Add support to load custom holidays on the fly

data/README.md

@@ -1,9 +1,11 @@
-# Ruby Holidays Gem
+# Ruby Holidays Gem [![Build Status](https://travis-ci.org/alexdunae/holidays.svg?branch=master)](https://travis-ci.org/alexdunae/holidays)
 
 A set of functions to deal with holidays in Ruby.
 
 Extends Ruby's built-in Date class and supports custom holiday definition lists.
 
+Full documentation can be found [here](http://www.rubydoc.info/github/alexdunae/holidays/master/frames).
+
 ## Installation
 
 To install the gem from RubyGems:
@@ -94,6 +96,14 @@ Lookup Canada Day in different regions.
     d.holiday?(:fr) # France
     => false
 
+### 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.
+
 ### How to contribute
 
 To make changes to any of the definitions, edit the YAML files only.
@@ -106,14 +116,8 @@ It is also very appreciated if documentation is attached to the pull request.  A
 
 ### Credits and code
 
-* Source: https://github.com/alexdunae/holidays
-* Docs: http://rdoc.info/github/alexdunae/holidays/master/frames
-* Contributors: https://github.com/alexdunae/holidays/contributors
-* Build status: http://travis-ci.org/#!/alexdunae/holidays
-
-Started by [Alex Dunae](http://dunae.ca) (e-mail 'code' at the same domain), 2007-12.
-Maintained by [Hana Wang](https://github.com/hahahana), 2013
-
-On Twitter: @MrMrBug.
+* Started by [Alex Dunae](http://dunae.ca) (e-mail 'code' at the same domain), 2007-12
+* Maintained by [Hana Wang](https://github.com/hahahana), 2013
+* Maintained by [Phil Trimble](https://github.com/ptrimble), 2014-present
 
-Made on Vancouver Island. Maintained in the way more beautiful Houston, TX.
+Plus all of these [wonderful contributors!](https://github.com/alexdunae/holidays/contributors)

data/Rakefile

@@ -1,4 +1,5 @@
 $:.unshift File.expand_path('../lib', __FILE__)
+$:.unshift File.expand_path('../test', __FILE__)
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
@@ -8,7 +9,7 @@ require 'holidays'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
-  t.test_files = FileList['test/**/test*.rb']
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
 task :default => :test

data/data/federal_reserve.yaml

@@ -15,9 +15,6 @@ months:
     week: 3
     wday: 1
     regions: [federal_reserve]
-  - name: Inauguration Day
-    function: us_inauguration_day(year)
-    regions: [federal_reserve]
   2:
   - name: Washington's Birthday
     week: 3
@@ -57,14 +54,6 @@ months:
     regions: [federal_reserve]
     mday: 25
     observed: to_monday_if_sunday
-methods:
-  us_inauguration_day: |
-    # January 20, every fourth year, following Presidential election
-    def self.us_inauguration_day(year)
-      year % 4 == 1 ? 20 : nil
-    end
-  
-        
 tests: |
   {Date.civil(2012,1,2) => "New Year's Day",
    Date.civil(2012,1,16) => "Birthday of Martin Luther King, Jr",
@@ -87,7 +76,7 @@ tests: |
    Date.civil(2013,11,11) => "Veterans Day",
    Date.civil(2013,11,28) => "Thanksgiving Day",
    Date.civil(2013,12,25) => "Christmas Day",
-   
+
    Date.civil(2014,1,1) => "New Year's Day",
    Date.civil(2014,1,20) => "Birthday of Martin Luther King, Jr",
    Date.civil(2014,2,17) => "Washington's Birthday",
@@ -120,8 +109,6 @@ tests: |
    Date.civil(2016,11,11) => "Veterans Day",
    Date.civil(2016,11,24) => "Thanksgiving Day",
    Date.civil(2016,12,26) => "Christmas Day",
-
-   Date.civil(2017,1, 20) => "Inauguration Day",
    }.each do |date, name|
      assert_equal name, (Holidays.on(date, :federal_reserve, :observed)[0] || {})[:name]
    end

data/lib/holidays.rb

@@ -51,6 +51,13 @@ module Holidays
   @@holidays_by_month = {}
   @@proc_cache = {}
 
+  @@cache = {}
+  @@cache_range = {}
+  class << self
+    def cache_range; @@cache_range; end
+    def cache; @@cache; end
+  end
+
   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]
   DAY_SYMBOLS = Date::DAYNAMES.collect { |n| n.downcase.intern }
@@ -108,16 +115,14 @@ module Holidays
     end_date = end_date.new_offset(0) + end_date.offset if end_date.respond_to?(:new_offset)
 
     # get simple dates
-    if start_date.respond_to?(:to_date)
-      start_date = start_date.to_date
-    else
-      start_date = Date.civil(start_date.year, start_date.mon, start_date.mday)
-    end
+    start_date, end_date = get_date(start_date), get_date(end_date)
 
-    if end_date.respond_to?(:to_date)
-      end_date = end_date.to_date
-    else
-      end_date = Date.civil(end_date.year, end_date.mon, end_date.mday)
+    if range = @@cache_range[options]
+      if range.begin < start_date && range.end > end_date
+        return @@cache[options].select do |holiday|
+          holiday[:date] >= start_date && holiday[:date] <= end_date
+        end
+      end
     end
 
     regions, observed, informal = parse_options(options)
@@ -179,6 +184,13 @@ module Holidays
     holidays.sort{|a, b| a[:date] <=> b[:date] }
   end
 
+  # Allows a developer to explicitly calculate and cache holidays within a given period
+  def self.cache_between(start_date, end_date, *options)
+    start_date, end_date = get_date(start_date), get_date(end_date)
+    @@cache[options]       = between(start_date, end_date, *options)
+    @@cache_range[options] = start_date..end_date
+  end
+
   # Merge a new set of definitions into the Holidays module.
   #
   # This method is automatically called when including holiday definition
@@ -336,6 +348,14 @@ private
     return regions, observed, informal
   end
 
+  def self.get_date(date)
+    if date.respond_to?(:to_date)
+      date.to_date
+    else
+      Date.civil(date.year, date.mon, date.mday)
+    end
+  end
+
   # Derive the containing region from a sub region wild-card or a sub region
   # and load its definition. (Common code factored out from parse_regions)
   def self.load_containing_region(sub_reg)

data/lib/holidays/federal_reserve.rb

@@ -19,8 +19,7 @@ module Holidays
     def self.holidays_by_month
       {
               1 => [{:mday => 1, :observed => lambda { |date| Holidays.to_monday_if_sunday(date) }, :observed_id => "to_monday_if_sunday", :name => "New Year's Day", :regions => [:federal_reserve]},
-            {:wday => 1, :week => 3, :name => "Birthday of Martin Luther King, Jr", :regions => [:federal_reserve]},
-            {:function => lambda { |year| Holidays.us_inauguration_day(year) }, :function_id => "us_inauguration_day(year)", :name => "Inauguration Day", :regions => [:federal_reserve]}],
+            {:wday => 1, :week => 3, :name => "Birthday of Martin Luther King, Jr", :regions => [:federal_reserve]}],
       2 => [{:wday => 1, :week => 3, :name => "Washington's Birthday", :regions => [:federal_reserve]}],
       5 => [{:wday => 1, :week => -1, :name => "Memorial Day", :regions => [:federal_reserve]}],
       7 => [{:mday => 4, :observed => lambda { |date| Holidays.to_monday_if_sunday(date) }, :observed_id => "to_monday_if_sunday", :name => "Independence Day", :regions => [:federal_reserve]}],
@@ -33,14 +32,6 @@ module Holidays
     end
   end
 
-# January 20, every fourth year, following Presidential election
-def self.us_inauguration_day(year)
-  year % 4 == 1 ? 20 : nil
-end
-
-    
-
-
 
 end
 

data/lib/holidays/version.rb

@@ -1,3 +1,3 @@
 module Holidays
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/test/defs/test_defs_federal_reserve.rb

@@ -28,7 +28,7 @@ class Federal_reserveDefinitionTests < Test::Unit::TestCase  # :nodoc:
  Date.civil(2013,11,11) => "Veterans Day",
  Date.civil(2013,11,28) => "Thanksgiving Day",
  Date.civil(2013,12,25) => "Christmas Day",
- 
+
  Date.civil(2014,1,1) => "New Year's Day",
  Date.civil(2014,1,20) => "Birthday of Martin Luther King, Jr",
  Date.civil(2014,2,17) => "Washington's Birthday",
@@ -61,8 +61,6 @@ class Federal_reserveDefinitionTests < Test::Unit::TestCase  # :nodoc:
  Date.civil(2016,11,11) => "Veterans Day",
  Date.civil(2016,11,24) => "Thanksgiving Day",
  Date.civil(2016,12,26) => "Christmas Day",
-
- Date.civil(2017,1, 20) => "Inauguration Day",
  }.each do |date, name|
    assert_equal name, (Holidays.on(date, :federal_reserve, :observed)[0] || {})[:name]
  end

data/test/test_holidays.rb

@@ -157,4 +157,19 @@ class HolidaysTests < Test::Unit::TestCase
       }
     }
   end
+
+  def test_caching
+    Holidays.cache_between(Date.civil(2008,3,21), Date.civil(2008,3,25), :ca, :informal)
+
+    # Test that cache has been set
+    cache_key = [:ca, :informal]
+    assert_equal Date.civil(2008,3,21), Holidays.cache_range[cache_key].begin
+    assert_equal Date.civil(2008,3,25), Holidays.cache_range[cache_key].end
+    assert_equal Date.civil(2008,3,21), Holidays.cache[cache_key].first[:date]
+    assert_equal Date.civil(2008,3,24), Holidays.cache[cache_key].last[:date]
+
+    # 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
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: holidays
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alex Dunae
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE