zakuro 0.5.0 → 0.6.0

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

@@ -0,0 +1,382 @@
+# frozen_string_literal: true
+
+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
+        # List
+        #
+        # 予約元号一覧
+        #
+        class List
+          # TODO: refactor
+
+          # @return [Integer] 不正年
+          INVALID_YEAR = -1
+          # @return [Integer] 最大試行数
+          MAX_SEARCH_COUNT = 10_000
+          # @return [Integer] 最大月日数
+          MAX_MONTH_DAYS = 30
+
+          # @return [Symbol] メソッド名
+          attr_reader :method_name
+          # @return [Western::Calendar] 開始日
+          attr_reader :start_date
+          # @return [Western::Calendar] 終了日
+          attr_reader :end_date
+          # @return [Array<Japan::Gengou>] 予約元号一覧
+          attr_reader :list
+
+          #
+          # 初期化
+          #
+          # @param [True, False] first true:1行目元号, false:2行目元号
+          # @param [Western::Calendar] start_date 開始日
+          # @param [Western::Calendar] end_date 終了日
+          #
+          def initialize(first: true, start_date: Western::Calendar.new,
+                         end_date: Western::Calendar)
+            @method_name = first ? :first_line : :second_line
+            @start_date = start_date
+            @end_date = end_date
+            @list = []
+
+            update
+          end
+
+          #
+          # 元号を取得する
+          #
+          # @param [Western::Calendar] western_date 西暦日
+          #
+          # @return [Gengou::Counter] 加算元号
+          #
+          def get(western_date: Western::Calendar.new)
+            @list.each do |gengou|
+              if gengou.include?(date: western_date)
+                return Gengou::Counter.new(gengou: gengou).clone
+              end
+            end
+
+            Gengou::Counter.new
+          end
+
+          #
+          # 範囲内元号を取得する
+          #
+          #   次のパターンが考えられる
+          #   1. 元号の開始日から終了日まで該当元号なし（無効な元号）
+          #   2. 元号の開始日までは該当元号なし（無効な元号、開始日以降の元号）
+          #   3. 元号の開始日と月初日が合致し、末日まで同一元号（開始日以降の元号のみ）
+          #   4. 月の途中で有効な元号が切り替わる（有効な元号、有効な元号...）
+          #   5. 途中から該当元号なし（開始日以降の元号、無効な元号）
+          #
+          # FIXME: 有効な元号、無効な元号、有効な元号のようなストライプのパターンに対応していない
+          #
+          # @param [Western::Calendar] start_date 西暦開始日
+          # @param [Western::Calendar] end_date 西暦終了日
+          #
+          # @return [Array<Gengou::Counter>] 範囲内元号
+          #
+          def collect(start_date: Western::Calendar.new, end_date: Western::Calendar.new)
+            result = []
+
+            # 開始チェック
+            current_gengou = get(western_date: start_date)
+            result.push(current_gengou)
+
+            ## 範囲内に次の有効元号があるか
+            if current_gengou.invalid?
+              current_gengou = proceed(western_date: start_date)
+
+              return result if suspend?(current_gengou: current_gengou, end_date: end_date)
+
+              result.push(current_gengou)
+            end
+
+            return result if suspend?(current_gengou: current_gengou, end_date: end_date)
+
+            # 有効元号チェック
+            continue(result: result, current_date: current_gengou.western_end_date.clone,
+                     end_date: end_date)
+          end
+
+          #
+          # 元号を進めて取得する
+          #
+          # @param [Western::Calendar] western_date 西暦日
+          #
+          # @return [Gengou::Counter] 加算元号
+          #
+          def proceed(western_date: Western::Calendar.new)
+            current_gengou = get(western_date: western_date)
+
+            # 無効な元号
+            if current_gengou.invalid?
+              @list.each do |gengou|
+                next if gengou.invalid?
+
+                # すでに超過している場合
+                break if western_date > gengou.end_date
+
+                return Gengou::Counter.new(gengou: gengou).clone
+              end
+
+              return Gengou::Counter.new
+            end
+
+            # 有効な元号
+            @list.each do |gengou|
+              next if gengou.invalid?
+
+              if gengou.both_start_date.western > current_gengou.western_end_date
+                return Gengou::Counter.new(gengou: gengou).clone
+              end
+            end
+
+            Gengou::Counter.new
+          end
+
+          #
+          # 和暦開始日を取得する
+          #
+          # @return [Japan::Calendar] 和暦開始日
+          #
+          def japan_start_date
+            return Japan::Calendar.new if invalid?
+
+            @list[0].both_start_date.japan.clone
+          end
+
+          #
+          # 西暦開始日を取得する
+          #
+          # @return [Western::Calendar] 西暦開始日
+          #
+          def western_start_date
+            return Western::Calendar.new if invalid?
+
+            @list[0].both_start_date.western.clone
+          end
+
+          #
+          # 西暦開始年を取得する
+          #
+          # @return [Integer] 西暦開始年
+          #
+          def western_start_year
+            return INVALID_YEAR if invalid?
+
+            @list[0].both_start_year.western.clone
+          end
+
+          #
+          # 西暦終了年を取得する
+          #
+          # @return [Integer] 西暦終了年
+          #
+          def western_end_year
+            return INVALID_YEAR if invalid?
+
+            return INVALID_YEAR if @list.size.zero?
+
+            @list[-1].end_year
+          end
+
+          #
+          # 不正か
+          #
+          # @return [True] 不正
+          # @return [False] 不正なし
+          #
+          def invalid?
+            return true unless @list
+
+            return true if @list.size.zero?
+
+            false
+          end
+
+          private
+
+          #
+          # 予約元号一覧を更新する
+          #
+          def update
+            result = internal
+
+            return result if result.size.zero?
+
+            prev_gengou(list: result)
+
+            next_gengou(list: result)
+
+            @list = result
+          end
+
+          #
+          # 開始日・終了日に対応する予約元号一覧を取得する
+          #
+          # @return [Array<Japan::Gengou>] 予約元号一覧
+          #
+          def internal
+            current_gengou = line(date: start_date)
+            result = []
+
+            return result if current_gengou.invalid?
+
+            result.push(current_gengou)
+            (0..MAX_SEARCH_COUNT).each do |_index|
+              current_end_date = current_gengou.end_date.clone
+              break if current_end_date > end_date
+
+              current_gengou = line(date: current_end_date + 1)
+              result.push(current_gengou)
+            end
+
+            result
+          end
+
+          #
+          # 前の元号を設定する
+          #
+          # @note 開始日の30日前に前の元号がある場合は、前の元号を設定する
+          #
+          # @param [Array<Japan::Gengou>] list 元号一覧
+          #
+          def prev_gengou(list:)
+            return unless list
+
+            return if list.size.zero?
+
+            first_gengou_date = list[0].both_start_date.western.clone
+
+            border_date = start_date.clone - MAX_MONTH_DAYS
+
+            return if first_gengou_date < border_date
+
+            gengou = line(date: first_gengou_date - 1)
+
+            return if gengou.invalid?
+
+            list.unshift(gengou)
+          end
+
+          #
+          # 次の元号を設定する
+          #
+          # @note 開始日の30日後に次の元号がある場合は、次の元号を設定する
+          #
+          # @param [Array<Japan::Gengou>] list 元号一覧
+          #
+          def next_gengou(list:)
+            return unless list
+
+            return if list.size.zero?
+
+            last_gengou_date = list[-1].end_date.clone
+
+            border_date = end_date.clone + MAX_MONTH_DAYS
+
+            return if border_date < last_gengou_date
+
+            gengou = line(date: last_gengou_date + 1)
+
+            return if gengou.invalid?
+
+            list.push(gengou)
+          end
+
+          #
+          # 元号
+          #
+          # @param [Western::Calendar] date 日付
+          #
+          # @return [Japan::Gengou] 元号
+          #
+          def line(date:)
+            List.send(method_name, **{ date: date })
+          end
+
+          #
+          # 有効元号を継続する
+          #
+          # @param [Array<Gengou::Counter>] result 範囲内元号
+          # @param [Gengou::Counter] current_gengou 現在元号
+          # @param [Western::Calendar] end_date 終了日
+          #
+          # @return [Array<Gengou::Counter>] 範囲内元号
+          #
+          def continue(result:, current_date:, end_date:)
+            (0..MAX_SEARCH_COUNT).each do |_index|
+              current_gengou = proceed(western_date: current_date)
+
+              return result if suspend?(current_gengou: current_gengou, end_date: end_date)
+
+              # 範囲内元号
+              result.push(current_gengou)
+
+              current_date = current_gengou.western_end_date.clone
+            end
+
+            # 終了
+            result
+          end
+
+          #
+          # 中断する
+          #
+          # @param [Gengou::Counter] current_gengou 現在元号
+          # @param [Western::Calendar] end_date 終了日
+          #
+          # @return [True] 中断
+          # @return [False] 継続
+          #
+          def suspend?(current_gengou:, end_date:)
+            ## 有効元号なし
+            return true if current_gengou.invalid?
+
+            ## 範囲内元号なし
+            return true if current_gengou.western_start_date > end_date
+
+            false
+          end
+
+          #
+          # 1行目元号
+          #
+          # @param [Western::Calendar] date 日付
+          #
+          # @return [Japan::Gengou] 1行目元号
+          #
+          def self.first_line(date:)
+            Zakuro::Japan::GengouResource.first_line(date: date)
+          end
+          private_class_method :first_line
+
+          #
+          # 2行目元号
+          #
+          # @param [Western::Calendar] date 日付
+          #
+          # @return [Japan::Gengou] 2行目元号
+          #
+          def self.second_line(date:)
+            Zakuro::Japan::GengouResource.second_line(date: date)
+          end
+          private_class_method :second_line
+        end
+      end
+    end
+  end
+end

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

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

data/lib/zakuro/calculation/gengou/scroll.rb

@@ -0,0 +1,262 @@
+# frozen_string_literal: true
+
+require_relative '../../era/western/calendar'
+require_relative '../base/gengou'
+require_relative '../base/linear_gengou'
+require_relative './internal/reserve/interval'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # Scroll
+      #
+      # 元号スクロール
+      #
+      class Scroll
+        # @return [Western::Calendar] 月初日
+        attr_reader :monthly_start_date
+        # @return [Western::Calendar] 月末日
+        attr_reader :monthly_end_date
+        # @return [Reserve::Interval] 予約範囲
+        attr_reader :interval
+        # @return [Array<Counte>] 1行目元号
+        attr_reader :first_gengou
+        # @return [Array<Counte>] 2行目元号
+        attr_reader :second_gengou
+
+        #
+        # 初期化
+        #
+        # @param [Western::Calendar] start_date 西暦開始日（最大範囲）
+        # @param [Western::Calendar] end_date 西暦終了日（最大範囲）
+        #
+        def initialize(start_date: Western::Calendar.new, end_date: Western::Calendar.new)
+          @monthly_start_date = Western::Calendar.new
+          @monthly_end_date = Western::Calendar.new
+          @interval = Reserve::Interval.new(start_date: start_date, end_date: end_date)
+          @first_gengou = []
+          @second_gengou = []
+          @ignited = false
+        end
+
+        #
+        # 進める
+        #
+        # @param [Monthly::Month] month 月
+        #
+        def run(month:)
+          unless @ignited
+            # 開始日の検索を行う
+            @ignited = ignite(month: month)
+            return
+          end
+
+          # 時間を進める
+          advance(month: month)
+        end
+
+        #
+        # 元号開始を試みる
+        #
+        # @param [Monthly::Month] month 月
+        #
+        # @return [True] 開始あり
+        # @return [False] 開始なし
+        #
+        def ignite(month:)
+          return false unless ignitable?(month: month)
+
+          japan_start_date = @interval.japan_start_date
+
+          western_start_date = @interval.western_start_date
+
+          # 今月初日（和暦日が1月2日であれば、開始日の1日前が初日）
+          @monthly_start_date = western_start_date.clone - japan_start_date.day + 1
+
+          # 今月末
+          @monthly_end_date = @monthly_start_date.clone + month.days - 1
+
+          update_current_gengou
+
+          true
+        end
+
+        #
+        # 進める
+        #
+        # @param [Monthly::Month] month 月
+        #
+        def advance(month:)
+          @monthly_start_date = @monthly_end_date.clone + 1
+
+          @monthly_end_date = @monthly_start_date.clone + month.days - 1
+
+          next_year if month.number == 1 && !month.leaped?
+
+          update_current_gengou
+        end
+
+        #
+        # 共通の元号に変換する
+        #
+        # @return [Base::Gengou] 元号
+        #
+        def to_gengou
+          start_date = @monthly_start_date.clone
+          end_date = @monthly_end_date.clone
+
+          Base::Gengou.new(
+            start_date: start_date,
+            end_date: end_date,
+            first_line: to_linear_gengou(
+              start_date: start_date, end_date: end_date, gengou_list: @first_gengou
+            ),
+            second_line: to_linear_gengou(
+              start_date: start_date, end_date: end_date, gengou_list: @second_gengou
+            )
+          )
+        end
+
+        #
+        # 開始西暦年を取得する
+        #
+        # @return [Integer] 開始西暦年
+        #
+        def western_start_year
+          @interval.western_start_year
+        end
+
+        #
+        # 終了西暦年を取得する
+        #
+        # @return [Integer] 終了西暦年
+        #
+        def western_end_year
+          @interval.western_end_year
+        end
+
+        private
+
+        #
+        # 現在月に合わせて元号を更新する
+        #
+        def update_current_gengou
+          start_date = @monthly_start_date
+          end_date = @monthly_end_date
+          first_gengou = @interval.collect_first_gengou(start_date: start_date, end_date: end_date)
+          second_gengou = @interval.collect_second_gengou(start_date: start_date,
+                                                          end_date: end_date)
+
+          @first_gengou = replace_gengou(source: @first_gengou, destination: first_gengou)
+          @second_gengou = replace_gengou(source: @second_gengou, destination: second_gengou)
+        end
+
+        #
+        # 元号を差し替える
+        #
+        # @param [Array<Counter>] source 元の元号
+        # @param [Array<Counter>] destination 次の元号
+        #
+        # @return [Array<Counter>] 差し替え結果
+        #
+        def replace_gengou(source: [], destination: [])
+          return destination if destination.size.zero?
+
+          return destination if source.size.zero?
+
+          last = source[-1]
+          destination[0] = last if destination[0].name == last.name
+
+          destination
+        end
+
+        #
+        # 直列元号に変換する
+        #
+        #   * 最初の元号：開始日～その元号の終了日
+        #   * 中間の元号：その元号の開始日～その元号の終了日
+        #   * 最後の元号：その元号の開始日～終了日
+        #
+        # @param [Western::Calendar] start_date 西暦開始日
+        # @param [Western::Calendar] end_date 西暦終了日
+        # @param [Array<Counter>] gengou_list 元号リスト
+        #
+        # @return [Array<Base::Gengou>] 元号リスト
+        #
+        def to_linear_gengou(start_date:, end_date:, gengou_list: [])
+          return [] if gengou_list.size.zero?
+
+          result = []
+
+          gengou_list.each do |gengou|
+            if gengou.invalid?
+              # 無効元号は無効のままにする
+              result.push(Base::LinearGengou.new)
+              next
+            end
+
+            linear_gengou = to_limited_linear_gengou(
+              start_date: start_date,
+              end_date: end_date,
+              gengou: gengou
+            )
+            result.push(linear_gengou)
+          end
+
+          result
+        end
+
+        #
+        # 範囲を限定した直列元号に変換する
+        #
+        # * 開始日・終了日により範囲を狭める
+        #
+        # @param [Western::Calendar] start_date 西暦開始日
+        # @param [Western::Calendar] end_date 西暦終了日
+        # @param [Counter] gengou 加算元号
+        #
+        # @return [Base::Gengou] 元号
+        #
+        def to_limited_linear_gengou(start_date:, end_date:, gengou:)
+          gengou_start_date = gengou.western_start_date.clone
+          gengou_end_date = gengou.western_end_date.clone
+
+          gengou_start_date = start_date.clone if start_date > gengou_start_date
+          gengou_end_date = end_date.clone if end_date < gengou_end_date
+
+          Base::LinearGengou.new(
+            start_date: gengou_start_date, end_date: gengou_end_date,
+            name: gengou.name, year: gengou.japan_year
+          )
+        end
+
+        #
+        # 開始可能か
+        #
+        # @param [Monthly::Month] month 月
+        #
+        # @return [True] 開始可
+        # @return [True] 開始不可
+        #
+        def ignitable?(month:)
+          return false unless @monthly_start_date.invalid?
+
+          japan_start_date = @interval.japan_start_date
+
+          japan_start_date.same_month?(leaped: month.leaped?, month: month.number)
+        end
+
+        #
+        # 次年にする
+        #
+        def next_year
+          @first_gengou.each(&:next_year)
+          @second_gengou.each(&:next_year)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/monthly/first_day.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../era/western'
+require_relative '../../era/western/calendar'
 
 # :nodoc:
 module Zakuro
@@ -23,7 +23,8 @@ module Zakuro
         # @param [Remainder] remainder 西暦日
         # @param [Western::Calendar] western_date 大余小余
         #
-        def initialize(western_date: Western::Calendar.new, remainder:)
+        def initialize(western_date: Western::Calendar.new,
+                       remainder: Calculation::Cycle::AbstractRemainder.new)
           # 西暦日
           @western_date = western_date
           # 大余小余