zakuro 0.1.1 → 0.2.0

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

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+require_relative './month'
+require_relative '../../operation/operation'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Monthly
+      # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+
+      #
+      # OperatedMonth 月情報（運用）
+      #
+      class OperatedMonth < Month
+        # @return [Operation::MonthHistory] 変更履歴（月）
+        attr_reader :history
+        # @return [OperatedSolarTerms] 運用時二十四節気
+        attr_reader :operated_solar_terms
+
+        # :reek:LongParameterList {max_params: 6}
+        # rubocop:disable Metrics/ParameterLists
+
+        #
+        # 初期化
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [OperatedSolarTerms] operated_solar_terms 運用時二十四節気
+        # @param [MonthLabel] month_label 月表示名
+        # @param [FirstDay] first_day 月初日（朔日）
+        # @param [Array<SolarTerm>] solar_terms 二十四節気
+        # @param [Operation::MonthHistory] history 変更履歴（月）
+        #
+        def initialize(context:, operated_solar_terms:, month_label: MonthLabel.new,
+                       first_day: FirstDay.new, solar_terms: [],
+                       history: Operation::MonthHistory.new)
+          super(context: context, month_label: month_label, first_day: first_day,
+                solar_terms: solar_terms)
+          @history = history
+          @operated_solar_terms = operated_solar_terms
+        end
+
+        # rubocop:enable Metrics/ParameterLists
+
+        #
+        # 書き換える
+        #
+        def rewrite
+          rewrite_month
+          rewrite_solar_terms
+          rewrite_first_day
+        end
+
+        #
+        # 月ごとの差分で書き換える
+        #
+        def rewrite_month
+          diff = history.diffs.month
+
+          @month_label = MonthLabel.new(
+            number: OperatedMonth.rewrite_month_fields(
+              month_diff: diff, month_label: month_label, name: 'number'
+            ),
+            is_many_days: OperatedMonth.rewrite_month_fields(
+              month_diff: diff, month_label: month_label, name: 'is_many_days'
+            ),
+            leaped: OperatedMonth.rewrite_month_fields(
+              month_diff: diff, month_label: month_label, name: 'leaped'
+            )
+          )
+        end
+
+        def self.rewrite_month_fields(month_diff:, month_label:, name:)
+          method_name = name.intern
+
+          diff = month_diff.send(method_name)
+          default = month_label.send(method_name)
+          return default if diff.invalid?
+
+          diff.actual
+        end
+
+        #
+        # 二十四節気ごとの差分で書き換える
+        #
+        def rewrite_solar_terms
+          matched, operated_solar_term = @operated_solar_terms.get(
+            western_date: first_day.western_date
+          )
+
+          return unless matched
+
+          @solar_terms = OperatedMonth.create_operated_solar_terms(
+            operated_solar_term: operated_solar_term,
+            solar_terms: solar_terms
+          )
+        end
+
+        #
+        # <Description>
+        #
+        # @param [<Type>] operated_solar_term <description>
+        # @param [Array<SolarTerm>] solar_terms 二十四節気
+        #
+        # @return [Array<SolarTerm>] 二十四節気
+        #
+        def self.create_operated_solar_terms(operated_solar_term:, solar_terms:)
+          index = operated_solar_term.index
+
+          # 別の月に移動する二十四節気。割り当てない。
+          result = remove_solar_term(index: index, solar_terms: solar_terms)
+
+          return result if used_solar_term?(index: index, solar_terms: solar_terms)
+
+          result.push(operated_solar_term)
+
+          result
+        end
+
+        # :reek:ControlParameter
+
+        #
+        # 二十四節気が使用されているか
+        #
+        # @param [Integer] index 二十四節気番号
+        # @param [Array<SolarTerm>] solar_terms 二十四節気
+        #
+        # @return [True] 使用
+        # @return [False] 未使用
+        #
+        def self.used_solar_term?(index:, solar_terms:)
+          solar_terms.each do |solar_term|
+            return true if index == solar_term.index
+          end
+
+          false
+        end
+
+        # :reek:ControlParameter
+
+        #
+        # 対象の二十四節気を除外する
+        #
+        # @param [Integer] index 二十四節気番号
+        # @param [Array<SolarTerm>] solar_terms 二十四節気
+        #
+        # @return [Array<SolarTerm>] 二十四節気（対象除外済）
+        #
+        def self.remove_solar_term(index:, solar_terms:)
+          result = []
+          solar_terms.each do |solar_term|
+            next if index == solar_term.index
+
+            result.push(solar_term)
+          end
+
+          result
+        end
+
+        #
+        # 月初日ごとの差分で書き換える
+        #
+        def rewrite_first_day
+          diffs = @history.diffs
+          return if diffs.invalid_days?
+
+          days = diffs.days
+
+          @first_day = FirstDay.new(
+            western_date: rewrite_western_date(days: days),
+            remainder: rewrite_remainder(days: days)
+          )
+        end
+
+        #
+        # 月初日の大余小余を日差分で書き換える
+        #
+        # @param [Integer] days 日差分
+        #
+        # @return [Remainder] 月初日の大余小余
+        #
+        def rewrite_remainder(days:)
+          remainder = first_day.remainder.clone
+          remainder.add!(
+            context.resolver.remainder.new(day: days, minute: 0, second: 0)
+          )
+
+          remainder
+        end
+
+        #
+        # 月初日の西暦日を日差分で書き換える
+        #
+        # @param [Integer] days 日差分
+        #
+        # @return [Western::Calendar] 月初日の西暦日
+        #
+        def rewrite_western_date(days:)
+          western_date = first_day.western_date.clone
+          western_date += days
+
+          western_date
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/range/full_range.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+require_relative '../../era/western'
+require_relative '../../output/logger'
+
+require_relative '../base/multi_gengou_roller'
+require_relative '../base/year'
+
+require_relative './transfer/year_boundary'
+require_relative './transfer/western_date_allocation'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Range
+      # :reek:TooManyInstanceVariables { max_instance_variables: 6 }
+
+      #
+      # FullRange 完全範囲
+      #   ある日からある日の範囲を計算可能な年月範囲
+      #   * 前提として元号年はその元号の開始年から数える
+      #   * ある日の元号年を求める場合、その元号が含まれる最初の年まで遡る
+      #   * 元号は一つとは限らない。南北朝などで二つある場合は、古い方の元号から求める
+      #
+      # NOTE: 割り当てた元号は年初を基準にした元号年である
+      #   * 元旦を基準にした時の正しい元号を設定している
+      #   * 引き当てたい日付が元旦ではない場合、その月日に従い元号を再度求める
+      #   * この再計算が必要になるのは、元号が切り替わる年のみである
+      #
+      class FullRange
+        # @return [Context] 暦コンテキスト
+        attr_reader :context
+        # @return [Western::Calendar] 開始日
+        attr_reader :start_date
+        # @return [Western::Calendar] 終了日
+        attr_reader :end_date
+        # @return [MultiGengouRoller] 改元処理
+        attr_reader :multi_gengou_roller
+        # @return [Western::Calendar] 最過去の元旦
+        attr_reader :new_year_date
+        # @return [Integer] 西暦年
+        attr_reader :western_year
+
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'full_range')
+
+        #
+        # 初期化
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Western::Calendar] start_date 開始日
+        # @param [Western::Calendar] end_date 終了日
+        #
+        def initialize(context:, start_date: Western::Calendar.new, end_date: Western::Calendar.new)
+          @start_date = start_date
+          @end_date = end_date
+          return if invalid?
+
+          @context = context
+          @multi_gengou_roller = Base::MultiGengouRoller.new(
+            start_date: start_date, end_date: end_date
+          )
+          @new_year_date = @multi_gengou_roller.oldest_date.clone
+          @western_year = @new_year_date.year
+        end
+
+        #
+        # 無効か
+        #
+        # @return [True] 無効
+        # @return [False] 有効
+        #
+        def invalid?
+          @start_date.invalid?
+        end
+
+        #
+        # 完全範囲を取得する
+        #
+        # @return [Array<Year>] 完全範囲
+        #
+        def get
+          return [] if invalid?
+
+          years = Transfer::YearBoundary.get(
+            context: @context, annual_ranges: annual_ranges
+          )
+          years = update_gengou(years: years)
+
+          Transfer::WesternDateAllocation.update_first_day(
+            context: @context, years: years
+          )
+
+          years
+        end
+
+        # :reek:TooManyStatements { max_statements: 7 }
+
+        #
+        # 完全範囲内の年データを取得する
+        #
+        # @return [Array<Year>] 年データ（冬至基準）
+        #
+        def annual_ranges
+          oldest_date = @new_year_date
+          newest_date = @multi_gengou_roller.newest_date
+          annual_range = context.resolver.annual_range
+
+          years = []
+          ((oldest_date.year)..(newest_date.year + 2)).each do |year|
+            years.push(
+              annual_range.get(
+                context: @context, western_year: year
+              )
+            )
+          end
+
+          years
+        end
+
+        # :reek:TooManyStatements { max_statements: 8 }
+
+        #
+        # 完全範囲内の年データの元号を開始年基準で更新する
+        #
+        # @param [Array<Year>] years 年データ（元旦基準）
+        #
+        # @return [Array<Year>] 元号更新済み年データ（元旦基準）
+        #
+        def update_gengou(years:)
+          updated_years = []
+
+          nearest_end_date = choise_nearest_end_date
+
+          years.each do |year|
+            next_year(years: updated_years, year: year)
+
+            if @new_year_date > nearest_end_date
+              @multi_gengou_roller.transfer
+              nearest_end_date = choise_nearest_end_date
+            end
+            @multi_gengou_roller.next_year
+          end
+
+          updated_years
+        end
+
+        private
+
+        #
+        # 元号処理対象の年を進める
+        #
+        # @param [Array<Year>] years 元号処理済み年データ（元旦基準）
+        # @param [Year] year 元号処理前の年（元旦基準）
+        #
+        def next_year(years:, year:)
+          updated_year = update_year(year: year)
+
+          years.push(updated_year)
+
+          next_new_year_date(total_days: updated_year.total_days)
+
+          nil
+        end
+
+        #
+        # 年の元号を更新する
+        #
+        # @param [Year] year 元号処理前の年（元旦基準）
+        #
+        # @return [Year] 元号処理済の年（元旦基準）
+        #
+        def update_year(year:)
+          multi_gengou = @multi_gengou_roller.multi_gengou.clone
+
+          updated_year = Base::Year.new(
+            multi_gengou: multi_gengou, new_year_date: @new_year_date.clone,
+            months: year.months
+          )
+          updated_year.commit
+
+          updated_year
+        end
+
+        #
+        # 次の年に進める
+        #
+        # @param [Integer] total_days 年の日数
+        #
+        def next_new_year_date(total_days:)
+          @new_year_date += total_days
+          @multi_gengou_roller.next(days: total_days)
+
+          nil
+        end
+
+        #
+        # 現在日からみて直近の未来に対する元号の切替前日を求める
+        #
+        # @return [Western::Calendar] 元号の切替前日
+        #
+        def choise_nearest_end_date
+          @multi_gengou_roller.choise_nearest_end_date
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/range/medieval_annual_range.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative '../../output/logger'
+require_relative '../monthly/initialized_month'
+require_relative '../monthly/month_label'
+require_relative '../monthly/first_day'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Range
+      #
+      # MedievalAnnualRange 年間範囲（中世）
+      #
+      # * 儀鳳暦 ～ 宣明暦 を便宜的に中世とした
+      # * 冬至から1年の開始を算出する
+      # * 二十四節気：平気法
+      # * 月の大小：定朔
+      #
+      module MedievalAnnualRange
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'medieval_annual_range')
+
+        #
+        # 一覧取得する
+        #
+        #   * 対象年に対して、前年11月-当年11月までを出力する
+        #   * 対象年（西暦）と計算年（元号x年）の紐付けは行わない
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Monthly::AbstractLunarPhase] lunar_phase 月の位相
+        # @param [Solar::AbstractAverage] solar_average 定気（太陽軌道平均）
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def self.get(context:, lunar_phase:, solar_average:)
+          annual_range = initialized_annual_range(context: context, lunar_phase: lunar_phase)
+
+          apply_big_and_small_of_the_month(annual_range: annual_range)
+
+          solar_average.set(annual_range: annual_range)
+
+          # 月間隔を取得するためだけの末尾要素を削除
+          annual_range.pop
+
+          initialize_month_label(annual_range: annual_range)
+        end
+
+        #
+        # 1年データを取得する
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Monthly::LunarPhase] lunar_phase 月の位相
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def self.initialized_annual_range(context:, lunar_phase:)
+          result = []
+
+          # 14ヶ月分を生成する（閏年で最大13ヶ月 + 末月の大小/二十四節気を求めるために必要な月）
+          (0..13).each do |_index|
+            adjusted = lunar_phase.next_month
+
+            result.push(
+              Monthly::InitializedMonth.new(
+                context: context,
+                month_label: Monthly::MonthLabel.new,
+                first_day: Monthly::FirstDay.new(remainder: adjusted),
+                phase_index: 0
+              )
+            )
+          end
+
+          result
+        end
+        private_class_method :initialized_annual_range
+
+        #
+        # 1年データの各月に月の大小を設定する
+        #
+        # @param [Array<Month>] annual_range 1年データ
+        #
+        def self.apply_big_and_small_of_the_month(annual_range:)
+          # NOTE: 最後の月は処理できない（=計算外の余分な月が最後に必要である）
+          annual_range.each_cons(2) do |(current_month, next_month)|
+            current_month.eval_many_days(next_month_day: next_month.remainder.day)
+          end
+        end
+        private_class_method :apply_big_and_small_of_the_month
+
+        #
+        # 月表示情報を更新する
+        #
+        # @param [Array<Month>] annual_range 1年データ
+        #
+        def self.initialize_month_label(annual_range:)
+          annual_range.each(&:rename_month_label_by_solar_term)
+        end
+        private_class_method :initialize_month_label
+      end
+    end
+  end
+end