zakuro 0.1.0 → 0.1.5

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/operated_range.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require_relative './operated_solar_terms'
+require_relative '../../operation/operation'
+require_relative '../../calculation/monthly/operated_month'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Range
+      #
+      # OperatedRange 運用結果範囲
+      #
+      # 何らかの理由により、計算された暦とは異なる運用結果である場合、その結果に合わせて計算結果を上書きする
+      class OperatedRange
+        # @return [Array<Year>] 年データ（完全範囲）
+        attr_reader :years
+        # @return [OperatedSolarTerms] 運用時二十四節気
+        attr_reader :operated_solar_terms
+        # @return [Context] 暦コンテキスト
+        attr_reader :context
+
+        #
+        # 初期化
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Array<Year>] years 年データ（完全範囲）
+        #
+        def initialize(context:, years: [])
+          @context = context
+          @years = years
+          @operated_solar_terms = OperatedSolarTerms.new(context: context, years: @years)
+          @operated_solar_terms.create
+        end
+
+        #
+        # 運用結果範囲を取得する
+        #
+        # @return [Array<Year>] 運用結果範囲
+        #
+        def get
+          rewrite
+        end
+
+        #
+        # 運用結果に書き換える
+        #
+        # @return [Array<Year>] 運用結果範囲
+        #
+        def rewrite
+          operated_years = []
+
+          years.each do |year|
+            operated_year = OperatedRange.rewrite_year(
+              context: context, year: year,
+              operated_solar_terms: @operated_solar_terms
+            )
+            operated_years.push(operated_year)
+          end
+
+          operated_years
+        end
+
+        #
+        # 年を書き換える
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Year] year 年
+        # @param [OperatedSolarTerms] operated_solar_terms 運用時二十四節気
+        #
+        # @return [Year] 年
+        #
+        def self.rewrite_year(context:, year:, operated_solar_terms:)
+          result = Base::Year.new(
+            multi_gengou: year.multi_gengou, new_year_date: year.new_year_date
+          )
+          year.months.each do |month|
+            result.push(month: resolve_month(
+              context: context, month: month,
+              operated_solar_terms: operated_solar_terms
+            ))
+          end
+
+          result.commit
+
+          result
+        end
+
+        #
+        # 履歴情報の有無に応じた月にする
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Month] month 月
+        # @param [OperatedSolarTerms] operated_solar_terms 運用時二十四節気
+        #
+        # @return [Month] 月
+        #
+        def self.resolve_month(context:, month:, operated_solar_terms:)
+          history = Operation.specify_history(western_date: month.western_date)
+
+          return month if history.invalid?
+
+          OperatedRange.rewrite_month(
+            context: context, month: month, history: history,
+            operated_solar_terms: operated_solar_terms
+          )
+        end
+
+        # :reek:LongParameterList {max_params: 4}
+
+        #
+        # 月を運用結果に書き換える
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Month] month 月
+        # @param [Operation::MonthHistory] history 変更履歴
+        # @param [OperatedSolarTerms] operated_solar_terms 運用時二十四節気
+        #
+        # @return [Month] 月（運用結果）
+        #
+        def self.rewrite_month(context:, month:, history:, operated_solar_terms:)
+          return month unless month.western_date == history.western_date
+
+          operated_month = Monthly::OperatedMonth.new(
+            context: context,
+            month_label: month.month_label, first_day: month.first_day,
+            solar_terms: month.solar_terms, history: history,
+            operated_solar_terms: operated_solar_terms
+          )
+
+          operated_month.rewrite
+
+          Monthly::Month.new(
+            context: context,
+            month_label: operated_month.month_label, first_day: operated_month.first_day,
+            solar_terms: operated_month.solar_terms
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require_relative '../../operation/operation'
+require_relative '../monthly/month'
+
+# TODO: solar_termの中はsrc/destだが、yamlはcalc/actual。統一したい。
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Range
+      #
+      # OperatedSolarTerm 運用時二十四節気
+      #
+      class OperatedSolarTerms
+        # @return [Array<Year>] 完全範囲（年データ）
+        attr_reader :years
+        # @return [Hash<String, SolarTerm>] 二十四節気の移動元/移動先（西暦日 -> 対応する二十四節気）
+        #
+        # * 移動元の二十四節気：無効な大余小余あり（削除対象）
+        # * 移動先の二十四節気：移動元からの二十四節気（追加対象）
+        #
+        attr_reader :directions
+        # @return [Context] 暦コンテキスト
+        attr_reader :context
+
+        #
+        # 初期化
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Array<Year>] years 完全範囲（年データ）
+        #
+        def initialize(context:, years: [])
+          @context = context
+          @years = years
+          @directions = {}
+        end
+
+        #
+        # データ生成する
+        #
+        # @return [<Type>] <description>
+        #
+        def create
+          @directions = create_directions
+        end
+
+        #
+        # 二十四節気を取得する
+        #
+        # @param [Western::Calendar] western_date 月初日の西暦日
+        #
+        # @return [True] 対象あり
+        # @return [False] 対象なし
+        # @return [SolarTerm] 二十四節気
+        #
+        def get(western_date: Western::Calendar.new)
+          solar_term_class = context.resolver.solar_term
+          solar_term = @directions.fetch(western_date.format, solar_term_class.new)
+
+          # 合致しない場合
+          return false, solar_term_class.new if solar_term.empty?
+
+          # 合致した上で、二十四節気が移動元（削除対象）の場合
+          # 合致した上で、二十四節気が移動先（追加対象）の場合
+          [true, solar_term]
+        end
+
+        #
+        # 二十四節気の移動元/移動先を生成する
+        #
+        # @return [Hash<String, SolarTerm>] 二十四節気の移動元/移動先（西暦日 -> 対応する二十四節気）
+        #
+        def create_directions
+          directions = {}
+
+          years.each do |year|
+            OperatedSolarTerms.create_directions_with_months(
+              context: context, directions: directions, months: year.months
+            )
+          end
+
+          directions
+        end
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 年内の全ての月の移動方向を作成する
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Hash<String, SolarTerm>] directions 二十四節気の移動元/移動先（西暦日 -> 対応する二十四節気）
+        # @param [Array<Month>] months 年内の全ての月
+        #
+        def self.create_directions_with_months(context:, directions: {}, months: [])
+          months.each do |month|
+            history = Operation.specify_history(western_date: month.western_date)
+
+            next if history.invalid?
+
+            direction = history.diffs.solar_term
+
+            next if direction.invalid?
+
+            OperatedSolarTerms.create_directions_each_month(
+              context: context, directions: directions, direction: direction, month: month
+            )
+          end
+        end
+
+        # :reek:LongParameterList {max_params: 4}
+
+        #
+        # 月毎の移動方向を作成する
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Month] 月
+        # @param [Hash<String, SolarTerm>] directions 二十四節気の移動元/移動先（西暦日 -> 対応する二十四節気）
+        # @param [Operation::SolarTerm::Diretion] 二十四節気（移動）
+        #
+        def self.create_directions_each_month(context:, month:, directions: {},
+                                              direction: Operation::SolarTerm::Diretion.new)
+
+          month.solar_terms.each do |solar_term|
+            OperatedSolarTerms.push_source(context: context, directions: directions,
+                                           direction: direction, solar_term: solar_term)
+          end
+          OperatedSolarTerms.push_destination(context: context, directions: directions,
+                                              destination: direction.destination)
+        end
+
+        # :reek:LongParameterList {max_params: 4}
+
+        #
+        # 移動先に有効な二十四節気（差し替える二十四節気）を指定する
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [SolarTerm] solar_term 二十四節気（計算値）
+        # @param [Hash<String, SolarTerm>] directions 二十四節気の移動元/移動先（西暦日 -> 対応する二十四節気）
+        # @param [Operation::SolarTerm::Direction] source 二十四節気（移動）
+        #
+        def self.push_source(context:, solar_term:, directions: {},
+                             direction: Operation::SolarTerm::Direction.new)
+          source = direction.source
+
+          return if source.invalid?
+
+          return unless source.index == solar_term.index
+
+          # 移動先に移動元の二十四節気を指定する
+          directions[source.to.format] = OperatedSolarTerms.created_source(
+            context: context, direction: direction, solar_term: solar_term
+          )
+        end
+
+        #
+        # 移動先に有効な二十四節気（差し替える二十四節気）を生成する
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [SolarTerm] solar_term 二十四節気（計算値）
+        # @param [Operation::SolarTerm::Direction] source 二十四節気（移動）
+        #
+        # @return [SolarTerm] 二十四節気（運用値）
+        #
+        def self.created_source(context:, solar_term:,
+                                direction: Operation::SolarTerm::Direction.new)
+          operated_solar_term = solar_term.clone
+          remainder_class_name = context.resolver.remainder
+
+          unless direction.invalid_days?
+            # 二十四節気の大余をずらす
+            operated_solar_term.remainder.add!(
+              remainder_class_name.new(day: direction.days, minute: 0, second: 0)
+            )
+          end
+
+          operated_solar_term
+        end
+
+        #
+        # 移動元に無効な二十四節気（連番のみ指定）を指定する
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Hash<String, SolarTerm>] directions 二十四節気の移動元/移動先（西暦日 -> 対応する二十四節気）
+        # @param [Operation::SolarTerm::Destination] destination 二十四節気（移動先）
+        #
+        def self.push_destination(context:, directions: {},
+                                  destination: Operation::SolarTerm::Destination.new)
+          return if destination.invalid?
+
+          solar_term_class = context.resolver.solar_term
+          directions[destination.from.format] = solar_term_class.new(
+            index: destination.index
+          )
+        end
+      end
+    end
+  end
+end