ri_state_holidays 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,25 @@
+==== RI State Holidays Gem - By Joseph Alba
+
+Built with lots of help from the Ruby Holidays Gem by Alex Dunae
+
+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.
+

data/README.md

@@ -0,0 +1,7 @@
+# RiStateHolidays
+
+Calculate Rhode Island state holidays and observances
+
+## Usage
+
+  RiStateHolidays.holiday? Date.today [true or false]

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/ri_state_holiday

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'ri_state_holidays'
+
+########################################
+date = STDIN.tty? ? ARGV[0] : STDIN.read
+if date
+  begin
+    date = Date.parse date
+  rescue
+    puts "ERROR: Invalid date -- unable to parse input"
+    exit 2
+  end
+end
+date ||= Date.today
+
+
+########################################
+if [0,6].include? date.wday
+  puts "ERROR: #{date.strftime('%B %d, %Y')} is a weekend day"
+  exit 2
+end
+
+is_holiday = RiStateHolidays.holiday? date
+
+if is_holiday
+  puts "YES: #{date.strftime('%B %d, %Y')} is a Rhode Island state holiday - #{RiStateHolidays.holiday(date).first[:name]}"
+  exit 1
+else
+  puts "NO: #{date.strftime('%B %d, %Y')} is not a Rhode Island state holiday"
+  exit 0
+end
+

data/lib/ri_state_holidays.rb

@@ -0,0 +1,215 @@
+# Much of this code comes right from the Holidays Ruby gem (https://github.com/alexdunae/holidays)
+# I created a separate gem rather than creating an ri_state_holidays 'region' because
+#   I wanted to keep the Date class unmodified.
+
+## RI state holiday information from http://sos.ri.gov/library/stateholidays/
+
+# New year's day, 4th of July, Christmas
+# Dr. Martin Luther King Jr's Birthday - Third Monday in January
+# Memorial Day - Last Monday in May
+# Victory Day - Second Monday in August
+# Labor Day - First Monday in September
+# Columbus Day - Second Monday in October
+# Election Day - Tuesday after the First Monday in November
+# Thanksgiving - Fourth Thursday in November
+
+require 'date'
+require 'digest/md5'
+
+module RiStateHolidays
+  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 }
+
+  def self.holiday?(d)
+    !holiday(d).empty?
+  end
+
+  def self.holiday(d)
+    self.between(d, d)
+  end
+
+  def self.holidays_by_month
+    @holidays_by_month ||= get_holidays_by_month
+  end
+
+
+  private
+
+
+  def self.between(start_date, end_date, *options)
+    # remove the timezone
+    start_date = start_date.new_offset(0) + start_date.offset if start_date.respond_to?(:new_offset)
+    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
+
+    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)
+    end
+
+    regions, observed, informal = parse_options(options)
+
+    holidays = []
+
+    dates = {}
+    (start_date..end_date).each do |date|
+      # Always include month '0' for variable-month holidays
+      dates[date.year] = [0] unless dates[date.year]
+      # TODO: test this, maybe should push then flatten
+      dates[date.year] << date.month unless dates[date.year].include?(date.month)
+    end
+
+    dates.each do |year, months|
+      months.each do |month|
+        next unless hbm = holidays_by_month[month]
+
+        hbm.each do |h|
+          if h[:function]
+            # Holiday definition requires a calculation
+            result = call_proc(h[:function], year)
+
+            # Procs may return either Date or an integer representing mday
+            if result.kind_of?(Date)
+              month = result.month
+              mday = result.mday
+            else
+              mday = result
+            end
+          else
+            # Calculate the mday
+            mday = h[:mday] || calculate_mday(year, month, h[:week], h[:wday])
+          end
+
+          # Silently skip bad mdays
+          begin
+            date = Date.civil(year, month, mday)
+          rescue; next; end
+
+          # If the :observed option is set, calculate the date when the holiday
+          # is observed.
+          if observed and h[:observed]
+            date = call_proc(h[:observed], date)
+          end
+
+          if date.between?(start_date, end_date)
+            holidays << {:date => date, :name => h[:name]}
+          end
+
+        end
+      end
+    end
+
+    holidays.sort{|a, b| a[:date] <=> b[:date] }
+  end
+
+
+  def self.get_holidays_by_month
+    {
+      1 => [
+        {:mday => 1, :observed => lambda { |date| to_weekday_if_weekend(date) }, :observed_id => "to_weekday_if_weekend", :name => "New Year's Day", :regions => [:us, :us_ri]},
+        {:wday => 1, :week => 3, :name => "Martin Luther King, Jr. Day", :regions => [:us, :us_ri]},
+        {:function => lambda { |year| us_inauguration_day(year) }, :function_id => "us_inauguration_day(year)", :name => "Inauguration Day", :regions => [:us_dc, :us_ri]}
+      ],
+      5 => [
+        {:wday => 1, :week => -1, :name => "Memorial Day", :regions => [:us, :us_ri]},
+      ],
+      7 => [
+        {:mday => 4, :observed => lambda { |date| to_weekday_if_weekend(date) }, :observed_id => "to_weekday_if_weekend", :name => "Independence Day", :regions => [:us, :us_ri]}
+      ],
+      8 => [
+        {:wday => 1, :week => 2, :name => "Victory Day", :regions => [:us, :us_ri]}
+      ],
+      9 => [
+        {:wday => 1, :week => 1, :name => "Labor Day", :regions => [:us, :us_ri]}
+      ],
+      10 => [
+        {:wday => 1, :week => 2, :name => "Columbus Day", :regions => [:us, :us_ri]}
+      ],
+      11 => [
+        {:mday => 11, :observed => lambda { |date| to_weekday_if_weekend(date) }, :observed_id => "to_weekday_if_weekend", :name => "Veterans Day", :regions => [:us, :us_ri]},
+        {:wday => 4, :week => 4, :name => "Thanksgiving", :regions => [:us, :us_ri]},
+        {:function => lambda { |year| us_election_day(year) }, :function_id => "us_election_day(year)", :name => "Election Day", :regions => [:us_ri]}
+      ],
+      12 => [
+        {:mday => 25, :observed => lambda { |date| to_weekday_if_weekend(date) }, :observed_id => "to_weekday_if_weekend", :name => "Christmas Day", :regions => [:us, :us_ri]}
+      ]
+    }
+  end
+
+
+  # January 20, every fourth year, following Presidential election
+  def self.us_inauguration_day(year)
+    year % 4 == 1 ? 20 : nil
+  end
+
+
+  # Return the Tuesday after the first Monday
+  def self.us_election_day(year)
+    month = 11
+    mday = 1
+    if year % 2 == 0
+      date = Date.civil(year, month, mday)
+      if date.wday < 2
+        return date + (2 - date.wday)
+      elsif date.wday == 2
+        return date + 7
+      elsif date.wday > 2
+        return date + (9 - date.wday)
+      end
+    end
+
+    return nil
+  end
+
+
+  def self.to_weekday_if_weekend(date)
+    date += 1 if date.wday == 0
+    date -= 1 if date.wday == 6
+    date
+  end
+
+
+  def self.calculate_mday(year, month, week, wday)
+    raise ArgumentError, "Week parameter must be one of Holidays::WEEKS (provided #{week})." unless WEEKS.include?(week) or WEEKS.has_value?(week)
+
+    unless wday.kind_of?(Numeric) and wday.between?(0,6) or DAY_SYMBOLS.index(wday)
+      raise ArgumentError, "Wday parameter must be an integer between 0 and 6 or one of Date::DAY_SYMBOLS."
+    end
+
+    week = WEEKS[week] if week.kind_of?(Symbol)
+    wday = DAY_SYMBOLS.index(wday) if wday.kind_of?(Symbol)
+
+    # :first, :second, :third, :fourth or :fifth
+    if week > 0
+      return ((week - 1) * 7) + 1 + ((wday - Date.civil(year, month,(week-1)*7 + 1).wday) % 7)
+    end
+    
+    days = MONTH_LENGTHS[month-1]
+
+    days = 29 if month == 2 and Date.leap?(year)
+      
+    return days - ((Date.civil(year, month, days).wday - wday + 7) % 7) - (7 * (week.abs - 1))
+  end
+
+  def self.call_proc(function, year) # :nodoc:
+    proc_key = Digest::MD5.hexdigest("#{function.to_s}_#{year.to_s}")
+    function.call(year)
+  end
+
+  def self.parse_options(options)
+    regions = [:us_ri]
+    observed = true
+    informal = nil
+    return regions, observed, informal
+  end
+
+
+end

data/ri_state_holidays.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joseph Alba"]
+  gem.email         = ["jalba@egov.com"]
+  gem.description   = %q{Calculate Rhode Island state holidays}
+  gem.summary       = %q{Based off the Holidays Ruby gem -- but without altering the Date class}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = ['ri_state_holiday']
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ri_state_holidays"
+  gem.require_paths = ["lib"]
+
+  gem.version       = '0.1.0'
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+end

data/spec/ri_state_holidays_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe RiStateHolidays do
+
+  describe "easy day-of-month holidays" do
+    it "knows New Years Day" do
+      RiStateHolidays.holiday?(Date.new(2013, 1, 1)).should be_true
+    end
+
+    it "knows Independence Day" do
+      RiStateHolidays.holiday?(Date.new(2012, 7, 4)).should be_true
+    end
+
+    it "knows Christmas" do
+      RiStateHolidays.holiday?(Date.new(2012, 12, 25)).should be_true
+    end
+
+    it "knows a non-holiday" do
+      RiStateHolidays.holiday?(Date.new(2012, 2, 28)).should be_false
+    end
+  end
+
+
+  describe "observed holidays" do
+    # When any legal holiday falls on a Sunday, the day following it is a full holiday.
+    it "observed New Years from a Sunday" do
+      RiStateHolidays.holiday?(Date.new(2012, 1, 2)).should be_true
+    end
+
+    it "observed Veterans Day from a Sunday" do
+      RiStateHolidays.holiday?(Date.new(2012, 11, 12)).should be_true
+    end
+  end
+
+
+  describe "calculated holidays" do
+    it "knows Veteran's Day" do
+      RiStateHolidays.holiday?(Date.new(2013, 11, 11)).should be_true
+      RiStateHolidays.holiday?(Date.new(2014, 11, 11)).should be_true
+    end
+
+    it "knows Victory Day" do
+      RiStateHolidays.holiday?(Date.new(2012, 8, 13)).should be_true
+      RiStateHolidays.holiday?(Date.new(2013, 8, 12)).should be_true
+      RiStateHolidays.holiday?(Date.new(2014, 8, 11)).should be_true
+    end
+
+    it "knows Labor Day" do
+      RiStateHolidays.holiday?(Date.new(2012, 9, 3)).should be_true
+      RiStateHolidays.holiday?(Date.new(2013, 9, 2)).should be_true
+      RiStateHolidays.holiday?(Date.new(2014, 9, 1)).should be_true
+    end
+
+    it "knows election day" do
+      RiStateHolidays.holiday?(Date.new(2012, 11, 6)).should be_true
+      RiStateHolidays.holiday?(Date.new(2013, 11, 5)).should be_false
+      RiStateHolidays.holiday?(Date.new(2014, 11, 4)).should be_true
+    end
+
+    it "knows Thanksgiving" do
+      RiStateHolidays.holiday?(Date.new(2012, 11, 22)).should be_true
+      RiStateHolidays.holiday?(Date.new(2013, 11, 28)).should be_true
+      RiStateHolidays.holiday?(Date.new(2014, 11, 27)).should be_true
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'ri_state_holidays'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: ri_state_holidays
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joseph Alba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Calculate Rhode Island state holidays
+email:
+- jalba@egov.com
+executables:
+- ri_state_holiday
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ri_state_holiday
+- lib/ri_state_holidays.rb
+- ri_state_holidays.gemspec
+- spec/ri_state_holidays_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2455822407572811696
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2455822407572811696
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Based off the Holidays Ruby gem -- but without altering the Date class
+test_files:
+- spec/ri_state_holidays_spec.rb
+- spec/spec_helper.rb