zakuro 0.1.1 → 0.2.0

data/lib/zakuro/calculation/cycle/abstract_solar_term.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require_relative './abstract_remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Cycle
+      #
+      # AbstractSolarTerm 二十四節気
+      #
+      class AbstractSolarTerm
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [AbstractRemainder] 時刻情報（大余小余）
+        attr_reader :remainder
+        # @return [AbstractRemainder] 気策（24分の1年）
+        attr_reader :average
+
+        # @return [Hash<Integer, Symbol>] 順序
+        ORDER = {
+          0 => :touji,
+          1 => :shoukan,
+          2 => :daikan,
+          3 => :risshun,
+          4 => :usui,
+          5 => :keichitsu,
+          6 => :shunbun,
+          7 => :seimei,
+          8 => :kokuu,
+          9 => :rikka,
+          10 => :shouman,
+          11 => :boushu,
+          12 => :geshi,
+          13 => :shousho,
+          14 => :taisho,
+          15 => :risshuu,
+          16 => :shosho,
+          17 => :hakuro,
+          18 => :shuubun,
+          19 => :kanro,
+          20 => :soukou,
+          21 => :rittou,
+          22 => :shousetsu,
+          23 => :taisetsu
+        }.freeze
+
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [AbstractRemainder] remainder 時刻情報（大余小余）
+        #
+        def initialize(index: -1, remainder: AbstractRemainder.new,
+                       average: AbstractRemainder.new)
+          @index = index
+          @remainder = remainder
+          @average = average
+        end
+
+        #
+        # 不正かどうか検証する
+        #
+        # @return [True] 正しくない
+        # @return [False] 正しい
+        #
+        def invalid?
+          (@index == -1 || @remainder.invalid?)
+        end
+
+        #
+        # データなしかを検証する
+        #
+        # @return [True] データなし
+        # @return [False] データあり
+        #
+        def empty?
+          (@index == -1 && @remainder.invalid?)
+        end
+
+        #
+        # 有効な二十四節気番号か
+        #
+        # @param [Integer] index 連番
+        #
+        # @return [True] 有効
+        # @return [False] 無効
+        #
+        def self.index?(index)
+          result = ORDER.fetch(index, -1)
+
+          result != -1
+        end
+
+        #
+        # 次の二十四節気に進める
+        #
+        def next_term!
+          @remainder = next_term
+        end
+
+        #
+        # 次の二十四節気に進める
+        #
+        def next_term
+          @index += 1
+          @index = 0 if @index >= ORDER.size
+
+          @remainder.add(@average)
+        end
+
+        #
+        # 指定した連番の二十四節気まで進める
+        #
+        # @param [Integer] index 連番
+        #
+        def next_by_index(index)
+          return ArgumentError.new, 'invalid index' unless AbstractSolarTerm.index?(index)
+
+          loop do
+            return if @index == index
+
+            next!
+          end
+        end
+
+        #
+        # 指定した連番の二十四節気まで戻す
+        #
+        # @param [Integer] index 連番
+        #
+        def prev_by_index(index)
+          return ArgumentError.new, 'invalid index' unless AbstractSolarTerm.index?(index)
+
+          loop do
+            return if @index == index
+
+            prev_term!
+          end
+        end
+
+        #
+        # 前の二十四節気に戻る
+        #
+        def prev_term!
+          @remainder = prev_term
+        end
+
+        #
+        # 前の二十四節気に戻る
+        #
+        def prev_term
+          @index -= 1
+          @index = 23 if @index.negative?
+
+          @remainder.sub(@average)
+        end
+
+        #
+        # ディープコピー
+        #
+        # @param [SolarTerm] obj 自身
+        #
+        def initialize_copy(obj)
+          @index = obj.index.clone
+          @remainder = obj.remainder.clone
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/cycle/zodiac.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Cycle
+      #
+      # Zodiac 十干十二支
+      #
+      module Zodiac
+        # @return [Hash<Integer, String>] 十干十二支
+        ZODIAC_NAME_PATTERNS = {
+          0 => '甲子',   # きのえね
+          1 => '乙丑',   # きのとうし
+          2 => '丙寅',   # ひのえとら
+          3 => '丁卯',   # ひのとう
+          4 => '戊辰',   # つちのえたつ
+          5 => '己巳',   # つちのとみ
+          6 => '庚午',   # かのえうま
+          7 => '辛未',   # かのとひつじ
+          8 => '壬申',   # みずのえさる
+          9 => '癸酉',   # みずのととり
+          10 => '甲戌',  # きのえいぬ
+          11 => '乙亥',  # きのとい
+          12 => '丙子',  # ひのえね
+          13 => '丁丑',  # ひのとうし
+          14 => '戊寅',  # つちのえとら
+          15 => '己卯',  # つちのとう
+          16 => '庚辰',  # かのえたつ
+          17 => '辛巳',  # かのとみ
+          18 => '壬午',  # みずのえうま
+          19 => '癸未',  # みずのとひつじ
+          20 => '甲申',  # きのえさる
+          21 => '乙酉',  # きのととり
+          22 => '丙戌',  # ひのえいぬ
+          23 => '丁亥',  # ひのとい
+          24 => '戊子',  # つちのえね
+          25 => '己丑',  # つちのとうし
+          26 => '庚寅',  # かのえとら
+          27 => '辛卯',  # かのとう
+          28 => '壬辰',  # みずのえたつ
+          29 => '癸巳',  # みずのとみ
+          30 => '甲午',  # きのえうま
+          31 => '乙未',  # きのとひつじ
+          32 => '丙申',  # ひのえさる
+          33 => '丁酉',  # ひのととり
+          34 => '戊戌',  # つちのえいぬ
+          35 => '己亥',  # つちのとい
+          36 => '庚子',  # かのえね
+          37 => '辛丑',  # かのとうし
+          38 => '壬寅',  # みずのえとら
+          39 => '癸卯',  # みずのとう
+          40 => '甲辰',  # きのえたつ
+          41 => '乙巳',  # きのとみ
+          42 => '丙午',  # ひのえうま
+          43 => '丁未',  # ひのとひつじ
+          44 => '戊申',  # つちのえさる
+          45 => '己酉',  # つちのととり
+          46 => '庚戌',  # かのえいぬ
+          47 => '辛亥',  # かのとい
+          48 => '壬子',  # みずのえね
+          49 => '癸丑',  # みずのとうし
+          50 => '甲寅',  # きのえとら
+          51 => '乙卯',  # きのとう
+          52 => '丙辰',  # ひのえたつ
+          53 => '丁巳',  # ひのとみ
+          54 => '戊午',  # つちのえうま
+          55 => '己未',  # つちのとひつじ
+          56 => '庚申',  # かのえさる
+          57 => '辛酉',  # かのととり
+          58 => '壬戌',  # みずのえいぬ
+          59 => '癸亥'   # みずのとい
+        }.freeze
+
+        # @return [Integer] 組み合わせ数
+        LENGTH = ZODIAC_NAME_PATTERNS.length
+
+        #
+        # 大余を十干十二支に変換する
+        #
+        # @param [Integer] day 大余
+        #
+        # @return [String] 十干十二支
+        #
+        def self.day_name(day:)
+          index = day % LENGTH
+
+          ZODIAC_NAME_PATTERNS[index]
+        end
+
+        #
+        # 西暦年を十干十二支に変換する
+        #
+        # @param [Integer] western_year 西暦年
+        #
+        # @return [String] 十干十二支
+        #
+        def self.year_name(western_year: 0)
+          ZODIAC_NAME_PATTERNS[(western_year - 4) % LENGTH]
+        end
+      end
+    end
+  end
+end

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