holidays 4.2.0 → 8.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c74b677a9819268733c692afe11958c2cf1ccaed
-  data.tar.gz: faedba7eb3f149f92de77ddb7ec567cc708a2485
+SHA256:
+  metadata.gz: 52c9a215e254d58739f7d8a48d4e1c4057ce10fa146604ed10dd062155103ed1
+  data.tar.gz: 0b5c0c77a7dc1135b516ae88196db1def87813f29d69dcbf15f787d75aee2363
 SHA512:
-  metadata.gz: 7530fa6ee86e2c3fe1136eac771c0d307d89cdb4e870c7fc2f4de8d14af8a967055c1c75ee6299a3e0f6238f3c50ea832c6db715c854a1a09814e32bdd397276
-  data.tar.gz: 9a608809435239e4ae5a7b7d6f97e3ae085afdd40eac49808b9947287f404442af265bd529508b3c1dfeae3b5f90c209fe967d78615de28906a327dd4222ee26
+  metadata.gz: b6534de20527e1359dfa809b3cdfd4bb9f1a8b4b2ea6fb5593ff28c0d875b8b271bc2009a308d3ee03b936ab6d56e02be82c1b675859f22cedbd69be42ac0790
+  data.tar.gz: c6ca55b847d05375cc6f4d90046d84d2afce8a93b3e4598ca5be36c01a6c9ef0fa68c98f6a2540d1a04fd8071d1073aa5dece5deb033ee725c41d96f3ba9e805

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "definitions"]
+	path = definitions
+	url = https://github.com/holidays/definitions

data/CHANGELOG.md

@@ -1,5 +1,200 @@
 # Ruby Holidays Gem CHANGELOG
 
+## 8.4.1
+
+* Fix jp holidays from 2022. 
+
+## 8.4.0
+
+* Update submodule definitions. 
+* Thanks to contributors!!
+
+
+## 8.3.0
+
+* Update submodule definitions. 
+* Remove test about feb 29 on non leap year.
+* Thanks to contributors!!
+
+## 8.2.0
+
+* Update submodule definitions. Thanks to contributors!!
+
+## 8.1.0
+
+* Update submodule definitions, so that the newest holidays from the definition
+  gem are represent here.
+
+## 8.0.0
+
+* Remove support for ruby 2.2 and ruby 2.3.
+* Add support for latest ruby 2.6
+* Update to [v5.0.1 definitions](https://github.com/holidays/definitions/releases/tag/v5.0.1). Please see the changelog for the definition details.
+
+## 7.1.0
+
+* Update to [v4.1.0 definitions](https://github.com/holidays/definitions/releases/tag/v4.1.0). Please see the changelog for the definition details.
+
+## 7.0.0
+
+Major semver bump due to the major version change in the [definitions](https://github.com/holidays/definitions/blob/master/CHANGELOG.md#400). Several non ISO regions have been modified in order to provide more clarity for parent and sub-regions.
+
+Affected regions:
+
+* `ecb_target` region changed to `ecbtarget`
+* `federal_reserve` region changed to `federalreserve`
+* `federalreservebanks` region changed to `federalreservebanks`
+* `north_america_informal` region changed to `northamericainformal`
+* `united_nations` region changed to `unitednations`
+* `north_america` region changed to `northamerica`
+* `south_america` region changed to `southamerica`
+
+Please see the [definitions v4.0.0 CHANGELOG](https://github.com/holidays/definitions/blob/master/CHANGELOG.md#400) for the full change list.
+
+## 6.6.1
+
+* Fixes `any_holidays_during_work_week?` so that it actually does what it says it does [issue-264](https://github.com/holidays/holidays/issues/264)
+
+## 6.6.0
+
+* Update to [v3.0.0 definitions](https://github.com/holidays/definitions/releases/tag/v3.0.0). This required updates to the custom method parser but no behavior changes.
+* Remove unused `simplecov-rcov` from gemspec dev dependencies
+* Fix parent region loading bug [PR](https://github.com/holidays/holidays/pull/320) (thanks to chadrschroeder)
+* Fix `ruby-head` build caused by new 'endless range' feature in ruby 2.6.0 [PR](https://github.com/holidays/holidays/pull/321)
+* Refactor definition search logic for improved readability [PR](https://github.com/holidays/holidays/pull/318) (thanks to https://github.com/guizma)
+* Reorganize most documentation into the `docs/` directory
+* Fix list of covered rubies in README
+
+## 6.5.0
+
+* Update to [v2.5.2 definitions](https://github.com/holidays/definitions/releases/tag/v2.5.2). Please see the changelog for the definition details.
+* Fix permissions on `bin` executables (thanks to github.com/JuanitoFatas)
+
+## 6.4.0
+
+* Update to [v2.4.0 definitions](https://github.com/holidays/definitions/releases/tag/v2.4.0). Please see the changelog for the definition details.
+
+## 6.3.0
+
+* Update to [v2.3.0 definitions](https://github.com/holidays/definitions/releases/tag/v2.3.0). Please see the changelog for the definition details.
+
+## 6.2.0
+
+* Update to [v2.2.1 definitions](https://github.com/holidays/definitions/releases/tag/v2.2.1). Please see the changelog for the definition details.
+* README update to add `:federal_reserve` examples (thanks to https://github.com/aahmad)
+
+## 6.1.0
+
+* Update to [v2.1.1 definitions](https://github.com/holidays/definitions/releases/tag/v2.1.1). Please see the changelog for
+  the definitions for details.
+
+## 6.0.0
+
+* Remove support for ruby 2.1.0 since it is [no longer officially supported](https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/). This is the cause of the major
+  version bump.
+* Update to [v2.0.0 definitions](https://github.com/holidays/definitions/releases/tag/v2.0.0). This changes the format
+  of definition tests and requires the other changes.
+* Rewrite test generation logic to consume new YAML format.
+
+To be crystal clear: this version should not behave differently in terms of holiday results than v5.7.0 of the gem. Any
+differences are a bug that should be addressed.
+
+## 5.7.0
+
+* Update to [v1.7.1 definitions](https://github.com/holidays/definitions/releases/tag/v1.7.1). Please see the
+  definitions repository for the list of changes.
+* Remove 'coveralls'. We never looked at the reports. We will we simplecov to enforce test coverage. It will
+  start off being set to require 99% and above.
+
+## 5.6.0
+
+* Update to v1.6.1 definitions, which includes updates for the `:ca` region (and subregions)
+
+## 5.5.1
+
+* Update to v1.5.1 definitions, which includes bugfix in `fedex` custom method
+
+## 5.5.0
+
+* Fix [#251](https://github.com/holidays/holidays/issues/251): `load_custom` would override all other definitions
+* Fix [#266](https://github.com/holidays/holidays/issues/266): `:any` does not return expected results
+* Fix [#265](https://github.com/holidays/holidays/issues/265): Jersey/je not loaded as expected when pulling `:gb`
+* Add lunar date calculations, which are used in `:kr` and `:vi` definitions (thanks to https://github.com/jonathanpike)
+* Improve cache performance (thanks to https://github.com/mzruya)
+* Remove incorrect comments in definition generation (thanks to https://github.com/morrme)
+* Fix bug related to definition functions inadvertently affecting subsequent date calculations
+* Point to latest version (1.5.0) of definitions, which includes:
+  * Add Vietnamese holidays
+  * Updates Australian holidays
+  * Updates Korean holidays to use native language and fancy lunar date calculations
+  * Fix NYSE definitions to correctly calculate observed "New Year's Day"
+
+## 5.4.0
+
+* Add support for ruby 2.4.0 (added it to the required tests in Travis CI)
+* Fix issue [#250](https://github.com/holidays/holidays/issues/250), which was that subregions were 'lost' if there was more than one underscore in it (thanks to https://github.com/chinito)
+* Fix caching when using Date extensions (thanks to https://github.com/alexgerstein)
+* Remove unused weekend date calculator method (thanks to https://github.com/ttwo32)
+* Use FULL_DEFINITIONS_PATH when loading definitions to avoid NameErrors when iterating whole LOAD_PATH (thanks to https://github.com/burke)
+* Point to latest version (1.3.0) of definitions, which includes:
+  * Add Tunisian (tn) holidays (thanks to https://github.com/achr3f)
+  * Corrects various Australian holidays
+  * Update certain German regions for accuracy
+  * Change 'yk' to 'yt'
+
+## 5.3.0
+
+* Fix `ca` province/territory codes for 'Newfoundland and Labrador' and 'Yukon' (thanks to https://github.com/slucaskim)
+
+## 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)
+  * updates `jp` defs to fix 'Foundation Day' name
+  * Fix `ca` defs for observed holidays
+  * Update `au` defs to have Christmas and Boxing Day for all of Australia instead of just individual territories
+  * Update `ie` defs to consolidate St Stephen's Day to use common method instead of custom method
+
+## 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)
+* Remove support for ruby 2.0 (since it is no longer being supported by the core ruby team)
+* Add back the lazy loading of regions (this was removed in the 4.0.0 bump) instead of loading upon require (this should have
+  no outward repercussions for users)
+* Move definitions into their own repository and add as submodule. This will allow for more flexibility for tools written
+  in other languages.
+* Rename `DateCalculatorFactory` to `Factory::DateCalculator`
+
+## 4.7.0
+
+* Fix issue-225 (`LocalJumpError` for certain `jp` definition combinations) (https://github.com/ttwo32)
+* Add Korean Lunar holidays (https://github.com/jonathanpike)
+
+## 4.6.0
+
+* Add holidays for 'Luxembourg' (https://github.com/dunyakirkali)
+
+## 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)
+
+## 4.3.0
+
+* Update Portuguese holidays to restore 4 holidays (https://github.com/ruippeixotog)
+
 ## 4.2.0
 
 * BUGFIX Issue-194: correctly calculate `next_holidays` if next holiday is far in the future

data/Makefile

@@ -0,0 +1,45 @@
+default: test
+
+setup: update-defs
+	bundle install
+
+generate:
+	bundle exec rake generate
+
+test:
+	bundle exec rake test
+
+console:
+	bundle exec rake console
+
+test-region:
+	bundle exec rake test_region $(REGION)
+
+build: clean
+	bundle exec gem build holidays.gemspec
+
+push:
+	bundle exec gem push $(GEM)
+
+update-defs: definitions/
+	git submodule update --init --remote --recursive
+
+definitions: point-to-defs-master
+
+point-to-defs-branch:
+	git submodule add -b $(BRANCH) git@github.com:$(USER)/definitions.git definitions/
+
+point-to-defs-master:
+	git submodule add https://github.com/holidays/definitions definitions/
+
+clean-defs:
+	git rm -f definitions
+	rm -rf .git/modules/definitions
+	git config -f .git/config --remove-section submodule.definitions 2> /dev/null
+
+clean:
+	rm -rf holidays-*.gem
+	rm -rf reports
+	rm -rf coverage
+
+.PHONY: setup test generate console build push update-defs test-region clean-defs point-to-defs-master point-to-defs-branch clean definitions

data/README.md

@@ -1,146 +1,322 @@
-# Ruby Holidays Gem [![Build Status](https://travis-ci.org/holidays/holidays.svg?branch=master)](https://travis-ci.org/holidays/holidays) [![Coverage Status](https://coveralls.io/repos/github/holidays/holidays/badge.svg?branch=master)](https://coveralls.io/github/holidays/holidays?branch=master)
+# Ruby Holidays Gem [![Build Status](https://travis-ci.org/holidays/holidays.svg?branch=master)](https://travis-ci.org/holidays/holidays)
 
-A set of functions to deal with holidays in Ruby.
+Functionality 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).
+Extends Ruby's built-in Date and Time classes and supports custom holiday definition lists.
 
 ## Installation
 
-To install the gem from RubyGems:
+```
+gem install holidays
+```
+
+## Tested versions
+
+This gem is tested with the following ruby versions:
 
-    gem install holidays
+  * 2.4.5
+  * 2.5.3
+  * 2.6.1
+  * JRuby 9.2.5.0
 
-The Holidays gem is tested on Ruby 2.0.0, 2.1.0, 2.2.0, 2.3.0 and JRuby.
+## Semver
 
-This gem follows [semantic versioning](http://semver.org/). The only methods covered by this guarantee are under the
-`Holidays` namespace specifically. Anything that is not a method off of `Holidays` or the core extension is not covered by
-semver. Please take this into account when relying on this gem as a dependency.
+This gem follows [semantic versioning](http://semver.org/). The guarantee specifically covers:
+
+ * methods in the top-most `Holidays` namespace e.g. `Holidays.<method>`
+ * the [core extensions](#extending-rubys-date-and-time-classes)
+
+Please note that we consider definition changes to be 'minor' bumps, meaning they are backwards compatible with your code but might give different holiday results!
 
 ## Time zones
 
 Time zones are ignored.  This library assumes that all dates are within the same time zone.
 
-### Using the Holidays class
+## Usage
 
-Get all holidays on April 25, 2008 in Australia.
+This gem offers multiple ways to check for holidays for a variety of scenarios.
 
-    date = Date.civil(2008,4,25)
+#### Checking a specific date
 
-    Holidays.on(date, :au)
-    => [{:name => 'ANZAC Day',...}]
+Get all holidays on April 25, 2008 in Australia:
 
-Get holidays that are observed on July 2, 2007 in British Columbia, Canada.
+```
+Holidays.on(Date.civil(2008, 4, 25), :au)
+=> [{:name => 'ANZAC Day',...}]
+```
 
-    date = Date.civil(2007,7,2)
+You can check multiple regions in a single call:
 
-    Holidays.on(date, :ca_bc, :observed)
-    => [{:name => 'Canada Day',...}]
+```
+Holidays.on(Date.civil(2008, 1, 1), :us, :fr)
+=> [{:name=>"New Year's Day", :regions=>[:us],...},
+    {:name=>"Jour de l'an", :regions=>[:fr],...}]
+```
 
-Get all holidays in July, 2008 in Canada and the US.
+You can leave off 'regions' to get holidays for any region in our [definitions](https://github.com/holidays/definitions):
 
-    from = Date.civil(2008,7,1)
-    to = Date.civil(2008,7,31)
+```
+ Holidays.on(Date.civil(2007, 4, 25))
+=> [{:name=>"ANZAC Day", :regions=>[:au],...},
+    {:name=>"Festa della Liberazione", :regions=>[:it],...},
+    {:name=>"Dia da Liberdade", :regions=>[:pt],...}
+    ...
+   ]
+```
 
-    Holidays.between(from, to, :ca, :us)
-    => [{:name => 'Canada Day',...}
-        {:name => 'Independence Day',...}]
+#### Checking a date range
 
-Get informal holidays in February.
+Get all holidays during the month of July 2008 in Canada and the US:
 
-    from = Date.civil(2008,2,1)
-    to = Date.civil(2008,2,15)
+```
+from = Date.civil(2008,7,1)
+to = Date.civil(2008,7,31)
 
-    Holidays.between(from, to, :informal)
-    => [{:name => 'Valentine\'s Day',...}]
+Holidays.between(from, to, :ca, :us)
+=> [{:name => 'Canada Day',...}
+    {:name => 'Independence Day',...}]
+```
 
-Return all available regions:
+#### Check for 'informal' holidays
+
+You can pass the 'informal' flag to include holidays specified as informal in your results. See [here](https://github.com/holidays/definitions/blob/master/doc/SYNTAX.md#formalinformal) for information on what constitutes 'informal' vs 'formal'.
+
+By default this flag is turned off, meaning no informal holidays will be returned.
+
+Get Valentine's Day in the US:
+
+```
+Holidays.on(Date.new(2018, 2, 14), :us, :informal)
+=> [{:name=>"Valentine's Day",...}]
+```
+
+Leaving off 'informal' will mean that Valentine's Day is not returned:
+
+```
+Holidays.on(Date.new(2018, 2, 14), :us)
+=> []
+```
+
+Get informal holidays during the month of February 2008 for any region:
+
+```
+from = Date.civil(2008,2,1)
+to = Date.civil(2008,2,15)
+
+Holidays.between(from, to, :informal)
+=> [{:name => 'Valentine\'s Day',...}]
+```
+
+#### Check for 'observed' holidays
+
+You can pass the 'observed' flag to include holidays that are observed on different days than they actually occur. See [here](https://github.com/holidays/definitions/blob/master/doc/SYNTAX.md#observed) for further explanation of 'observed'.
+
+By default this flag is turned off, meaning no observed logic will be applied.
+
+Get holidays that are observed on Monday July 2, 2007 in British Columbia, Canada:
+
+```
+Holidays.on(Date.civil(2007, 7, 2), :ca_bc, :observed)
+=> [{:name => 'Canada Day',...}]
+```
+
+Leaving off the 'observed' flag will mean that 'Canada Day' is not returned since it actually falls on Sunday July 1:
 
-    Holidays.available_regions
-    => [:ar, :at, ..., :sg] # this will be a big array
+```
+Holidays.on(Date.civil(2007, 7, 2), :ca_bc)
+=> []
+Holidays.on(Date.civil(2007, 7, 1), :ca_bc)
+=> [{:name=>"Canada Day", :regions=>[:ca],...}]
+```
 
-To check if there are any holidays taking place during a specified work week:
+Get all observed US Federal holidays between 2018 and 2019:
 
-    Holidays.any_holidays_during_work_week?(Date.civil(2016, 1, 1))
-    => true
+```
+from = Date.civil(2018,1,1)
+to = Date.civil(2019,12,31)
 
-To find and return the next holidays occurring from date, inclusively:
+Holidays.between(from, to, :federalreserve, :observed)
+=> [{:name => "New Year's Day"....}
+    {:name => "Birthday of Martin Luther King, Jr"....}]
+```
 
-    Holidays.next_holidays(3, [:us, :informal], Date.civil(2016, 2, 23))
-    => [{:name => "St. Patrick's Day",...}, {:name => "Good Friday",...}, {:name => "Easter Sunday",...}]
+#### Check whether any holidays occur during work week
 
-Will default to `Date.today` if no date is provided.
+Check if there are any holidays taking place during a specified work week. 'Work week' is defined as the period of Monday through Friday of the week specified by the date.
 
-### Loading Custom Definitions on the fly
+Check whether a holiday falls during first week of the year for any region:
 
-Load custom definitions file on the fly and use them immediately.
+```
+Holidays.any_holidays_during_work_week?(Date.civil(2016, 1, 1))
+=> true
+```
 
-Load custom 'Company Founding' holiday on June 1st:
+You can also pass in `informal` or `observed`:
 
-    Holidays.load_custom('/home/user/holiday_definitions/custom_holidays.yaml')
+```
+# Returns true since Valentine's Day falls on a Wednesday
+holidays.any_holidays_during_work_week?(date.civil(2018, 2, 14), :us, :informal)
+=> true
+# Returns false if you don't specify informal
+irb(main):006:0> Holidays.any_holidays_during_work_week?(Date.civil(2018, 2, 14), :us)
+=> false
+# Returns true since Veteran's Day is observed on Monday November 12, 2018
+holidays.any_holidays_during_work_week?(date.civil(2018, 11, 12), :us, :observed)
+=> true
+# Returns false if you don't specify observed since the actual holiday is on Sunday November 11th 2018
+irb(main):005:0> Holidays.any_holidays_during_work_week?(Date.civil(2018, 11, 12), :us)
+=> false
+```
 
-    date = Date.civil(2013,6,1)
+#### Find the next holiday(s) that will occur from a specific date
 
-    Holidays.on(date, :my_custom_region)
-      => [{:name => 'Company Founding',...}]
+Get the next holidays occurring from February 23, 2016 for the US:
 
-Custom definition files must match the format of the existing definition YAML files location in the 'definitions' directory.
+```
+Holidays.next_holidays(3, [:us, :informal], Date.civil(2016, 2, 23))
+=> [{:name => "St. Patrick's Day",...}, {:name => "Good Friday",...}, {:name => "Easter Sunday",...}]
+```
 
-Multiple files can also be passed:
+You can specify the number of holidays to return. This method will default to `Date.today` if no date is provided.
 
-    Holidays.load_custom('/home/user/holidays/custom_holidays1.yaml', '/home/user/holidays/custom_holidays2.yaml')
+#### Find all holidays occuring starting from a specific date to the end of the year
 
-### Extending Ruby's Date class
+Get all holidays starting from February 23, 2016 to end of year in the US:
+
+```
+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",...}]
+```
+
+This method will default to `Date.today` if no date is provided.
+
+#### Return all available regions
+
+Return all available regions:
+
+```
+Holidays.available_regions
+=> [:ar, :at, ..., :sg] # this will be a big array
+```
+
+## Loading Custom Definitions on the fly
+
+In addition to the [provided definitions](https://github.com/holidays/definitions) you can load custom definitions file on the fly and use them immediately.
+
+To load custom 'Company Founding' holiday on June 1st:
+
+```
+Holidays.load_custom('/home/user/holiday_definitions/custom_holidays.yaml')
+Holidays.on(Date.civil(2013, 6, 1), :my_custom_region)
+  => [{:name => 'Company Founding',...}]
+```
+
+Custom definition files must match the [syntax of the existing definition files](https://github.com/holidays/definitions/blob/master/doc/SYNTAX.md).
+
+Multiple files can be loaded at the same time:
+
+```
+Holidays.load_custom('/home/user/holidays/custom_holidays1.yaml', '/home/user/holidays/custom_holidays2.yaml')
+```
+
+## Extending Ruby's Date and Time classes
+
+### Date
 
 To extend the 'Date' class:
 
-    require 'holidays/core_extensions/date'
-    class Date
-      include Holidays::CoreExtensions::Date
-    end
+```
+require 'holidays/core_extensions/date'
+class Date
+  include Holidays::CoreExtensions::Date
+end
+```
 
 Now you can check which holidays occur in Iceland on January 1, 2008:
 
-    d = Date.civil(2008,7,1)
+```
+d = Date.civil(2008,7,1)
 
-    d.holidays(:is)
-    => [{:name => 'Nýársdagur'}...]
+d.holidays(:is)
+=> [{:name => 'Nýársdagur'}...]
+```
 
 Or lookup Canada Day in different regions:
 
-    d = Date.civil(2008,7,1)
+```
+d = Date.civil(2008,7,1)
+
+d.holiday?(:ca) # Canada
+=> true
 
-    d.holiday?(:ca) # Canada
-    => true
+d.holiday?(:ca_bc) # British Columbia, Canada
+=> true
 
-    d.holiday?(:ca_bc) # British Columbia, Canada
-    => true
+d.holiday?(:fr) # France
+=> false
+```
 
-    d.holiday?(:fr) # France
-    => false
+Or return the new date based on the options:
+
+```
+d = Date.civil(2008,7,1)
+d.change(:year => 2016, :month => 1, :day => 1)
+=> #<Date: 2016-01-01 ((2457389j,0s,0n),+0s,2299161j)>
+```
 
 Or you can calculate the day of the month:
 
-    Date.calculate_mday(2015, 4, :first, 2)
-    => 7
+```
+Date.calculate_mday(2015, 4, :first, 2)
+=> 7
+```
+
+### Time
+
+```
+require 'holidays/core_extensions/time'
+class Time
+  include Holidays::CoreExtensions::Time
+end
+```
+
+Find end of month for given date:
+
+```
+d = Date.civil(2016,8,1)
+d.end_of_month
+=> #<Date: 2016-08-31 ((2457632j,0s,0n),+0s,2299161j)>
+```
 
-### Caching Holiday Lookups
+## 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):
+If you are checking holidays regularly you can cache your results for improved performance. Run this before looking up a holiday (e.g. in an initializer):
 
-    Holidays.cache_between(Time.now, 2.years.from_now, :ca, :us, :observed)
+```
+YEAR = 365 * 24 * 60 * 60
+Holidays.cache_between(Time.now, Time.now + 2 * YEAR, :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
+## How to contribute
 
-See our [contribution guidelines](CONTRIBUTING.md) for information on how to help out!
+See our [contribution guidelines](doc/CONTRIBUTING.md) for information on how to help out!
 
-### Credits and code
+## Credits and code
 
-* 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
+* Started by [@alexdunae](http://github.com/alexdunae) 2007-2012
+* Maintained by [@hahahana](https://github.com/hahahana), 2013
+* Maintained by [@ppeble](https://github.com/ppeble), 2014-present
+* Maintained by [@ttwo32](https://github.com/ttwo32), 2016-present
 
 Plus all of these [wonderful contributors!](https://github.com/holidays/holidays/contributors)