zakuro 0.4.0 → 0.5.0

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

@@ -12,8 +12,25 @@ module Zakuro
     # Gateway アクセサメソッド群
     #
     class Gateway < AbstractVersion
-      # @return [False] リリースなし
-      RELEASE = false
+      # @return [True] リリースあり
+      RELEASE = true
+
+      # @return [String] 暦クラス名
+      VERSION_NAME = 'Genka'
+
+      #
+      # 西暦日から和暦日に変換する
+      #
+      # @param [Date] western_date 西暦日
+      #
+      # @return [Result::Single] 和暦日
+      #
+      def self.to_japan_date(western_date:)
+        date = Western::Calendar.create(date: western_date)
+
+        context = Context.new(version_name: VERSION_NAME)
+        Calculation::Summary::Single.get(context: context, date: date)
+      end
     end
   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

data/lib/zakuro/version/genka/stella/origin/first_term.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../../const/number'
+require_relative '../../cycle/remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    # :nodoc:
+    module Origin
+      #
+      # FirstTerm 年初の中気（正月中雨水）
+      #
+      module FirstTerm
+        # @return [Integer] 二十四節気の1日
+        TERM_DAY = Const::Number::Cycle::TERM_DAY
+        # @return [Float] 余数
+        YEAR_REMAINDER = Const::Number::Stack::YEAR_REMAINDER.to_f
+        # @return [Integer] 西暦0年の積年
+        WESTERN_YEAR = Const::Number::Stack::WESTERN_YEAR
+
+        #
+        # 年初の中気（正月中雨水）を求める
+        #
+        # @note 計算は宋書（1）に従う。念のため『日本暦日原典』（2）と比較する
+        #   1. (1612 + 西暦年) * 餘数（1595） / 度法（304） = A' ...余りが中気の小余
+        #      A' / 60 = B' ...余りが朔の大余
+        #     『歴代天文律暦等志彙編　六』中華書房 p.1728
+        #
+        #   2. (1612 + x) * 222070 / 608 = A' ...余りが中気の小余
+        #      A' / 60 = B' ...余りが朔の大余
+        #
+        #   小余上限（度法）の違いで、宋書に従ったほうが良いと判断した。分母が変わるだけで結果に相違はない
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Remainder] 年初の中気（正月中雨水）
+        #
+        def self.get(western_year:)
+          total_western_year = WESTERN_YEAR + western_year
+          # (1612 + x) * 222070 / 608 = A' ...余りが中気の小余
+          stack = (total_western_year * YEAR_REMAINDER / TERM_DAY).to_i
+          minute = (total_western_year * YEAR_REMAINDER % TERM_DAY).to_i
+          # A' / 60 = B' ...余りが朔の大余
+          day = stack % Cycle::TermRemainder::LIMIT
+          # p stack
+          # p minute
+          # p day
+          Cycle::TermRemainder.new(day: day, minute: minute, second: 0)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/genka/stella/origin/january.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../../const/number'
+require_relative '../../cycle/remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    # :nodoc:
+    module Origin
+      #
+      # January 1月
+      #
+      module January
+        # @return [Integer] 日法
+        DAY = Const::Number::Cycle::DAY
+        # @return [Float] 朔望月
+        SYNODIC_MONTH = Const::Number::Cycle::SYNODIC_MONTH.to_f
+        # @return [Integer] 西暦0年の積年
+        WESTERN_YEAR = Const::Number::Stack::WESTERN_YEAR
+        # @return [Float] 19年=235朔望月
+        METONIC_CYCLE = 235 / 19.to_f
+
+        #
+        # 1月経朔を求める
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Remainder] 11月経朔
+        #
+        def self.get(western_year:)
+          # (1612 + x) * 235 / 19 = A ...余り
+          stack = ((WESTERN_YEAR + western_year) * METONIC_CYCLE).to_i
+          # A * 22207 / 752 = B ...余りが朔の小余
+          minute_total = (stack * SYNODIC_MONTH / DAY).to_i
+          minute = (stack * SYNODIC_MONTH % DAY).to_i
+          # B / 60 = C ...余りが朔の大余
+          day = minute_total % Cycle::Remainder::LIMIT
+          # p stack
+          # p minute_total
+          # p minute
+          # p day
+          Cycle::Remainder.new(day: day, minute: minute, second: 0)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/stella/solar/abstract_average'
+
+require_relative '../../const/remainder'
+
+require_relative '../../cycle/solar_term'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    # :nodoc:
+    module Solar
+      #
+      # Average 平気（太陽軌道平均）
+      #
+      class Average < Calculation::Solar::AbstractAverage
+        #
+        # 初期化
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        def initialize(solar_term:)
+          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
+      end
+    end
+  end
+end

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

@@ -29,6 +29,19 @@ module Zakuro
           super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
+
+        #
+        # 特定の文字フォーマットにして出力する
+        #
+        # @param [String] form フォーマット（大余、小余、秒それぞれを%dで指定する）
+        #
+        # @return [String] フォーマットした結果
+        #
+        def format(form: '%d-%d')
+          return '' if invalid?
+
+          super(form, @day, @minute, @second)
+        end
       end
 
       #
@@ -50,6 +63,19 @@ module Zakuro
           super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
+
+        #
+        # 特定の文字フォーマットにして出力する
+        #
+        # @param [String] form フォーマット（大余、小余、秒それぞれを%dで指定する）
+        #
+        # @return [String] フォーマットした結果
+        #
+        def format(form: '%d-%d')
+          return '' if invalid?
+
+          super(form, @day, @minute, @second)
+        end
       end
     end
   end

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

@@ -55,7 +55,7 @@ module Zakuro
           # 二十四節気（冬至）
           solar_term = Cycle::SolarTerm.new(index: 0, remainder: winter_solstice)
 
-          first_solar_term_index = Average.calc_fist_solar_term_index(western_year: western_year)
+          first_solar_term_index = Average.calc_first_solar_term_index(western_year: western_year)
 
           # 対象の二十四節気まで戻す
           solar_term.prev_by_index(first_solar_term_index)
@@ -77,7 +77,7 @@ module Zakuro
         #
         # @return [Integer] 二十四節気番号
         #
-        def self.calc_fist_solar_term_index(western_year:)
+        def self.calc_first_solar_term_index(western_year:)
           # 天正閏余
           lunar_age = Origin::LunarAge.get(western_year: western_year)
 

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

@@ -29,6 +29,19 @@ module Zakuro
           super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
+
+        #
+        # 特定の文字フォーマットにして出力する
+        #
+        # @param [String] form フォーマット（大余、小余、秒それぞれを%dで指定する）
+        #
+        # @return [String] フォーマットした結果
+        #
+        def format(form: '%d-%d')
+          return '' if invalid?
+
+          super(form, @day, @minute, @second)
+        end
       end
 
       #
@@ -50,6 +63,19 @@ module Zakuro
           super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
+
+        #
+        # 特定の文字フォーマットにして出力する
+        #
+        # @param [String] form フォーマット（大余、小余、秒それぞれを%dで指定する）
+        #
+        # @return [String] フォーマットした結果
+        #
+        def format(form: '%d-%d')
+          return '' if invalid?
+
+          super(form, @day, @minute, @second)
+        end
       end
     end
   end

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

@@ -55,7 +55,7 @@ module Zakuro
           # 二十四節気（冬至）
           solar_term = Cycle::SolarTerm.new(index: 0, remainder: winter_solstice)
 
-          first_solar_term_index = Average.calc_fist_solar_term_index(western_year: western_year)
+          first_solar_term_index = Average.calc_first_solar_term_index(western_year: western_year)
 
           # 対象の二十四節気まで戻す
           solar_term.prev_by_index(first_solar_term_index)
@@ -77,7 +77,7 @@ module Zakuro
         #
         # @return [Integer] 二十四節気番号
         #
-        def self.calc_fist_solar_term_index(western_year:)
+        def self.calc_first_solar_term_index(western_year:)
           # 天正閏余
           lunar_age = Origin::LunarAge.get(western_year: western_year)
 

data/lib/zakuro/version/version_class_resolver.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require_relative './genka/cycle/remainder'
+require_relative './genka/cycle/solar_term'
+require_relative './genka/range/annual_range'
+
 require_relative './gihou/cycle/remainder'
 require_relative './gihou/cycle/solar_term'
 require_relative './gihou/range/annual_range'

data/lib/zakuro/version.rb

@@ -3,5 +3,5 @@
 # :nodoc:
 module Zakuro
   # @return [String] library version
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end