mcalendar 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a634777135f135d9aeae14ea0bc037a3974ebe8f1574d6d021a11f959d01cc7
-  data.tar.gz: 3afd599f14c4689099906def2f233f489ba990b09b4424422dad20dfd2b4e054
+  metadata.gz: 106df652910d9257dddfa3814af1ab493c2ead746ed454c94ce4aa9950014f16
+  data.tar.gz: 6889c7be1874699ac9c86bd96ee7e48f1d61a566c90a78dfb2f398163e86dcda
 SHA512:
-  metadata.gz: 3f54acf7a0748733220713a0fb2395e881c2364e2ee76d95c4ce6f7840bcc5202a8f7f7b1c85eaf0aaa48782af05f063f29761a47cb4313101ca74e0ce0f18ec
-  data.tar.gz: d9f6e5f64f7668e771e7bb183f940f0c5d465e9544819abef54d773d8b3071ffe8f40e4e736cda4b373b26622b5967c32fd06bb4c2d63a1309df2a1339df352b
+  metadata.gz: 953e8b02928a44b6129fc716858aceaf0d29288bd473b3f2e9e2e6dd2a3f7a8276fc1948e403840acb7640b83a68e4f733100c93d2fdc114843c33412823e629
+  data.tar.gz: 027ba073a3567099bf0f18378726925754097826ea8066c1c99b1776e87e90b816f9f6fc9af1cf03b41b1656ade0dc61c1bc2cfbe5e54fb4ffca8680d40d7801

data/README.md

@@ -1,7 +1,7 @@
 
 # Mcalendar [![Gem Version](https://badge.fury.io/rb/mcalendar.svg)](https://badge.fury.io/rb/mcalendar)
 
-Ruby monthly calendar, console and pdf.  
+Ruby monthly calendar, output to console and pdf.  
 This calendar includes Japanese holidays.
 
 ## Installation
@@ -29,35 +29,130 @@ When you run the command, the calendar appears on the console. The pdf file is c
 ```
 mcalendar
 ```
+Output to console and pdf.
+```
+      September 2021
+Sun Mon Tue Wed Thu Fri Sat
+             1   2   3   4
+ 5   6   7   8   9  10  11
+12  13  14  15  16  17  18
+19  20  21  22  23  24  25
+26  27  28  29  30
+```
+
 
-If you want to create a calendar for any month.
+Calendar for any month.
+```
+mcalendar 2021/02
+```
+Output to console and pdf.
 ```
-mcalendar 2020/02
+>mcalendar 2021/02
+       February 2021
+Sun Mon Tue Wed Thu Fri Sat
+     1   2   3   4   5   6
+ 7   8   9  10  11  12  13
+14  15  16  17  18  19  20
+21  22  23  24  25  26  27
+28
 ```
 
-If you want to output only PDF, use the `-p` option.
+Output only PDF, use the `-p` option.
 ```
-mcalendar 2020/02 -p
+mcalendar 2021/02 -p
 ```
 
 Also, If you want to output only console, use the `-c` option.
 ```
-mcalendar 2020/02 -c
+mcalendar 2021/02 -c
 ```
 
 The default PDF file name is `calendar.pdf`. You can specify any name using the `-n` option.
 ```
-mcalendar 2020/02 -n my_calendar.pdf
+mcalendar 2021/02 -n my_calendar.pdf
+```
+
+### Configure mcalendar schedule
+
+mcalendar reads mcalendar.yml in the current working directory as mcalendar's schedule file. It can contain the following settings:
+* holiday
+* anniversary
+
+Here is the included mcalendar.yml as a sample.
+
+`mcalendar.yml`
 ```
+holiday:
+  20210101: New Year's Day
+  20210111: Coming-of-age Day
+  20210211: National Foundation Day
+  20210223: Emperor's Birthday
+  20210320: Vernal Equinox Day
+  20210429: Showa Day
+  20210503: Constitution Memorial Day
+  20210504: Greenery Day
+  20210505: Children's Day
+  20210722: Marine Day
+  20210723: Sports Day
+  20210808: Mountain Day
+  20210809: Substitute Holiday
+  20210920: Respect for the Aged Day
+  20210923: Autumnal Equinox Day
+  20211103: Culture Day
+  20211123: Labour Thanksgiving Day
+
+anniversary:
+  20210224: Ruby's Birthday
+  20210909: RubyKaigi Takeout 2021
+  20210910: RubyKaigi Takeout 2021
+  20210911: RubyKaigi Takeout 2021
+```
+
+You can use the command option `-y` or `--holidays` to check the contents of mcalendar.yml.
+
+```
+>mcalendar --holidays
+=========== Holidays ===========
+20210101: New Year's Day
+20210111: Coming-of-age Day
+20210211: National Foundation Day
+20210223: Emperor's Birthday
+20210320: Vernal Equinox Day
+20210429: Showa Day
+20210503: Constitution Memorial Day
+20210504: Greenery Day
+20210505: Children's Day
+20210722: Marine Day
+20210723: Sports Day
+20210808: Mountain Day
+20210809: Substitute Holiday
+20210920: Respect for the Aged Day
+20210923: Autumnal Equinox Day
+20211103: Culture Day
+20211123: Labour Thanksgiving Day
+======== Anniversaries =========
+20210224: Ruby's Birthday
+20210909: RubyKaigi Takeout 2021
+20210910: RubyKaigi Takeout 2021
+20210911: RubyKaigi Takeout 2021
+```
+
+You can also use the command option `-f` or `--config=` to load your own `your_schedule.yml` file.
+```
+>mcalendar -f your_schedule.yml
+```
+
 
 show help
 ```
->mcalendar -h
+>mcalendar --help
 Usage: mcalendar [options]
     -v, --version                    Show version
     -p, --pdf                        output pdf
     -n, --name=NAME                  output pdf name
     -c, --console                    output console
+    -f, --config=FILE                Use YAML format file.
+    -y, --holidays                   Display holidays and anniversaries in YAML file
 ```
 
 ## License

data/lib/mcalendar/command.rb

@@ -18,6 +18,13 @@ module Mcalendar
       @outputpdf.render_file(pdf_filename)
     end
 
+    def output_holidays
+      puts "=========== Holidays ==========="
+      puts @schedule.show_holidays
+      puts "======== Anniversaries ========="
+      puts @schedule.show_anniversaries
+    end
+
     def pdf_filename
       if  @pdf_name.nil? || @pdf_name.empty?
         Mcalendar::DEFAULT_PDF_NAME
@@ -27,25 +34,29 @@ module Mcalendar
     end
 
     def execute
-      options = Mcalendar::Options.parse(@argv)
+      options = Mcalendar::Options.new.parse(@argv)
       date = options[:date]
-      console = options[:opt][:console]
-      pdf = options[:opt][:pdf]
-      @pdf_name = options[:opt][:name]
-      version = options[:opt][:version]
+      console = options[:console]
+      pdf = options[:pdf]
+      @pdf_name = options[:name]
+      version = options[:version]
+      holidays = options[:holidays]
+
       @calendar = Mcalendar::Calendar.new(date.year, date.month)
-      @outputpdf = Mcalendar::OutputPdf.new(@calendar)
+      @schedule = Mcalendar::Schedule.new(@calendar, options)
+      @outputpdf = Mcalendar::OutputPdf.new(@calendar, @schedule)
 
       # output calendar
       output_console if console
       output_pdf if pdf
-
+      output_holidays if holidays
 
       # both outputs if no options
-      if console.nil? && pdf.nil? && version.nil?
+      if console.nil? && pdf.nil? && version.nil? && holidays.nil?
         output_console
         output_pdf
       end
+      
     end
   end
 end

data/lib/mcalendar/config.rb

@@ -22,75 +22,6 @@ module Mcalendar
   DAY_OF_WEEK = %w[Sun Mon Tue Wed Thu Fri Sat].freeze
   DEFAULT_PDF_NAME = "calendar.pdf".freeze
 
-  Config_day = Struct.new(
-    "ConfigDay",
-    :day,
-    :day_color,
-    :holiday_text,
-    :anniversary_text
-  )
+  DEFAULT_CONFIG_FILE = "mcalendar.yml".freeze
 
-  class Schedule
-    extend Forwardable
-    def_delegators :@calendar, :first_of_month, :end_of_month
-
-    def initialize(calendar)
-      @calendar = calendar
-      @days_config = Hash.new(nil)
-      
-      setup_schedule
-    end
-
-
-    def setup_schedule
-      holiday_description_language
-      days_basic
-      holidays_in_the_month
-      anniversaries_in_the_month
-    end
-
-    def holiday_description_language
-      Mcalendar.const_set(:HOLIDAY, Mcalendar::EN::HOLIDAY)
-      Mcalendar.const_set(:ANNIVERSARY, Mcalendar::EN::ANNIVERSARY)
-    end
-
-    def days_basic
-      (first_of_month..end_of_month).each do |date|
-        d_sym = date.strftime("%Y%m%d").to_sym
-        @days_config[d_sym] = Config_day.new(date.day, :black, nil, nil)
-      end
-      @days_config
-    end
-
-    def holidays_in_the_month
-      y = format("%4d", first_of_month.year)
-      m = format("%02d", first_of_month.month)
-      regex = /#{y}#{m}\d\d/
-
-      Mcalendar::HOLIDAY.keys.grep(regex).each do |d|
-        @days_config[d].day = Date.parse(d.to_s).day
-        @days_config[d].day_color = :red
-        @days_config[d].holiday_text = Mcalendar::HOLIDAY[d]
-      end
-      @days_config
-    end
-
-    def anniversaries_in_the_month
-      y = format("%4d", first_of_month.year)
-      m = format("%02d", first_of_month.month)
-      regex = /#{y}#{m}\d\d/
-
-      Mcalendar::ANNIVERSARY.keys.grep(regex).each do |d|
-        @days_config[d].day = Date.parse(d.to_s).day
-        @days_config[d].anniversary_text = Mcalendar::ANNIVERSARY[d]
-      end
-      @days_config
-    end
-
-    def daily_schedule
-      daily = @days_config.each_value.map { |val| val }
-      first_of_month.wday.times { daily.unshift("  ") }
-      daily
-    end
-  end
 end

data/lib/mcalendar/holiday.rb

@@ -1,63 +1,62 @@
 module Mcalendar
   module JA
     # Japanese holidays in Japanese
+    # https://www8.cao.go.jp/chosei/shukujitsu/gaiyou.html
     HOLIDAY = {
-      "20200101": "元日",
-      "20200113": "成人の日",
-      "20200211": "建国記念の日",
-      "20200223": "天皇誕生日",
-      "20200224": "振替休日",
-      "20200320": "春分の日",
-      "20200429": "昭和の日",
-      "20200503": "憲法記念日",
-      "20200504": "みどりの日",
-      "20200505": "子供の日",
-      "20200506": "振替休日",
-      "20200723": "海の日",
-      "20200724": "スポーツの日",
-      "20200810": "山の日",
-      "20200921": "敬老の日",
-      "20200922": "秋分の日",
-      "20201103": "文化の日",
-      "20201123": "勤労感謝の日",
+      "20210101": "元日",
+      "20210111": "成人の日",
+      "20210211": "建国記念の日",
+      "20210223": "天皇誕生日",
+      "20210320": "春分の日",
+      "20210429": "昭和の日",
+      "20210503": "憲法記念日",
+      "20210504": "みどりの日",
+      "20210505": "子供の日",
+      "20210722": "海の日",
+      "20210723": "スポーツの日",
+      "20210808": "山の日",
+      "20210809": "振替休日",
+      "20210920": "敬老の日",
+      "20210923": "秋分の日",
+      "20211103": "文化の日",
+      "20211123": "勤労感謝の日",
     }.freeze
 
     ANNIVERSARY = {
       "20200224": "Rubyの誕生日",
-      "20200903": "RubyKaigi 2020 Nagano",
-      "20200904": "RubyKaigi 2020 Nagano",
-      "20200905": "RubyKaigi 2020 Nagano",
+      "20200909": "RubyKaigi Takeout 2021",
+      "20200910": "RubyKaigi Takeout 2021",
+      "20200911": "RubyKaigi Takeout 2021",
     }.freeze
   end
 
   module EN
     # Japanese holidays in English
     HOLIDAY = {
-      "20200101": "New Year's Day",
-      "20200113": "Coming-of-age Day",
-      "20200211": "National Foundation Day",
-      "20200223": "Emperor's Birthday",
-      "20200224": "Substitute Holiday",
-      "20200320": "Vernal Equinox Day",
-      "20200429": "Showa Day",
-      "20200503": "Constitution Memorial Day",
-      "20200504": "Greenery Day",
-      "20200505": "Children's Day",
-      "20200506": "Substitute Holiday",
-      "20200723": "Marine Day",
-      "20200724": "Sports Day",
-      "20200810": "Mountain Day",
-      "20200921": "Respect for the Aged Day",
-      "20200922": "Autumnal Equinox Day",
-      "20201103": "Culture Day",
-      "20201123": "Labour Thanksgiving Day",
+      "20210101": "New Year's Day",
+      "20210111": "Coming-of-age Day",
+      "20210211": "National Foundation Day",
+      "20210223": "Emperor's Birthday",
+      "20210320": "Vernal Equinox Day",
+      "20210429": "Showa Day",
+      "20210503": "Constitution Memorial Day",
+      "20210504": "Greenery Day",
+      "20210505": "Children's Day",
+      "20210722": "Marine Day",
+      "20210723": "Sports Day",
+      "20210808": "Mountain Day",
+      "20210809": "Substitute Holiday",
+      "20210920": "Respect for the Aged Day",
+      "20210923": "Autumnal Equinox Day",
+      "20211103": "Culture Day",
+      "20211123": "Labour Thanksgiving Day",
     }.freeze
 
     ANNIVERSARY = {
-      "20200224": "Ruby's Birthday",
-      "20200903": "RubyKaigi 2020 Nagano",
-      "20200904": "RubyKaigi 2020 Nagano",
-      "20200905": "RubyKaigi 2020 Nagano",
+      "20210224": "Ruby's Birthday",
+      "20210909": "RubyKaigi Takeout 2021",
+      "20210910": "RubyKaigi Takeout 2021",
+      "20210911": "RubyKaigi Takeout 2021",
     }.freeze
   end
 end

data/lib/mcalendar/options.rb

@@ -1,17 +1,59 @@
 module Mcalendar
-  module Options
-    def self.parse(argv)
-      options = {}
+  class Options
 
+    def initialize
+      @options = {
+        :holiday => {}, 
+        :anniversary => {}
+      }
+
+      # If mcalendar.yml is not found, load the built-in mcalendar.yml.
+      if File.exist?(Mcalendar::DEFAULT_CONFIG_FILE)
+        load_config(Mcalendar::DEFAULT_CONFIG_FILE)
+      else
+        config_file = File.expand_path("../../mcalendar.yml",__dir__)
+        load_config(config_file)
+      end
+
+    end
+
+    def hash_key_to_sym(h)
+      Hash[h.map{|k, v| [k.to_s.to_sym, v]}]
+    end
+
+    def load_config(file)
+      @config = YAML.load(File.read(file))
+      holidays_schedule
+      anniversaries_schedule
+    end
+
+    def holidays_schedule
+      @options[:holiday] = hash_key_to_sym(@config["holiday"]) if @config["holiday"]
+    end
+
+    def anniversaries_schedule
+      @options[:anniversary] = hash_key_to_sym(@config["anniversary"]) if @config["anniversary"]
+    end
+
+    def parse(argv)
       parser = OptionParser.new do |o|
         o.on_head("-v", "--version", "Show version") do |v|
-          options[:version] = v
+          @options[:version] = v
           o.version = Mcalendar::VERSION
           puts o.version
         end
-        o.on("-p", "--pdf", "output pdf") { |v| options[:pdf] = v }
-        o.on("-n NAME", "--name=NAME", String, "output pdf name") { |v| options[:name] = v }
-        o.on("-c", "--console", "output console") { |v| options[:console] = v }
+
+        o.on("-p", "--pdf", "output pdf") { |v| @options[:pdf] = v }
+        
+        o.on("-n NAME", "--name=NAME", String, "output pdf name") { |v| @options[:name] = v }
+        
+        o.on("-c", "--console", "output console") { |v| @options[:console] = v }
+        
+        o.on("-f FILE", "--config=FILE", "Use YAML format file.") do |file|
+          load_config(file) if file and File.exist?(file)
+        end
+
+        o.on("-y", "--holidays", "Display holidays and anniversaries in YAML file") { |v| @options[:holidays] = v }
       end
 
       begin
@@ -21,17 +63,18 @@ module Mcalendar
       rescue OptionParser::MissingArgument => e
         case e.args
         when ["-n"], ["--name"]
-          options[:name] = Mcalendar::DEFAULT_PDF_NAME
+          @options[:name] = Mcalendar::DEFAULT_PDF_NAME
         end
       end
 
       begin
-        d = Date.parse(remained.first)
+        @options[:date] = Date.parse(remained.first)
       rescue
-        d = Date.today
+        @options[:date] = Date.today
       end
 
-      { date: d, opt: options }
+      @options
     end
+
   end
 end

data/lib/mcalendar/output_pdf.rb

@@ -3,13 +3,15 @@ module Mcalendar
     extend Forwardable
     def_delegator :@calendar, :month_title
 
-    def initialize(calendar)
+    def initialize(calendar, schedule)
       @calendar = calendar
+      @schedule = schedule
+      
       @month_header = [[month_title]]
       @day_of_week = [Mcalendar::DAY_OF_WEEK] 
 
-      schedule = Mcalendar::Schedule.new(calendar)
-      @weekly_schedule = schedule.daily_schedule.each_slice(7).map
+    
+      @weekly_schedule = @schedule.daily_schedule.each_slice(7).map
       @day_height = @weekly_schedule.size > 5 ? 20 : 20
       @text_height = @weekly_schedule.size > 5 ? 30 : 40
  

data/lib/mcalendar/schedule.rb

@@ -0,0 +1,82 @@
+module Mcalendar
+
+  class Schedule
+    extend Forwardable
+    def_delegators :@calendar, :first_of_month, :end_of_month
+
+    Config_day = Struct.new(
+      "ConfigDay",
+      :day,
+      :day_color,
+      :holiday_text,
+      :anniversary_text
+    )
+
+    def initialize(calendar, config_schedule)
+      @calendar = calendar
+      @config_schedule = config_schedule
+      @days_config = Hash.new(nil)
+      @holidays = @config_schedule[:holiday]
+      @anniversaries = @config_schedule[:anniversary]
+      
+      setup_schedule
+    end
+
+    def show_holidays
+      @holidays.map{|k,v| "#{k}: #{v}"}
+    end
+
+    def show_anniversaries
+      @anniversaries.map{|k,v| "#{k}: #{v}"}
+    end
+
+    def setup_schedule
+      days_basic
+      holidays_in_the_month
+      anniversaries_in_the_month
+    end
+
+    def days_basic
+      (first_of_month..end_of_month).each do |date|
+        d_sym = date.strftime("%Y%m%d").to_sym
+        @days_config[d_sym] = Config_day.new(date.day, :black, nil, nil)
+      end
+
+      @days_config
+    end
+
+    def holidays_in_the_month
+      y = format("%4d", first_of_month.year)
+      m = format("%02d", first_of_month.month)
+      regex = /#{y}#{m}\d\d/
+
+      @holidays.keys.grep(regex).each do |d|
+        @days_config[d].day = Date.parse(d.to_s).day
+        @days_config[d].day_color = :red
+        @days_config[d].holiday_text = @holidays[d]
+      end
+      
+      @days_config
+    end
+
+    def anniversaries_in_the_month
+      y = format("%4d", first_of_month.year)
+      m = format("%02d", first_of_month.month)
+      regex = /#{y}#{m}\d\d/
+
+      @anniversaries.keys.grep(regex).each do |d|
+        @days_config[d].day = Date.parse(d.to_s).day
+        @days_config[d].anniversary_text = @anniversaries[d]
+      end
+
+      @days_config
+    end
+
+    def daily_schedule
+      daily = @days_config.each_value.map { |val| val }
+      first_of_month.wday.times { daily.unshift("  ") }
+      daily
+    end
+
+  end
+end

data/lib/mcalendar/version.rb

@@ -1,3 +1,3 @@
 module Mcalendar
-  VERSION = "0.4.0"
+  VERSION = "0.5.1"
 end

data/lib/mcalendar.rb

@@ -3,6 +3,7 @@ require "prawn"
 require "prawn/table"
 require "optparse"
 require 'forwardable'
+require "yaml"
 
 require_relative 'mcalendar/calendar'
 require_relative 'mcalendar/command'
@@ -10,4 +11,5 @@ require_relative 'mcalendar/config'
 require_relative 'mcalendar/holiday'
 require_relative 'mcalendar/options'
 require_relative 'mcalendar/output_pdf'
+require_relative 'mcalendar/schedule'
 require_relative 'mcalendar/version'

data/mcalendar.yml

@@ -0,0 +1,25 @@
+holiday:
+  20210101: New Year's Day
+  20210111: Coming-of-age Day
+  20210211: National Foundation Day
+  20210223: Emperor's Birthday
+  20210320: Vernal Equinox Day
+  20210429: Showa Day
+  20210503: Constitution Memorial Day
+  20210504: Greenery Day
+  20210505: Children's Day
+  20210722: Marine Day
+  20210723: Sports Day
+  20210808: Mountain Day
+  20210809: Substitute Holiday
+  20210920: Respect for the Aged Day
+  20210923: Autumnal Equinox Day
+  20211103: Culture Day
+  20211123: Labour Thanksgiving Day
+
+anniversary:
+  20210224: Ruby's Birthday
+  20210909: RubyKaigi Takeout 2021
+  20210910: RubyKaigi Takeout 2021
+  20210911: RubyKaigi Takeout 2021
+

data/test-unit.yml

@@ -0,0 +1,12 @@
+runner: console
+console_options:
+  color_scheme: normal
+color_schemes:
+  normal:
+    success:
+      name: green
+      bold: false
+    failure:
+      name: red
+      bold: true
+  

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mcalendar
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - icm7216
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-12 00:00:00.000000000 Z
+date: 2021-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -132,8 +132,11 @@ files:
 - lib/mcalendar/holiday.rb
 - lib/mcalendar/options.rb
 - lib/mcalendar/output_pdf.rb
+- lib/mcalendar/schedule.rb
 - lib/mcalendar/version.rb
 - mcalendar.gemspec
+- mcalendar.yml
+- test-unit.yml
 homepage: https://github.com/icm7216/mcalendar
 licenses:
 - MIT