hk_holidays 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+  gem "ri_cal"
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.10)
+    git (1.2.5)
+    i18n (0.6.4)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.8.0)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    ri_cal (0.8.8)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.4)
+    shoulda-matchers (2.2.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (> 1.0.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  ri_cal
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Alan Ho
+
+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.rdoc

@@ -0,0 +1,19 @@
+= hk_holidays
+
+Description goes here.
+
+== Contributing to hk_holidays
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Alan Ho. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "hk_holidays"
+  gem.homepage = "http://github.com/alanho/hk_holidays"
+  gem.license = "MIT"
+  gem.summary = %Q{A utility to tell whether a specific date is a Hong Kong's holiday}
+  gem.description = %Q{A utility to tell whether a specific date is a Hong Kong's holiday}
+  gem.email = "alanho@gmail.com"
+  gem.authors = ["Alan Ho"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hk_holidays #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/hk_holidays.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "hk_holidays"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alan Ho"]
+  s.date = "2013-06-29"
+  s.description = "A utility to tell whether a specific date is a Hong Kong's holiday"
+  s.email = "alanho@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "hk_holidays.gemspec",
+    "lib/core_ext/date.rb",
+    "lib/hk_holidays.rb",
+    "lib/hk_holidays.yml",
+    "lib/hk_holidays/version.rb",
+    "tasks/update.rake",
+    "test/helper.rb",
+    "test/test_hk_holidays.rb"
+  ]
+  s.homepage = "http://github.com/alanho/hk_holidays"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "A utility to tell whether a specific date is a Hong Kong's holiday"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<ri_cal>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<ri_cal>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<ri_cal>, [">= 0"])
+  end
+end
+

data/lib/core_ext/date.rb

@@ -0,0 +1,11 @@
+class Date
+  def is_hk_holiday?(options = {})
+    return_name = (options[:return_name] == true)
+
+    if HKHolidays.is_hk_holiday?(self)
+      return_name ? HKHolidays.holiday_name(self) : true
+    else
+      false
+    end
+  end
+end

data/lib/hk_holidays.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+$:.unshift File.dirname(__FILE__)
+
+require "date"
+require "yaml"
+
+class HKHolidays
+  class << self
+    def is_hk_holiday?(date)
+      holidays.map { |d| d[:date] }.include? date
+    end
+
+    def holiday_name(date)
+      holiday = holidays.find { |d| d[:date] == date }
+      holiday ? holiday[:name] : false
+    end
+
+    def holidays
+      @holidays ||= load_holidays
+    end
+
+    protected
+    def load_holidays
+      YAML::load_file(File.join(File.dirname(__FILE__), "hk_holidays.yml"))
+    end
+  end
+end
+
+require "core_ext/date"

data/lib/hk_holidays.yml

@@ -0,0 +1,107 @@
+---
+- :name: The first weekday after Chrstmas Day
+  :date: 2011-12-26
+- :name: The second weekday after Chrstmas Day
+  :date: 2011-12-27
+- :name: The day following the first day of January
+  :date: 2012-01-02
+- :name: Lunar New Year's Day
+  :date: 2012-01-23
+- :name: The second day of Lunar New Year
+  :date: 2012-01-24
+- :name: The third day of Lunar New Year
+  :date: 2012-01-25
+- :name: Ching Ming Festival
+  :date: 2012-04-04
+- :name: Good Friday
+  :date: 2012-04-06
+- :name: The day following Good Friday
+  :date: 2012-04-07
+- :name: Easter Monday
+  :date: 2012-04-09
+- :name: The Birthday of the Buddha
+  :date: 2012-04-28
+- :name: Labour Day
+  :date: 2012-05-01
+- :name: Tuen Ng Festival
+  :date: 2012-06-23
+- :name: The day following Hong Kong Special Administrative Region Establishment Day
+  :date: 2012-07-02
+- :name: The day following the Chinese Mid-Autumn Festival
+  :date: 2012-10-01
+- :name: The day following National Day
+  :date: 2012-10-02
+- :name: Chung Yeung Festival
+  :date: 2012-10-23
+- :name: Christmas Day
+  :date: 2012-12-25
+- :name: The first weekday after Christmas Day
+  :date: 2012-12-26
+- :name: The first day of January
+  :date: 2013-01-01
+- :name: The second day of Lunar New Year
+  :date: 2013-02-11
+- :name: The third day of Lunar New Year
+  :date: 2013-02-12
+- :name: The fourth day of Lunar New Year
+  :date: 2013-02-13
+- :name: Good Friday
+  :date: 2013-03-29
+- :name: The day following Good Friday
+  :date: 2013-03-30
+- :name: Easter Monday
+  :date: 2013-04-01
+- :name: Ching Ming Festival
+  :date: 2013-04-04
+- :name: Labour Day
+  :date: 2013-05-01
+- :name: The Birthday of the Buddha
+  :date: 2013-05-17
+- :name: Tuen Ng Festival
+  :date: 2013-06-12
+- :name: Hong Kong Special Administrative Region Establishment Day
+  :date: 2013-07-01
+- :name: The day following the Chinese Mid-Autumn Festival
+  :date: 2013-09-20
+- :name: National Day
+  :date: 2013-10-01
+- :name: The day following Chung Yeung Festival
+  :date: 2013-10-14
+- :name: Christmas Day
+  :date: 2013-12-25
+- :name: The first weekday after Christmas Day
+  :date: 2013-12-26
+- :name: The first day of January
+  :date: 2014-01-01
+- :name: Lunar New Year’s Day
+  :date: 2014-01-31
+- :name: The second day of Lunar New Year
+  :date: 2014-02-01
+- :name: The fourth day of Lunar New Year
+  :date: 2014-02-03
+- :name: Ching Ming Festival
+  :date: 2014-04-05
+- :name: Good Friday
+  :date: 2014-04-18
+- :name: The day following Good Friday
+  :date: 2014-04-19
+- :name: Easter Monday
+  :date: 2014-04-21
+- :name: Labour Day
+  :date: 2014-05-01
+- :name: The Birthday of the Buddha
+  :date: 2014-05-06
+- :name: Tuen Ng Festival
+  :date: 2014-06-02
+- :name: Hong Kong Special Administrative Region Establishment Day
+  :date: 2014-07-01
+- :name: The day following the Chinese Mid-Autumn Festival
+  :date: 2014-09-09
+- :name: National Day
+  :date: 2014-10-01
+- :name: Chung Yeung Festival
+  :date: 2014-10-02
+- :name: Christmas Day
+  :date: 2014-12-25
+- :name: The first weekday after Christmas Day
+  :date: 2014-12-26

data/tasks/update.rake

@@ -0,0 +1,22 @@
+require "open-uri"
+require "ri_cal"
+require "yaml"
+
+desc "Update holidays from HK Government's official iCal file"
+namespace :hk_holidays do
+  task :update do
+    ICAL_URL = "http://www.1823.gov.hk/common/ical/en.ics"
+
+    holidays = []
+    RiCal.parse_string(open(ICAL_URL).read).first.events.each do |event|
+      # p event.dtstart
+      holidays << {
+        name: event.summary.force_encoding("utf-8").gsub(/[[:cntrl:]]/,""),
+        date: event.dtstart
+      }
+    end
+    File.open(File.join(File.dirname(__FILE__), "../lib/hk_holidays.yml"), "w") do |f|
+      f.write YAML::dump(holidays)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'hk_holidays'
+
+class Test::Unit::TestCase
+end

data/test/test_hk_holidays.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestHkHolidays < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: hk_holidays
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alan Ho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: ri_cal
+  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: A utility to tell whether a specific date is a Hong Kong's holiday
+email: alanho@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- hk_holidays.gemspec
+- lib/core_ext/date.rb
+- lib/hk_holidays.rb
+- lib/hk_holidays.yml
+- lib/hk_holidays/version.rb
+- tasks/update.rake
+- test/helper.rb
+- test/test_hk_holidays.rb
+homepage: http://github.com/alanho/hk_holidays
+licenses:
+- MIT
+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: -1196745162011333692
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A utility to tell whether a specific date is a Hong Kong's holiday
+test_files: []