holiday 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in holiday.gemspec
+gemspec

data/README.md

@@ -0,0 +1,80 @@
+# Holiday
+
+Holiday is a gem that lets you configure holidays for multiple countries with YAML.
+
+## Default Usage
+
+First setup path to a YAML file and set the country code.
+
+```ruby
+
+Holiday.yaml_file = "/path/to/yaml/holiday.yml"
+Holiday.country = "US"
+
+```
+
+You can query for dates
+
+```ruby
+
+# Defaults to current year
+Holiday.find("christmas")
+Holiday.find("labour day")
+
+```
+
+Or supply a year
+
+```ruby
+
+# Can supply the year as optional argument
+Holiday.find(:christmas, 2005)
+Holiday.find(:thanksgiving, 1999)
+
+```
+
+## YAML
+
+The YAML format for Holiday is as follows
+
+```yaml
+holiday:
+  US:
+    christmas:
+      when: december 25th
+      as: christmas
+    halloween:
+      when: october 31st
+      as: halloween, all hallows eve
+    labor_day:
+      when: 1st monday in september
+      as: labor day, labour day
+    thanksgiving:
+      when: 4th thursday in november
+      as: thanksgiving, turkey day
+```
+
+Holidays are scoped by country code. Each holiday needs both "when" and "as" keys. The "when" key can either be an exact
+month and day, or the occurrence of the holiday in the given month. E.g., "1st monday in september".
+
+The "as" key is used to identify holidays by alternate names and spellings. For instance, "thanksgiving" and "turkey day" should both
+point to the 4th thursday in november.
+
+```ruby
+
+Holiday.find("turkey day")
+Holiday.find(:thanksgiving)
+
+```
+
+## Other methods
+
+There are a few other methods that may be useful
+
+```ruby
+
+Holiday.all # array containing all keys and alternate names of holidays from yaml file
+Holiday.scan("a string containing a holiday by name, like christmas") # => christmas
+Holiday::Query.find("all hallows eve") # => october 31st
+
+```

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+# Run the test with 'rake' or 'rake test'
+desc 'Default: run hashed_attributes unit tests.'
+task :default => :test
+
+desc 'Test the hashed_attributes gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end

data/holiday.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "holiday/version"
+
+Gem::Specification.new do |s|
+  s.name        = "holiday"
+  s.version     = Holiday::VERSION
+  s.authors     = ["Sean Behan"]
+  s.email       = ["bseanvt@gmail.com"]
+  s.homepage    = "https://github.com/bseanvt/holiday"
+  s.summary     = %q{Holiday is a gem that lets you configure holidays for any country using a simple YAML file format.}
+  s.description = %q{Holiday is a gem that lets you configure holidays for any country using a simple YAML file format.}
+
+  s.rubyforge_project = "holiday"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "activesupport" #, ">= 3.1.0"
+end

data/lib/holiday.rb

@@ -0,0 +1,59 @@
+require 'active_support/time'
+require 'yaml'
+
+require "#{File.dirname(__FILE__)}/holiday/builder"
+require "#{File.dirname(__FILE__)}/holiday/parser"
+require "#{File.dirname(__FILE__)}/holiday/query"
+
+module Holiday
+  class << self
+    attr_accessor :yaml_file, :country
+    
+    def find(holiday,year=nil)
+      year = year || Time.now.year
+      
+      holiday = holiday.to_s
+      occurrs = Query.find(holiday)
+      parts   = Parser.parse(occurrs)
+
+      date = if parts.kind_of?(Hash)
+        d = Date.parse("#{parts[:month]} 1 #{year}")
+        weeks = (d.beginning_of_month..d.end_of_month).group_by{|d| d.wday}
+        weeks[parts[:wday]][parts[:occurrence]-1]
+      else
+        Date.parse([parts, year].join(" "))
+      end
+    end
+
+    # Returns all holidays
+    def all
+      Builder.build.keys
+    end
+
+    # holiday = Holiday.all.map { |h| string.scan(h) }.uniq.flatten # return match
+    def scan(string)
+      all.map{ |h| string.scan(h) }.uniq.flatten.join
+    end
+    
+    def include?(holiday)
+      all.keys.include?(holiday)
+    end
+    
+    def yaml
+      @yaml ||= YAML.load_file(yaml_file)["holiday"]
+    end
+
+    def holidays
+      yaml[country].keys
+    end
+
+    def country_holidays
+      yaml[country]
+    end
+    
+    # TODO add method missing to allow for methods like...
+    # Holiday.christmas_2005
+    # Holiday.thanksgiving(1999)
+    # Holiday.third_thursday_in_march(2005)
+  end
+end

data/lib/holiday.yml

@@ -0,0 +1,18 @@
+holiday:
+  US:
+    christmas:
+      when: december 25th
+      as: christmas
+    halloween:
+      when: october 31st
+      as: halloween, all hallows eve
+    labor_day:
+      when: 1st monday in september
+      as: labor day, labour day
+    thanksgiving:
+      when: 4th thursday in november
+      as: thanksgiving, turkey day
+  CA:
+    christmas:
+      when: december 25th
+      as: christmas, noël

data/lib/holiday/builder.rb

@@ -0,0 +1,18 @@
+module Holiday
+  # Sets up a container for holidays based on keys and alternative holiday names from yaml file.
+  class Builder
+    class << self
+      def build
+        return @container if defined?(@container)
+        @container = {}
+        Holiday.holidays.each do |holiday|
+          Holiday.country_holidays[holiday]["as"].split(",").each do |other|
+            @container[holiday] = holiday      # yaml key should be looked against as well
+            @container[other.strip] = holiday  # natural name, labour day, is a key
+          end
+        end
+        @container
+      end
+    end
+  end
+end

data/lib/holiday/parser.rb

@@ -0,0 +1,41 @@
+module Holiday  
+  # Extracts the relevant information from strings
+  class Parser
+    class << self
+      def parse(string)
+        if string =~ /in/
+          w,m,o = weekday(string), month(string), occurrence(string)
+          d = wday(w)
+          
+          { :weekday => w, :wday => d, :month => m, :occurrence => o }          
+        else
+          string
+        end
+      end
+
+      def weekday(string)
+        (string.split(' ').map(&:downcase) & weekdays).join
+      end
+
+      def month(string)
+        (string.split(' ').map(&:downcase) & months).join
+      end
+
+      def occurrence(string)
+        string.scan(/\d/).join.to_i
+      end
+
+      def wday(which)
+        weekdays.index(which)
+      end
+
+      def weekdays
+        %W(sunday monday tuesday wednesday thursday friday saturday)
+      end
+
+      def months
+        %W(january february march april may june july august september october november december)
+      end
+    end
+  end
+end

data/lib/holiday/query.rb

@@ -0,0 +1,11 @@
+module Holiday
+  # Query finds when a holiday occurrs
+  class Query
+    class << self
+      def find(holiday)
+        key = Builder.build[holiday]
+        Holiday.country_holidays[key]["when"] # => 1st monday in september
+      end
+    end
+  end
+end

data/lib/holiday/version.rb

@@ -0,0 +1,3 @@
+module Holiday
+  VERSION = "0.0.1"
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require "#{File.dirname(__FILE__)}/../lib/holiday"

data/test/holiday.yml

@@ -0,0 +1,18 @@
+holiday:
+  US:
+    christmas:
+      when: december 25th
+      as: christmas
+    halloween:
+      when: october 31st
+      as: halloween, all hallows eve
+    labor_day:
+      when: 1st monday in september
+      as: labor day, labour day
+    thanksgiving:
+      when: 4th thursday in november
+      as: thanksgiving, turkey day
+  CA:
+    christmas:
+      when: december 25th
+      as: christmas, noël

data/test/holiday_builder_test.rb

@@ -0,0 +1,16 @@
+require 'helper.rb'
+
+class HolidayTest < Test::Unit::TestCase
+  def setup
+    Holiday.yaml_file = "#{File.dirname(__FILE__)}/holiday.yml"
+    Holiday.country = "US"
+  end
+
+  def test_builder
+    assert Holiday::Builder.build
+    assert_kind_of Hash, Holiday::Builder.build
+
+    assert_equal "halloween", Holiday::Builder.build["all hallows eve"]
+    assert_equal "labor_day", Holiday::Builder.build["labour day"]
+  end
+end

data/test/holiday_parser_test.rb

@@ -0,0 +1,41 @@
+require 'helper.rb'
+
+class HolidayTest < Test::Unit::TestCase
+  def setup
+    Holiday.yaml_file = "#{File.dirname(__FILE__)}/holiday.yml"
+    Holiday.country = "US"
+  end
+
+  def test_parser_parse
+    assert_kind_of Hash, Holiday::Parser.parse("1st monday in june")
+    parts = {:weekday => "thursday", :occurrence => 2, :month => "october", :wday=>4}
+    assert_equal parts,  Holiday::Parser.parse("2nd thursday in october"), Holiday::Parser.parse('2nd thursday in october')
+    assert_equal "december 25th", Holiday::Parser.parse("december 25th")
+  end
+
+  def test_parser_wday
+    assert_equal 0, Holiday::Parser.wday("sunday")
+    assert_equal 1, Holiday::Parser.wday("monday")
+    assert_equal 2, Holiday::Parser.wday("tuesday")
+    assert_equal 3, Holiday::Parser.wday("wednesday")
+    assert_equal 4, Holiday::Parser.wday("thursday")
+    assert_equal 5, Holiday::Parser.wday("friday")
+    assert_equal 6, Holiday::Parser.wday("saturday")
+  end
+
+  def test_parser_weekday
+    assert_equal "monday", Holiday::Parser.weekday("today is monday")
+    assert_equal "friday", Holiday::Parser.weekday("thank goodness it's Friday")
+  end
+
+  def test_parser_month
+    assert_equal "january", Holiday::Parser.month("january is the first month of the year")
+    assert_equal "october", Holiday::Parser.month("halloween is a holiday that occurrs in october")
+    assert_equal "december", Holiday::Parser.month("christmas is in December")
+  end
+
+  def test_parser_occurrence
+    assert_equal 1, Holiday::Parser.occurrence("i'm looking for the number 1")
+    assert_equal 4, Holiday::Parser.occurrence("i love the 4th of july")
+  end
+end

data/test/holiday_query_test.rb

@@ -0,0 +1,16 @@
+require 'helper.rb'
+
+class HolidayTest < Test::Unit::TestCase
+  def setup
+    Holiday.yaml_file = "#{File.dirname(__FILE__)}/holiday.yml"
+    Holiday.country = "US"
+  end
+
+  def test_query
+    assert_kind_of String, Holiday::Query.find("christmas")
+    assert_equal "december 25th", Holiday::Query.find("christmas")
+    assert_equal "october 31st", Holiday::Query.find("all hallows eve"), Holiday::Query.find("all hallows eve")
+    assert_equal "1st monday in september", Holiday::Query.find("labour day"), Holiday::Query.find("labour day")
+    assert_equal Holiday::Query.find("labour day"), Holiday::Query.find("labor_day"), Holiday::Query.find("labour day")
+  end
+end

data/test/holiday_test.rb

@@ -0,0 +1,53 @@
+require 'helper.rb'
+
+class HolidayTest < Test::Unit::TestCase
+  def setup
+    Holiday.yaml_file = "#{File.dirname(__FILE__)}/holiday.yml"
+    Holiday.country = "US"
+  end
+
+  def test_config
+    assert "holiday.yml", Holiday.yaml_file
+    assert "US", Holiday.country
+  end
+  
+  def test_yaml_file_loaded
+    assert_kind_of Hash, Holiday.yaml
+  end
+  
+  def test_country_holidays
+    assert Holiday.holidays.include?("christmas"), Holiday.holidays.join(" ")
+    assert Holiday.holidays.include?("labor_day"), Holiday.holidays.join(" ")
+  
+    Holiday.country = "CA"
+    assert_equal "CA", Holiday.country
+    assert Holiday.holidays.include?("christmas")
+    assert !Holiday.holidays.include?("labor_day")
+  end
+  
+  def test_scan_string
+    assert_equal "labour day", Holiday.scan("labour day 2009"), Holiday.scan("hello labour day world")
+    assert_equal "turkey day", Holiday.scan("turkey day 2007"), Holiday.scan("turkey day 2007")    
+    assert_equal false, Holiday.scan("octoberfest 1990").present?, Holiday.scan("octoberfest 1990")        
+  end
+  
+  def test_holiday_find
+    assert_kind_of Date, Holiday.find(:christmas, 2005)
+  
+    # by keys and by alternate names
+    assert_equal "2005-12-25", Holiday.find(:christmas, 2005).to_s # symbol
+    assert_equal "2005-12-25", Holiday.find("christmas", 2005).to_s # or string
+    assert_equal "2004-09-06", Holiday.find("labor_day", 2004).to_s
+    assert_equal "2004-09-06", Holiday.find("labor day", 2004).to_s
+    assert_equal "2004-09-06", Holiday.find("labour day", 2004).to_s
+    assert_equal "1999-11-25", Holiday.find("thanksgiving", 1999).to_s
+    assert_equal "1999-11-25", Holiday.find("turkey day", 1999).to_s
+    
+  end
+  
+  def test_year_defaults_to_this_year
+    # defaults to current year
+    assert_equal "#{Time.now.year}-12-25", Holiday.find("christmas").to_s
+    assert_equal "#{Time.now.year}-11-24", Holiday.find("thanksgiving").to_s    
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: holiday
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sean Behan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70225950789700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70225950789700
+description: Holiday is a gem that lets you configure holidays for any country using
+  a simple YAML file format.
+email:
+- bseanvt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- holiday.gemspec
+- lib/holiday.rb
+- lib/holiday.yml
+- lib/holiday/builder.rb
+- lib/holiday/parser.rb
+- lib/holiday/query.rb
+- lib/holiday/version.rb
+- test/helper.rb
+- test/holiday.yml
+- test/holiday_builder_test.rb
+- test/holiday_parser_test.rb
+- test/holiday_query_test.rb
+- test/holiday_test.rb
+homepage: https://github.com/bseanvt/holiday
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: holiday
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Holiday is a gem that lets you configure holidays for any country using a
+  simple YAML file format.
+test_files:
+- test/helper.rb
+- test/holiday.yml
+- test/holiday_builder_test.rb
+- test/holiday_parser_test.rb
+- test/holiday_query_test.rb
+- test/holiday_test.rb