holiday_tools 0.0.13 → 0.0.14

data/README.md

@@ -1,12 +1,36 @@
 # HolidayTools
 
-TODO: Write a gem description
+This is a wrapper around the alexdunae/holidays gem with a more intuitive API (at least IMO). It uses the region-id's of that gem to filter the results.
+
+## API Description
+
+### Class methods
+
+* **show_regions**  
+generates a list of region-id's and names of that region (country in Englich and sub-region in local name, e.g. Germany/Sachsen) 
+
+### Instance methods
+
+* **new(filter=[])**  
+You may supply an array of region-id's (see show_regions)
+
+* **show\_holiday( date )**  
+Generates a list of all public holidays for _date_, which is a Date object (e.g. Date.today)
+
+* **show\_week( date )**  
+Generates the list of holidays for the week (sunday to saturday), which contains the date 
+
+* **show\_month( date )**  
+Generates the list of holidays for the month, which contains the date
+
+* **show\_year( date )**  
+Generates the list of holidays for the year, which contains the date
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'holiday_tools'
+    $ gem 'holiday_tools'
 
 And then execute:
 
@@ -18,8 +42,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Included in the gem is an executable, which can be used as CLI command. Examples:  
+
+    $ holiday_tools 
+shows all regions which observe today a public holiday
+
+    $ holiday_tools --date 2013-05-01 --mode m  
+shows all holidays in all regions in May, 2013  
+
+    $ holiday_tools --mode y at ge
+shows all holidays in the current year in Austria and Germany
 
+    $ holiday_tools --help
+shows the usage hints
+ 
 ## Contributing
 
 1. Fork it

data/bin/holiday_tools

@@ -92,6 +92,7 @@ rescue OptionParser::InvalidOption
 end
 
 if @opts.list
+  puts "Region \tName"
   puts HolidayTools::Locator.show_regions
   exit
 end

data/lib/holiday_tools/locator.rb

@@ -156,7 +156,6 @@ module HolidayTools
     def self.show_regions
       regs = Holidays.regions.sort
       txt = []
-      txt << "Region \tName"
       regs.each do |key|
         name = @@reg_names[key]
         if name

data/lib/holiday_tools/version.rb

@@ -1,3 +1,3 @@
 module HolidayTools
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

data/spec/holiday_tools/locator_spec.rb

@@ -23,7 +23,7 @@ describe HolidayTools do
   it 'should list all available regions' do
     regions = HolidayTools::Locator.show_regions
     p regions
-    regions.size.should == 101
+    regions.size.should == 100
     
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: holiday_tools
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: holidays