holidays 6.4.0 → 8.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 211587fa0f6cc9770aa844987375a9c4494f9268
-  data.tar.gz: 195e0a198d61ded54df5dd59b19abedbf54b0e48
+SHA256:
+  metadata.gz: 9eb1a9a2387a3734d10203b125345004d0c470ccc2394b82e36f57277a487db0
+  data.tar.gz: 9a77c89d65379366e70b9d6e3eed67080ce5fadb096c11dad1b5edb81dee2e8c
 SHA512:
-  metadata.gz: 819cc7b8eca33162c12031432f60d91b2f9d848a26c385d2c126b810b5534ab3279408a025d4571d7700d0a3ad15f3694454d2180c44f0cb2d67607d64185a01
-  data.tar.gz: 1463973d2d30e143217e2049c8a353c6cf8582051b7007cde8e27d252c40a4016a2a772c4714be05c60ca8c2b8c226f8891f625ffa44d17126088decfdfebe48
+  metadata.gz: 5580b2c4ed9f227fc68558382fa2635df1fb234291b7bd554f3675bea59cf81345be20de1cc7fa8babb9cd445cf1d076dde9eebed1947d75a5a956fdf2ae2158
+  data.tar.gz: 210b384735179c141e9c15d0de847449a3e70cd7e468453afd9b038afced110c1ea957b69d48e1196e524a2da3804af1d3502558407f4a9b71e998fb9ae3da64

data/.gitmodules

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

data/CHANGELOG.md

@@ -1,5 +1,85 @@
 # Ruby Holidays Gem CHANGELOG
 
+## 8.6.0
+
+* Update to [v5.5.0 definitions](https://github.com/holidays/definitions/releases/tag/v5.5.0). Please see the changelog for the definition details.
+* Temporarily remove jruby from required jobs due to test coverage issues
+
+## 8.5.0
+
+* Update submodule definitions. 
+* Thanks to contributors!!
+
+## 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.

data/Makefile

@@ -1,6 +1,6 @@
 default: test
 
-setup: update_defs
+setup: update-defs
 	bundle install
 
 generate:
@@ -12,7 +12,7 @@ test:
 console:
 	bundle exec rake console
 
-test_region:
+test-region:
 	bundle exec rake test_region $(REGION)
 
 build: clean
@@ -21,12 +21,25 @@ build: clean
 push:
 	bundle exec gem push $(GEM)
 
-update_defs:
+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
+.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,183 +1,318 @@
 # 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:
+
+  * 2.4.5
+  * 2.5.3
+  * 2.6.1
+  * JRuby 9.2.5.0
 
-    gem install holidays
+## Semver
 
-The Holidays gem is tested on Ruby 2.2.0, 2.3.0, 2.4.0 and JRuby.
+This gem follows [semantic versioning](http://semver.org/). The guarantee specifically covers:
 
-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.
+ * methods in the top-most `Holidays` namespace e.g. `Holidays.<method>`
+ * the [core extensions](#extending-rubys-date-and-time-classes)
 
-Also note that we consider definition changes as 'minor' bumps, meaning they are backwards compatible with your code
-but might give different holiday results!
+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 all US Federal holidays between 2018 and 2019.
+Get all holidays during the month of July 2008 in Canada and the US:
 
-    from = Date.civil(2018,1,1)
-    to = Date.civil(2019,12,31)
+```
+from = Date.civil(2008,7,1)
+to = Date.civil(2008,7,31)
 
-    Holidays.between(from, to, :federal_reserve, :observed)
-    => [{:name => "New Year's Day"....}
-        {:name => "Birthday of Martin Luther King, Jr"....}]
+Holidays.between(from, to, :ca, :us)
+=> [{:name => 'Canada Day',...}
+    {:name => 'Independence Day',...}]
+```
 
-Get informal holidays in February.
+#### Check for 'informal' holidays
 
-    from = Date.civil(2008,2,1)
-    to = Date.civil(2008,2,15)
+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'.
 
-    Holidays.between(from, to, :informal)
-    => [{:name => 'Valentine\'s Day',...}]
+By default this flag is turned off, meaning no informal holidays will be returned.
 
-Return all available regions:
+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',...}]
+```
 
-    Holidays.available_regions
-    => [:ar, :at, ..., :sg] # this will be a big array
+Leaving off the 'observed' flag will mean that 'Canada Day' is not returned since it actually falls on Sunday July 1:
 
-To check if there are any holidays taking place during a specified work week:
+```
+Holidays.on(Date.civil(2007, 7, 2), :ca_bc)
+=> []
+Holidays.on(Date.civil(2007, 7, 1), :ca_bc)
+=> [{:name=>"Canada Day", :regions=>[:ca],...}]
+```
 
-    Holidays.any_holidays_during_work_week?(Date.civil(2016, 1, 1))
-    => true
+Get all observed US Federal holidays between 2018 and 2019:
 
-To find and return the next holidays occurring from date, inclusively:
+```
+from = Date.civil(2018,1,1)
+to = Date.civil(2019,12,31)
 
-    Holidays.next_holidays(3, [:us, :informal], Date.civil(2016, 2, 23))
-    => [{:name => "St. Patrick's Day",...}, {:name => "Good Friday",...}, {:name => "Easter Sunday",...}]
+Holidays.between(from, to, :federalreserve, :observed)
+=> [{:name => "New Year's Day"....}
+    {:name => "Birthday of Martin Luther King, Jr"....}]
+```
 
-Will default to `Date.today` if no date is provided.
+#### Check whether any holidays occur during work week
 
-To find all holidays occuring from date to end of year, inclusively:
+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.
 
-    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",...}]
+Check whether a holiday falls during first week of the year for any region:
 
-Will default to `Date.today` if no date is provided.
+```
+Holidays.any_holidays_during_work_week?(Date.civil(2016, 1, 1))
+=> true
+```
 
-### Loading Custom Definitions on the fly
+You can also pass in `informal` or `observed`:
 
-Load custom definitions file on the fly and use them immediately.
+```
+# 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
+```
 
-Load custom 'Company Founding' holiday on June 1st:
+#### Find the next holiday(s) that will occur from a specific date
 
-    Holidays.load_custom('/home/user/holiday_definitions/custom_holidays.yaml')
+Get the next holidays occurring from February 23, 2016 for the US:
 
-    date = Date.civil(2013,6,1)
+```
+Holidays.next_holidays(3, [:us, :informal], Date.civil(2016, 2, 23))
+=> [{:name => "St. Patrick's Day",...}, {:name => "Good Friday",...}, {:name => "Easter Sunday",...}]
+```
 
-    Holidays.on(date, :my_custom_region)
-      => [{:name => 'Company Founding',...}]
+You can specify the number of holidays to return. This method will default to `Date.today` if no date is provided.
 
-Custom definition files must match the format of the existing definition YAML files location in the 'definitions' directory.
+#### Find all holidays occuring starting from a specific date to the end of the year
 
-Multiple files can also be passed:
+Get all holidays starting from February 23, 2016 to end of year in the US:
 
-    Holidays.load_custom('/home/user/holidays/custom_holidays1.yaml', '/home/user/holidays/custom_holidays2.yaml')
+```
+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",...}]
+```
 
-### Extending Ruby's Date and Time classes
+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)>
+```
+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
+```
 
-Or find end of month for given date (requires 'Time' extensions as well):
+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)>
+```
+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 [@alexdunae](http://github.com/alexdunae) 2007-2012
 * Maintained by [@hahahana](https://github.com/hahahana), 2013

data/Rakefile

@@ -41,7 +41,7 @@ end
 
 desc 'Launch IRB session'
 task :console do
-  sh "irb -rubygems -I lib -r holidays.rb"
+  sh "irb -r rubygems -I lib -r holidays.rb"
 end
 
 desc 'Generate definitions and tests used in main holiday logic based on raw YAML definitions'

data/bin/setup

@@ -1,5 +1,6 @@
 #!/bin/bash
 set -euo pipefail
 IFS=$'\n\t'
+set -vx
 
 bundle install

data/doc/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# How to contribute
+
+There are multiple ways to help! We rely on users around the world to help keep our definitions accurate and up to date. In addition, pull requests to address bugs or implement new features are always welcome.
+
+## Code of Conduct
+
+Please read our [Code of Conduct](../CODE_OF_CONDUCT.md) before contributing. Everyone interacting with this project (or associated projects) is expected to abide by its terms.
+
+## General note
+
+The definitions for this project are housed in a submodule. When pulling this repo please make sure to run `git clone --recursive git@github.com/holidays/holidays`
+or, if you forgot to do so, run `make update-defs` so that all of the submodule data is pulled correctly.
+
+## For definition updates
+
+Our definitions are written in YAML. They are housed in a [separate repository](https://github.com/holidays/definitions) so that they can be used by tools written in other languages. You can find a complete guide to our format in the [definitions SYNTAX guide](https://github.com/holidays/definitions/blob/master/doc/SYNTAX.md).
+
+In this ruby project we take the YAML definitions and generate final ruby classes that are loaded at runtime for fast calculations.
+
+Once you have a good idea on what you want to change, please see the [CONTRIBUTING guide](https://github.com/holidays/definitions/blob/master/doc/CONTRIBUTING.md) in the `definitions` repository.
+
+The idea is that if the validation passes on the other repo then you shouldn't have to worry about generating and testing here. We'll see how that goes!
+
+Once that PR is accepted the maintainers of this project will be responsible for generating the updated definitions here and releasing a new gem. Don't worry about versioning, we'll take care of it!
+
+#### Testing out your definitions locally
+
+As mentioned above we use a git submodule for the definitions. Sometimes you might want to manually test out how this ruby project will behave with your changes. To facilitate that we provide some commands for pointing the definitions submodule to your fork/branch.
+
+To point at your fork/branch:
+
+```sh
+make clean-defs
+BRANCH=<branch-name> USER=<user> make point-to-defs-branch
+```
+
+Example:
+
+```sh
+make clean-defs
+BRANCH=issue-24 USER=ppeble make point-to-defs-branch
+```
+
+This will pull everything down for the latest commit on that fork/branch. When you are done testing and want to point back at the master definitions:
+
+```sh
+make clean-defs
+make point-to-defs-master
+```
+
+## For non-definition functionality
+
+* Fork this repository
+* Make your changes. Don't forget to run `make test` to execute the test suite!
+* Create a PR pointing back to `master`
+
+Don't worry about versioning, we'll handle it on our end.
+
+*Tests are required*. If your PR results in lower test coverage then it will not be accepted.
+
+## Local development helpers
+
+We have included a few handy tasks to help you troubleshoot and test:
+
+* `make test` - runs the entire suite
+* `bundle exec ruby <test-file-to-run>` - runs just the tests in the specified file
+* `REGION=<region> make test-region` - runs the tests for just that region
+* `make console` - launches an IRB session with the 'holidays' gem loaded for quick testing
+* `make update-defs` - runs the appropriate git submodule commands to pull the latest definitions
+* `make clean-defs` - removes the definitions submodule, useful for switching between a fork and the main definitions repository
+* `BRANCH=<branch> USER=<user> make point-to-defs-branch` - updates your definitions submodule to point at a fork/branch
+* `make point-to-defs-master` - updates your definitions submodule to point back at the `holidays/definitions` repo and master branch