zakuro 0.5.0 → 0.7.0

data/lib/zakuro/calculation/era/gengou/internal/reserve/abstract_range.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require_relative '../../../../../era/western/calendar'
+
+require_relative './dated_list'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # :nodoc:
+      module Reserve
+        #
+        # AbstractRange 予約済み計算範囲
+        #
+        class AbstractRange
+          # @return [List] 1行目元号
+          attr_reader :first_list
+          # @return [List] 2行目元号
+          attr_reader :second_list
+
+          #
+          # 初期化
+          #
+          # @param [Western::Calendar] start_date 西暦開始日
+          # @param [Western::Calendar] last_date 西暦終了日
+          #
+          def initialize(start_date: Western::Calendar.new, last_date: Western::Calendar.new)
+            last_date = start_date.clone if last_date.invalid?
+
+            @first_list = DatedList.new(first: true, start_date: start_date, last_date: last_date)
+            @second_list = DatedList.new(first: false, start_date: start_date, last_date: last_date)
+
+            renew(last_date: last_date)
+          end
+
+          #
+          # 再初期化
+          #   含まれる最初の元号が別の行にまたがっている場合に開始日を前倒しする
+          #
+          # @param [Western::Calendar] last_date 西暦終了日
+          #
+          def renew(last_date: Western::Calendar.new)
+            native_start_date = Western::Calendar.new
+            [@first_list, @second_list].each do |list|
+              next unless list.change_start_date?
+
+              if native_start_date.invalid?
+                native_start_date = list.native_start_date.clone
+                next
+              end
+
+              next if native_start_date <= list.native_start_date
+
+              native_start_date = list.native_start_date.clone
+            end
+
+            return if native_start_date.invalid?
+
+            @first_list = DatedList.new(first: true, start_date: native_start_date,
+                                        last_date: last_date)
+            @second_list = DatedList.new(first: false, start_date: native_start_date,
+                                         last_date: last_date)
+          end
+
+          #
+          # 不正か
+          #
+          # @return [True] 不正
+          # @return [False] 不正なし
+          #
+          def invalid?
+            @first_list.invalid?
+          end
+
+          #
+          # 範囲内元号（1行目元号）を取得する
+          #
+          # @param [Western::Calendar] start_date 西暦開始日
+          # @param [Western::Calendar] last_date 西暦終了日
+          #
+          # @return [Array<Gengou::Counter>] 範囲内元号（1行目元号）
+          #
+          def collect_first(start_date: Western::Calendar.new,
+                            last_date: Western::Calendar.new)
+            @first_list.collect(start_date: start_date, last_date: last_date)
+          end
+
+          #
+          # 範囲内元号（2行目元号）を取得する
+          #
+          # @param [Western::Calendar] start_date 西暦開始日
+          # @param [Western::Calendar] last_date 西暦終了日
+          #
+          # @return [Array<Gengou::Counter>] 範囲内元号（2行目元号）
+          #
+          def collect_second(start_date: Western::Calendar.new,
+                             last_date: Western::Calendar.new)
+            @second_list.collect(start_date: start_date, last_date: last_date)
+          end
+
+          #
+          # 最古の元号から和暦開始日を取得する
+          #
+          # @return [Japan::Calendar] 和暦開始日
+          #
+          def japan_start_date
+            list = oldest_list
+
+            return Japan::Calendar.new if list.invalid?
+
+            list.japan_start_date
+          end
+
+          #
+          # 最古の元号から西暦開始日を取得する
+          #
+          # @return [Western::Calendar] 西暦開始日
+          #
+          def western_start_date
+            list = oldest_list
+
+            return Western::Calendar.new if list.invalid?
+
+            list.western_start_date
+          end
+
+          #
+          # 開始西暦年を取得する
+          #
+          # @return [Integer] 開始西暦年
+          #
+          def western_start_year
+            first_start_year = @first_list.western_start_year
+            second_start_year = @second_list.western_start_year
+
+            return first_start_year if @first_list.invalid?
+
+            return first_start_year if @second_list.invalid?
+
+            return first_start_year if first_start_year < second_start_year
+
+            second_start_year
+          end
+
+          #
+          # 終了西暦年を取得する
+          #
+          # @return [Integer] 終了西暦年
+          #
+          def western_last_year
+            first_last_year = @first_list.western_last_year
+            second_last_year = @second_list.western_last_year
+
+            return first_last_year if @first_list.invalid?
+
+            return first_last_year if @second_list.invalid?
+
+            return first_last_year if first_last_year > second_last_year
+
+            second_last_year
+          end
+
+          private
+
+          #
+          # 最古の元号を取得する
+          #
+          # @return [List] 最古の元号
+          #
+          def oldest_list
+            return @first_list if @first_list.invalid?
+
+            return @first_list if @second_list.invalid?
+
+            first_western_date = @first_list.western_start_date
+            second_western_date = @second_list.western_start_date
+
+            return @first_list if first_western_date.invalid?
+
+            return @first_list if second_western_date.invalid?
+
+            return @first_list if first_western_date < second_western_date
+
+            @second_list
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/era/gengou/internal/reserve/dated_list.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative './abstract_list'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # :nodoc:
+      module Reserve
+        # List
+        #
+        # 予約元号一覧
+        #
+        class DatedList < AbstractList
+          #
+          # 初期化
+          #
+          # @param [True, False] first true:1行目元号, false:2行目元号
+          # @param [Western::Calendar] start_date 開始日
+          # @param [Western::Calendar] last_date 終了日
+          #
+          def initialize(first: true, start_date: Western::Calendar.new,
+                         last_date: Western::Calendar)
+            @index = parse_index(first: first)
+            @start_date = start_date.clone
+            @last_date = last_date.invalid? ? start_date.clone : last_date.clone
+            super(index: @index, start_date: start_date, last_date: last_date)
+          end
+
+          #
+          # 予約元号一覧を更新する
+          #
+          def update
+            # 開始日の30日前に前の元号がある場合は、前の元号を設定する
+            start_date = @start_date.clone - (MAX_MONTH_DAYS + 1)
+            # 開始日の30日後に次の元号がある場合は、次の元号を設定する
+            last_date = @last_date.clone + (MAX_MONTH_DAYS + 1)
+
+            @list |= line(start_date: start_date, last_date: last_date)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/era/gengou/internal/reserve/dated_range.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative './abstract_range'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # :nodoc:
+      module Reserve
+        #
+        # DatedRange 予約済み計算範囲
+        #
+        class DatedRange < AbstractRange
+          #
+          # 初期化
+          #
+          # @param [Western::Calendar] start_date 西暦開始日
+          # @param [Western::Calendar] last_date 西暦終了日
+          #
+          def initialize(start_date: Western::Calendar.new, last_date: Western::Calendar.new)
+            super(start_date: start_date, last_date: last_date)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/era/gengou/internal/reserve/empty_link.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative '../../../../../era/japan/gengou/resource'
+require_relative '../../../../../era/japan/gengou'
+require_relative '../../../../../era/japan/calendar'
+require_relative '../../../../../era/western/calendar'
+
+require_relative '../counter'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # :nodoc:
+      module Reserve
+        # EmptyLink
+        #
+        # 空元号連結
+        #
+        #  * 開始日と終了日の間は常に元号で満たす必要がある
+        #  * もし元号が存在しない期間があれば、空の元号を生成する
+        #
+        module EmptyLink
+          #
+          # 空元号で満たす
+          #
+          # @param [Array<Gengou::Counter>] counters 加算元号リスト
+          # @param [Western::Calendar] start_date 開始日
+          # @param [Western::Calendar] last_date 終了日
+          #
+          def self.fill(counters:, start_date: Western::Calendar.new,
+                        last_date: Western::Calendar.new)
+            if counters.size.zero?
+              counters.push(
+                create_empty_counter(
+                  start_date: start_date.clone,
+                  last_date: last_date.clone
+                )
+              )
+              return counters
+            end
+
+            fill_both_ends(counters: counters, start_date: start_date, last_date: last_date)
+
+            fill_middle(counters: counters)
+          end
+
+          #
+          # リストの両端を空元号で満たす
+          #
+          # @param [Array<Gengou::Counter>] counters 加算元号リスト
+          # @param [Western::Calendar] start_date 開始日
+          # @param [Western::Calendar] last_date 終了日
+          #
+          def self.fill_both_ends(counters:, start_date: Western::Calendar.new,
+                                  last_date: Western::Calendar.new)
+            fill_by_start(counters: counters, start_date: start_date)
+
+            fill_by_last(counters: counters, last_date: last_date)
+          end
+          private_class_method :fill_both_ends
+
+          #
+          # 先頭要素の手前を空元号で満たす
+          #
+          # @param [Array<Gengou::Counter>] counters 加算元号リスト
+          # @param [Western::Calendar] start_date 開始日
+          #
+          def self.fill_by_start(counters:, start_date:)
+            return unless start_date < counters[0].start_date
+
+            counters.unshift(
+              create_empty_counter(
+                start_date: start_date.clone,
+                last_date: counters[0].start_date.clone - 1
+              )
+            )
+          end
+          private_class_method :fill_by_start
+
+          #
+          # 最終要素の手前を空元号で満たす
+          #
+          # @param [Array<Gengou::Counter>] counters 加算元号リスト
+          # @param [Western::Calendar] last_date 終了日
+          #
+          def self.fill_by_last(counters:, last_date:)
+            return unless last_date > counters[-1].last_date
+
+            counters.push(
+              create_empty_counter(
+                start_date: counters[-1].last_date.clone + 1,
+                last_date: last_date.clone
+              )
+            )
+          end
+          private_class_method :fill_by_last
+
+          #
+          # 元号間を空元号で満たす
+          #
+          # @param [Array<Gengou::Counter>] counters 加算元号リスト
+          #
+          def self.fill_middle(counters:)
+            return if counters.size.zero?
+
+            size = counters.size - 1
+            (0..size).reverse_each do |index|
+              break if index <= 0
+
+              insert(counters: counters, index: index)
+            end
+          end
+          private_class_method :fill_middle
+
+          #
+          # 対象要素に空元号を追加する
+          #
+          # @param [Array<Gengou::Counter>] counters 加算元号リスト
+          # @param [Integer] index 要素番号
+          #
+          def self.insert(counters:, index:)
+            before_last_date = counters[index - 1].last_date.clone
+            current_start_date = counters[index].start_date.clone
+
+            return if (before_last_date.clone + 1) == current_start_date
+
+            counters.insert(
+              index,
+              create_empty_counter(
+                start_date: before_last_date + 1, last_date: current_start_date - 1
+              )
+            )
+          end
+          private_class_method :insert
+
+          #
+          # 空元号を生成する
+          #
+          # @param [Western::Calendar] start_date 西暦開始日
+          # @param [Western::Calendar] last_date 西暦終了日
+          #
+          # @return [Gengou::Counter] 加算元号（空元号）
+          #
+          def self.create_empty_counter(start_date:, last_date:)
+            Gengou::Counter.new(
+              gengou: Japan::Gengou::Resource::Gengou.new,
+              start_date: start_date, last_date: last_date
+            )
+          end
+          private_class_method :create_empty_counter
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/era/gengou/internal/reserve/named_list.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative './abstract_list'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # :nodoc:
+      module Reserve
+        # NamedList
+        #
+        # 予約元号一覧（元号名）
+        #
+        class NamedList < AbstractList
+          # @return [String] 不正元号名
+          INVALID_NAME = Japan::Calendar::EMPTY
+
+          #
+          # 初期化
+          #
+          # @param [True, False] first true:1行目元号, false:2行目元号
+          # @param [String] start_name 開始元号名
+          # @param [String] last_name 終了元号名
+          #
+          def initialize(first: true, start_name: INVALID_NAME, last_name: INVALID_NAME)
+            @index = parse_index(first: first)
+            @start_date = Western::Calendar.new
+            @last_date = Western::Calendar.new
+
+            locate(start_name: start_name, last_name: last_name)
+            super(index: @index, start_date: @start_date, last_date: @last_date)
+          end
+
+          private
+
+          #
+          # 開始日・終了日を配置する
+          #
+          # @param [String] start_name 開始元号名
+          # @param [String] last_name 終了元号名
+          #
+          def locate(start_name:, last_name:)
+            start = start_name
+            last = last_name
+            last = start if last == INVALID_NAME
+
+            return if start == INVALID_NAME
+
+            [start, last].each do |name|
+              gengou_list = line_by_name(name: name)
+
+              next if gengou_list.size.zero?
+
+              choise_start_date(
+                date: gengou_list[0].start_date.clone
+              )
+              choise_last_date(
+                date: gengou_list[-1].last_date.clone
+              )
+            end
+          end
+
+          #
+          # 最古の開始日を選択する
+          #
+          # @param [Western::Calendar] date 西暦日
+          #
+          def choise_start_date(date:)
+            return if date.invalid?
+
+            if @start_date.invalid?
+              @start_date = date
+              return
+            end
+
+            return if date > @start_date
+
+            @start_date = date
+          end
+
+          #
+          # 最新の終了日を選択する
+          #
+          # @param [Western::Calendar] date 西暦日
+          #
+          def choise_last_date(date:)
+            return if date.invalid?
+
+            if @last_date.invalid?
+              @last_date = date
+              return
+            end
+
+            return if date < @last_date
+
+            @last_date = date
+          end
+
+          #
+          # 元号を取得する（元号名）
+          #
+          # @param [String] name 元号名
+          #
+          # @return [Array<Japan::Alignment::LinearGengou>] 元号
+          #
+          def line_by_name(name:)
+            Japan::Gengou.line_by_name(line: @index, name: name)
+          end
+
+          #
+          # 予約元号一覧を更新する
+          #
+          # すでに解決済みの開始日・終了日をそのまま使用する（前後の元号を引き当てない）
+          #
+          def update
+            @list |= line(start_date: start_date, last_date: last_date)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/era/gengou/internal/reserve/named_range.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative './abstract_range'
+require_relative './named_list'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # :nodoc:
+      module Reserve
+        #
+        # NamedRange 予約済み計算範囲（元号名）
+        #
+        class NamedRange < AbstractRange
+          # @return [String] 不正元号名
+          INVALID_NAME = Japan::Calendar::EMPTY
+
+          #
+          # 初期化
+          #
+          # @param [String] start_name 開始元号名
+          # @param [String] last_name 終了元号名
+          #
+          def initialize(start_name: INVALID_NAME, last_name: INVALID_NAME)
+            @first_list = NamedList.new(first: true, start_name: start_name, last_name: last_name)
+            @second_list = NamedList.new(first: false, start_name: start_name, last_name: last_name)
+
+            start_date = western_start_date
+            last_date = western_last_date
+
+            super(start_date: start_date, last_date: last_date)
+          end
+
+          #
+          # 最新の元号から西暦終了日を取得する
+          #
+          # @return [Western::Calendar] 西暦終了日
+          #
+          def western_last_date
+            list = newest_list
+
+            return Western::Calendar.new if list.invalid?
+
+            list.western_last_date
+          end
+
+          #
+          # 最新の元号を取得する
+          #
+          # @return [List] 最新の元号
+          #
+          def newest_list
+            return @first_list if @first_list.invalid?
+
+            return @first_list if @second_list.invalid?
+
+            first_western_date = @first_list.western_last_date
+            second_western_date = @second_list.western_last_date
+
+            return @first_list if first_western_date.invalid?
+
+            return @first_list if second_western_date.invalid?
+
+            return @first_list if first_western_date > second_western_date
+
+            @second_list
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/era/gengou/internal/reserve.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../../era/western/calendar'
+require_relative './reserve/dated_range'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # Reserve
+      #
+      # 元号に基づき計算範囲を予約する
+      #
+      module Reserve
+        #
+        # 予約結果を取得する
+        #
+        #   * 開始日・終了日から計算する範囲を求める
+        #   * 開始日・終了日の範囲内にある元号全てが対象となる
+        #   * 元号に応じて計算範囲は変化する
+        #     * 元号の開始日（改元日）が開始日よりも前であれば、結果開始日は前者になる
+        #     * 元号の終了日（改元前日）が終了日よりも後であれば、結果終了日は前者になる
+        #     * 南北朝のように複数元号に属する場合、より広い範囲の元号に合わせる
+        #   * 属する元号よりもさらに範囲を広げる場合がある
+        #     * 開始日が最初の元号の改元後30日以内の場合、さらに前の元号まで対象にする
+        #     * 終了日が最後の元号の改元前日30日以内の場合、さらに次の元号まで対象にする
+        #
+        # @param [Western::Calendar] start_date 開始日
+        # @param [Western::Calendar] last_date 終了日
+        #
+        # @return [Range] 予約済み計算範囲
+        #
+        def self.get(start_date: Western::Calendar.new, last_date: Western::Calendar.new)
+          DatedRange.new(start_date: start_date, last_date: last_date)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/era/gengou/named_scroll.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative './abstract_scroll'
+require_relative './internal/reserve/named_range'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # NamedScroll
+      #
+      # 元号スクロール
+      #
+      class NamedScroll < AbstractScroll
+        #
+        # 初期化
+        #
+        # @param [String] start_name 開始元号名
+        # @param [String] last_name 終了元号名
+        #
+        def initialize(start_name: INVALID_NAME, last_name: INVALID_NAME)
+          range = Reserve::NamedRange.new(start_name: start_name, last_name: last_name)
+          super(range: range)
+        end
+      end
+    end
+  end
+end