national_holidays 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d49e1a4f16f57faae9173300299c13e8addcffd1
-  data.tar.gz: ac17ebe82b0523e4eb01e1066cf3ce9c4e2ae579
+  metadata.gz: cb7291b45904d9a8e6eabe11401ebcc3177e7385
+  data.tar.gz: 5bed83c2b535c5461d6d59f75278cf972e12b54a
 SHA512:
-  metadata.gz: 38e9259b565a312419117fb4d92fde792407743ddec6049519b4a8015ba902b962e181977dce1cb30f180f6d302db95f34b6fa66de1828bbe5bd246dfbaf9c91
-  data.tar.gz: bc3eaa23e914bdf06925f5e5501a75fb9daa8bc5348e206a59e6e553957b959deb71486c38946363e3a810a288aedf49a383ab071df2448214d6b8dff259546d
+  metadata.gz: b36421e48049f73133c21313a9177f9dccbf019ecc767c4671fc8adfd4de2100536cb3b9b411a2bc4fe4a82657b3a63c41c18d0bee8b73793140d44dfc090b80
+  data.tar.gz: 00e0e05e3b837d264e8f7b48ff8ff6c2f006dcf103fdedf73e1a78c0bf29df559b4e422a5ebcb7db8313b680d6ee1c95ce5692aed6e1d893c67b58cf5136828a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2018] [CharlieHR]
+
+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.

data/README.md

@@ -0,0 +1,95 @@
+# National Holidays for Ruby
+
+## Where does this data come from?
+
+The national holidays data used in this gem comes from the [national-holidays-config](https://github.com/kaoru/national-holidays-config) project.
+
+## Installation
+
+    gem install national_holidays
+
+## Usage
+
+    require 'national_holidays'
+
+    NationalHolidays.load! # optionally pre-load all data
+
+    NationalHolidays.countries.each do |country|
+      country.regions.each do |region|
+        holidays = region.all_holidays.select { |h| h.date.day == 18 && h.date.month == 11 }
+
+        if holidays.any?
+          puts "My birthday is a public holiday in #{country.name}: #{holidays.first.names.except(:en).first.last}!"
+        end
+      end
+    end
+
+    # My birthday is a public holiday in Haiti: Vertières Day!
+    # My birthday is a public holiday in Iran (Islamic Republic of): Martyrdom of Imam Reza!
+    # My birthday is a public holiday in Latvia: Latvijas Republikas proklamēšanas diena!
+    # My birthday is a public holiday in Mexico: Revolución Mexicana!
+
+## Country
+
+    country = NationalHolidays::Country.new(:gb)
+
+    puts country.code
+    # gb
+
+    puts country.name
+    # United Kingdom of Great Britain and Northern Ireland
+
+    puts country.regions.map(&:name)
+    # ["England", "Wales", "Scotland", "Northern Ireland"]
+
+Country names come from https://github.com/hexorx/countries
+
+Region names come from https://github.com/kaoru/national-holidays-config
+
+## Region
+
+    region = NationalHolidays::Region.new(:united_states14)
+
+    puts region.code
+    # :united_states14
+
+    puts region.name
+    # Illinois
+
+    date = Date.new(2018, 1, 1)
+
+    puts region.all_holidays.count
+    # 374
+
+    puts region.holidays_on_or_before(date).count
+    # 87
+    puts region.holidays_before(date).count
+    # 86
+
+    puts region.holidays_on_or_after(date).count
+    # 288
+    puts region.holidays_after(date).count
+    # 287
+
+    puts region.holidays_between(date, date).count
+    # 1
+
+## Holiday
+
+    holiday.names
+    # {
+    #   en: "New Year's Day",
+    #   es: "Año Nuevo"
+    # }
+
+    holiday.date
+    # Date.new(2018, 1, 1)
+
+    holiday.public_holiday?
+    # true
+
+In the future we hope to also support non-public holidays, ie. days which are notable but do not mean that people get the day of work.
+
+## Who are we?
+
+We run [CharlieHR](https://www.charliehr.com) where knowing about public and national holidays helps us calculate time off for 1000s of companies.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/lib/national_holidays/country.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'countries'
+
+class NationalHolidays
+  class Country
+    attr_reader :code, :name
+
+    def self.all
+      Dir.glob("#{NationalHolidays.config_directory}/*").sort.map do |country_directory|
+        new(File.basename(country_directory))
+      end
+    end
+
+    def initialize(code)
+      @code = code.to_sym
+      @name = ISO3166::Country.new(code).name
+    end
+
+    def regions
+      dir = "#{NationalHolidays.config_directory}/#{code}"
+
+      raise NationalHolidays::UnknownCountryError, "Unknown country: #{code}" unless Dir.exist?(dir)
+
+      Dir.glob("#{dir}/*.yml").sort.map do |filename|
+        Region.new(File.basename(filename).sub(/\.yml/, ''))
+      end
+    end
+  end
+end

data/lib/national_holidays/holiday.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class NationalHolidays
+  class Holiday
+    attr_reader :names, :date
+
+    def initialize(names, date, public_holiday)
+      @names = names.map { |k, v| [k.to_sym, v] }.to_h
+      @date = Date.parse(date.to_s)
+      @public_holiday = public_holiday
+    end
+
+    def public_holiday?
+      @public_holiday
+    end
+  end
+end

data/lib/national_holidays/region.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'national_holidays/holiday'
+
+require 'yaml'
+
+class NationalHolidays
+  class Region
+    attr_reader :code
+
+    def self.all
+      Dir.glob("#{NationalHolidays.config_directory}/*/*.yml").map do |region_filename|
+        new(File.basename(region_filename).sub(/\.yml/, ''))
+      end.sort_by(&:code)
+    end
+
+    def initialize(code)
+      @code = code.to_sym
+    end
+
+    def name
+      config.fetch('name')
+    end
+
+    def all_holidays
+      holidays
+    end
+
+    def holidays_on_or_before(date)
+      holidays(nil, date)
+    end
+
+    def holidays_before(date)
+      holidays(nil, date.prev_day)
+    end
+
+    def holidays_on_or_after(date)
+      holidays(date, nil)
+    end
+
+    def holidays_after(date)
+      holidays(date.next_day, nil)
+    end
+
+    def holidays_between(start_date, end_date)
+      holidays(start_date, end_date)
+    end
+
+    private
+
+    def holidays(start_date = nil, end_date = nil)
+      start_date = Date.parse(start_date.to_s).to_s if start_date
+      end_date = Date.parse(end_date.to_s).to_s if end_date
+
+      config.fetch('years').flat_map do |_, holidays|
+        holidays.map do |holiday_config|
+          holiday_config_date = holiday_config.fetch('date')
+
+          next if start_date && start_date > holiday_config_date
+          next if end_date && end_date < holiday_config_date
+
+          Holiday.new(*holiday_config.values_at('names', 'date', 'public_holiday'))
+        end
+      end.compact
+    end
+
+    @cache = {}
+    class << self
+      attr_reader :cache
+    end
+
+    def config
+      return self.class.cache[code] if self.class.cache.key?(code)
+
+      filename = Dir.glob("#{NationalHolidays.config_directory}/*/*.yml").sort.find do |f|
+        File.basename(f) == "#{code}.yml"
+      end
+
+      raise NationalHolidays::UnknownRegionError, "Unknown region: #{code}" unless filename
+
+      self.class.cache[code] = YAML.safe_load(File.read(filename))
+    end
+  end
+end

data/test/test_national_holidays.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'national_holidays'
+
+class NationalHolidaysTest < Minitest::Test
+  def test_load
+    assert_equal true, NationalHolidays.load!
+  end
+
+  def test_countries
+    assert_equal :ae, NationalHolidays.countries.first.code
+    assert_equal 'South Africa', NationalHolidays.countries.last.name
+  end
+
+  def test_regions
+    assert_equal :angola01, NationalHolidays.regions.first.code
+    assert_equal 'Vietnam', NationalHolidays.regions.last.name
+  end
+
+  def test_regions_to_public_holiday_count_for_year
+    assert_equal 8, NationalHolidays.regions_to_public_holiday_count_for_year(2017).fetch(:united_kingdom01)
+  end
+end

data/test/test_national_holidays_country.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'national_holidays'
+
+class NationalHolidaysCountryTest < Minitest::Test
+  def test_code
+    assert_equal :gb, NationalHolidays::Country.new(:gb).code
+    assert_equal :gb, NationalHolidays::Country.new('gb').code
+  end
+
+  def test_name
+    assert_equal 'United Kingdom of Great Britain and Northern Ireland', NationalHolidays::Country.new(:gb).name
+  end
+
+  def test_regions
+    assert_equal %i[united_kingdom01 united_kingdom02 united_kingdom03 united_kingdom04], NationalHolidays::Country.new(:gb).regions.map(&:code)
+  end
+end

data/test/test_national_holidays_holiday.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'national_holidays'
+
+class NationalHolidaysHolidayTest < Minitest::Test
+  def holiday
+    NationalHolidays::Holiday.new(
+      {
+        'en' => "New Year's Day",
+        'es' => 'Año Nuevo'
+      },
+      '2018-01-01',
+      true
+    )
+  end
+
+  def test_names
+    assert_equal "New Year's Day", holiday.names.fetch(:en)
+    assert_equal 'Año Nuevo', holiday.names.fetch(:es)
+  end
+
+  def test_date
+    assert_equal Date.new(2018, 1, 1), holiday.date
+  end
+
+  def test_public_holiday
+    assert holiday.public_holiday?
+  end
+end

data/test/test_national_holidays_region.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'national_holidays'
+
+class NationalHolidaysRegionTest < Minitest::Test
+  def test_code
+    assert_equal :united_kingdom01, NationalHolidays::Region.new(:united_kingdom01).code
+    assert_equal :united_kingdom01, NationalHolidays::Region.new('united_kingdom01').code
+  end
+
+  def test_name
+    assert_equal 'England', NationalHolidays::Region.new(:united_kingdom01).name
+  end
+
+  def test_all_holidays
+    refute_empty(NationalHolidays::Region.new(:united_kingdom01).all_holidays.select { |holiday| holiday.date == Date.new(2011, 1, 3) })
+    refute_empty(NationalHolidays::Region.new(:united_kingdom01).all_holidays.select { |holiday| holiday.date == Date.new(2040, 1, 2) })
+  end
+
+  def test_holidays_on_or_before
+    refute_empty NationalHolidays::Region.new(:united_kingdom01).holidays_on_or_before(Date.new(2018, 1, 1))
+    assert_empty(NationalHolidays::Region.new(:united_kingdom01).holidays_on_or_before(Date.new(2018, 1, 1)).select { |holiday| holiday.date > Date.new(2018, 1, 1) })
+    assert_equal Date.new(2018, 1, 1), NationalHolidays::Region.new(:united_kingdom01).holidays_on_or_before(Date.new(2018, 1, 1)).last.date
+  end
+
+  def test_holidays_before
+    refute_empty NationalHolidays::Region.new(:united_kingdom01).holidays_before(Date.new(2018, 1, 1))
+    assert_empty(NationalHolidays::Region.new(:united_kingdom01).holidays_before(Date.new(2018, 1, 1)).select { |holiday| holiday.date >= Date.new(2018, 1, 1) })
+    assert_equal Date.new(2017, 12, 26), NationalHolidays::Region.new(:united_kingdom01).holidays_before(Date.new(2018, 1, 1)).last.date
+  end
+
+  def test_holidays_on_or_after
+    refute_empty NationalHolidays::Region.new(:united_kingdom01).holidays_on_or_after(Date.new(2018, 1, 1))
+    assert_empty(NationalHolidays::Region.new(:united_kingdom01).holidays_on_or_after(Date.new(2018, 1, 1)).select { |holiday| holiday.date < Date.new(2018, 1, 1) })
+    assert_equal Date.new(2018, 1, 1), NationalHolidays::Region.new(:united_kingdom01).holidays_on_or_after(Date.new(2018, 1, 1)).first.date
+  end
+
+  def test_holidays_after
+    refute_empty NationalHolidays::Region.new(:united_kingdom01).holidays_after(Date.new(2018, 1, 1))
+    assert_empty(NationalHolidays::Region.new(:united_kingdom01).holidays_after(Date.new(2018, 1, 1)).select { |holiday| holiday.date <= Date.new(2018, 1, 1) })
+    assert_equal Date.new(2018, 3, 30), NationalHolidays::Region.new(:united_kingdom01).holidays_after(Date.new(2018, 1, 1)).first.date
+  end
+
+  def test_holidays_between
+    assert_equal(['Good Friday', 'Easter Monday', 'Royal Wedding Day'], NationalHolidays::Region.new(:united_kingdom01).holidays_between(Date.new(2011, 4, 1), Date.new(2011, 4, 30)).map { |holiday| holiday.names.fetch(:en) })
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: national_holidays
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alex Balhatchet
@@ -73,8 +73,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
+- Rakefile
 - lib/national_holidays.rb
-homepage: 
+- lib/national_holidays/country.rb
+- lib/national_holidays/holiday.rb
+- lib/national_holidays/region.rb
+- test/test_national_holidays.rb
+- test/test_national_holidays_country.rb
+- test/test_national_holidays_holiday.rb
+- test/test_national_holidays_region.rb
+homepage: https://github.com/kaoru/national-holidays-ruby
 licenses:
 - MIT
 metadata: {}