zakuro 0.6.0 → 0.6.1

data/lib/zakuro/era/japan/gengou/resource/type.rb

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+require_relative '../../../western/calendar'
+
+require_relative '../../calendar'
+
+# :nodoc:
+module Zakuro
+  #
+  # Japan 和暦
+  #
+  module Japan
+    #
+    # Resource yaml解析結果
+    #
+    module Resource
+      #
+      # Gengou 元号情報
+      #
+      class Gengou
+        # @return [String] 元号名
+        attr_reader :name
+        # @return [Both::Year] 開始年（和暦/西暦）
+        attr_reader :both_start_year
+        # @return [Both::Date] 開始日（和暦/西暦）
+        attr_reader :both_start_date
+        # @return [Integer] 終了年
+        attr_reader :last_year
+        # @return [Western::Calendar] 終了日
+        attr_reader :last_date
+
+        #
+        # 初期化
+        #
+        # @param [String] name 元号名
+        # @param [Both::Year] both_start_year 開始年（和暦/西暦）
+        # @param [Both::Date] both_start_date 開始日（和暦/西暦）
+        # @param [Integer] last_date 終了年
+        # @param [Western::Calendar] last_date 終了日
+        #
+        def initialize(name: '', both_start_year: Both::Year.new,
+                       both_start_date: Both::Date.new,
+                       last_date: Western::Calendar.new,
+                       last_year: Both::Year::INVALID)
+          @name = name
+          @both_start_year = both_start_year
+          @both_start_date = both_start_date
+          @last_year = last_year
+          @last_date = last_date
+        end
+
+        #
+        # 終了年を更新する
+        #
+        # @param [Integer] last_year 終了年
+        #
+        def write_last_year(last_year:)
+          unless Gengou.valid_year(year: last_year)
+            raise ArgumentError, "invalid year format. [#{last_year}]"
+          end
+
+          @last_year = last_year
+        end
+
+        #
+        # 終了日を更新する
+        #
+        # @param [Western::Calendar] last_date 終了日
+        #
+        def write_last_date(last_date:)
+          unless Gengou.valid_date(date: last_date)
+            raise ArgumentError, "invalid date format. [#{last_date}]"
+          end
+
+          @last_date = last_date
+          nil
+        end
+
+        #
+        # 年が不正なしかどうかを確認する
+        #
+        # @param [Integer] year 年
+        #
+        # @return [True] 不正なし
+        # @return [False] 不正
+        #
+        def self.valid_year(year:)
+          return false unless year
+
+          year.is_a?(Integer)
+        end
+
+        #
+        # 日付が不正なしかどうかを確認する
+        #
+        # @param [Western::Calendar] date 日付
+        #
+        # @return [True] 不正なし
+        # @return [False] 不正
+        #
+        def self.valid_date(date:)
+          return false unless date
+
+          date.is_a?(Western::Calendar)
+        end
+
+        #
+        # 次の元号の開始年から、元号の終了年に変換する
+        #
+        # @param [Integer] next_start_year 次回開始年
+        #
+        def convert_next_start_year_to_last_year(next_start_year:)
+          if @both_start_year.western >= next_start_year
+            @last_year = next_start_year
+            return
+          end
+
+          @last_year = next_start_year - 1
+
+          nil
+        end
+
+        #
+        # 次の元号の開始日から、元号の終了日に変換する
+        #
+        # @param [String] next_start_date 次回開始日
+        #
+        def convert_next_start_date_to_last_date(next_start_date: '')
+          raise ArgumentError, 'empty string cannot convert' if next_start_date.empty?
+
+          start_date = Western::Calendar.parse(str: next_start_date)
+          @last_date = start_date - 1
+
+          nil
+        end
+
+        #
+        # 指定した日が元号に含まれるか
+        #
+        # @param [Western::Calendar] date 日
+        #
+        # @return [True] 含まれる
+        # @return [False] 含まれない
+        #
+        def include?(date:)
+          date >= @both_start_date.western && date <= @last_date
+        end
+
+        #
+        # 不正か
+        #
+        # @return [True] 不正
+        # @return [False] 不正なし
+        #
+        def invalid?
+          @both_start_year.japan == -1 || @both_start_year.invalid? ||
+            @both_start_date.invalid? || @last_date.invalid?
+        end
+
+        #
+        # 1元号年を追加する
+        #
+        # def next_year
+        #   @year += 1 unless invalid?
+        #   nil
+        # end
+
+        def to_s
+          "name: #{@name}, both_start_year: #{@both_start_year.format}, " \
+          "both_start_date: #{@both_start_date.format}, last_date: #{@last_date.format}"
+        end
+      end
+
+      #
+      # Set 元号セット
+      #
+      class Set
+        # @return [Integer] 不正値
+        INVALID = -1
+        # @return [Integer] 元号セットID
+        attr_reader :id
+        # @return [String] 元号セット名
+        attr_reader :name
+        # @return [Both::Date] 元号セットでの終了年
+        attr_reader :both_last_year
+        # @return [Both::Date] 元号セットでの終了日
+        attr_reader :both_last_date
+        # @return [Array<Gengou>] 元号リスト
+        attr_reader :list
+
+        #
+        # 初期化
+        #
+        # @param [Integer] id 元号セットID
+        # @param [String] name 元号セット名
+        # @param [Western::Calendar] last_date 元号セットでの終了日
+        # @param [Array<Gengou>] list 元号リスト
+        #
+        def initialize(id: INVALID, name: '', both_last_year: Both::Year.new,
+                       both_last_date: Both::Date.new, list: [])
+          @id = id
+          @name = name
+          @both_last_year = both_last_year
+          @both_last_date = both_last_date
+          @list = list
+        end
+
+        #
+        # 指定した日付を含む元号を返す
+        #
+        # @param [Western::Calendar] date 日
+        #
+        # @return [Gengou] 元号
+        #
+        def include_item(date:)
+          @list.each do |item|
+            return item if item.include?(date: date)
+          end
+
+          Gengou.new
+        end
+
+        #
+        # 元号セットが不正かどうかを確認する
+        #
+        # @return [True] 正しくない
+        # @return [False] 正しい
+        #
+        def invalid?
+          @id == INVALID
+        end
+      end
+
+      #
+      # 和暦/西暦
+      #
+      module Both
+        #
+        # Year 年
+        #
+        class Year
+          # @return [Integer] 不正値
+          INVALID = -1
+          # @return [Integer] 和暦元号年
+          attr_reader :japan
+          # @return [Integer] 西暦年
+          attr_reader :western
+
+          def initialize(japan: INVALID, western: INVALID)
+            @japan = japan
+            @western = western
+          end
+
+          #
+          # 不正か
+          #
+          # @return [True] 不正
+          # @return [False] 不正なし
+          #
+          def invalid?
+            @japan == INVALID || @western == INVALID
+          end
+        end
+
+        #
+        # Date 日
+        #
+        class Date
+          # @return [Japan::Calendar] 和暦日
+          attr_reader :japan
+          # @return [Western::Calendar] 西暦日
+          attr_reader :western
+
+          def initialize(japan: Japan::Calendar.new, western: Western::Calendar.new)
+            @japan = japan
+            @western = western
+          end
+
+          #
+          # 不正か
+          #
+          # @return [True] 不正
+          # @return [False] 不正なし
+          #
+          def invalid?
+            @japan.invalid? || @western.invalid?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/era/japan/gengou/resource/validator.rb

@@ -0,0 +1,346 @@
+# frozen_string_literal: true
+
+require_relative '../../../japan/calendar'
+require_relative '../../../western/calendar'
+require_relative './type'
+require 'yaml'
+
+# :nodoc:
+module Zakuro
+  #
+  # Japan 和暦
+  #
+  module Japan
+    #
+    # Resource yaml解析結果
+    #
+    module Resource
+      #
+      # Validator yaml解析
+      #
+      module Validator
+        #
+        # Set 元号セット情報の検証/展開
+        #
+        class Set
+          # @return [String] 元号セットID
+          attr_reader :id
+          # @return [String] 元号セット名
+          attr_reader :name
+          # @return [Hash<String, String>] 終了年
+          attr_reader :both_last_year
+          # @return [Hash<String, String>] 終了日
+          attr_reader :both_last_date
+          # @return [Array<Hash<String, String>>] 元号情報
+          attr_reader :list
+
+          #
+          # 初期化
+          #
+          # @param [Hash<String, Object>] hash 元号セット情報
+          #
+          def initialize(hash:)
+            @id = hash['id']
+            @name = hash['name']
+            @both_last_year = hash['last_year']
+            @both_last_date = hash['last_date']
+            @list = hash['list']
+          end
+
+          #
+          # 検証する
+          #
+          # @return [Array<String>] 不正メッセージ
+          #
+          def validate
+            failed = []
+            failed.push("invalid id. #{@id}") unless id?
+
+            failed.push("invalid name. #{@name}") unless name?
+
+            failed |= validate_both_last_year
+
+            failed |= validate_both_last_date
+
+            failed |= validate_list
+            failed
+          end
+
+          #
+          # IDを検証する
+          #
+          # @return [True] 正しい
+          # @return [False] 正しくない
+          #
+          def id?
+            return false unless @id
+
+            @id.is_a?(Integer)
+          end
+
+          #
+          # 元号セット名を検証する
+          #
+          # @return [True] 正しい
+          # @return [False] 正しくない
+          #
+          def name?
+            return false unless @name
+
+            @name.is_a?(String)
+          end
+
+          #
+          # 終了年を検証する
+          #
+          # @return [Array<String>] 不正メッセージ
+          #
+          def validate_both_last_year
+            Both::Year.new(hash: @both_last_year).validate
+          end
+
+          #
+          # 終了日を検証する
+          #
+          # @return [Array<String>] 不正メッセージ
+          #
+          def validate_both_last_date
+            Both::Date.new(hash: @both_last_date).validate
+          end
+
+          #
+          # 元号情報を検証する
+          #
+          # @return [True] 正しい
+          # @return [False] 正しくない
+          #
+          def list?
+            return false unless @list
+
+            @list.is_a?(Array)
+          end
+
+          #
+          # 元号情報を検証する
+          #
+          # @return [Array<String>] 不正メッセージ
+          #
+          def validate_list
+            return ["invalid list. #{@list.class}"] unless list?
+
+            failed = []
+            list.each_with_index do |li, index|
+              failed |= Gengou.new(hash: li, index: index).validate
+            end
+            failed
+          end
+        end
+
+        #
+        # Gengou 元号情報
+        #
+        class Gengou
+          # @return [Integer] 要素位置
+          attr_reader :index
+          # @return [String] 元号名
+          attr_reader :name
+          # @return [Hash<String, String>] 開始年
+          attr_reader :both_start_year
+          # @return [Hash<String, String>] 開始日
+          attr_reader :both_start_date
+
+          #
+          # 初期化
+          #
+          # @param [Hash<String, Strin>] hash 元号情報
+          # @param [Integer] index （元号セット内での）元号の要素位置
+          #
+          def initialize(hash:, index:)
+            @index = index
+            @name = hash['name']
+            @both_start_year = hash['start_year']
+            @both_start_date = hash['start_date']
+          end
+
+          #
+          # 検証する
+          #
+          # @return [Array<String>] 不正メッセージ
+          #
+          def validate
+            prefix = "list[#{index}]. "
+            failed = []
+
+            failed.push(prefix + "invalid name. #{@name}") unless name?
+
+            failed |= validate_both_start_year
+
+            failed |= validate_both_start_date
+
+            failed
+          end
+
+          #
+          # 元号名を検証する
+          #
+          # @return [True] 正しい
+          # @return [False] 正しくない
+          #
+          def name?
+            return false unless @name
+
+            @name.is_a?(String)
+          end
+
+          #
+          # 開始年を検証する
+          #
+          # @return [Array<String>] 不正メッセージ
+          #
+          def validate_both_start_year
+            Both::Year.new(hash: @both_start_year).validate
+          end
+
+          #
+          # 開始日を検証する
+          #
+          # @return [Array<String>] 不正メッセージ
+          #
+          def validate_both_start_date
+            Both::Date.new(hash: @both_start_date).validate
+          end
+        end
+
+        #
+        # 和暦/西暦
+        #
+        module Both
+          #
+          # Year 年
+          #
+          class Year
+            # @return [String] 和暦元号年
+            attr_reader :japan
+            # @return [String] 西暦年
+            attr_reader :western
+
+            #
+            # 初期化
+            #
+            # @param [Hash<String, Strin>] hash 年情報
+            #
+            def initialize(hash:)
+              @japan = hash['japan']
+              @western = hash['western']
+            end
+
+            #
+            # 検証する
+            #
+            # @return [Array<String>] 不正メッセージ
+            #
+            def validate
+              failed = []
+
+              failed.push("invalid japan year. #{@japan}") unless japan?
+
+              failed.push("invalid western year. #{@western}") unless western?
+
+              failed
+            end
+
+            #
+            # 和暦元号年を検証する
+            #
+            # @return [True] 正しい
+            # @return [False] 正しくない
+            #
+            def japan?
+              return false unless @japan
+
+              @japan.is_a?(Integer)
+            end
+
+            #
+            # 和暦元号年を検証する
+            #
+            # @return [True] 正しい
+            # @return [False] 正しくない
+            #
+            def western?
+              return false unless @western
+
+              @western.is_a?(Integer)
+            end
+          end
+
+          #
+          # Date 日
+          #
+          class Date
+            # @return [String] 和暦日
+            attr_reader :japan
+            # @return [String] 西暦日
+            attr_reader :western
+
+            #
+            # 初期化
+            #
+            # @param [Hash<String, Strin>] hash 日情報
+            #
+            def initialize(hash:)
+              @japan = hash['japan']
+              @western = hash['western']
+            end
+
+            #
+            # 検証する
+            #
+            # @return [Array<String>] 不正メッセージ
+            #
+            def validate
+              failed = []
+
+              failed.push("invalid japan date. #{@japan}") unless japan?
+
+              failed.push("invalid western date. #{@western}") unless western?
+
+              failed
+            end
+
+            #
+            # 和暦日を検証する
+            #
+            # @return [True] 正しい
+            # @return [False] 正しくない
+            #
+            def japan?
+              Japan::Calendar.valid_date_string(text: @japan)
+            end
+
+            #
+            # 西暦日を検証する
+            #
+            # @return [True] 正しい
+            # @return [False] 正しくない
+            #
+            def western?
+              Western::Calendar.valid_date_string(str: @western)
+            end
+          end
+        end
+
+        #
+        # 検証する
+        #
+        # @param [Hash<String, Object>] yaml_hash yaml取得結果
+        #
+        # @return [Array<String>] 不正メッセージ
+        #
+        def self.run(yaml_hash:)
+          Set.new(hash: yaml_hash).validate
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/era/japan/gengou/{yaml → resource/yaml}/set-001-until-south.yaml

@@ -1,10 +1,10 @@
 ---
 id: 1
 name: 南北朝前+南朝
-end_year:
+last_year:
   japan: 9
   western: 1392
-end_date:
+last_date:
   japan: 元中09年閏10月04日
   western: '1392-11-18'
 list:

data/lib/zakuro/era/japan/gengou/{yaml → resource/yaml}/set-002-from-north.yaml

@@ -1,10 +1,10 @@
 ---
 id: 2
 name: 北朝+南北朝後
-end_year:
+last_year:
   japan: 1
   western: 1865
-end_date:
+last_date:
   japan: 慶応01年09月07日
   western: '1868-10-22'
 list:

data/lib/zakuro/era/japan/gengou/{yaml → resource/yaml}/set-003-modern.yaml

@@ -1,10 +1,10 @@
 ---
 id: 3
 name: 近代（一世一元）
-end_year:
+last_year:
   japan: 7981
   western: 9999
-end_date:
+last_date:
   japan: 令和7981年12月31日
   western: '9999-12-31'
 list:

data/lib/zakuro/era/japan/gengou/resource.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative './resource/parser'
+
+# :nodoc:
+module Zakuro
+  #
+  # Japan 和暦
+  #
+  module Japan
+    #
+    # Resource yaml解析結果
+    #
+    module Resource
+      # @return [Array<Set>] 元号セット情報リスト
+      LIST = [
+        Parser.run(filepath: File.expand_path(
+          './resource/yaml/set-001-until-south.yaml',
+          __dir__
+        )),
+        Parser.run(filepath: File.expand_path(
+          './resource/yaml/set-002-from-north.yaml',
+          __dir__
+        )),
+        Parser.run(filepath: File.expand_path(
+          './resource/yaml/set-003-modern.yaml',
+          __dir__
+        ))
+      ].freeze
+    end
+  end
+end