zakuro 0.2.0 → 0.6.0

data/lib/zakuro/version/daien/stella/solar/average.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/stella/solar/abstract_average'
+
+require_relative '../../const/remainder'
+
+require_relative '../../cycle/solar_term'
+
+require_relative '../origin/winter_solstice'
+
+require_relative './location'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Solar
+      #
+      # Average 平気（太陽軌道平均）
+      #
+      class Average < Calculation::Solar::AbstractAverage
+        #
+        # 初期化
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        def initialize(western_year:)
+          solar_term = Average.first_solar_term(western_year: western_year)
+          super(solar_term: solar_term)
+        end
+
+        #
+        # 冬至から数えた1年データの月ごとに二十四節気を割り当てる
+        #
+        # @param [Array<Month>] annual_range 1年データ
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def set(annual_range:)
+          super(annual_range: annual_range)
+        end
+
+        #
+        # 計算開始する二十四節気を求める
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [SolarTerm] 二十四節気
+        #
+        def self.first_solar_term(western_year:)
+          # 天正冬至
+          winter_solstice = Origin::WinterSolstice.get(western_year: western_year)
+
+          # 二十四節気（冬至）
+          solar_term = Cycle::SolarTerm.new(index: 0, remainder: winter_solstice)
+
+          first_solar_term_index = Average.calc_first_solar_term_index(western_year: western_year)
+
+          # 対象の二十四節気まで戻す
+          solar_term.prev_by_index(first_solar_term_index)
+
+          solar_term
+        end
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 計算開始する二十四節気番号を求める
+        #
+        # * 前提として入定気は冬至の手前にある
+        # * 例えば、定気が大雪であれば入定気は大雪の範囲内にある
+        # * 入定気は、定気の開始位置に重複しない限り、常に定気より後にある
+        # * 基本的に定気の一つ前から起算すれば、当時から求めた11月(閏10/閏11月)に二十四節気を割り当てられる
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Integer] 二十四節気番号
+        #
+        def self.calc_first_solar_term_index(western_year:)
+          # 天正閏余
+          lunar_age = Origin::LunarAge.get(western_year: western_year)
+
+          solar_location = Solar::Location.new(lunar_age: lunar_age)
+          solar_location.run
+
+          solar_term_index = solar_location.index
+
+          # 入定気の一つ後の二十四節気まで戻す（ただし11月経朔が二十四節気上にある場合は戻さない）
+          # NOTE: 789年で大余0のパターンあり
+          solar_term_index += 1 unless solar_location.remainder.day.zero?
+
+          solar_term_index
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/solar/interval.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Solar
+      #
+      # Interval 入気定日加減数（二十四節気の間隔）
+      #
+      module Interval
+        #
+        # 気策の 15-664.7 を加減する
+        #
+        # @note 『歴代天文律暦等志彙編　七』中華書房 p.2224 盈縮分の行で加減した
+        #
+        # @return [Hash<Symbol, Cycle::Remainder>] 一覧
+        MAP = {
+          # 冬至（とうじ）・大雪（たいせつ）
+          touji: Cycle::Remainder.new(day: 14, minute: 1351, second: 7), # -2353
+          taisetsu: Cycle::Remainder.new(day: 14, minute: 1351, second: 7),
+          # 小寒（しょうかん）・小雪（しょうせつ）
+          shoukan: Cycle::Remainder.new(day: 14, minute: 1859, second: 7), # -1845
+          shousetsu: Cycle::Remainder.new(day: 14, minute: 1859, second: 7),
+          # 大寒（だいかん）・立冬（りっとう）
+          daikan: Cycle::Remainder.new(day: 14, minute: 2314, second: 7), # -1390
+          rittou: Cycle::Remainder.new(day: 14, minute: 2314, second: 7),
+          # 立春（りっしゅん）・霜降（そうこう）
+          risshun: Cycle::Remainder.new(day: 14, minute: 2728, second: 7), # -976
+          soukou: Cycle::Remainder.new(day: 14, minute: 2728, second: 7),
+          # 雨水（うすい）・寒露（かんろ）
+          usui: Cycle::Remainder.new(day: 15, minute: 76, second: 7), # -588
+          kanro: Cycle::Remainder.new(day: 15, minute: 76, second: 7),
+          # 啓蟄（けいちつ）・秋分（しゅうぶん）
+          keichitsu: Cycle::Remainder.new(day: 15, minute: 450, second: 7), # -214
+          shuubun: Cycle::Remainder.new(day: 15, minute: 450, second: 7),
+          # 春分（しゅんぶん）・白露（はくろ）
+          shunbun: Cycle::Remainder.new(day: 15, minute: 878, second: 7), # +214
+          hakuro: Cycle::Remainder.new(day: 15, minute: 878, second: 7),
+          # 清明（せいめい）・処暑（しょしょ）
+          seimei: Cycle::Remainder.new(day: 15, minute: 1252, second: 7), # +588
+          shosho: Cycle::Remainder.new(day: 15, minute: 1252, second: 7),
+          # 穀雨（こくう）・立秋（りっしゅう）
+          kokuu: Cycle::Remainder.new(day: 15, minute: 1640, second: 7), # +976
+          risshuu: Cycle::Remainder.new(day: 15, minute: 1640, second: 7),
+          # 立夏（りっか）・大暑（たいしょ）
+          rikka: Cycle::Remainder.new(day: 15, minute: 2054, second: 7), # +1390
+          taisho: Cycle::Remainder.new(day: 15, minute: 2054, second: 7),
+          # 小満（しょうまん）・小暑（しょうしょ）
+          shouman: Cycle::Remainder.new(day: 15, minute: 2509, second: 7), # +1845
+          shousho: Cycle::Remainder.new(day: 15, minute: 2509, second: 7),
+          # 芒種（ぼうしゅ）・夏至（げし）
+          boushu: Cycle::Remainder.new(day: 15, minute: 3017, second: 7), # +2353
+          geshi: Cycle::Remainder.new(day: 15, minute: 3017, second: 7)
+        }.freeze
+
+        # @return [Array<Remainder>] 索引
+        LIST = [
+          MAP[:touji],      #  0
+          MAP[:shoukan],    #  1
+          MAP[:daikan],     #  2
+          MAP[:risshun],    #  3
+          MAP[:usui],       #  4
+          MAP[:keichitsu],  #  5
+          MAP[:shunbun],    #  6
+          MAP[:seimei],     #  7
+          MAP[:kokuu],      #  8
+          MAP[:rikka],      #  9
+          MAP[:shouman],    # 10
+          MAP[:boushu],     # 11
+          MAP[:geshi],      # 12
+          MAP[:shousho],    # 13
+          MAP[:taisho],     # 14
+          MAP[:risshuu],    # 15
+          MAP[:shosho],     # 16
+          MAP[:hakuro],     # 17
+          MAP[:shuubun],    # 18
+          MAP[:kanro],      # 19
+          MAP[:soukou],     # 20
+          MAP[:rittou],     # 21
+          MAP[:shousetsu],  # 22
+          MAP[:taisetsu]    # 23
+        ].freeze
+
+        #
+        # 入気定日加減数を引き当てる
+        #
+        # @param [Integer] index 二十四節気番号
+        #
+        # @return [Cycle::Remainder] 入気定日加減数
+        #
+        def self.index_of(index)
+          LIST[index]
+        end
+
+        #
+        # 入気定日加減数の総数を返す
+        #
+        # @return [Integer] 入気定日加減数の総数
+        #
+        def self.size
+          LIST.size
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/solar/location.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/stella/solar/abstract_location'
+
+require_relative '../../const/remainder'
+
+require_relative './interval'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Solar
+      #
+      # Location 入定気
+      #
+      class Location < Calculation::Solar::AbstractLocation
+        # @return [Cycle::Remainder] 弦
+        QUARTER = Const::Remainder::Solar::QUARTER
+
+        #
+        # 初期化
+        #
+        # @param [Cycle::Remainder] lunar_age 天正閏余（大余小余）
+        #
+        def initialize(lunar_age:)
+          super(lunar_age: lunar_age, quarter: QUARTER)
+        end
+
+        # :reek:UtilityFunction
+
+        #
+        # 二十四節気番号に対応する入気定日加減数を返す
+        #
+        # @note 継承のためクラスメソッドにしない
+        #
+        # @param [Integer] index 二十四節気番号
+        #
+        # @return [Cycle::Remainder] 入気定日加減数
+        #
+        def interval(index:)
+          Interval.index_of(index)
+        end
+
+        # :reek:UtilityFunction
+
+        #
+        # 入気定日加減数の要素数を返す
+        #
+        # @note 継承のためクラスメソッドにしない
+        #
+        # @return [Integer] 入気定日加減数の要素数
+        #
+        def interval_size
+          Interval.size
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/stella/solar/value.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/stella/solar/choukei_value'
+
+require_relative '../../const/number'
+
+require_relative './adjustment'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Daien
+    # :nodoc:
+    module Solar
+      #
+      # Value 太陽補正値
+      #
+      module Value
+        #
+        # 太陽の運行による補正値を算出する
+        #
+        # @param [SolarTerm] solar_location 入定気
+        #
+        # @return [Integer] 補正値
+        #
+        def self.get(solar_location:)
+          remainder = solar_location.remainder
+
+          row = Adjustment.specify(index: solar_location.index)
+
+          Calculation::Solar::ChoukeiValue.get(remainder: remainder, row: row)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/genka/const/number.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    #
+    # Const 定数
+    #
+    module Const
+      #
+      # Number 数値
+      #
+      module Number
+        #
+        # Cycle 周期
+        #
+        module Cycle
+          # @return [Integer] 日法（1日=752分）
+          DAY = 752
+          # @return [Integer] 度法（1日=304分）
+          TERM_DAY = 304
+          # @return [Integer] 朔望月
+          SYNODIC_MONTH = 22_207
+        end
+
+        #
+        # 累積
+        #
+        module Stack
+          # @return [Integer] 積年（甲子夜半朔旦冬至〜暦の開始前）
+          TOTAL_YEAR = 5703
+          # @return [Integer] 暦の開始年（元嘉20年）
+          BEGIN_YEAR = 443
+          # @return [Integer] 西暦0年の積年
+          WESTERN_YEAR = 1612
+          # @return [Integer] 余数
+          YEAR_REMAINDER = 1595
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/genka/const/remainder.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../cycle/remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    #
+    # Const 定数
+    #
+    module Const
+      #
+      # Remainder 大余小余
+      #
+      module Remainder
+        #
+        # @note 『歴代天文律暦等志彙編　六』中華書房 p.1727
+        # 「推弦望法..加朔大餘七，小餘二百八十七，小分三，小分満四從小餘」
+        #
+        # @return [Cycle::Remainder] 弦（1分=4秒）
+        QUARTER = Cycle::Remainder.new(day: 7, minute: 287, second: 3)
+
+        #
+        # @note 『歴代天文律暦等志彙編　六』中華書房 p.1727
+        # 「推二十四氣術」「求次氣，加朔大餘十五，小餘六十六，小分十一，小分満氣法從小餘，小餘満度法從大餘」
+        #
+        # @return [Cycle::Remainder] 気策（24分の1年）
+        SOLAR_TERM_AVERAGE = Cycle::TermRemainder.new(day: 15, minute: 66 + 11.0 / 24, second: 0)
+      end
+    end
+  end
+end

data/lib/zakuro/version/genka/cycle/remainder.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative '../../../calculation/cycle/abstract_remainder'
+
+require_relative '../const/number'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    # :nodoc:
+    module Cycle
+      #
+      # Remainder 時刻情報（大余小余）
+      #
+      class Remainder < Calculation::Cycle::AbstractRemainder
+        #
+        # @note 『歴代天文律暦等志彙編　六』中華書房 p.1727
+        # 「推弦望法..加朔大餘七，小餘二百八十七，小分三，小分満四從小餘」
+        #
+        # @return [Integer] 分（1分=4秒）
+        MINUTE = 4
+
+        #
+        # 初期化
+        #
+        # @param [Integer] day 大余（"日"に相当）
+        # @param [Integer] minute 小余（"分"に相当）
+        # @param [Integer] second 秒
+        # @param [Integer] total 繰り上げなしの小余
+        #
+        def initialize(day: -1, minute: -1, second: -1, total: -1)
+          super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
+                day: day, minute: minute, second: second, total: total)
+        end
+
+        #
+        # 特定の文字フォーマットにして出力する
+        #
+        # @return [String] フォーマットした結果
+        #
+        def format(form: '%.4f', digit: 4)
+          return '' if invalid?
+
+          decimal = @day + @minute / @base_day.to_f
+          super(form, decimal.round(digit))
+        end
+      end
+
+      #
+      # TermRemainder 時刻情報（大余小余）
+      #
+      class TermRemainder < Calculation::Cycle::AbstractRemainder
+        #
+        # @note 『歴代天文律暦等志彙編　六』中華書房 p.1726
+        # 「氣法，二十四」
+        #
+        # @return [Integer] 分（1分=24秒）
+        MINUTE = 24
+
+        #
+        # 初期化
+        #
+        # @param [Integer] day 大余（"日"に相当）
+        # @param [Integer] minute 小余（"分"に相当）
+        # @param [Integer] second 秒
+        # @param [Integer] total 繰り上げなしの小余
+        #
+        def initialize(day: -1, minute: -1, second: -1, total: -1)
+          super(base_day: Const::Number::Cycle::TERM_DAY, base_mitune: MINUTE,
+                day: day, minute: minute, second: second, total: total)
+        end
+
+        #
+        # 特定の文字フォーマットにして出力する
+        #
+        # @return [String] フォーマットした結果
+        #
+        def format(form: '%.4f', digit: 4)
+          return '' if invalid?
+
+          decimal = @day + @minute / @base_day.to_f
+          # NOTE: roundなしで format を使用した場合は、四捨五入が正しく実行されないことが判明した
+          # 具体的には、468年の中気は '55.7813' だが '55.7812' になる
+          # これは '55.7812500' を4桁にした際に、境界値の少数点以下5桁目の '5' が切り捨てを受けたためである
+          # format による四捨五入は避け、roundによる四捨五入を採用する
+          super(form, decimal.round(digit))
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/genka/cycle/solar_term.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../../calculation/cycle/abstract_solar_term'
+
+require_relative '../const/remainder'
+
+require_relative './remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    # :nodoc:
+    module Cycle
+      #
+      # SolarTerm 二十四節気
+      #
+      class SolarTerm < Calculation::Cycle::AbstractSolarTerm
+        # @return [Remainder] 気策（24分の1年）
+        SOLAR_TERM_AVERAGE = Const::Remainder::SOLAR_TERM_AVERAGE
+
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Remainder] remainder 時刻情報（大余小余）
+        #
+        def initialize(index: -1, remainder: TermRemainder.new)
+          super(index: index, remainder: remainder, average: SOLAR_TERM_AVERAGE)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/genka/genka.rb

@@ -1,19 +1,11 @@
 # frozen_string_literal: true
 
-require_relative '../abstract_version'
-
 # :nodoc:
 module Zakuro
   #
   # Genka 元嘉暦
   #
   module Genka
-    #
-    # Gateway アクセサメソッド群
-    #
-    class Gateway < AbstractVersion
-      # @return [False] リリースなし
-      RELEASE = false
-    end
+    # none
   end
 end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative '../const/remainder'
+
+require_relative '../cycle/solar_term'
+
+require_relative '../stella/origin/first_term'
+
+require_relative '../stella/origin/january'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    # :nodoc:
+    module Monthly
+      #
+      # LunarPhase 月の位相
+      #
+      class LunarPhase
+        # @return [Cycle::Remainder] 弦
+        QUARTER = Const::Remainder::QUARTER
+
+        # TODO: AbstractLunarPhase でも使用している
+
+        # @return [Array<String>] 月内の弦
+        PHASE_INDEXES = %w[朔日 上弦 望月 下弦].freeze
+
+        # @return [Cycle::AbstractRemainder] 経
+        attr_reader :remainder
+
+        #
+        # 初期化
+        #
+        # @param [Cycle::Remainder] remainder 正月経朔
+        #
+        def initialize(remainder:)
+          # 経
+          @remainder = remainder
+
+          # 弦の位置
+          @index = 0
+        end
+
+        #
+        # 次の弦に進める
+        #
+        # @return [Remainder] 定朔
+        #
+        def next_phase
+          adjusted = remainder.clone
+
+          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
+
+        def add_quarter_moon_size
+          @remainder.add!(QUARTER)
+
+          next_index
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/genka/range/annual_range.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative '../../../calculation/range/medieval_annual_range'
+require_relative '../../../output/logger'
+require_relative '../monthly/lunar_phase'
+require_relative '../stella/solar/average'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    # :nodoc:
+    module Range
+      #
+      # AnnualRange 年間範囲
+      #
+      module AnnualRange
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'annual_range')
+
+        #
+        # 一覧取得する
+        #
+        #   * 対象年に対して、当年1月-翌年1月までを出力する
+        #   * 対象年（西暦）と計算年（元号x年）の紐付けは行わない
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def self.get(context:, western_year:)
+          # 正月中気
+          solar_term = Cycle::SolarTerm.new(
+            index: 4, remainder: Origin::FirstTerm.get(western_year: western_year)
+          )
+          # 正月に立春が含まれる可能性があるので、立春まで戻しておく
+          solar_term.prev_term!
+
+          # 経
+          remainder = Origin::January.get(western_year: western_year)
+
+          lunar_phase = Monthly::LunarPhase.new(remainder: remainder)
+
+          solar_average = Solar::Average.new(solar_term: solar_term)
+
+          annual_range = Calculation::Range::MedievalAnnualRange.get(
+            context: context, lunar_phase: lunar_phase, solar_average: solar_average
+          )
+
+          pop_months_on_next_year(annual_range: annual_range)
+        end
+
+        #
+        # 来年の月を除去する
+        #
+        # @param [Array<Month>] annual_range 1年データ
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def self.pop_months_on_next_year(annual_range:)
+          result = []
+          number = 0
+          annual_range.each do |month|
+            # 来年
+            break if number > month.month_label.number
+
+            number = month.month_label.number
+            result.push(month)
+          end
+
+          result
+        end
+      end
+    end
+  end
+end