zakuro 0.9.4 → 1.0.0

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

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require_relative '../../../western/calendar'
+require_relative './switch_date'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Japan
+    # :nodoc:
+    module Type
+      # :nodoc:
+      module Base
+        #
+        # Gengou 元号情報
+        #
+        class Gengou
+          # @return [String] 元号名
+          attr_reader :name
+          # @return [Both::Year] 開始年（和暦/西暦）
+          attr_reader :start_year
+          # @return [SwitchDate] 開始日（和暦/西暦）
+          attr_reader :start_date
+          # @return [Integer] 終了年
+          attr_reader :last_year
+          # @return [Western::Calendar] 終了日
+          attr_reader :last_date
+
+          #
+          # 初期化
+          #
+          # @param [String] name 元号名
+          # @param [Both::Year] start_year 開始年（和暦/西暦）
+          # @param [SwitchDate] start_date 開始日（和暦/西暦）
+          # @param [Integer] last_date 終了年
+          # @param [Western::Calendar] last_date 終了日
+          #
+          def initialize(name: '', start_year: Both::Year.new,
+                         start_date: SwitchDate.new,
+                         last_date: Western::Calendar.new,
+                         last_year: Both::Year::INVALID)
+            @name = name
+            @start_year = start_year
+            @start_date = start_date
+            @last_year = last_year
+            @last_date = last_date
+          end
+
+          #
+          # 終了年を更新する
+          #
+          # @param [Integer] last_year 終了年
+          #
+          # @raise [ArgumentError] 引数エラー
+          #
+          def write_last_year(last_year:)
+            unless self.class.valid_year(year: last_year)
+              raise ArgumentError, "invalid year format. [#{last_year}]"
+            end
+
+            @last_year = last_year
+          end
+
+          #
+          # 終了日を更新する
+          #
+          # @param [Western::Calendar] last_date 終了日
+          #
+          # @raise [ArgumentError] 引数エラー
+          #
+          def write_last_date(last_date:)
+            unless self.class.valid_date(date: last_date)
+              raise ArgumentError, "invalid date format. [#{last_date}]"
+            end
+
+            @last_date = last_date
+            nil
+          end
+
+          #
+          # 次の元号の開始年から、元号の終了年に変換する
+          #
+          # @param [Integer] next_start_year 次回開始年
+          #
+          def convert_next_start_year_to_last_year(next_start_year:)
+            if start_year.western >= next_start_year
+              @last_year = next_start_year
+              return
+            end
+
+            @last_year = next_start_year - 1
+
+            nil
+          end
+
+          #
+          # 次の元号の開始日から、元号の終了日に変換する
+          #
+          # @param [Western::Calendar] next_start_date 次回開始日
+          #
+          # @raise [ArgumentError] 引数エラー
+          #
+          def convert_next_start_date_to_last_date(next_start_date: Western::Calendar.new)
+            raise ArgumentError, 'invalid value. cannot convert' if next_start_date.invalid?
+
+            @last_date = next_start_date.clone - 1
+
+            nil
+          end
+
+          #
+          # 指定した日が元号に含まれるか
+          #
+          # @param [Western::Calendar] date 日
+          #
+          # @return [True] 含まれる
+          # @return [False] 含まれない
+          #
+          def include?(date:)
+            date >= start_date.western && date <= last_date
+          end
+
+          #
+          # 不正か
+          #
+          # @return [True] 不正
+          # @return [False] 不正なし
+          #
+          def invalid?
+            start_year.japan == -1 || start_year.invalid? ||
+              start_date.invalid? || last_date.invalid?
+          end
+
+          #
+          # インスタンス値（文字列）を取得する
+          #
+          # @return [String] インスタンス値（文字列）
+          #
+          def to_s
+            "name: #{@name}, start_year: #{start_year.format}, " \
+            "start_date: #{start_date.format}, last_date: #{last_date.format}"
+          end
+
+          class << self
+            #
+            # 年が不正なしかどうかを確認する
+            #
+            # @param [Integer] year 年
+            #
+            # @return [True] 不正なし
+            # @return [False] 不正
+            #
+            def valid_year(year:)
+              return false unless year
+
+              year.is_a?(Integer)
+            end
+
+            #
+            # 日付が不正なしかどうかを確認する
+            #
+            # @param [Western::Calendar] date 日付
+            #
+            # @return [True] 不正なし
+            # @return [False] 不正
+            #
+            def valid_date(date:)
+              return false unless date
+
+              date.is_a?(Western::Calendar)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/era/japan/type/base/gengou_set.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative './both/date'
+require_relative './both/year'
+require_relative './gengou'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Japan
+    # :nodoc:
+    module Type
+      # :nodoc:
+      module Base
+        #
+        # GengouSet 元号セット
+        #
+        class GengouSet
+          # @return [Integer] 不正値
+          INVALID = -1
+          # @return [Integer] 元号セットID
+          attr_reader :id
+          # @return [String] 元号セット名
+          attr_reader :name
+          # @return [Both::Year] 元号セットでの終了年
+          attr_reader :last_year
+          # @return [Both::Date] 元号セットでの終了日
+          attr_reader :last_date
+          # @return [Array<Gengou>] 元号リスト
+          attr_reader :list
+
+          #
+          # 初期化
+          #
+          # @param [Integer] id 元号セットID
+          # @param [String] name 元号セット名
+          # @param [Both::Year] last_year 元号セットでの終了年
+          # @param [Both::Date] last_date 元号セットでの終了日
+          # @param [Array<Gengou>] list 元号リスト
+          #
+          def initialize(id: INVALID, name: '', last_year: Both::Year.new,
+                         last_date: Both::Date.new, list: [])
+            @id = id
+            @name = name
+            @last_year = last_year
+            @last_date = 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
+      end
+    end
+  end
+end

data/lib/zakuro/era/japan/type/base/switch_date.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative '../../../western/calendar'
+require_relative '../../calendar'
+require_relative './both/date'
+require_relative './both/year'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Japan
+    # :nodoc:
+    module Type
+      # :nodoc:
+      module Base
+        #
+        # SwitchDate 切替日（運用/計算）
+        #
+        class SwitchDate
+          # @return [Both::Date] 計算値
+          attr_reader :calculation
+          # @return [Both::Date] 運用値
+          attr_reader :operation
+          # @return [True, False] 運用値
+          attr_reader :operated
+          # @return [Japan::Calendar] 和暦日
+          attr_reader :japan
+          # @return [Western::Calendar] 西暦日
+          attr_reader :western
+
+          #
+          # 初期化
+          #
+          # @param [Both::Date] calculation 計算値
+          # @param [Both::Date] operation 運用値
+          # @param [True, False] operated 運用値設定
+          #
+          def initialize(calculation: Both::Date.new, operation: Both::Date.new, operated: false)
+            @calculation = calculation
+            @operation = operation
+            @operated = operated
+
+            select
+          end
+
+          #
+          # 不正か
+          #
+          # @return [True] 不正
+          # @return [False] 不正なし
+          #
+          def invalid?
+            japan.invalid? || western.invalid?
+          end
+
+          private
+
+          def select
+            @japan = operation.japan
+            @western = operation.western
+
+            return if operated
+
+            calc_japan = calculation.japan
+            calc_western = calculation.western
+
+            @japan = calc_japan unless calc_japan.invalid?
+            @western = calc_western unless calc_western.invalid?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/era/japan/type/base/version_range.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require_relative '../../../western/calendar'
+require_relative './both/date'
+require_relative './both/year'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Japan
+    # :nodoc:
+    module Type
+      # :nodoc:
+      module Base
+        #
+        # VersionRange 暦範囲情報
+        #
+        class VersionRange
+          # @return [String] 暦名
+          attr_reader :name
+          # @return [Both::Year] 開始年（和暦/西暦）
+          attr_reader :start_year
+          # @return [Both::Date] 開始日（和暦/西暦）
+          attr_reader :start_date
+          # @return [Integer] 終了年
+          attr_reader :last_year
+          # @return [Western::Calendar] 終了日
+          attr_reader :last_date
+          # @return [True] リリース有
+          # @return [False] リリース無
+          attr_reader :released
+
+          # rubocop:disable Metrics/ParameterLists
+
+          #
+          # 初期化
+          #
+          # @param [String] name 暦名
+          # @param [Both::Year] start_year 開始年（和暦/西暦）
+          # @param [Both::Date] start_date 開始日（和暦/西暦）
+          # @param [Integer] last_date 終了年
+          # @param [Western::Calendar] last_date 終了日
+          # @param [True, False] released リリース有無
+          #
+          def initialize(
+            name: '', start_year: Both::Year.new,
+            start_date: Both::Date.new,
+            last_date: Western::Calendar.new, last_year: Both::Year::INVALID,
+            released: false
+          )
+            @name = name
+            @start_year = start_year
+            @start_date = start_date
+            @last_year = last_year
+            @last_date = last_date
+            @released = released
+          end
+          # rubocop:enable Metrics/ParameterLists
+
+          #
+          # 終了年を更新する
+          #
+          # @param [Integer] last_year 終了年
+          #
+          # @raise [ArgumentError] 引数エラー
+          #
+          def write_last_year(last_year:)
+            unless self.class.valid_year(year: last_year)
+              raise ArgumentError, "invalid year format. [#{last_year}]"
+            end
+
+            @last_year = last_year
+          end
+
+          #
+          # 終了日を更新する
+          #
+          # @param [Western::Calendar] last_date 終了日
+          #
+          # @raise [ArgumentError] 引数エラー
+          #
+          def write_last_date(last_date:)
+            unless self.class.valid_date(date: last_date)
+              raise ArgumentError, "invalid date format. [#{last_date}]"
+            end
+
+            @last_date = last_date
+
+            nil
+          end
+
+          #
+          # 次の元号の開始年から、元号の終了年に変換する
+          #
+          # @param [Integer] next_start_year 次回開始年
+          #
+          def convert_next_start_year_to_last_year(next_start_year:)
+            if start_year.western >= next_start_year
+              @last_year = next_start_year
+              return
+            end
+
+            @last_year = next_start_year - 1
+
+            nil
+          end
+
+          #
+          # 次の元号の開始日から、元号の終了日に変換する
+          #
+          # @param [Western::Calendar] next_start_date 次回開始日
+          #
+          # @raise [ArgumentError] 引数エラー
+          #
+          def convert_next_start_date_to_last_date(next_start_date: Western::Calendar.new)
+            raise ArgumentError, 'invalid value. cannot convert' if next_start_date.invalid?
+
+            @last_date = next_start_date.clone - 1
+
+            nil
+          end
+
+          #
+          # 指定した日が元号に含まれるか
+          #
+          # @param [Western::Calendar] date 日
+          #
+          # @return [True] 含まれる
+          # @return [False] 含まれない
+          #
+          def include?(date:)
+            date >= start_date.western && date <= last_date
+          end
+
+          #
+          # 不正か
+          #
+          # @return [True] 不正
+          # @return [False] 不正なし
+          #
+          def invalid?
+            start_year.japan == -1 || start_year.invalid? ||
+              start_date.invalid? || last_date.invalid?
+          end
+
+          #
+          # インスタンス値（文字列）を取得する
+          #
+          # @return [String] インスタンス値（文字列）
+          #
+          def to_s
+            "name: #{@name}, start_year: #{start_year.format}, " \
+            "start_date: #{start_date.format}, last_date: #{last_date.format}"
+          end
+
+          class << self
+            #
+            # 年が不正なしかどうかを確認する
+            #
+            # @param [Integer] year 年
+            #
+            # @return [True] 不正なし
+            # @return [False] 不正
+            #
+            def valid_year(year:)
+              return false unless year
+
+              year.is_a?(Integer)
+            end
+
+            #
+            # 日付が不正なしかどうかを確認する
+            #
+            # @param [Western::Calendar] date 日付
+            #
+            # @return [True] 不正なし
+            # @return [False] 不正
+            #
+            def valid_date(date:)
+              return false unless date
+
+              date.is_a?(Western::Calendar)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative '../../../../western/calendar'
+
+require_relative '../../../calendar'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Japan
+    # :nodoc:
+    module Type
+      # :nodoc:
+      module Validation
+        # :nodoc:
+        module Both
+          #
+          # 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Japan
+    # :nodoc:
+    module Type
+      # :nodoc:
+      module Validation
+        # :nodoc:
+        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
+        end
+      end
+    end
+  end
+end