holidate 0.0.3 → 0.0.4

data/.gitignore

@@ -0,0 +1,16 @@
+/holidate-*.gem
+/Gemfile.lock
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Cohen Carlisle
+
+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,38 @@
+# Holidate
+
+A simple gem that returns Date objects for holidays
+
+# Usage
+
+Currently has methods to find the 10 US federal holidays, with year as an optional argument that defaults to the current year.
+```ruby
+Holidate.new_years_day              # alias: new_year
+Holidate.martin_luther_king_jr_day  # alias: mlk
+Holidate.washingtons_birthday       # alias: washington
+Holidate.memorial_day               # alias: memorial
+Holidate.independence_day           # alias: july_4
+Holidate.labor_day                  # alias: labor
+Holidate.columbus_day               # alias: columbus
+Holidate.veterans_day               # alias: veteran
+Holidate.thanksgiving_day           # alias: thanksgiving
+Holidate.christmas_day              # alias: xmas
+```
+
+Also has a ::find method that allows you to find the nth day of the week in a given month and year.
+```ruby
+Holidate.find('1st', 'Friday', 'December', '1985')
+```
+
+You can also find the nth to last day.
+```ruby
+Holidate.find(:third_to_last, :wed , :oct, :'2013')
+```
+
+::find is case-insensitive and accepts both strings and symbols.
+It also accepts abbreviations for months and days of the week and allows first, second, etc. to be abbreviated as 1st, 2nd, etc.
+You can also give ::find integers. Day of the week and month should correspond to Date#wday and Date#month, respectively.
+```ruby
+Holidate.find(-1, 0, 7, 1985) # == Holidate.find('last', 'Sunday', 'July', '1985')
+```
+
+Of course, magic numbers can make code harder to understand, so use with caution.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/*_spec.rb'
+end
+
+desc 'Run tests'
+task :default => :test

data/holidate.gemspec

@@ -0,0 +1,18 @@
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name        = 'holidate'
+  s.version     = '0.0.4'
+  s.date        = Date.today.to_s
+  s.summary     = 'Holiday Dates'
+  s.description = 'A simple gem that returns Date objects for holidays'
+  s.authors     = ['Cohen Carlisle']
+  s.email       = 'holidate.gem@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'http://rubygems.org/gems/holidate'
+  s.license     = 'MIT'
+
+  s.add_development_dependency 'bundler', '~> 1.7'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'minitest', '~> 5.5'
+end

data/lib/holidate.rb

@@ -1,91 +1,92 @@
 require 'date'
 
 class Holidate
-  def self.find nth_, wday_, month_, year_=Date.today.year
+  def self.find(nth_, wday_, month_, year_=Date.today.year)
     nth = nth_int(nth_)
     wday = wday_int(wday_)
     month = month_int(month_)
     year = year_int(year_)
     if nth > 0
-      Date.new year, month, (      1       + ( nth - 1) * 7 + (wday       -       Date.new(year, month, 1).wday) % 7)
+      Date.new(year, month, (1 + (nth - 1) * 7 + (wday - Date.new(year, month, 1).wday) % 7))
     else
-      days_in_month = ((Date.new(year, month) >> 1) -1).day
-      Date.new year, month, (days_in_month - (-nth - 1) * 7 - (Date.new(year, month, days_in_month).wday - wday) % 7)
+      days_in_month = ((Date.new(year, month) >> 1) - 1).day
+      Date.new(year, month, (days_in_month - (-nth - 1) * 7 - (Date.new(year, month, days_in_month).wday - wday) % 7))
     end
   end
   singleton_class.send(:alias_method, :find_day, :find)
 
-  def self.new_years_day year=Date.today.year
-    Date.new year, 1, 1
+  def self.new_years_day(year=Date.today.year)
+    Date.new(year, 1, 1)
   end
   singleton_class.send(:alias_method, :new_year, :new_years_day)
 
-  def self.martin_luther_king_jr_day year=Date.today.year
-    find 'third', 'monday', 'january', year
+  def self.martin_luther_king_jr_day(year=Date.today.year)
+    find('third', 'monday', 'january', year)
   end
   singleton_class.send(:alias_method, :mlk, :martin_luther_king_jr_day)
 
-  def self.washingtons_birthday year=Date.today.year
-    find 'third', 'monday', 'february', year
+  def self.washingtons_birthday(year=Date.today.year)
+    find('third', 'monday', 'february', year)
   end
   singleton_class.send(:alias_method, :washington, :washingtons_birthday)
 
-  def self.memorial_day year=Date.today.year
-    find 'last', 'monday', 'may', year
+  def self.memorial_day(year=Date.today.year)
+    find('last', 'monday', 'may', year)
   end
   singleton_class.send(:alias_method, :memorial, :memorial_day)
 
-  def self.independence_day year=Date.today.year
-    Date.new year, 7, 4
+  def self.independence_day(year=Date.today.year)
+    Date.new(year, 7, 4)
   end
   singleton_class.send(:alias_method, :july_4, :independence_day)
 
-  def self.labor_day year=Date.today.year
-    find 'first', 'monday', 'september', year
+  def self.labor_day(year=Date.today.year)
+    find('first', 'monday', 'september', year)
   end
   singleton_class.send(:alias_method, :labor, :labor_day)
 
-  def self.columbus_day year=Date.today.year
-    find 'second', 'monday', 'october', year
+  def self.columbus_day(year=Date.today.year)
+    find('second', 'monday', 'october', year)
   end
   singleton_class.send(:alias_method, :columbus, :columbus_day)
 
-  def self.veterans_day year=Date.today.year
-    Date.new year, 11, 11
+  def self.veterans_day(year=Date.today.year)
+    Date.new(year, 11, 11)
   end
   singleton_class.send(:alias_method, :veteran, :veterans_day)
 
-  def self.thanksgiving_day year=Date.today.year
-    find 'fourth', 'thursday', 'november', year
+  def self.thanksgiving_day(year=Date.today.year)
+    find('fourth', 'thursday', 'november', year)
   end
   singleton_class.send(:alias_method, :thanksgiving, :thanksgiving_day)
 
-  def self.christmas_day year=Date.today.year
-    Date.new year, 12, 25
+  def self.christmas_day(year=Date.today.year)
+    Date.new(year, 12, 25)
   end
   singleton_class.send(:alias_method, :xmas, :christmas_day)
 
-  private
+  class << self
+    protected
 
-  def self.nth_int nth_
-    h = { 'first' => 1, 'second' => 2, 'third' => 3, 'fourth' => 4, 'fifth' => 5, 'last' => 1 }
-    nth = nth_.to_s.downcase
-    nth_int = nth.to_i == 0 ? h[nth.split(/[-_ ]/).first] : nth.to_i
-    nth_int = -nth_int if nth.to_s.downcase.end_with?('last')
-    nth_int
-  end
+    def nth_int(nth_)
+      h = { 'first' => 1, 'second' => 2, 'third' => 3, 'fourth' => 4, 'fifth' => 5, 'last' => 1 }
+      nth = nth_.to_s.downcase
+      nth_int = (nth.to_i == 0 ? h[nth.split(/[-_ ]/).first] : nth.to_i)
+      nth.end_with?('last') ? -nth_int : nth_int
+    end
 
-  def self.wday_int wday
-    h = { 'sun' => 0, 'mon' => 1, 'tue' => 2, 'wed' => 3, 'thu' => 4, 'fri' => 5, 'sat' => 6 }
-    (0..6).include?(wday) ? wday : h[wday.to_s.downcase[0..2]]
-  end
+    def wday_int(wday)
+      h = { 'sun' => 0, 'mon' => 1, 'tue' => 2, 'wed' => 3, 'thu' => 4, 'fri' => 5, 'sat' => 6 }
+      (0..6).include?(wday) ? wday : h[wday.to_s.downcase[0..2]]
+    end
 
-  def self.month_int month
-    h = { 'jan' => 1, 'feb' => 2, 'mar' => 3, 'apr' => 4, 'may' => 5, 'jun' => 6, 'jul' => 7, 'aug' => 8, 'sep' => 9, 'oct' => 10, 'nov' => 11, 'dec' => 12 }
-    (1..12).include?(month) ? month : h[month.to_s.downcase[0..2]]
-  end
+    def month_int(month)
+      h = { 'jan' => 1, 'feb' => 2, 'mar' => 3, 'apr' => 4, 'may' => 5, 'jun' => 6, 'jul' => 7, 'aug' => 8, 'sep' => 9, 'oct' => 10, 'nov' => 11, 'dec' => 12 }
+      (1..12).include?(month) ? month : h[month.to_s.downcase[0..2]]
+    end
 
-  def self.year_int year
-    year.to_s.to_i
+    def year_int(year)
+      year.to_s.to_i
+    end
   end
 end

data/spec/holidate_spec.rb

@@ -0,0 +1,125 @@
+gem 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'holidate'
+
+describe Holidate do
+
+  describe '::new_years_day' do
+    it "finds New Year's Day" do
+      Holidate.new_year(2014).must_equal Date.new(2014, 1, 1)
+      Holidate.new_year(2015).must_equal Date.new(2015, 1, 1)
+      Holidate.new_year(2016).must_equal Date.new(2016, 1, 1)
+      Holidate.new_year(2017).must_equal Date.new(2017, 1, 1)
+    end
+  end
+
+  describe '::martin_luther_king_jr_day' do
+    it 'finds Martin Luther King, Jr. Day' do
+      Holidate.mlk(2014).must_equal Date.new(2014, 1, 20)
+      Holidate.mlk(2015).must_equal Date.new(2015, 1, 19)
+      Holidate.mlk(2016).must_equal Date.new(2016, 1, 18)
+      Holidate.mlk(2017).must_equal Date.new(2017, 1, 16)
+    end
+  end
+
+  describe '::washingtons_birthday' do
+    it "finds Washington's Birthday" do
+      Holidate.washington(2014).must_equal Date.new(2014, 2, 17)
+      Holidate.washington(2015).must_equal Date.new(2015, 2, 16)
+      Holidate.washington(2016).must_equal Date.new(2016, 2, 15)
+      Holidate.washington(2017).must_equal Date.new(2017, 2, 20)
+    end
+  end
+
+  describe '::memorial_day' do
+    it 'finds Memorial Day' do
+      Holidate.memorial(2014).must_equal Date.new(2014, 5, 26)
+      Holidate.memorial(2015).must_equal Date.new(2015, 5, 25)
+      Holidate.memorial(2016).must_equal Date.new(2016, 5, 30)
+      Holidate.memorial(2017).must_equal Date.new(2017, 5, 29)
+    end
+  end
+
+  describe '::independence_day' do
+    it 'finds Independence Day' do
+      Holidate.july_4(2014).must_equal Date.new(2014, 7, 4)
+      Holidate.july_4(2015).must_equal Date.new(2015, 7, 4)
+      Holidate.july_4(2016).must_equal Date.new(2016, 7, 4)
+      Holidate.july_4(2017).must_equal Date.new(2017, 7, 4)
+    end
+  end
+
+  describe '::labor_day' do
+    it 'finds Labor Day' do
+      Holidate.labor(2014).must_equal Date.new(2014, 9, 1)
+      Holidate.labor(2015).must_equal Date.new(2015, 9, 7)
+      Holidate.labor(2016).must_equal Date.new(2016, 9, 5)
+      Holidate.labor(2017).must_equal Date.new(2017, 9, 4)
+    end
+  end
+
+  describe '::columbus_day' do
+    it 'finds Columbus Day' do
+      Holidate.columbus(2014).must_equal Date.new(2014, 10, 13)
+      Holidate.columbus(2015).must_equal Date.new(2015, 10, 12)
+      Holidate.columbus(2016).must_equal Date.new(2016, 10, 10)
+      Holidate.columbus(2017).must_equal Date.new(2017, 10, 9)
+    end
+  end
+
+  describe '::veterans_day' do
+    it 'finds Veterans Day' do
+      Holidate.veteran(2014).must_equal Date.new(2014, 11, 11)
+      Holidate.veteran(2015).must_equal Date.new(2015, 11, 11)
+      Holidate.veteran(2016).must_equal Date.new(2016, 11, 11)
+      Holidate.veteran(2017).must_equal Date.new(2017, 11, 11)
+    end
+  end
+
+  describe '::thanksgiving_day' do
+    it 'finds Thanksgiving Day' do
+      Holidate.thanksgiving(2014).must_equal Date.new(2014, 11, 27)
+      Holidate.thanksgiving(2015).must_equal Date.new(2015, 11, 26)
+      Holidate.thanksgiving(2016).must_equal Date.new(2016, 11, 24)
+      Holidate.thanksgiving(2017).must_equal Date.new(2017, 11, 23)
+    end
+  end
+
+  describe '::christmas_day' do
+    it 'finds Christmas Day' do
+      Holidate.xmas(2014).must_equal Date.new(2014, 12, 25)
+      Holidate.xmas(2015).must_equal Date.new(2015, 12, 25)
+      Holidate.xmas(2016).must_equal Date.new(2016, 12, 25)
+      Holidate.xmas(2017).must_equal Date.new(2017, 12, 25)
+    end
+  end
+
+  describe '::find' do
+    it 'accepts a strings, symbols, or integers as arguments' do
+      Holidate.find('first', 'Friday', 'December', '1985').must_equal Date.new(1985, 12, 6)
+      Holidate.find(:third, :wednesday , :october, :'2013').must_equal Date.new(2013, 10, 16)
+      Holidate.find(4, 0, 7, 1985).must_equal Date.new(1985, 7, 28)
+    end
+
+    it 'allows you to search from the beginning or end of a month' do
+      Holidate.find('second', 'Tuesday', 'July', 2012).must_equal Date.new(2012, 7, 10)
+      Holidate.find('last', 'Thursday', 'January', 2006).must_equal Date.new(2006, 1, 26)
+    end
+
+    it 'allows spaces, underscores, or hyphens to separate words in the first argument when searching from the end of a month' do
+      Holidate.find('second to last', 'Tuesday', 'September', 1991).must_equal Date.new(1991, 9, 17)
+      Holidate.find('fourth-from-last', 'Thursday', 'April', 2005).must_equal Date.new(2005, 4, 7)
+      Holidate.find(:fourth_to_last, :wednesday, :june, 1989).must_equal Date.new(1989, 6, 7)
+    end
+
+    it 'ignores case for string and symbol arguments' do
+      Holidate.find('third', 'wednesday', 'october', 2004).must_equal Date.new(2004, 10, 20)
+      Holidate.find(:last, :Sunday, :August, 2006).must_equal Date.new(2006, 8, 27)
+    end
+
+    it 'allows abbreviations for the first three arguments' do
+      Holidate.find('1st', 'thu', 'jan', 1970).must_equal Date.new(1970, 1, 1)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: holidate
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,7 +65,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- holidate.gemspec
 - lib/holidate.rb
+- spec/holidate_spec.rb
 homepage: http://rubygems.org/gems/holidate
 licenses:
 - MIT