zakuro 0.0.0

data/lib/zakuro/version/senmyou/monthly/lunar_phase.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require_relative '../../../output/logger'
+
+require_relative '../stella/winter_solstice'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    # :reek:TooManyStatements { max_statements: 7 }
+    # :reek:TooManyInstanceVariables { max_instance_variables: 7 }
+
+    #
+    # LunarPhase 月の位相
+    #
+    class LunarPhase
+      #
+      # QuarterMoon 弦
+      #
+      module QuarterMoon
+        # @return [Remainder] 弦（1分=8秒）
+        DEFAULT = Remainder.new(day: 7, minute: 3214, second: 2)
+        # @return [Remainder] 弦（1分=100秒）
+        BASE_HUNDRED = LunarRemainder.new(day: 7, minute: 3214, second: 25)
+      end
+
+      # @return [Logger] ロガー
+      LOGGER = Logger.new(location: 'lunar_phase')
+
+      # @return [Array<String>] 月内の弦
+      PHASE_INDEXES = %w[朔日 上弦 望月 下弦].freeze
+
+      # @return [Integer] 西暦年
+      attr_reader :western_year
+      # @return [Remainder]] 経
+      attr_reader :average_remainder
+      # @return [True] 初回計算
+      # @return [False] 次回以降計算
+      attr_reader :first
+      # @return [SolarTerm] 二十四節気（入定気）
+      attr_reader :solar_term
+      # @return [Remainder] 入暦
+      attr_reader :moon_remainder
+      # @return [True] 進（遠地点より数える）
+      # @return [False] 退（近地点より数える）
+      attr_reader :is_forward
+      # @return [Integer] 弦
+      attr_reader :phase_index
+
+      #
+      # 初期化
+      #
+      # @param [Integer] western_year 西暦年
+      #
+      def initialize(western_year:)
+        @western_year = western_year
+        # 経
+        @average_remainder = WinterSolstice.calc_averaged_last_november_1st(
+          western_year: @western_year
+        )
+        # 天正冬至
+        winter_solstice_age = \
+          WinterSolstice.calc_moon_age(western_year: @western_year)
+        # 入定気
+        @solar_term = SolarTerm.new(remainder: winter_solstice_age)
+        # 入暦
+        @moon_remainder = LunarRemainder.new(total: 0).add!(winter_solstice_age)
+
+        @is_forward = false
+        @first = true
+
+        # 弦
+        @phase_index = 0
+      end
+
+      #
+      # 次の弦に進める
+      #
+      # @return [Remainder] 定朔
+      #
+      def next_phase
+        adjusted = current_remainder
+
+        @first = false if @first
+
+        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_phase_index
+        @phase_index += 1
+        @phase_index = 0 if @phase_index >= PHASE_INDEXES.size
+        @phase_index
+      end
+
+      #
+      # 朔月（月初）かを確認する
+      #
+      # @return [True] 朔月である
+      # @return [False] 朔月ではない
+      #
+      def first_phase?
+        @phase_index.zero?
+      end
+
+      #
+      # 朔月のみログ出力する
+      #
+      # @param [String] messages メッセージ（可変長）
+      #
+      def debug(*messages)
+        return unless first_phase?
+
+        LOGGER.debug(*messages)
+      end
+
+      #
+      # 現在の定朔を取得する
+      #
+      # @return [Remainder] 定朔
+      #
+      def current_remainder
+        debug('@average_remainder.format:' + @average_remainder.format)
+
+        sum = correction_value
+        adjusted = @average_remainder.add(
+          Remainder.new(day: 0, minute: sum, second: 0)
+        )
+        adjusted.up_on_new_moon!
+
+        debug("result: #{adjusted.format}")
+
+        adjusted
+      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
+        @solar_term = SolarOrbit.calc_solar_term_by_remainder(
+          solar_term: @solar_term
+        )
+        debug("@solar_term.remainder: #{@solar_term.remainder.format(form: '%d-%d.%d')}")
+        debug("@solar_term.index: #{@solar_term.index}")
+
+        SolarOrbit.calc_sun_orbit_value(solar_term: @solar_term)
+      end
+
+      #
+      # 月運動の補正値を得る
+      #
+      # @return [Integer] 月運動の補正値
+      #
+      def correction_moon_value
+        @moon_remainder, @is_forward = \
+          LunarOrbit.calc_moon_point(remainder: @moon_remainder,
+                                     western_year: @western_year,
+                                     is_forward: @is_forward,
+                                     first: @first)
+
+        debug("@moon_remainder.format: #{@moon_remainder.format}")
+        debug("@is_forward: #{@is_forward}")
+
+        LunarOrbit.calc_moon_orbit_value(remainder_month: @moon_remainder,
+                                         is_forward: @is_forward)
+      end
+
+      def add_quarter_moon_size
+        @average_remainder.add!(QuarterMoon::DEFAULT)
+        @solar_term.remainder.add!(QuarterMoon::DEFAULT)
+        @moon_remainder.add!(QuarterMoon::BASE_HUNDRED)
+
+        next_phase_index
+      end
+    end
+  end
+end

data/lib/zakuro/version/senmyou/monthly/month.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    #
+    # Month 月情報
+    #
+    class Month
+      # @return [True] 昨年の月
+      # @return [False] 今年の月
+      # @note 冬至基準で1年データを作成するため昨年の11月-12月である可能性がある
+      attr_accessor :is_last_year
+      # @return [True] 大の月（30日）
+      # @return [False] 小の月（29日）
+      attr_accessor :is_many_days
+      # @return [Integer] 月（xx月のxx）
+      attr_accessor :number
+      # @return [True] 閏月
+      # @return [False] 平月
+      attr_accessor :leaped
+      # @return [SolarTerm] 二十四節気（中気）
+      attr_accessor :even_term
+      # @return [SolarTerm] 二十四節気（節気）
+      attr_accessor :odd_term
+      # @return [Remainder] 月初日の大余小余
+      attr_reader :remainder
+      # @return [String] 月齢（朔月、上弦、望月、下弦）
+      attr_reader :phase_index
+
+      # rubocop:disable Metrics/ParameterLists
+      # :reek:BooleanParametere
+
+      #
+      # 初期化
+      #
+      # @param [True, False] is_last_year 昨年の月/今年の月
+      # @param [Integer] number 月（xx月のxx）
+      # @param [True, False] is_many_days 大の月（30日）/小の月（29日）
+      # @param [True, False] leaped 閏月/平月
+      # @param [Remainder] remainder 月初日の大余小余
+      # @param [String] phase_index 月齢（朔月、上弦、望月、下弦）
+      # @param [SolarTerm] even_term 二十四節気（中気）
+      # @param [SolarTerm] odd_term 二十四節気（節気）
+      #
+      def initialize(is_last_year: -1, number: -1, is_many_days: false,
+                     leaped: false, remainder: Remainder.new, phase_index: -1,
+                     even_term: SolarTerm.new, odd_term: SolarTerm.new)
+        # 年
+        @is_last_year = is_last_year
+        # 月の大小
+        @is_many_days = is_many_days
+        # 月
+        @number = number
+        # 閏
+        @leaped = leaped
+        # 日
+        @remainder = remainder
+        # 月齢（朔月、上弦、望月、下弦）
+        @phase_index = phase_index
+        # 中気（二十四節気）
+        @even_term = even_term
+        # 節気（二十四節気）
+        @odd_term = odd_term
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      #
+      # 月の日数を返す
+      #
+      # @return [Integer] 日数
+      #
+      def days
+        @is_many_days ? 30 : 29
+      end
+
+      #
+      # 月の名前（大小）を返す
+      #
+      # @return [String] 月の名前（大小）
+      #
+      def days_name
+        @is_many_days ? '大' : '小'
+      end
+
+      #
+      # 同一の月情報かを検証する
+      #
+      # @param [Month] other 他の月情報
+      #
+      # @return [True] 同一の月
+      # @return [False] 異なる月
+      #
+      def same?(other:)
+        @number == other.number && @leaped == other.leaped
+      end
+
+      #
+      # 文字化する
+      #
+      # @return [String] 文字
+      #
+      def to_s
+        "is_last_year: #{@is_last_year}, number: #{@number}, leaped: #{@leaped}, " \
+          "remainder: #{@remainder.format}, phase_index: #{@phase_index}, " \
+          "even_term: #{@even_term.remainder.format}: #{@even_term.index}, " \
+          "odd_term: #{@odd_term.remainder.format}: #{@odd_term.index}"
+      end
+    end
+  end
+end

data/lib/zakuro/version/senmyou/senmyou.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'date'
+require_relative '../abstract_version'
+require_relative '../../era/western'
+require_relative 'summary/gengou_data'
+
+# :nodoc:
+module Zakuro
+  #
+  # Senmyou 宣明暦
+  #
+  module Senmyou
+    #
+    # Gateway アクセサメソッド群
+    #
+    class Gateway < AbstractVersion
+      # @return [True] リリースあり
+      RELEASE = true
+
+      #
+      # 西暦日から和暦日に変換する
+      #
+      # @param [Date] western_date 西暦日
+      #
+      # @return [Result::SingleDay] 和暦日
+      #
+      def self.to_japan_date(western_date:)
+        date = Western::Calendar.create(date: western_date)
+        GengouData.get_ancient_date(date: date)
+      end
+    end
+  end
+end

data/lib/zakuro/version/senmyou/stella/lunar_orbit.rb

@@ -0,0 +1,332 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    #
+    # LunarOrbit 月軌道
+    #
+    module LunarOrbit
+      # @return [Integer] 暦周（1近日点）
+      ANOMALISTIC_MONTH = 231_458.19
+      # @return [Integer] 暦中日
+      # @note ANOMALISTIC_MONTH の半分に相当する
+      HALF_ANOMALISTIC_MONTH = \
+        LunarRemainder.new(day: 13, minute: 6529, second: 9.5)
+
+      #
+      # Adjustment 補正値情報
+      #
+      module Adjustment
+        #
+        # Item 補正値
+        #
+        class Item
+          # @return [Integer] 損益率
+          attr_reader :per
+          # @return [Integer] 眺朒（ちょうじく）積
+          attr_reader :stack
+
+          #
+          # 初期化
+          #
+          # @param [Integer] per 損益率
+          # @param [Integer] stack 眺朒（ちょうじく）積
+          #
+          def initialize(per:, stack:)
+            @per = per
+            @stack = stack
+          end
+
+          #
+          # 文字化
+          #
+          # @return [String] 文字
+          #
+          def to_s
+            "per:#{@per}, stack:#{@stack}"
+          end
+        end
+
+        # @return [Array<Item>] 月の補正値
+        # @note キーは複合キーであり、以下のパターンに対応する
+        #   * 進退
+        #     * forward: 進（遠地点より数える）
+        #     * back: 退（近地点より数える）
+        #  * 入暦（1-14）
+        #  * 小余（0-8400）
+        LIST = {
+          forward_01_0000_8400: Item.new(per: +830, stack: 0),
+          forward_02_0000_8400: Item.new(per: +726, stack: +830),
+          forward_03_0000_8400: Item.new(per: +606, stack: +1556),
+          forward_04_0000_8400: Item.new(per: +471, stack: +2162),
+          forward_05_0000_8400: Item.new(per: +337, stack: +2633),
+          forward_06_0000_8400: Item.new(per: +202, stack: +2970),
+          forward_07_0000_7465: Item.new(per: +53, stack: +3172),
+          forward_07_7465_8400: Item.new(per: -7, stack: +3225),  # +3172 + 53（初益）
+          forward_08_0000_8400: Item.new(per: -82, stack: +3218),
+          forward_09_0000_8400: Item.new(per: -224, stack: +3136),
+          forward_10_0000_8400: Item.new(per: -366, stack: +2912),
+          forward_11_0000_8400: Item.new(per: -509, stack: +2546),
+          forward_12_0000_8400: Item.new(per: -643, stack: +2037),
+          forward_13_0000_8400: Item.new(per: -748, stack: +1394),
+          forward_14_0000_6529: Item.new(per: -646, stack: +646), # 14日の小余は常に6529以下
+          back_01_0000_8400: Item.new(per: -830, stack: 0),
+          back_02_0000_8400: Item.new(per: -726, stack: -830),
+          back_03_0000_8400: Item.new(per: -598, stack: -1556),
+          back_04_0000_8400: Item.new(per: -464, stack: -2154),
+          back_05_0000_8400: Item.new(per: -329, stack: -2618),
+          back_06_0000_8400: Item.new(per: -195, stack: -2947),
+          back_07_0000_7465: Item.new(per: -53, stack: -3142),
+          back_07_7465_8400: Item.new(per: +7, stack: -3195), # -3142 - 53（初益）
+          back_08_0000_8400: Item.new(per: +82, stack: -3188),
+          back_09_0000_8400: Item.new(per: +225, stack: -3106),
+          back_10_0000_8400: Item.new(per: +366, stack: -2881),
+          back_11_0000_8400: Item.new(per: +501, stack: -2515),
+          back_12_0000_8400: Item.new(per: +628, stack: -2014),
+          back_13_0000_8400: Item.new(per: +740, stack: -1386),
+          back_14_0000_6529: Item.new(per: +646, stack: -646) # 14日の小余は常に6529以下
+        }.freeze
+      end
+
+      #
+      # 月の運行による補正値を算出する
+      #
+      # @param [Remainder] remainder_month 月の大余小余
+      # @param [True, False] is_forward 進（遠地点より数える）/退（近地点より数える）
+      #
+      # @return [Integer] 補正値
+      #
+      def self.calc_moon_orbit_value(remainder_month:, is_forward:)
+        valid?(remainder: remainder_month)
+
+        day, minute = make_calculable_remainder_value(remainder: remainder_month)
+
+        # 引き当て
+        adjustment, diff, minute = specify_moon_adjustment(
+          is_forward: is_forward, day: day, minute: minute
+        )
+        day = make_cumulative_value_for_days(per: adjustment.per,
+                                             denominator: diff, minute: minute)
+
+        adjustment.stack + day
+      end
+
+      #
+      # 大余小余を検証する
+      #
+      # @param [Remainder] remainder 大余小余
+      #
+      # @return [True] 正しい（月の位相計算に使う大余小余）
+      # @return [True] 正しくない
+      #
+      def self.valid?(remainder:)
+        return if remainder.is_a?(LunarRemainder)
+
+        raise ArgumentError, "unmatch parameter type: #{remainder.class}"
+      end
+      private_class_method :valid?
+
+      #
+      # 大余小余を計算可能な値にする
+      # @note 大余の秒（second）は使わない
+      #
+      # @param [LunarRemainder] remainder 大余小余
+      #
+      # @return [Integer] 大余
+      # @return [Integer] 小余
+      #
+      def self.make_calculable_remainder_value(remainder:)
+        day = remainder.day
+        minute = remainder.minute + (remainder.second / 100)
+        minute = minute.floor
+
+        [day, minute]
+      end
+      private_class_method :make_calculable_remainder_value
+
+      # :reek:TooManyStatements { max_statements: 9 }
+
+      #
+      # 累計値（大余）を作成する
+      #
+      # @param [Integer] per 入暦（1-14）
+      # @param [Integer] denominator 小余の分母
+      # @param [Integer] minute 小余
+      #
+      # @return [Integer] 累計値（大余）
+      #
+      def self.make_cumulative_value_for_days(per:, denominator:, minute:)
+        remainder_minute = (per * minute).to_f
+        day = remainder_minute / denominator
+        # 切り捨て（プラスマイナスに関わらず小数点以下切り捨て）
+        day = day.negative? ? day.ceil : day.floor
+        sign = remainder_minute.negative? ? -1 : 1
+        remainder_day = (sign * remainder_minute) % denominator
+        # 四捨五入（8400ならその半分の4200以上を繰り上げる）
+        day += sign if remainder_day >= (denominator / 2)
+
+        day
+      end
+      private_class_method :make_cumulative_value_for_days
+
+      # :reek:TooManyStatements { max_statements: 9 }
+
+      #
+      # 月軌道の補正に必要な基本値を引き当てる
+      #
+      # @note 戻り値は calc_moon_orbit_value で使用する
+      #
+      # @param [True, False] is_forward 進（遠地点より数える）/退（近地点より数える）
+      # @param [Integer] day 大余
+      # @param [Integer] minute 小余
+      #
+      # @return [Adjustment::Item] 補正値
+      # @return [Integer] （小余を処理する時の）分母
+      # @return [Integer] 小余の下げ幅
+      #
+      def self.specify_moon_adjustment(is_forward:, day:, minute:)
+        prefix = { true => 'forward', false => 'back' }[is_forward]
+
+        targets = Adjustment::LIST.select \
+          { |key, _| key.match(/^#{prefix}_#{format('%<day>02d', day: day)}_.*/) }
+
+        targets.each do |key, value|
+          # NOTE 境界値は上から順に引き当てた方を返す（7日の境界値7465は上のキーで返す）
+          matched, diff = \
+            extract_data_from_moon_adjustment_key(key, minute)
+          # 小余の下げ幅
+          calc_minute = (day == 7 && minute > 7465 ? minute - 7465 : minute)
+          return value, diff, calc_minute if matched
+        end
+
+        [nil, nil, nil]
+      end
+      private_class_method :specify_moon_adjustment
+
+      #
+      # 補正値を引き当てる
+      #
+      # @param [String] key 補正値のキー
+      # @param [Integer] minute 小余
+      #
+      # @return [Adjustment::Item] 補正値
+      # @return [Integer] （小余を処理する時の）分母
+      #
+      def self.extract_data_from_moon_adjustment_key(key, minute)
+        matched = key.match(/([0-9]{4})_([0-9]{4})$/)
+        start = matched[1].to_i
+        finish = matched[2].to_i
+
+        matched = minute >= start && minute <= finish
+        [matched, (finish - start)]
+      end
+      private_class_method :extract_data_from_moon_adjustment_key
+
+      # :reek:ControlParameter and :reek:BooleanParameter
+      # :reek:LongParameterList { max_params: 4 }
+
+      #
+      # 月地点を計算する
+      #
+      # @param [LunarRemainder] remainder 初回（昨年冬至）, 前回計算結果（入暦）
+      # @param [Integer] western_year 西暦年
+      # @param [True, False] is_forward  進（遠地点より数える）/退（近地点より数える）
+      # @param [True, False] first 初回計算, 次回以降計算
+      #
+      # @return [LunarRemainder] 入暦
+      # @return [True]  進（遠地点より数える）
+      # @return [False]  退（近地点より数える）
+      #
+      def self.calc_moon_point(remainder:, western_year:,
+                               is_forward: true, first: true)
+        if first
+          return calc_first_moon_point(winter_solstice_age: remainder,
+                                       western_year: western_year)
+        end
+        calc_following_moon_point(remainder: remainder, is_forward: is_forward)
+      end
+
+      # :reek:TooManyStatements { max_statements: 7 }
+
+      #
+      # 入暦（月の遠地点から数えた日数/近地点から数えた日数）を求める
+      #
+      # 天正冬至（入暦前回未計算）を求める
+      #
+      # @param [Remainder] winter_solstice_age 昨年冬至
+      # @param [Integer] western_year 西暦年
+      #
+      # @return [LunarRemainder] 入暦
+      # @return [True]  進（遠地点より数える）
+      # @return [False]  退（近地点より数える）
+      #
+      def self.calc_first_moon_point(winter_solstice_age:, western_year:)
+        # 積年の開始から対象年までの年数
+        total_year = \
+          WinterSolstice::TOTAL_YEAR + western_year - WinterSolstice::BEGIN_YEAR
+
+        # 通積分 - 天正閏余
+        total_day = \
+          total_year * WinterSolstice::YEAR - winter_solstice_age.to_minute
+
+        remainder_month = \
+          LunarRemainder.new(total: (total_day % ANOMALISTIC_MONTH))
+
+        remainder_month, is_forward = decrease_moon_point(
+          remainder_month: remainder_month,
+          remainder_limit: HALF_ANOMALISTIC_MONTH, is_forward: true
+        )
+
+        remainder_month.add!(Remainder.new(day: 1, minute: 0, second: 0))
+
+        [remainder_month, is_forward]
+      end
+      private_class_method :calc_first_moon_point
+
+      #
+      # 入暦（月の遠地点から数えた日数/近地点から数えた日数）を求める
+      #
+      # 前回計算結果を補正する
+      #
+      # @param [LunarRemainder] remainder 前回計算結果（入暦）
+      # @param [True, False] is_forward  進（遠地点より数える）/退（近地点より数える）
+      #
+      # @return [LunarRemainder] 入暦
+      # @return [True]  進（遠地点より数える）
+      # @return [False]  退（近地点より数える）
+      #
+      def self.calc_following_moon_point(remainder:, is_forward:)
+        # 前回計算結果を引き継いた場合、暦中日ではなく損益眺朒（ちょうじく）数の上限とする
+        remainder_month, is_forward = \
+          decrease_moon_point(
+            remainder_month: remainder,
+            remainder_limit: Remainder.new(day: 14, minute: 6529, second: 0),
+            is_forward: is_forward
+          )
+
+        [remainder_month, is_forward]
+      end
+      private_class_method :calc_following_moon_point
+
+      #
+      # 月地点を減算する
+      #
+      # @param [LunarRemainder] remainder_month 大余小余
+      # @param [Remainder] remainder_limit 大余小余の上限（最大の入暦）
+      # @param [True, False] is_forward  進（遠地点より数える）/退（近地点より数える）
+      #
+      # @return [LunarRemainder] 大余小余の減算結果（上限値超えした場合）
+      # @return [True]  進（遠地点より数える）
+      # @return [False]  退（近地点より数える）
+      #
+      def self.decrease_moon_point(remainder_month:, remainder_limit:, is_forward:)
+        return remainder_month, is_forward if remainder_month < remainder_limit
+
+        [remainder_month.sub(HALF_ANOMALISTIC_MONTH), !is_forward]
+      end
+      private_class_method :decrease_moon_point
+    end
+  end
+end