zakuro 0.1.5 → 0.2.0

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative '../cycle/remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gihou
+    #
+    # Const 定数
+    #
+    module Const
+      #
+      # Remainder 大余小余
+      #
+      module Remainder
+        #
+        # Solar 太陽
+        #
+        module Solar
+          # @return [Remainder] 気策（24分の1年）
+          SOLAR_TERM_AVERAGE = Cycle::Remainder.new(day: 15, minute: 292, second: 5)
+          #
+          # @note 常朔実 39571 = 29-711
+          #   * 39571 / 4 = 9892.75 / 1340 = 7 余り 512.75
+          #   * 0.75 * 6（1分=6秒） = 4.5
+          #
+          # @return [Cycle::Remainder] 弦（1分=6秒）
+          QUARTER = Cycle::Remainder.new(day: 7, minute: 512, second: 4.5)
+        end
+
+        #
+        # Lunar 月
+        #
+        module Lunar
+          # @return [Cycle::LunarRemainder] 変日（1近点月）
+          ANOMALISTIC_MONTH = \
+            Cycle::LunarRemainder.new(day: 27, minute: 743, second: 1)
+          # @return [Cycle::LunarRemainder] 入暦上限
+          LIMIT = Cycle::LunarRemainder.new(day: 28, minute: 743, second: 0)
+          #
+          # @note 常朔実 39571 = 29-711
+          #   * 39571 / 4 = 9892.75 / 1340 = 7 余り 512.75
+          #   * 0.75 * 12（1分=12秒） = 9
+          #
+          # @return [Cycle::LunarRemainder] 弦（1分=12秒）
+          # TODO: 9秒だと通らない。 0.00378 〜 0.0208 の範囲内で通る
+          # QUARTER = Cycle::LunarRemainder.new(day: 7, minute: 512, second: 9)
+          # QUARTER = Cycle::LunarRemainder.new(day: 7, minute: 512, second: 9.00378)
+          # QUARTER = Cycle::LunarRemainder.new(day: 7, minute: 512, second: 9.0208)
+          QUARTER = Cycle::LunarRemainder.new(day: 7, minute: 512, second: 9.00378)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../../../calculation/cycle/abstract_remainder'
+
+require_relative '../const/number'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gihou
+    # :nodoc:
+    module Cycle
+      #
+      # Remainder 宣明暦の時刻情報（大余小余）
+      #
+      # * 「15日1012分5秒」のような形式で表される
+      # * 分は1340で一日に繰り上げる
+      # * 秒は基本的に1/6分で、6秒で1分に繰り上げる。ただし、月補正値は1分に100秒とするなど基数の変更がありえる
+      # * 十干十二支（60日）を上限とした「日時分秒」の情報で、日付（date）/時刻（time）と部分的に重なる概念
+      #
+      class Remainder < Calculation::Cycle::AbstractRemainder
+        # @return [Integer] 分（1分=6秒）
+        MINUTE = 6
+
+        #
+        # 初期化
+        #
+        # @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
+      end
+
+      #
+      # LunarRemainder 月の位相計算向け時刻情報（大余小余）
+      #
+      class LunarRemainder < Calculation::Cycle::AbstractRemainder
+        # @return [Integer] 分（1分=12秒）
+        MINUTE = 12
+
+        #
+        # 初期化
+        #
+        # @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
+      end
+    end
+  end
+end

data/lib/zakuro/version/gihou/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 Gihou
+    # :nodoc:
+    module Cycle
+      #
+      # SolarTerm 二十四節気
+      #
+      class SolarTerm < Calculation::Cycle::AbstractSolarTerm
+        # @return [Remainder] 気策（24分の1年）
+        SOLAR_TERM_AVERAGE = Const::Remainder::Solar::SOLAR_TERM_AVERAGE
+
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Remainder] remainder 時刻情報（大余小余）
+        #
+        def initialize(index: -1, remainder: Remainder.new)
+          super(index: index, remainder: remainder, average: SOLAR_TERM_AVERAGE)
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
+require 'date'
+require_relative '../../era/western'
 require_relative '../abstract_version'
+require_relative '../context'
+require_relative '../../calculation/summary/single'
 
 # :nodoc:
 module Zakuro
@@ -12,8 +16,25 @@ module Zakuro
     # Gateway アクセサメソッド群
     #
     class Gateway < AbstractVersion
-      # @return [False] リリースなし
-      RELEASE = false
+      # @return [True] リリースあり
+      RELEASE = true
+
+      # @return [String] 暦クラス名
+      VERSION_NAME = 'Gihou'
+
+      #
+      # 西暦日から和暦日に変換する
+      #
+      # @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/gihou/monthly/lunar_phase.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative '../../../calculation/monthly/abstract_lunar_phase'
+
+require_relative '../const/remainder'
+
+require_relative '../stella/solar/location'
+require_relative '../stella/solar/value'
+require_relative '../stella/lunar/location'
+require_relative '../stella/lunar/value'
+
+require_relative '../stella/origin/lunar_age'
+require_relative '../stella/origin/average_november'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gihou
+    # :nodoc:
+    module Monthly
+      #
+      # LunarPhase 月の位相
+      #
+      class LunarPhase < Calculation::Monthly::AbstractLunarPhase
+        # @return [Cycle::Remainder] 弦
+        QUARTER = Const::Remainder::Solar::QUARTER
+
+        #
+        # 初期化
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        def initialize(western_year:)
+          # 天正閏余
+          lunar_age = Origin::LunarAge.get(western_year: western_year)
+
+          super(
+            quater: QUARTER,
+            average_remainder: Origin::AverageNovember.get(western_year: western_year),
+            solar_location: Solar::Location.new(lunar_age: lunar_age),
+            lunar_location: Lunar::Location.new(
+              western_year: western_year,
+              lunar_age: Cycle::LunarRemainder.new(total: 0).add!(lunar_age)
+            )
+          )
+        end
+
+        private
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 現在の定朔を取得する
+        #
+        # @return [Remainder] 定朔
+        #
+        def current_remainder
+          # debug("@average_remainder.format: #{@average_remainder.format(form: '%d-%d-%.5f')}")
+
+          sum = correction_value
+          adjusted = @average_remainder.add(
+            Cycle::Remainder.new(day: 0, minute: sum, second: 0)
+          )
+          # NOTE: 儀鳳暦では進朔しない
+          # adjusted.up_on_new_moon!
+
+          debug("result: #{adjusted.format}")
+
+          adjusted
+        end
+
+        #
+        # 太陽運動の補正値を得る
+        #
+        # @return [Integer] 太陽運動の補正値
+        #
+        def correction_solar_value
+          @solar_location.run
+          # debug("@solar_term.remainder: #{@solar_location.remainder.format(form: '%d-%d-%.5f')}")
+          # debug("@solar_term.index: #{@solar_location.index}")
+
+          Solar::Value.get(solar_location: @solar_location)
+        end
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 月運動の補正値を得る
+        #
+        # @return [Integer] 月運動の補正値
+        #
+        def correction_moon_value
+          @lunar_location.run
+
+          remainder = @lunar_location.remainder
+
+          # debug("[lunar]remainder.format: #{remainder.format(form: '%d-%d-%.5f')}")
+          # debug("[lunar]remainder.day: #{remainder.day}")
+          # debug("[lunar]remainder.minute: #{remainder.minute}")
+
+          Lunar::Value.get(remainder: remainder)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../../calculation/range/medieval_annual_range'
+require_relative '../monthly/lunar_phase'
+require_relative '../stella/solar/average'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gihou
+    # :nodoc:
+    module Range
+      #
+      # AnnualRange 年間範囲
+      #
+      module AnnualRange
+        #
+        # 一覧取得する
+        #
+        #   * 対象年に対して、前年11月-当年11月までを出力する
+        #   * 対象年（西暦）と計算年（元号x年）の紐付けは行わない
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def self.get(context:, western_year:)
+          lunar_phase = Monthly::LunarPhase.new(western_year: western_year)
+          solar_average = Solar::Average.new(western_year: western_year)
+
+          Calculation::Range::MedievalAnnualRange.get(
+            context: context, lunar_phase: lunar_phase, solar_average: solar_average
+          )
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/gihou/stella/lunar/adjustment.rb

@@ -0,0 +1,250 @@
+# frozen_string_literal: true
+
+require_relative '../../const/number'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gihou
+    # :nodoc:
+    module Lunar
+      #
+      # Adjustment 補正値情報
+      #
+      module Adjustment
+        #
+        # 遠/近の地点での中間
+        #
+        # 7、14、21日の小余の境界は下記のようにして求めた
+        #   * 宣明暦の7日の小余は7465である。入暦は1始まりなので、0始まりで表現すると 6-7465 となる
+        #   * 6 * 8400（統法） + 7465（初益） = 57865
+        #   * これを儀鳳暦に変えると、 57865 / 1340（総法） = 6 余り 1190.845238..
+        #   * これを入暦の1始まりに置き換え、少数部を消すと 7-1190、これが7日目となる
+        #   * 同様の方法で14日と21日も求める
+        #   * 57865 * 2 = 115730 / 1340（総法） = 13 余り 1041.690476 = 14-1041
+        #   * 57865 * 3 = 173595 / 1340（総法） = 20 余り 892.5357143 = 21-892
+        #
+        # 28日は変日の範囲内743とした。
+        #   * 宣明暦では 進退 14-6529（1始まりなので実質13） * 2 = 27-4658
+        #   * 暦周 27-4658.19 に一致する。これを変日27-743.1と同等とみなした
+        #
+        # @return [Hash<Integer>] 遠/近の地点での中間
+        DAY_LIMIT = {
+          7 => 1191,  # 天平勝宝2年（750年）5月 により 1190 ではないことを確認した
+          14 => 1042, # 養老6年（722年） 6月 により 1041 ではないことを確認した
+          21 => 892,
+          28 => 743.06 # 天平13年（741年） 2月 により 743 ではないことを確認した
+        }.freeze
+
+        #
+        # Row 行情報
+        #
+        class Row
+          # @return [Integer] 入暦（1-14）
+          attr_reader :day
+          # @return [Range] 小余範囲
+          attr_reader :range
+          # @return [Value] 補正値
+          attr_reader :value
+
+          #
+          # 初期化
+          #
+          # @param [Integer] day 入暦（1-14）
+          # @param [Range] range 小余範囲
+          # @param [Value] value 補正値
+          #
+          def initialize(day:, range:, value:)
+            @day = day
+            @range = range
+            @value = value
+          end
+
+          # :reek:ControlParameter
+
+          #
+          # 一致するか
+          #
+          # @param [Integer] day 入暦（1-14）
+          # @param [Integer] minute 小余
+          #
+          # @return [True] 一致
+          # @return [False] 不一致
+          #
+          def match?(day:, minute:)
+            return false unless @day == day
+
+            return false unless @range.include?(minute: minute)
+
+            true
+          end
+
+          #
+          # 分母を返す
+          #
+          # @return [Integer] 分母
+          #
+          def denominator
+            @range.denominator
+          end
+        end
+
+        #
+        # Range 小余範囲
+        #
+        class Range
+          # @return [Integer] 下限
+          MIN = 0
+          # @return [Integer] 上限
+          MAX = Const::Number::Cycle::DAY
+
+          # @return [Integer] 下限
+          attr_reader :min
+          # @return [Integer] 上限
+          attr_reader :max
+
+          #
+          # 初期化
+          #
+          # @param [Integer] min 下限
+          # @param [Integer] max 上限
+          #
+          def initialize(min: MIN, max: MAX)
+            @min = min
+            @max = max
+          end
+
+          #
+          # 含まれるか
+          #
+          # @param [Integer] minute 小余
+          #
+          # @return [True] 含まれる
+          # @return [False] 含まれない
+          #
+          def include?(minute:)
+            minute >= @min && minute <= @max
+          end
+
+          #
+          # 分母を返す
+          #
+          # @return [Integer] 分母
+          #
+          def denominator
+            @max - @min
+          end
+        end
+
+        #
+        # Value 補正値
+        #
+        class Value
+          # @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
+
+        # rubocop:disable Layout/LineLength
+
+        # @note 7日、14日、21日、28日の小余は DAY_LIMIT を参照のこと
+        #
+        # @return [Array<Row>] 月の補正値情報
+        #
+        LIST = [
+          Row.new(day: 1, range: Range.new, value: Value.new(per: -134, stack: 0)),
+          Row.new(day: 2, range: Range.new, value: Value.new(per: -117, stack: -134)),
+          Row.new(day: 3, range: Range.new, value: Value.new(per: -99, stack: -251)),
+          Row.new(day: 4, range: Range.new, value: Value.new(per: -78, stack: -350)),
+          Row.new(day: 5, range: Range.new, value: Value.new(per: -56, stack: -428)),
+          Row.new(day: 6, range: Range.new, value: Value.new(per: -33, stack: -484)),
+          Row.new(day: 7, range: Range.new(max: DAY_LIMIT[7]), value: Value.new(per: -9, stack: -517)),
+          Row.new(day: 7, range: Range.new(min: DAY_LIMIT[7]), value: Value.new(per: 0, stack: -526)),
+          Row.new(day: 8, range: Range.new, value: Value.new(per: +14, stack: -526)),
+          Row.new(day: 9, range: Range.new, value: Value.new(per: +38, stack: -512)),
+          Row.new(day: 10, range: Range.new, value: Value.new(per: +62, stack: -474)),
+          Row.new(day: 11, range: Range.new, value: Value.new(per: +85, stack: -412)),
+          Row.new(day: 12, range: Range.new, value: Value.new(per: +104, stack: -327)),
+          Row.new(day: 13, range: Range.new, value: Value.new(per: +121, stack: -223)),
+          Row.new(day: 14, range: Range.new(max: DAY_LIMIT[14]), value: Value.new(per: +102, stack: -102)),
+          Row.new(day: 14, range: Range.new(min: DAY_LIMIT[14]), value: Value.new(per: +29, stack: 0)),
+          Row.new(day: 15, range: Range.new, value: Value.new(per: +128, stack: +29)),
+          Row.new(day: 16, range: Range.new, value: Value.new(per: +115, stack: +157)),
+          Row.new(day: 17, range: Range.new, value: Value.new(per: +95, stack: +272)),
+          Row.new(day: 18, range: Range.new, value: Value.new(per: +74, stack: +367)),
+          Row.new(day: 19, range: Range.new, value: Value.new(per: +52, stack: +441)),
+          Row.new(day: 20, range: Range.new, value: Value.new(per: +28, stack: +493)),
+          Row.new(day: 21, range: Range.new(max: DAY_LIMIT[21]), value: Value.new(per: +4, stack: +521)),
+          Row.new(day: 21, range: Range.new(min: DAY_LIMIT[21]), value: Value.new(per: 0, stack: +525)),
+          Row.new(day: 22, range: Range.new, value: Value.new(per: -20, stack: +525)),
+          Row.new(day: 23, range: Range.new, value: Value.new(per: -44, stack: +505)),
+          Row.new(day: 24, range: Range.new, value: Value.new(per: -68, stack: +461)),
+          Row.new(day: 25, range: Range.new, value: Value.new(per: -89, stack: +393)),
+          Row.new(day: 26, range: Range.new, value: Value.new(per: -108, stack: +304)),
+          Row.new(day: 27, range: Range.new, value: Value.new(per: -125, stack: +196)),
+          Row.new(day: 28, range: Range.new(max: DAY_LIMIT[28]), value: Value.new(per: -71, stack: +71))
+        ].freeze
+        # rubocop:enable Layout/LineLength
+
+        #
+        # 月軌道の補正に必要な基本値を引き当てる
+        #
+        # @param [True, False] forward 進（遠地点より数える）/退（近地点より数える）
+        # @param [Integer] day 大余
+        # @param [Integer] minute 小余
+        #
+        # @return [Row] 補正値
+        #
+        def self.specify(day:, minute:)
+          LIST.each do |row|
+            # NOTE: 範囲が重複している場合、最初に引き当てたほうを優先する
+            return row if row.match?(day: day, minute: minute)
+          end
+
+          raise ArgumentError.new, "invalid parameter: #{day}/#{minute}"
+        end
+
+        # :reek:ControlParameter
+
+        #
+        # 小余の下げ幅を求める
+        #
+        # @param [Integer] day 大余
+        # @param [Integer] minute 小余
+        #
+        # @return [Integer] 小余の下げ幅
+        #
+        def self.minus_minute(day:, minute:)
+          limit = DAY_LIMIT.fetch(day, -1)
+          # 該当なし
+          return minute if limit == -1
+
+          return minute unless minute > limit
+
+          minute - limit
+        end
+      end
+    end
+  end
+end