xcal 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 381a7242d8cc072c67ca700f455f96a7ce793d5e
-  data.tar.gz: da3ccee9b1e44f40e3b56a54ca5cc313e7fcdf5b
+  metadata.gz: c428b7d20554555f682cdedb790233cbe56016d0
+  data.tar.gz: ac7fff1bd5b7fb5f3e49efb93e4fbbd78fb9817b
 SHA512:
-  metadata.gz: 37fd55ddc8f6e0b79685bd2e0320bb025ce9f9bdfd2a008b5c39c573107eeea0e73e6d32e48b5071aa7565e864382de72038afa6e43a747557e61eaa38e3d96d
-  data.tar.gz: 3544167b6037474f8e0da456e000775b76f195d439f67fec8e4cd34f2715ea0aeed4af7df36988e83cf6dd032860e98764727c4d141b7788a170f69ded909239
+  metadata.gz: 1718c31a659f8ab85df6c2e85716626ec42e44f1a32323446fdb330da8265bc893320a4aef5d38ad2b83a4a565727e24d0a06365b3f97320290e847e87e5f2ad
+  data.tar.gz: 0ad9116449e3bba907c2449921a4693380c3a9f09baa2e43d583d15534ba86c87f6cdb8fd7d1b5d4dd7180a65b4215ed0441b40f1530a4512edca1f270d12423

data/README.md

@@ -1,6 +1,130 @@
-xcal
-====
+# xcal
 
-xcalは日本の祝日に対応したcal, ncalライクなカレンダーコマンドです。
-祝日の情報はGoogleが提供するiCalを利用し、表示のたびにダウンロードします。
-カレンダーはカラフルに土曜日が青色、日曜日と祝日が赤色で表示されます。
+xcalは休日の色付き表示に対応したcal, ncalライクなカレンダーコマンドです。
+休日の情報は表示のたびにiCal(icsファイル)をダウンロードして取得します。
+デフォルトではGoogleが提供するiCalを利用し日本の休日を表示します。
+また任意のicsファイルを指定して休日を表示することもできます。
+カレンダーはカラフルに土曜日が青色、日曜日と休日が赤色で表示されます。
+
+## インストール
+
+```
+# gem install xcal
+```
+
+## 使い方
+
+デフォルトで前後1ヶ月の3ヶ月分のカレンダーを表示します。(実際は色付きです)
+
+```
+$ xcal
+   November 2017         December 2017          January 2018    
+Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+          1  2  3  4                  1  2      1  2  3  4  5  6
+ 5  6  7  8  9 10 11   3  4  5  6  7  8  9   7  8  9 10 11 12 13
+12 13 14 15 16 17 18  10 11 12 13 14 15 16  14 15 16 17 18 19 20
+19 20 21 22 23 24 25  17 18 19 20 21 22 23  21 22 23 24 25 26 27
+26 27 28 29 30        24 25 26 27 28 29 30  28 29 30 31         
+                      31                                        
+```
+
+`-l`オプションで休日の詳細を表示することができます。(iCalの`summary`を表示します)
+
+```
+$ xcal -l
+   November 2017         December 2017          January 2018    
+Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+          1  2  3  4                  1  2      1  2  3  4  5  6
+ 5  6  7  8  9 10 11   3  4  5  6  7  8  9   7  8  9 10 11 12 13
+12 13 14 15 16 17 18  10 11 12 13 14 15 16  14 15 16 17 18 19 20
+19 20 21 22 23 24 25  17 18 19 20 21 22 23  21 22 23 24 25 26 27
+26 27 28 29 30        24 25 26 27 28 29 30  28 29 30 31         
+                      31                                        
+2017-11-03 (Fr) 文化の日
+2017-11-23 (Th) 勤労感謝の日
+2017-12-23 (Sa) 天皇誕生日
+2018-01-01 (Mo) 元日
+2018-01-08 (Mo) 成人の日
+```
+
+`-9`オプションで前後4ヶ月の9ヶ月分のカレンダーを表示します。
+
+```
+$ xcal -9
+     August 2017        September 2017          October 2017    
+Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+       1  2  3  4  5                  1  2   1  2  3  4  5  6  7
+ 6  7  8  9 10 11 12   3  4  5  6  7  8  9   8  9 10 11 12 13 14
+13 14 15 16 17 18 19  10 11 12 13 14 15 16  15 16 17 18 19 20 21
+20 21 22 23 24 25 26  17 18 19 20 21 22 23  22 23 24 25 26 27 28
+27 28 29 30 31        24 25 26 27 28 29 30  29 30 31            
+                                                                
+   November 2017         December 2017          January 2018    
+Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+          1  2  3  4                  1  2      1  2  3  4  5  6
+ 5  6  7  8  9 10 11   3  4  5  6  7  8  9   7  8  9 10 11 12 13
+12 13 14 15 16 17 18  10 11 12 13 14 15 16  14 15 16 17 18 19 20
+19 20 21 22 23 24 25  17 18 19 20 21 22 23  21 22 23 24 25 26 27
+26 27 28 29 30        24 25 26 27 28 29 30  28 29 30 31         
+                      31                                        
+   February 2018            March 2018            April 2018    
+Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+             1  2  3               1  2  3   1  2  3  4  5  6  7
+ 4  5  6  7  8  9 10   4  5  6  7  8  9 10   8  9 10 11 12 13 14
+11 12 13 14 15 16 17  11 12 13 14 15 16 17  15 16 17 18 19 20 21
+18 19 20 21 22 23 24  18 19 20 21 22 23 24  22 23 24 25 26 27 28
+25 26 27 28           25 26 27 28 29 30 31  29 30               
+```
+
+環境変数`XCAL_ICS_URL`にicsファイルのURLを指定すると日本以外の休日を表示することもできます。
+以下はアメリカ合衆国の休日のicsファイルを読み込ませてアメリカ合衆国のカレンダーを表示する例です。
+
+```
+$ export XCAL_ICS_URL=https://calendar.google.com/calendar/ical/ja.usa%23holiday%40group.v.calendar.google.com/public/basic.ics
+$ xcal -9 -l
+     August 2017        September 2017          October 2017    
+Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+       1  2  3  4  5                  1  2   1  2  3  4  5  6  7
+ 6  7  8  9 10 11 12   3  4  5  6  7  8  9   8  9 10 11 12 13 14
+13 14 15 16 17 18 19  10 11 12 13 14 15 16  15 16 17 18 19 20 21
+20 21 22 23 24 25 26  17 18 19 20 21 22 23  22 23 24 25 26 27 28
+27 28 29 30 31        24 25 26 27 28 29 30  29 30 31            
+                                                                
+   November 2017         December 2017          January 2018    
+Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+          1  2  3  4                  1  2      1  2  3  4  5  6
+ 5  6  7  8  9 10 11   3  4  5  6  7  8  9   7  8  9 10 11 12 13
+12 13 14 15 16 17 18  10 11 12 13 14 15 16  14 15 16 17 18 19 20
+19 20 21 22 23 24 25  17 18 19 20 21 22 23  21 22 23 24 25 26 27
+26 27 28 29 30        24 25 26 27 28 29 30  28 29 30 31         
+                      31                                        
+   February 2018            March 2018            April 2018    
+Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+             1  2  3               1  2  3   1  2  3  4  5  6  7
+ 4  5  6  7  8  9 10   4  5  6  7  8  9 10   8  9 10 11 12 13 14
+11 12 13 14 15 16 17  11 12 13 14 15 16 17  15 16 17 18 19 20 21
+18 19 20 21 22 23 24  18 19 20 21 22 23 24  22 23 24 25 26 27 28
+25 26 27 28           25 26 27 28 29 30 31  29 30               
+                                                                
+2017-09-04 (Mo) Labor Day
+2017-10-09 (Mo) Columbus Day (regional holiday)
+2017-10-31 (Tu) Halloween
+2017-11-05 (Su) Daylight Saving Time ends
+2017-11-10 (Fr) Veterans Day observed
+2017-11-11 (Sa) Veterans Day
+2017-11-23 (Th) Thanksgiving Day
+2017-12-24 (Su) Christmas Eve
+2017-12-25 (Mo) Christmas Day
+2017-12-31 (Su) New Year's Eve
+2018-01-01 (Mo) New Year's Day
+2018-01-15 (Mo) Martin Luther King Jr. Day
+2018-02-14 (We) Valentine's Day
+2018-02-19 (Mo) Presidents' Day
+2018-03-11 (Su) Daylight Saving Time starts
+2018-04-01 (Su) Easter Sunday
+2018-04-13 (Fr) Thomas Jefferson's Birthday
+```
+
+## License
+
+This software is distributed under the MIT license.

data/exe/xcal

@@ -2,6 +2,5 @@
 
 require 'rubygems'
 require 'xcal'
-include Xcal
 
-main()
+Xcal::Xcal.new.main(ARGV)

data/lib/xcal.rb

@@ -1,6 +1,9 @@
-require 'date'
-require 'open-uri'
-require 'icalendar'
+module Xcal
+  require 'date'
+  require 'open-uri'
 
-require "xcal/version"
-require "xcal/xcal"
+  require 'icalendar'
+
+  require "xcal/version"
+  require "xcal/xcal"
+end

data/lib/xcal/version.rb

@@ -1,3 +1,3 @@
 module Xcal
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/xcal/xcal.rb

@@ -1,4 +1,4 @@
-module Xcal
+class Xcal::Xcal
   BLUE = "\e[34m"
   RED = "\e[31m"
   REVERSE = "\e[7m"
@@ -16,7 +16,7 @@ module Xcal
     REVERSE + str + CLEAR
   end
 
-  URL = 'https://www.google.com/calendar/ical/ja.japanese%23holiday%40group.v.calendar.google.com/public/basic.ics'
+  ICS_URL = ENV['XCAL_ICS_URL'] || 'https://www.google.com/calendar/ical/ja.japanese%23holiday%40group.v.calendar.google.com/public/basic.ics'
 
   MONTH_TEMPLATE = [
     "    January %    ",
@@ -44,9 +44,9 @@ module Xcal
     [red('Su'), 'Mo', 'Tu', 'We', 'Th', 'Fr', blue('Sa')]
   end
 
-  def get_japan_holidays()
+  def fetch_holidays_from_remote_ics(ics_url)
     holidays = {}
-    ical = open(URL){|f| f.read}
+    ical = open(ics_url){|f| f.read}
     cals = Icalendar::Calendar.parse(ical)
     cals.each{|cal|
       cal.events.each{|event|
@@ -58,7 +58,7 @@ module Xcal
         
         holidays[y] = {} unless holidays[y]
         holidays[y][m] = {} unless holidays[y][m]
-        holidays[y][m][d] = true
+        holidays[y][m][d] = {holiday: true, date: Date.new(y, m, d), summary: event.summary}
       }
     }
 
@@ -89,7 +89,7 @@ module Xcal
   end
 
   def is_holiday?(y, m, d, holidays)
-    holidays[y] and holidays[y][m] and holidays[y][m][d]
+    holidays[y] and holidays[y][m] and holidays[y][m][d] and holidays[y][m][d][:holiday]
   end
 
   def month_header(y, m)
@@ -104,9 +104,43 @@ module Xcal
     day
   end
 
-  def main()
-    japan_holidays = get_japan_holidays()
+  def main(argv)
+    @holidays = fetch_holidays_from_remote_ics(ICS_URL)
 
+    if argv.include?('-9')
+      cal9
+    else
+      cal3
+    end
+
+    if argv.include?('-l')
+      if argv.include?('-9')
+        first = (Date.today << 4) - (Date.today.day - 1)
+        last =  (Date.today >> 5) - Date.today.day
+      else
+        first = (Date.today << 1) - (Date.today.day - 1)
+        last =  (Date.today >> 2) - Date.today.day
+      end
+
+      list_holidays(first, last)
+    end
+  end
+
+  def cal3
+    origin_date = Date.today
+
+    print_3month_calendar(origin_date)
+  end
+
+  def cal9
+    [-3, 0, 3].each do |offset_month|
+      origin_date = Date.today >> (offset_month)
+
+      print_3month_calendar(origin_date)
+    end
+  end
+
+  def print_3month_calendar(origin_date)
     table = Array.new(ROWS){
       Array.new(WEEK * MONTH + SPACE){|i|
         (i + 1) % 8 == 0 ? '' : '  ' 
@@ -114,16 +148,16 @@ module Xcal
     }
 
     today = Date.today
-    last_month = today << 1
-    next_month = today >> 1
+    last_month = origin_date << 1
+    next_month = origin_date >> 1
 
-    fill_calendar(last_month.year, last_month.month, table, 0, japan_holidays, today)
-    fill_calendar(today.year, today.month, table, 8, japan_holidays, today)
-    fill_calendar(next_month.year, next_month.month, table, 16, japan_holidays, today)
+    fill_calendar(last_month.year, last_month.month, table, 0, @holidays, today)
+    fill_calendar(origin_date.year, origin_date.month, table, 8, @holidays, today)
+    fill_calendar(next_month.year, next_month.month, table, 16, @holidays, today)
 
     month_headers = [
       month_header(last_month.year, last_month.month),
-      month_header(today.year, today.month),
+      month_header(origin_date.year, origin_date.month),
       month_header(next_month.year, next_month.month)
     ]
     puts month_headers.join('  ')
@@ -134,4 +168,18 @@ module Xcal
       puts row.join(' ')
     }
   end
+
+  def list_holidays(first, last)
+    holidays = (first..last).each_with_object([]){|date, memo|
+      y = date.year
+      m = date.month
+      d = date.day
+
+      memo << @holidays[y][m][d] if @holidays[y] && @holidays[y][m] && @holidays[y][m][d]
+    }
+
+    holidays.each{|holiday|
+      puts "#{holiday[:date].strftime("%Y-%m-%d")} (#{header[holiday[:date].wday]}) #{holiday[:summary]}"
+    }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcal
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - xmisao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-03 00:00:00.000000000 Z
+date: 2017-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: icalendar