zakuro 0.9.3 → 1.0.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../western/calendar'
-require_relative './type'
+require_relative '../../type/base/gengou_set'
 require_relative './validator'
 require 'yaml'
 
@@ -41,6 +41,7 @@ module Zakuro
             #
             # @param [Hash<String, Strin>] hash 元号情報
             # @param [Integer] index （元号セット内での）元号の要素位置
+            # @param [True, False] operated 運用値設定
             #
             def initialize(hash:, index:, operated: false)
               @index = index
@@ -53,21 +54,21 @@ module Zakuro
             #
             # 元号情報を生成する
             #
-            # @return [Gengou] 元号情報
+            # @return [Type::Base::Gengou] 元号情報
             #
             def create
               year = Both::YearParser.new(hash: start_year).create
               date = SwitchDateParser.new(hash: start_date, operated: operated).create
 
-              Gengou.new(name: name, start_year: year,
-                         start_date: date)
+              Type::Base::Gengou.new(name: name, start_year: year,
+                                     start_date: date)
             end
           end
 
           #
-          # SetParser 元号セット情報の検証/展開
+          # GengouSetParser 元号セット情報の検証/展開
           #
-          class SetParser
+          class GengouSetParser
             # @return [String] 元号セットID
             attr_reader :id
             # @return [String] 元号セット名
@@ -99,12 +100,12 @@ module Zakuro
             #
             # 元号セット情報を生成する
             #
-            # @return [Set] 元号セット情報
+            # @return [Type::Base::GengouSet] 元号セット情報
             #
             def create
               date = SwitchDateParser.new(hash: last_date, operated: operated).create
               list = create_list
-              Set.new(
+              Type::Base::GengouSet.new(
                 id: id, name: name, last_date: date, list: list
               )
             end
@@ -114,7 +115,7 @@ module Zakuro
             #
             # 元号情報を生成する
             #
-            # @return [Array<Gengou>] 元号情報
+            # @return [Array<Type::Base::Gengou>] 元号情報
             #
             def create_list
               result = []
@@ -200,13 +201,13 @@ module Zakuro
             #
             # 切替日（運用/計算）情報を生成する
             #
-            # @return [SwitchDate] 切替日（運用/計算）情報
+            # @return [Type::Base::SwitchDate] 切替日（運用/計算）情報
             #
             def create
               calculation_date = Both::DateParser.new(hash: calculation).create
               operation_date = Both::DateParser.new(hash: operation).create
 
-              Japan::Gengou::Resource::SwitchDate.new(
+              Type::Base::SwitchDate.new(
                 calculation: calculation_date, operation: operation_date,
                 operated: operated
               )
@@ -245,7 +246,7 @@ module Zakuro
                 japan_year = japan.to_i
                 western_year = western.to_i
 
-                Japan::Gengou::Resource::Both::Year.new(
+                Type::Base::Both::Year.new(
                   japan: japan_year, western: western_year
                 )
               end
@@ -273,7 +274,7 @@ module Zakuro
               #
               # 日情報を生成する
               #
-              # @return [Both::Date] 日情報
+              # @return [Type::Base::Both::Date] 日情報
               #
               def create
                 japan_date = Japan::Calendar.new
@@ -282,7 +283,7 @@ module Zakuro
                 japan_date = Japan::Calendar.parse(text: japan) unless japan == ''
                 western_date = Western::Calendar.parse(text: western) unless western == ''
 
-                Japan::Gengou::Resource::Both::Date.new(
+                Type::Base::Both::Date.new(
                   japan: japan_date, western: western_date
                 )
               end
@@ -296,7 +297,7 @@ module Zakuro
             # @param [String] filepath 元号セットファイルパス
             # @param [True, False] operated 運用値設定
             #
-            # @return [Set] 元号セット情報
+            # @return [Type::Base::GengouSet] 元号セット情報
             #
             # @raise [ArgumentError] 引数エラー
             #
@@ -307,7 +308,7 @@ module Zakuro
 
               raise ArgumentError, failed.join("\n") unless failed.empty?
 
-              parser = SetParser.new(hash: yaml, operated: operated)
+              parser = GengouSetParser.new(hash: yaml, operated: operated)
               parser.create
             end
           end

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

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../../../japan/calendar'
-require_relative '../../../western/calendar'
-require_relative './type'
+require_relative '../../type/validation/gengou_set'
+
 require 'yaml'
 
 # :nodoc:
@@ -19,396 +18,6 @@ module Zakuro
         # Validator yaml解析
         #
         module Validator
-          #
-          # Set 元号セット情報の検証/展開
-          #
-          class Set
-            # @return [String] 元号セットID
-            attr_reader :id
-            # @return [String] 元号セット名
-            attr_reader :name
-            # @return [Hash<String, String>] 終了年
-            attr_reader :last_year
-            # @return [Hash<String, String>] 終了日
-            attr_reader :last_date
-            # @return [Array<Hash<String, String>>] 元号情報
-            attr_reader :list
-
-            #
-            # 初期化
-            #
-            # @param [Hash<String, Object>] hash 元号セット情報
-            #
-            def initialize(hash:)
-              @id = hash['id']
-              @name = hash['name']
-              @last_year = hash['last_year']
-              @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_last_year
-
-              failed |= validate_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_last_year
-              Both::Year.new(hash: last_year).validate
-            end
-
-            #
-            # 終了日を検証する
-            #
-            # @return [Array<String>] 不正メッセージ
-            #
-            def validate_last_date
-              SwitchDate.new(hash: 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 :start_year
-            # @return [Hash<String, String>] 開始日
-            attr_reader :start_date
-
-            #
-            # 初期化
-            #
-            # @param [Hash<String, Strin>] hash 元号情報
-            # @param [Integer] index （元号セット内での）元号の要素位置
-            #
-            def initialize(hash:, index:)
-              @index = index
-              @name = hash['name']
-              @start_year = hash['start_year']
-              @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_start_year
-
-              failed |= validate_start_date
-
-              failed
-            end
-
-            #
-            # 元号名を検証する
-            #
-            # @return [True] 正しい
-            # @return [False] 正しくない
-            #
-            def name?
-              return false unless name
-
-              name.is_a?(String)
-            end
-
-            #
-            # 開始年を検証する
-            #
-            # @return [Array<String>] 不正メッセージ
-            #
-            def validate_start_year
-              Both::Year.new(hash: start_year).validate
-            end
-
-            #
-            # 開始日を検証する
-            #
-            # @return [Array<String>] 不正メッセージ
-            #
-            def validate_start_date
-              SwitchDate.new(hash: start_date).validate
-            end
-          end
-
-          #
-          # SwitchDate 切替日（運用/計算）
-          #
-          class SwitchDate
-            # @return [Hash<String, Strin>] 計算値
-            attr_reader :calculation
-            # @return [Hash<String, Strin>] 運用値
-            attr_reader :operation
-
-            #
-            # 初期化
-            #
-            # @param [Hash<String, Strin>] hash 切替日（運用/計算）
-            #
-            def initialize(hash:)
-              @calculation = hash['calculation']
-              @operation = hash['operation']
-            end
-
-            #
-            # 検証する
-            #
-            # @return [Array<String>] 不正メッセージ
-            #
-            def validate
-              failed = []
-
-              failed |= validate_calculation_date
-
-              failed |= validate_operation_date
-
-              failed
-            end
-
-            private
-
-            #
-            # 日（計算値）を検証する
-            #
-            # @return [Array<String>] 不正メッセージ
-            #
-            def validate_calculation_date
-              Both::Date.new(hash: calculation, optional: true).validate
-            end
-
-            #
-            # 日（運用値）を検証する
-            #
-            # @return [Array<String>] 不正メッセージ
-            #
-            def validate_operation_date
-              Both::Date.new(hash: operation).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
-              # @return [True] 省略可
-              # @return [False] 省略不可
-              attr_reader :optional
-
-              #
-              # 初期化
-              #
-              # @param [Hash<String, Strin>] hash 日情報
-              #
-              def initialize(hash:, optional: false)
-                @japan = hash['japan']
-                @western = hash['western']
-                @optional = optional
-              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?
-                return true if optional?(text: japan)
-
-                Japan::Calendar.valid_date_text(text: japan)
-              end
-
-              #
-              # 西暦日を検証する
-              #
-              # @return [True] 正しい
-              # @return [False] 正しくない
-              #
-              def western?
-                return true if optional?(text: western)
-
-                Western::Calendar.valid_date_text(text: western)
-              end
-
-              #
-              # 省略可で省略されているか
-              #
-              # @param [String] text 文字列
-              #
-              # @return [True] 省略あり
-              # @return [False] 省略なし
-              #
-              def optional?(text: '')
-                return false unless optional
-
-                return true if text == ''
-
-                false
-              end
-            end
-          end
-
           class << self
             #
             # 検証する
@@ -418,7 +27,7 @@ module Zakuro
             # @return [Array<String>] 不正メッセージ
             #
             def run(yaml_hash:)
-              Set.new(hash: yaml_hash).validate
+              Type::Validation::GengouSet.new(hash: yaml_hash).validate
             end
           end
         end

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

@@ -1125,13 +1125,13 @@ list:
   start_date:
     calculation:
       japan: ''
-      western: ''
+      western: '1037-5-8'
     operation:
       japan: 長暦01年04月21日
       western: '1037-5-9'
   disuse:
     new_year_date: '1037-1-19'
-    note: ''
+    note: '行親記（計算：1037-5-8）'
 - name: 長久
   start_year:
     japan: 1

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

@@ -27,29 +27,31 @@ module Zakuro
         # @param [Western::Calendar] start_date 開始日
         # @param [Western::Calendar] last_date 終了日
         # @param [True, False] operated 運用値設定
+        # @param [True, False] restored 運用値から計算値に戻すか
         #
         # @return [Array<LinearGengou>] 該当行の元号
         #
         def line(line: FIRST_LINE,
                  start_date: Western::Calendar.new, last_date: Western::Calendar.new,
-                 operated: false)
+                 operated: false, restored: false)
           Alignment.get(
-            line: line, start_date: start_date, last_date: last_date, operated: operated
+            line: line, start_date: start_date, last_date: last_date, operated: operated,
+            restored: restored
           )
         end
 
         #
         # 該当行の元号を取得する（元号名）
         #
+        # @param [String] name 元号名
         # @param [Integer] line 行番号
-        # @param [Western::Calendar] start_date 開始日
-        # @param [Western::Calendar] last_date 終了日
         # @param [True, False] operated 運用値設定
+        # @param [True, False] restored 運用値から計算値に戻すか
         #
         # @return [Array<LinearGengou>] 該当行の元号
         #
-        def line_by_name(line: FIRST_LINE, name:, operated: false)
-          Alignment.get_by_name(line: line, name: name, operated: operated)
+        def line_by_name(name:, line: FIRST_LINE, operated: false, restored: false)
+          Alignment.get_by_name(name: name, line: line, operated: operated, restored: restored)
         end
       end
     end

data/lib/zakuro/era/japan/type/base/both/date.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../../../../western/calendar'
+
+require_relative '../../../calendar'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Japan
+    # :nodoc:
+    module Type
+      # :nodoc:
+      module Base
+        # :nodoc:
+        module Both
+          #
+          # Date 日
+          #
+          class Date
+            # @return [Japan::Calendar] 和暦日
+            attr_reader :japan
+            # @return [Western::Calendar] 西暦日
+            attr_reader :western
+
+            #
+            # 初期化
+            #
+            # @param [Japan::Calendar] japan 和暦日
+            # @param [Western::Calendar] 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
+end

data/lib/zakuro/era/japan/type/base/both/year.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative '../../../../western/calendar'
+
+require_relative '../../../calendar'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Japan
+    # :nodoc:
+    module Type
+      # :nodoc:
+      module Base
+        # :nodoc:
+        module Both
+          #
+          # Year 年
+          #
+          class Year
+            # @return [Integer] 不正値
+            INVALID = -1
+            # @return [Integer] 和暦元号年
+            attr_reader :japan
+            # @return [Integer] 西暦年
+            attr_reader :western
+
+            #
+            # 初期化
+            #
+            # @param [Integer] japan 和暦元号年
+            # @param [Integer] western 西暦年
+            #
+            def initialize(japan: INVALID, western: INVALID)
+              @japan = japan
+              @western = western
+            end
+
+            #
+            # 不正か
+            #
+            # @return [True] 不正
+            # @return [False] 不正なし
+            #
+            def invalid?
+              japan == INVALID || western == INVALID
+            end
+          end
+        end
+      end
+    end
+  end
+end