holiday_tools 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1,2 @@
+rvmarchflags="-arch x86_64"
+rvm use 1.9.3@holidays --create

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 kittekat
+
+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,29 @@
+# HolidayTools
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'holiday_tools'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install holiday_tools
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/holiday_tools

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# CLI for the HolidayTools::Locator
+# list the countries/subregions which have a holiday
+
+# kittekat /may/jun 2013
+
+require "date"
+require "optparse"
+require "optparse/date"
+require "ostruct"
+
+require "holiday_tools"
+
+# dummy entry will keep the ruby interpeter happy
+# as the "real" @opts is generated in an begin/rescue/end block
+@opts={}
+
+# collect the commandline options
+def get_opts
+  options = OpenStruct.new
+  
+  #set the defaults
+  options.mode = :d
+  options.date = Date.today
+  options.debug = false
+  #options.list = false
+  
+  # prepare the parser
+  opts = OptionParser.new
+  opts.banner = "Usage: #{__FILE__} [options] [region [region] ...]"
+  
+  opts.on( '-m', '--mode MODE', [:d, :w, :m, :y], 
+                 "d(ay), w(eek), m(onth), y(ear) [Default: d]") do |m|
+    options.mode = m
+  end
+  
+  opts.on( '-d', '--date YYYY-MM-DD', Date, 
+                 "Year-Month-Day [Default: today]") do |d|
+    options.date = d
+  end
+  
+  opts.on( '-v', '--verbose', "Flag for debug output [Default: false]") do |v|
+    options.debug = v
+  end
+  
+  opts.on( '-l', '--list', 'List available regions') do |l|
+    options.list = l
+  end
+  
+  opts.on_tail( '-h', '--help', "Show this message") do
+    puts opts
+    exit
+  end
+  
+  opts.parse!(ARGV)  # start the parser
+  
+  # collect additional parameters as filter 
+  options.filter = ARGV
+
+  options           # return the struct
+end
+
+
+# start with the commandline options
+# recover from bad user input for options
+begin
+  @opts = get_opts
+  if @opts.debug
+    puts "mode: %s" %  [@opts.mode]
+    puts "date: %s" %  [@opts.date]
+    puts "filter: %s" % [@opts.filter]
+    puts "list: %s" % [@opts.list]
+  end
+rescue OptionParser::InvalidArgument
+  puts "Invalid date argument"
+  puts "Use --help for a format hint"
+  exit
+rescue OptionParser::MissingArgument
+  puts "Missing argument"
+  puts "Use --help for hints"
+  exit
+rescue OptionParser::InvalidOption
+  puts "Invalid option"
+  puts "Use --help for a list"
+  exit
+end
+
+holidays = HolidayTools::Locator.new(@opts.filter)
+if @opts.list
+  puts holidays.show_regions
+  exit
+end
+
+# distribute depending on mode
+date = @opts.date
+case @opts.mode
+when :d
+  puts holidays.show_holiday(date)
+when :w
+  puts holidays.show_week(date)
+when :m
+  puts holidays.show_month(date)
+when :y
+  puts holidays.show_year(date)
+end
+

data/holiday_tools.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/holiday_tools/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["kittekat"]
+  gem.email         = ["wolfkibe@gmail.com"]
+  gem.description   = %q{List regions of public holidays}
+  gem.summary       = %q{Select date, period and regions for public holidays}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "holiday_tools"
+  gem.require_paths = ["lib"]
+  gem.version       = HolidayTools::VERSION
+  
+  gem.add_dependency 'holidays'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+end

data/lib/holiday_tools/version.rb

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

data/lib/holiday_tools.rb

@@ -0,0 +1,284 @@
+# encoding: utf-8
+
+require "holiday_tools/version"
+
+module HolidayTools
+  class Locator
+
+    # prerequisit: gem install holidays
+    # see https://github.com/alexdunae/holidays
+
+    require "holidays"
+    require "holidays/at"
+    require "holidays/au"
+    require "holidays/br"
+    require "holidays/ca"
+    # require "holidays/ch"
+    require "holidays/cz"
+    require "holidays/de"
+    require "holidays/dk"
+    require "holidays/el"
+    require "holidays/es"
+    require "holidays/fi"
+    require "holidays/fr"
+    require "holidays/gb"
+    # require "holidays/hr"
+    # require "holidays/hu"
+    require "holidays/ie"
+    require "holidays/is"
+    require "holidays/it"
+    require "holidays/jp"
+    require "holidays/li"
+    require "holidays/mx"
+    require "holidays/nl"
+    require "holidays/no"
+    require "holidays/nz"
+    require "holidays/pl"
+    require "holidays/pt"
+    require "holidays/se"
+    require "holidays/us"
+    # require "holidays/vz"
+    require "holidays/za"
+
+    def initialize( filter )
+      @filter = filter
+    
+      # names of the regions/subregions used in the holidays gem
+      @reg_names = {
+        at:     'Austria',
+        au:     'Australia',
+        au_act:  'Australia/Australian Capital Terretory',
+        au_nsw:  'Australia/New South Wales',
+        au_nt:  'Australia/Nothern Terretory',
+        au_qld: 'Australia/Queensland',
+        au_qld_brisbane: 'Australia/Queensland and Brisbane',
+        au_sa:  'Australia/South Australia',
+        au_tas: 'Australia/Tasmania',
+        au_vic: 'Australia/Victoria',
+        au_wa:  'Australia/Western Australia',
+        br:     'Brasilia',
+        ca:     'Canada',
+        ca_ab:  'Canada/Alberta',
+        ca_bc:  'Canada/British Columbia',
+        ca_mb:  'Canada/Manitoba',
+        ca_nb:  'Canada/New Brunswick',
+        ca_nf:  'Canada/Newfoundland',
+        ca_ns:  'Canada/Nova Scotia',
+        ca_nt:  'Canada/Northwest Territories',
+        ca_nu:  'Canada/Nunavut',
+        ca_on:  'Canada/Ontario',
+        ca_pe:  'Canada/Prince Edward Island',
+        ca_sk:  'Canada/Saskatchewan',
+        ca_qc:  'Canada/Quebeck',
+        ca_yk:  'Canada/Yukon',
+        cz:     'Czech Republic',
+        de:     'Germany',
+        de_bb:  'Germany/Brandenburg',
+      # de_be:  'Germany/Berlin',
+        de_bw:  'Germany/Baden-Württemberg',
+        de_by:  'Germany/Bayern',
+      # de_hb:  'Germany/Freie Hansestadt Bremen',
+        de_he:  'Germany/Hessen',
+      # de_hh:  'Germany/Hamburg',
+        de_mv:  'Germany/Mecklenburg-Vorpommern',
+      # de_ni:  'Germany/Niedersachsen',
+        de_nw:  'Germany/Nordrhein-Westfalen',
+        de_rp:  'Germany/Rheinland-Pfalz',
+      # de_sh:  'Germany/Schleswig-Holstein',
+        de_sl:  'Germany/Saarland',
+        de_sn:  'Germany/Sachsen',
+        de_st:  'Germany/Sachsen-Anhalt',
+        de_th:  'Germany/Thüringen',
+        dk:     'Denmark',
+        el:     'Greece',
+        es:     'Spain',
+        es_an:  'Spain/Andalusia',
+        es_ar:  'Spain/Aragon',
+        es_ce:  'Spain/Ceuta',
+        es_cl:  'Spain/Castile and Leon',
+        es_cm:  'Spain/Castile-La Mancha',
+        es_cn:  'Spain/Canary Island',
+        es_ct:  'Spain/Catalonia',
+        es_ex:  'Spain/Extremadura',
+        es_ga:  'Spain/Galicia',
+        es_ib:  'Spain/Islas Baleares',
+        es_lo:  'Spain/La Rioja',
+        es_m:   'Spain/Madrid',
+        es_mu:  'Spain/Murcia',
+        es_na:  'Spain/Navarre',
+        es_o:   'Spain/Asturias',
+        es_pv:  'Spain/Euskadi (Pais Vasco - Basque Country)',
+        es_v:   'Spain/Valencia',
+        es_vc:  'Spain/Valencia',
+        fi:     'Finland',
+        fr:     'France',
+        gb:     'Great Britain',
+        gb_eng: 'Great Britain/England',
+        gb_wls: 'Great Britain/Wales',
+        gb_eaw: 'Great Britain/England and Wales',
+        gb_nir: 'Great Britain/Norther Ireland',
+        gb_sct: 'Great Britain/Scotland',
+        gb_jsy: 'Great Britain/Jersey',
+        gb_gsy: 'Great Britain/Guernsey',
+        gb_con: 'Great Britain/Cornwall',
+        gb_iom: 'Great Britain/Isle of Man',
+        gg:     'Guernsey',
+        ie:     'ireland',
+        im:     'Isle of Man',
+        it:     'Italy',
+        is:     'Iceland',
+        je:     'Jersey',
+        jp:     'Japan',
+        li:     'Liechtenstein',
+        mx:     'Mexico',
+        mx_pue: 'Mexico/Puebla',
+        nz:     'New Zealand',
+        nz_ak:  'New Zealand/Auckland',
+        nz_ca:  'New Zealand/Canterbury',
+        nz_ch:  'New Zealand/Chatham',
+        nz_hb:  "New Zealand/Hawke's Bay",
+        nz_mb:  'New Zealand/Marlboro',
+        nz_nl:  'New Zealand/Northland',
+        nz_ot:  'New Zealand/Otago',
+        nz_sc:  'New Zealand/South Canterbury',
+        nz_sl:  'New Zealand/Southland',
+        nz_we:  'New Zealand/Wellington',
+        nz_wl:  'New Zealand/Westland',
+        nl:     'Netherlands',
+        no:     'Norway',
+        pl:     'Poland',
+        pt:     'Portugal',
+        se:     'Sweden',
+        us:     'United States of America',
+        us_dc:  'United States of America/Washington DC',
+        za:     'South Africa'
+        }
+    end
+  
+    # loop over region names
+    def show_regions
+      txt = []
+      txt << "Region \tName"
+      @reg_names.each do |key, val|
+        txt << "%s \t%s" % [key, val]
+      end
+      txt
+    end
+
+    # get the name of a holiday and the regions, where it is observed
+    def show_holiday(date)
+      ans = Holidays.on(date, :any, :observed)
+      # dat = date.to_s
+      if ans.size > 0
+        if @filter.size == 0
+          show_all(date, ans)
+        else
+          show_filtered(date, ans)      
+        end
+      end
+    end
+
+    # loop over a week
+    def show_week(date)
+      fw = date - date.wday   # from sunday
+      tw = fw + 6             # to saturday
+      show_holidays(fw, tw)
+    end
+
+    # loop over a month
+    def show_month(date)
+      fm = date - date.mday + 1  # from 1. in month
+      tm = (fm >> 1) - 1      # to last in month ( '>> 1' advances one month )
+      show_holidays(fm, tm)
+    end
+
+
+    # loop over a year
+    def show_year(date)
+      fy = date - date.yday + 1
+      ty = Date.civil(fy.year, 12, 31)
+      show_holidays(fy, ty)
+    end
+
+    private
+    # get the name of a weekday
+    def wday_nam(wday)
+      name = %w( Sunday Monday Tuesday Wednesday Thursday Friday Saturday )
+      name[wday]
+    end
+
+    # show the date
+    def show_dat(dat)
+      "%s (%s)" % [dat.to_s, wday_nam(dat.wday)]
+    end
+
+    # show the name of the holiday
+    def show_nam(nam)
+      "\t %s" % [ nam ]
+    end
+
+    # show the expanded name of a region
+    def show_reg(reg)
+      rn = @reg_names[reg]
+      if rn
+        "\t \t %s" % [ rn ]
+      else
+        "\t \t :%s (?)" % [ reg ]        
+      end
+    end
+
+    # show without region filter
+    def show_all(dat, ans)
+      txt = []
+      txt << show_dat(dat)
+      ans.each do |entry|
+        nam = entry[:name]
+        txt << show_nam(nam)
+        entry[:regions].each do |reg|
+          txt << show_reg(reg)
+        end
+      end
+      txt
+    end
+
+    # show with region filter
+    def show_filtered(dat, ans)
+      txt = []
+      date_shown = false
+      ans.each do |entry|
+        nam = entry[:name]
+        name_shown = false
+        entry[:regions].each do |reg|
+          @filter.each do |pat|
+            # construct a pattern
+            pattern = Regexp.new(pat)
+            if reg.to_s =~ pattern
+              # we have a match
+              unless date_shown
+                txt << show_dat(dat)
+                date_shown = true
+              end
+              unless name_shown
+                txt << show_nam(nam)
+                name_shown = true
+              end
+              txt << show_reg(reg)
+            end
+          end
+        end  
+      end
+      txt
+    end
+
+    # loop over a range of dates
+    def show_holidays(from_date, to_date)
+      txt = []
+      from_date.upto(to_date) do |date|
+        res = show_holiday(date)
+        txt << res if res
+      end
+      txt
+    end 
+
+  end # class
+end # module

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: holiday_tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- kittekat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: holidays
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: List regions of public holidays
+email:
+- wolfkibe@gmail.com
+executables:
+- holiday_tools
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/holiday_tools
+- holiday_tools.gemspec
+- lib/holiday_tools.rb
+- lib/holiday_tools/version.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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Select date, period and regions for public holidays
+test_files: []