zakuro 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5bbb00f73830eff0f9e912c0fa0c10d49d7849b3f46395c19de8ec1f71f8012
-  data.tar.gz: e95b80813e7ce382e0c5fce6a62382d3c26383db6f0b7e64e82bd1f005a6f15c
+  metadata.gz: a4269bda9e7a1bc90589d072ac97a0acc089f098a5b1e8bbe6d04d661407c256
+  data.tar.gz: cb8821e9f1f9692a867c4baec73ce515281d3bf4ef8a04db676909d03cd3b7b0
 SHA512:
-  metadata.gz: a3bb973f87a0bb6e3d3caffca76e9cc57cf5748e16bb3e9f87b3e9ffe2307682646aa08077ad6685a04ec282d255aa0f3ecf5992d2595f89bcd00b364aa22f45
-  data.tar.gz: f85ca93529ec87eb15e97f2564509429b95d8433c22d3141bdef26fa79154689030d9552ca38e8e81812289d5adf272b8445e510a21967cd9b517c805e6956a5
+  metadata.gz: f4acc077c7191f18601765cc81668660f4fe0af9dbeecf0af74cf0841f20546a0792484bbcc9bf8c490f62065ef8b32c9268def780037ec62739665823950d47
+  data.tar.gz: 97ea77400bd644d2c84e08e4d3056ee121563e5d52e1b418dfb57e50cbf5c741f4dde1954d4951460618b5c5837bc13103f8ae7857075b159a307986e2fb39af

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

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require_relative '../../output/logger'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Monthly
+      #
+      # AbstractLunarPhase 月の位相
+      #
+      class AbstractLunarPhase
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'lunar_phase')
+
+        # @return [Array<String>] 月内の弦
+        PHASE_INDEXES = %w[朔日 上弦 望月 下弦].freeze
+
+        # @return [Cycle::AbstractRemainder] 経
+        attr_reader :average_remainder
+        # @return [Solar::AbstractLocation] 入定気
+        attr_reader :solar_location
+        # @return [Lunar::AbstractLocation] 入暦
+        attr_reader :lunar_location
+        # @return [Integer] 弦の位置
+        attr_reader :index
+
+        #
+        # 初期化
+        #
+        # @param [Cycle::AbstractRemainder] quater 弦
+        # @param [Solar::AbstractLocation] average_remainder 経
+        # @param [Solar::AbstractLocation] solar_location 入定気
+        # @param [Lunar::AbstractLocation] lunar_location 入暦
+        #
+        def initialize(quater:, average_remainder:, solar_location:, lunar_location:)
+          # 弦
+          @quarter = quater
+          # 経
+          @average_remainder = average_remainder
+          # 入定気
+          @solar_location = solar_location
+          # 入暦
+          @lunar_location = lunar_location
+
+          # 弦の位置
+          @index = 0
+        end
+
+        #
+        # 次の弦に進める
+        #
+        # @return [Remainder] 定朔
+        #
+        def next_phase
+          adjusted = current_remainder
+
+          add_quarter_moon_size
+
+          adjusted
+        end
+
+        #
+        # 次の月に進める
+        # @note 進めた後の月の定朔ではなく、当月のものを返却する
+        #
+        # @return [Remainder] 当月初の定朔
+        #
+        def next_month
+          result = nil
+          PHASE_INDEXES.each_with_index do |_phase, index|
+            adjust = next_phase
+            result = adjust if index.zero?
+          end
+
+          result
+        end
+
+        private
+
+        #
+        # 次の弦に進める
+        #
+        # @return [Integer] 弦
+        #
+        def next_index
+          @index += 1
+          @index = 0 if @index >= PHASE_INDEXES.size
+          @index
+        end
+
+        #
+        # 朔月（月初）であるか
+        #
+        # @return [True] 朔月である
+        # @return [False] 朔月ではない
+        #
+        def first_phase?
+          @index.zero?
+        end
+
+        #
+        # 朔月のみログ出力する
+        #
+        # @param [String] messages メッセージ（可変長）
+        #
+        def debug(*messages)
+          # 全ての弦を対象にするためコメントアウトする
+          # return unless first_phase?
+
+          LOGGER.debug(*messages)
+        end
+
+        #
+        # 現在の定朔を取得する
+        #
+        # @return [Remainder] 定朔
+        #
+        def current_remainder
+          # abstract
+        end
+
+        #
+        # 補正値を得る
+        #
+        # @return [Integer] 補正値
+        #
+        def correction_value
+          sun = correction_solar_value
+          moon = correction_moon_value
+
+          sum = sun + moon
+
+          debug("sun: #{sun}", "moon: #{moon}", "sun + moon : #{sum}")
+
+          sum
+        end
+
+        #
+        # 太陽運動の補正値を得る
+        #
+        # @return [Integer] 太陽運動の補正値
+        #
+        def correction_solar_value
+          # abstract
+        end
+
+        #
+        # 月運動の補正値を得る
+        #
+        # @return [Integer] 月運動の補正値
+        #
+        def correction_moon_value
+          # abstract
+        end
+
+        def add_quarter_moon_size
+          @average_remainder.add!(@quarter)
+          @solar_location.add_quarter
+          @lunar_location.add_quarter
+
+          next_index
+        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

data/lib/zakuro/calculation/stella/lunar/abstract_location.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative '../../cycle/abstract_remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Lunar
+      #
+      # AbstractLocation 入暦
+      #
+      class AbstractLocation
+        # @return [True] 計算済み（前回計算あり）
+        # @return [False] 未計算（初回計算）
+        attr_reader :calculated
+        # @return [Integer] 西暦年
+        attr_reader :western_year
+        # @return [Cycle::LunarRemainder] 大余小余（初回：昨年天正閏余）
+        attr_reader :remainder
+
+        #
+        # 初期化
+        #
+        # @param [Cycle::LunarRemainder] lunar_age 天正閏余（大余小余）
+        # @param [Integer] western_year 西暦年
+        #
+        def initialize(lunar_age:, western_year:)
+          @calculated = false
+          @western_year = western_year
+          @remainder = lunar_age
+        end
+
+        #
+        # 入暦を計算する
+        #
+        def run
+          # abstract
+        end
+
+        #
+        # 弦の分だけ月地点を進める
+        #
+        def add_quarter
+          # abstract
+        end
+
+        private
+
+        #
+        # 初回計算
+        #
+        def first
+          # abstract
+        end
+
+        #
+        # 大余小余に合わせて減算する（折り返す）
+        #
+        # @param [Cycle::LunarRemainder] limit 上限
+        #
+        def decrease(limit:)
+          # abstract
+        end
+
+        #
+        # 1始まりにする
+        #
+        def one_based
+          @remainder.add!(Cycle::AbstractRemainder.new(day: 1, minute: 0, second: 0))
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/stella/lunar/choukei_value.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../type/old_float'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Lunar
+      #
+      # ChoukeiValue 再考長慶宣明暦算法
+      #
+      module ChoukeiValue
+        #
+        # 四捨五入した大余を返す
+        #
+        # @param [Integer] per 増減率
+        # @param [Integer] denominator 小余の分母
+        # @param [Integer] minute 小余
+        #
+        # @return [Integer] 累計値（大余）
+        #
+        def self.rounded_day(per:, denominator:, minute:)
+          remainder_minute = Type::OldFloat.new((per * minute).to_f)
+          day = day_only(remainder_minute: remainder_minute.get, denominator: denominator)
+          # 繰り上げ結果を足す
+          day += carried_minute(remainder_minute: remainder_minute, denominator: denominator)
+
+          day
+        end
+
+        def self.day_only(remainder_minute:, denominator:)
+          float_day = Type::OldFloat.new(remainder_minute / denominator)
+          # 切り捨て（プラスマイナスに関わらず小数点以下切り捨て）
+          float_day.floor!
+          float_day.get
+        end
+        private_class_method :day_only
+
+        def self.carried_minute(remainder_minute:, denominator:)
+          remainder_day = remainder_minute.abs % denominator
+          # 四捨五入（1/2日 以上なら繰り上げる）
+          return remainder_minute.sign if remainder_day >= (denominator / 2)
+
+          0
+        end
+        private_class_method :carried_minute
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/stella/solar/abstract_average.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Solar
+      #
+      # AbstractAverage 平気（太陽軌道平均）
+      #
+      class AbstractAverage
+        #
+        # 初期化
+        #
+        # @param [Cycle::AbstractSolarTerm] solar_term 入定気
+        #
+        def initialize(solar_term:)
+          @solar_term = solar_term
+        end
+
+        #
+        # 冬至から数えた1年データの月ごとに二十四節気を割り当てる
+        #
+        # @param [Array<Month>] annual_range 1年データ
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def set(annual_range:)
+          # 次月と比較しながら当月の二十四節気を決める
+          # NOTE: 最後の月は処理できない（=計算外の余分な月が最後に必要である）
+          annual_range.each_cons(2) do |(current_month, next_month)|
+            set_solar_term(
+              current_month: current_month,
+              next_month: next_month
+            )
+          end
+
+          annual_range
+        end
+
+        # :reek:TooManyStatements { max_statements: 7 }
+
+        #
+        # 月内（当月朔日から当月末日（来月朔日の前日）の間）に二十四節気があるか
+        # @note 大余60で一巡するため 以下2パターンがある
+        #   * current_month <= next_month : (二十四節気) >= current_month && (二十四節気) < next_month
+        #   * current_month > next_month  : (二十四節気) >= current_month || (二十四節気) < next_month
+        #
+        # @param [Cycle::AbstractRemainder] solar_term 二十四節気
+        # @param [Cycle::AbstractRemainder] current_month 月初
+        # @param [Cycle::AbstractRemainder] next_month 月末
+        #
+        # @return [True] 対象の二十四節気がある
+        # @return [False] 対象の二十四節気がない
+        #
+        def self.in_solar_term?(solar_term:, current_month:, next_month:)
+          # 大余で比較する
+          target_time = solar_term.day
+          current_month_time = current_month.day
+          next_month_time = next_month.day
+          current_month_over = (target_time >= current_month_time)
+          next_month_under = (target_time < next_month_time)
+
+          return current_month_over && next_month_under if current_month_time <= next_month_time
+
+          current_month_over || next_month_under
+        end
+
+        private
+
+        # :reek:TooManyStatements { max_statements: 8 }
+
+        #
+        # 二十四節気を設定する
+        #
+        # @param [Month] current_month 当月
+        # @param [Month] next_month 次月
+        #
+        def set_solar_term(current_month:, next_month:)
+          # 安全策として無限ループは回避する
+          # * 最大試行回数：4回（設定なし => 設定あり => 設定あり => 設定なし）
+          # * 閏月は1回しか設定しない
+          # * 最大2回設定する（中気・節気）
+          (0..3).each do |_index|
+            in_range = AbstractAverage.in_solar_term?(
+              solar_term: @solar_term.remainder, current_month: current_month.remainder,
+              next_month: next_month.remainder
+            )
+
+            # 範囲外
+            unless in_range
+              # 1つ以上設定されていれば切り上げる（一つ飛ばしで二十四節気を設定することはない）
+              break unless current_month.empty_solar_term?
+
+              next_solar_term
+              next
+            end
+
+            current_month.add_term(term: @solar_term.clone)
+            next_solar_term
+
+            # 定気は最大2つまで
+            break if current_month.solar_term_size == 2
+          end
+        end
+
+        #
+        # 次の二十四節気に移る
+        #
+        def next_solar_term
+          @solar_term.next_term!
+        end
+      end
+    end
+  end
+end