date_holidays-reader 0.9.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68183e8a07810a5f19bd53c39badfa6beb0b542db295e9b60ad161912110bf28
+  data.tar.gz: 537732b57dc72b37ff4393278d12852cf62a81d08f7fe56eae1da3b9612488e2
+SHA512:
+  metadata.gz: ae53cfbd8700c0a935e0e97f5eb1c59b014eacb36613f4e720d9946a00f9fa90edb3d13367f11323694ba0e7a3e9cb0bb5d941591c2a3fc674372c4aa0c7f029
+  data.tar.gz: 428ba957ae64044460201fdf21cee1a378dfcf2e8a144d4b850ac0f4360198f482ef4de4068f2a17a441444b8d93cf30c93972760cc8627f9813a067cbed6282

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+node_modules
+/node_bin/
+
+# rspec failure tracking
+.rspec_status

data/.nvmrc

@@ -0,0 +1 @@
+v10.14.2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+#inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - Gemfile
+    - 'vendor/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    # The outer describe blocks throw this off for Rspec tests so disable.
+    - spec/**/*_spec.rb
+
+Metrics/LineLength:
+  Max: 100
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.ruby-version

@@ -0,0 +1 @@
+2.3.8

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+sudo: false
+language: ruby
+cache:
+  - bundler
+  - yarn
+rvm:
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.1
+before_install:
+  - gem install bundler -v 1.17.2
+  - bin/setup
+script:
+  - bundle exec rake spec
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+
+# DateHolidays::Reader Change Log
+
+## 0.9.9 (February, 5, 2019)
+
+* Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@bluemarblepayroll.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,19 @@
+# Build with:
+# docker build -t date_holidays-reader .
+FROM ruby:2.3.8
+
+# throw errors if Gemfile has been modified since Gemfile.lock
+RUN bundle config --global frozen 1
+
+WORKDIR /usr/src/app
+
+COPY Gemfile Gemfile.lock date-holiday-reader.gemspec ./
+COPY lib ./lib
+COPY node_bin ./node_bin
+
+RUN find .
+
+RUN bundle install
+
+# Run tests with:
+# docker run -it --mount src="$(pwd)",target=/usr/src/app/mount,type=bind date_holidays-reader sh -c 'cd mount && rspec'

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in date_holidays-reader.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    date_holidays-reader (0.9.9)
+      acts_as_hashable (~> 1)
+      caution
+      os (~> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    acts_as_hashable (1.0.5)
+    ast (2.4.0)
+    byebug (10.0.2)
+    caution (0.1.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.2)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    os (1.0.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    terminal-notifier-guard (1.7.0)
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  date_holidays-reader!
+  guard
+  guard-rspec
+  pry
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  terminal-notifier-guard
+
+BUNDLED WITH
+   1.17.3

data/Guardfile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,17 @@
+Copyright 2019 Blue Marble Payroll, LLC
+
+The source code of this project is provided under the MIT license:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+Holiday definitions:
+
+Some of holiday data contained in pre-compiled date-holidays Node module wrapper programs which ship with the packaged version of the gem and the holiday data provided by the date-holidays module itself are licensed under Creative Commons Attribution-ShareAlike 3.0 <http://creativecommons.org/licenses/by-sa/3.0/>. This is because some of the data relies on Wikipedia articles.
+
+The attributions can be found in the license file for the date-holidays Node module: https://raw.githubusercontent.com/commenthol/date-holidays/master/LICENSE .

data/README.md

@@ -0,0 +1,176 @@
+# DateHolidays::Reader
+
+[![Build Status](https://travis-ci.org/bluemarblepayroll/date_holidays-reader.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/date_holidays-reader)
+
+This is a read only Ruby wrapper for the
+[date-holidays](https://github.com/commenthol/date-holidays) Node module. Note that Node does not have to be installed on many machines in order to use this gem. See the configuration section for more details.
+
+## Usage
+
+Holiday information is available for many different locales. The first step is to create a locale object which represents a country or part of a country. For example, to retreive all holidays for this year in the United States:
+
+```ruby
+us = DateHolidays::Reader::Locale.new(country: :us)
+us.holidays(Date.today.year) # returns a list of US holidays for the current year
+```
+
+Locales can be refined to just one state or even a region within a state:
+
+```ruby
+louisiana = DateHolidays::Reader::Locale.new(country: :us, state: :la)
+louisiana.holidays(Date.today.year) # returns US and Louisiana holidays
+
+new_orleans = DateHolidays::Reader::Locale.new(country: :us, state: :la, region: :no)
+new_orleans.holidays(Date.today.year) # includes Mardi Gras plus all state country holidays
+```
+
+### Languages
+
+Some countries support more than one language:
+
+```ruby
+mx = DateHolidays::Reader::Locale.new(country: :mx)
+mx.languages # ["en", "es"]
+mx.holidays(Date.year)
+mx.holidays(Date.today.year).first.name                # "New Year's Day"
+mx.holidays(Date.today.year, language: :es).first.name # "Año Nuevo"
+```
+
+### Meta Data
+
+Country, state, and region codes are defined in the [ISO 3166-2 standard](https://en.wikipedia.org/wiki/ISO_3166-2). These examples pass in the codes using Ruby symbols. However, it is also valid to specify them as Ruby strings. The supported codes can also be retrived using the following meta-data methods:
+
+```ruby
+# Returns a hash of all supported countries keyed by two letter ISO 3166-2 code
+# and values of the country name:
+DateHolidays::Reader::Config.countries
+# {"AD"=>"Andorra", "AE"=>"دولة الإمارات العربية المتحدة", ... }
+
+# Returns a hash of all supported states keyed by two letter ISO 3166-2 code
+# and values of the state name:
+DateHolidays::Reader::Locale.new(country: :us).states
+# {"AL"=>"Alabama", "AK"=>"Alaska", "AZ"=>"Arizona", ... }
+
+# Returns a hash of all supported regions keyed by two letter ISO 3166-2 code
+# and values of the region name:
+DateHolidays::Reader::Locale.new(country: :us, state: :la).regions
+# {"NO"=>"New Orleans"}
+```
+
+### Holiday Object
+
+`DateHolidays::Reader::Locale#holidays` returns a list contining an instance of `DateHolidays::Reader::Holiday` objects which have the following fields:
+
+* *date* - The start date of the holiday which is stored in a Ruby `Date` instance.
+* *start_time* - The start time of the holiday in UTC represented as a `Time` instance. Note that these times represent when the holiday starts *in this locale*. For example, US New Year's day in 2019 has a time of '2019-01-01 05:00:00 UTC' as Washington DC is five hours behind UTC.
+* *end_time* - The time in UTC when the holiday ends. Note that some holidays (for example certian religious holidays) may not start or end on midnight. Also, some holidays last more or less then 24 hours.
+* *name* - A string representing the human readable name of the holiday. For example: "New Year's Day."
+* *type* - A symbol which describes the status of the holiday. See the [date-holidays documentation](https://github.com/commenthol/date-holidays#types-of-holidays) for a full explanation.
+* *substitute* - A boolean value that, if true, means that it is a substitute for another holiday.
+* *note* - An optional human readable note represented as a `String` or `nil`.
+
+Note that this is a wrapper for the JavaScript Holiday object described [here](https://github.com/commenthol/date-holidays#types-of-holidays).
+
+### API Comparison
+
+The API provided by this gem is somewhat different than the [API provided by the date-holidays node module](https://github.com/commenthol/date-holidays-parser/blob/master/docs/Holidays.md). This is intentional in order to make the Ruby API more object-oriented. The biggest change is that the JavaScript API does not have a locale class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'date_holidays-reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install date_holidays-reader
+
+If you are runnning a Linux or Mac OS X machine running a 64 x86 compatible processor then everything should work at this point. If you are running a different OS, different processor, or would like to use Node directly then continue to the configuration section.
+
+## Configuration
+
+This gem ships with pre-compiled wrapper programs for the date-holidays node module for Mac OS X and Linux running on 64 bit x86 processors. If you are running on those architectures then no configuration is needed as one those binaries will be used by default. If the gem detects that you are running on a different architecture then it will attempt to use the version of Node.js in your path. In this case, you will need to install the [date-holidays Node module](https://github.com/commenthol/date-holidays) before using this gem. It is also possible to explicitly tell the gem where your Node.js binary is located:
+
+```ruby
+  DateHolidays::Reader::Config.node_path = '/path/to/your/version/of/node`
+```
+
+Note that setting `node_path` will also force the gem to use Node instead of the provided binaries when running on a supported OS and processor combination.
+
+Note that native Windows support would not be difficult to add. Pull requests are welcome!
+
+## Related Work
+
+The [holidays](https://github.com/holidays/holidays) gem is very similar and is a pure Ruby implimentaiton. This gem was created as the date-holidays node module has support for more countries. An advantages of the holidays gem over this gem is that holidays is faster as it does not have to fork a Node.js process in order to retreive data. Also, the holidays gem has support for some niche data such as [US Federal Reserve Banks](https://github.com/holidays/definitions/blob/master/federalreservebanks.yaml), the [New York Stock Exchange](https://github.com/holidays/definitions/blob/master/nyse.yaml), and others. Use the right tool for your needs.
+
+## Future Direction
+
+The holiday definitions provided by the date-holidays Node module defined by a specific grammer housed in YAML files. The next logical step would be to build a pure Ruby parser for this grammar. Time is the only limit here. If this works is done, it would be in a separate gem as it would not have to be a read only interface; it would be trivial to support user defined holiday definitions like the Node module.
+
+## Development
+
+Since this gem wraps a Node module, a Node.js installation is required. See the `.nvmrc` file for a recommended Node version. [Yarn](https://yarnpkg.com/lang/en/docs/install/) is also required to install requisite Node modules.
+
+After checking out the repo and installing Node and Yarn, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+Note that `rake clobber` can be used to removed the pre-compiled Node wrappers.
+
+There is also a `Dockerfile` provided which can be used to verify the Linux binaries.
+
+### Releasing
+
+1. Update the version number in `version.rb` and add a new entry to `CHANGELOG.md`.
+
+1. Then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Updating the date-holidays Node Module Dependency
+
+1. Update node modules:
+
+```bash
+$ yarn upgrade
+```
+
+Verify from the Yarn output that date-holidays was updated.
+
+2. Recompile the node-bin binaries:
+
+```bash
+bundle exec rake node_compile
+```
+
+3. Update the node module version in `spec/date_holidays/reader/version_spec.rb`.
+
+4. Verify by running the tests and check in yarn.lock.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bluemarblepayroll/date_holidays-reader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+Before submitting a pull requests, please do the following:
+
+1. Update the README.md if changing or adding to the API.
+2. Add to or update unit tests.
+3. Ensure that all tests are passing.
+4. Ensure that rubocop does not find any issues.
+
+## Code of Conduct
+
+Everyone interacting in the DateHolidays::Reader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/date_holidays-reader/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT and [Creative Commons Attribution-ShareAlike 3.0](http://creativecommons.org/licenses/by-sa/3.0/)
+Licensed. See the LICENSE file for more information.
+
+## TODO
+
+* Holiday type filtering should be handled by Node.