zakuro 0.1.5 → 0.5.0

data/lib/zakuro/calculation/base/operated_year.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative './year'
+require_relative './multi_gengou'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Base
+      #
+      # OperatedYear 年（運用）
+      #
+      class OperatedYear < Year
+        #
+        # 初期化
+        #
+        # @param [Gengou] multi_gengou 元号
+        # @param [Array<OperatedMonth>] months 年内の全ての月
+        # @param [Integer] total_days 年の日数
+        # @param [Western::Calendar] new_year_date 元旦
+        #
+        def initialize(multi_gengou: MultiGengou.new, new_year_date: Western::Calendar.new,
+                       months: [], total_days: 0)
+          super(multi_gengou: multi_gengou, new_year_date: new_year_date,
+                months: months, total_days: total_days)
+        end
+
+        def commit
+          super
+
+          return if months.empty?
+
+          @new_year_date = months[0].first_day.western_date
+        end
+
+        #
+        # 引数を月の先頭に加える
+        #
+        # @param [Array<OperatedMonth>] first_months 先頭の月
+        #
+        def unshift_months(first_months)
+          # 逆順で加える
+          first_months.reverse_each do |month|
+            month.moved
+            months.unshift(month)
+          end
+        end
+
+        #
+        # 引数を月の最後に加える
+        #
+        # @param [Array<OperatedMonth>] last_months 最後の月
+        #
+        def push_months(last_months)
+          last_months.each do |month|
+            month.moved
+            months.push(month)
+          end
+        end
+
+        #
+        # 昨年に属する月を取り出す
+        #
+        # @return [Array<OperatedMonth>] 昨年に属する月
+        #
+        def shift_last_year_months
+          result, @months = OperatedYear.devide_with(method: :last_year?, arr: months)
+
+          result
+        end
+
+        #
+        # 来年に属する月を取り出す
+        #
+        # @return [Array<OperatedMonth>] 来年に属する月
+        #
+        def pop_next_year_months
+          result, @months = OperatedYear.devide_with(method: :next_year?, arr: months)
+
+          result
+        end
+
+        # :reek:TooManyStatements { max_statements: 8 }
+
+        #
+        # メソッドで配列を分離する
+        #
+        # @param [Symbol] method 条件メソッド
+        # @param [Array<Object>] arr 配列
+        #
+        # @return [Array<Object>] 一致配列
+        # @return [Array<Object>] 不一致配列
+        #
+        def self.devide_with(method:, arr: [])
+          match = []
+          unmatch = []
+
+          arr.each do |item|
+            if !item.moved? && item.send(method)
+              match.push(item)
+              next
+            end
+
+            unmatch.push(item)
+          end
+
+          [match, unmatch]
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/base/year.rb

@@ -25,6 +25,9 @@ module Zakuro
         # 初期化
         #
         # @param [Gengou] multi_gengou 元号
+        # @param [Array<Month>] months 年内の全ての月
+        # @param [Integer] total_days 年の日数
+        # @param [Western::Calendar] new_year_date 元旦
         #
         def initialize(multi_gengou: MultiGengou.new, new_year_date: Western::Calendar.new,
                        months: [], total_days: 0)

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

@@ -10,6 +10,11 @@ module Zakuro
       # 大余小余（時刻情報）
       # @abstract 大余小余計算に必要な処理を行う、暦に依存しない汎用的なクラス
       #
+      # * 十干十二支（60日）を上限とした「日時分秒」の情報で、日付（date）/時刻（time）と部分的に重なる概念
+      # * 「15日1012分5秒」のような形式で表される
+      # * 分の上限で大余に繰り上げる
+      # * 秒の上限で1分に繰り上げる
+      #
       class AbstractRemainder # rubocop:disable Metrics/ClassLength
         # @return [Integer] 大余上限
         LIMIT = 60
@@ -224,8 +229,7 @@ module Zakuro
         # @return [False] より小さい
         #
         def >=(other)
-          up?(other) || \
-            (@day == other.day && @minute == other.minute && @second == other.second)
+          up?(other) || eql?(other)
         end
 
         #
@@ -249,8 +253,7 @@ module Zakuro
         # @return [False] より大きい
         #
         def <=(other)
-          down?(other) || \
-            (@day == other.day && @minute == other.minute && @second == other.second)
+          down?(other) || eql?(other)
         end
 
         #
@@ -339,10 +342,19 @@ module Zakuro
         # @return [Integer] 小余（秒切り捨て）
         #
         def floor_minute
-          result = @minute + @second / @base_minute
+          result = float_minute
           result.floor
         end
 
+        #
+        # 秒を含めた小余を返す
+        #
+        # @return [Float] 小余
+        #
+        def float_minute
+          @minute + @second.to_f / @base_minute
+        end
+
         #
         # 大余に四捨五入した結果を返す（秒は除外する）
         #
@@ -365,26 +377,18 @@ module Zakuro
         end
 
         #
-        # 特定の文字フォーマットにして出力する
+        # 繰り上げる
         #
-        # @param [String] form フォーマット（大余、小余、秒それぞれを%dで指定する）
+        # @return [AbstractRemainder] 繰り上げ結果
         #
-        # @return [String] フォーマットした結果
-        #
-        def format(form: '%d-%d')
-          return '' if invalid?
+        def carry!
+          @day, @minute, @second = carry(@day, @minute, @second)
 
-          super(form, @day, @minute, @second)
+          self
         end
 
         private
 
-        def carry!(day, minute, second)
-          @day, @minute, @second = carry(day, minute, second)
-
-          self
-        end
-
         # 繰り上げ、繰り下げ
         def carry(param_day, param_minute, param_second)
           # NOTE: 計算方法としてマイナスでも徐算・剰余算の結果をプラス同様に扱う
@@ -437,33 +441,29 @@ module Zakuro
         def up?(other)
           invalid?(param: other)
           day = other.day
-          minute = other.minute
+          minute = other.float_minute
+
           return true if @day > day
           return false if @day < day
 
-          return true if @minute > minute
-          return false if @minute < minute
-
-          @second > other.second
+          float_minute > minute
         end
 
         def eql?(other)
           invalid?(param: other)
 
-          (@day == other.day && @minute == other.minute && @second == other.second)
+          (@day == other.day && float_minute == other.float_minute)
         end
 
         def down?(other)
           invalid?(param: other)
           day = other.day
-          minute = other.minute
+          minute = other.float_minute
+
           return true if @day < day
           return false if @day > day
 
-          return true if @minute < minute
-          return false if @minute > minute
-
-          @second < other.second
+          float_minute < minute
         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

data/lib/zakuro/calculation/monthly/first_day.rb

@@ -23,7 +23,7 @@ module Zakuro
         # @param [Remainder] remainder 西暦日
         # @param [Western::Calendar] western_date 大余小余
         #
-        def initialize(western_date: Western::Calendar.new, remainder: Remainder.new)
+        def initialize(western_date: Western::Calendar.new, remainder:)
           # 西暦日
           @western_date = western_date
           # 大余小余

data/lib/zakuro/calculation/monthly/operated_month.rb

@@ -9,7 +9,7 @@ module Zakuro
   module Calculation
     # :nodoc:
     module Monthly
-      # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+      # :reek:TooManyInstanceVariables { max_instance_variables: 6 }
 
       #
       # OperatedMonth 月情報（運用）
@@ -40,6 +40,7 @@ module Zakuro
                 solar_terms: solar_terms)
           @history = history
           @operated_solar_terms = operated_solar_terms
+          @moved = false
         end
 
         # rubocop:enable Metrics/ParameterLists
@@ -99,9 +100,9 @@ module Zakuro
         end
 
         #
-        # <Description>
+        # 運用情報によって改変した二十四節気を作成する
         #
-        # @param [<Type>] operated_solar_term <description>
+        # @param [<Type>] operated_solar_term 運用情報（二十四節気）
         # @param [Array<SolarTerm>] solar_terms 二十四節気
         #
         # @return [Array<SolarTerm>] 二十四節気
@@ -203,6 +204,49 @@ module Zakuro
 
           western_date
         end
+
+        #
+        # 運用情報では昨年の月か
+        #
+        # @return [True] 昨年の月
+        # @return [False] 今年/来年の月
+        #
+        def last_year?
+          history_month_number.last_year?
+        end
+
+        #
+        # 運用情報では来年の月か
+        #
+        # @return [True] 来年の月
+        # @return [False] 今年/昨年の月
+        #
+        def next_year?
+          history_month_number.next_year?
+        end
+
+        #
+        # 別の年に移動したか
+        #
+        # @return [True] 移動済
+        # @return [False] 移動なし
+        #
+        def moved?
+          @moved
+        end
+
+        #
+        # 移動済とする
+        #
+        def moved
+          @moved = true
+        end
+
+        private
+
+        def history_month_number
+          @history.diffs.month.number
+        end
       end
     end
   end

data/lib/zakuro/calculation/range/medieval_annual_range.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative '../../output/logger'
+require_relative '../monthly/initialized_month'
+require_relative '../monthly/month_label'
+require_relative '../monthly/first_day'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Range
+      #
+      # MedievalAnnualRange 年間範囲（中世）
+      #
+      # * 儀鳳暦 ～ 宣明暦 を便宜的に中世とした
+      # * 冬至から1年の開始を算出する
+      # * 二十四節気：平気法
+      # * 月の大小：定朔
+      #
+      module MedievalAnnualRange
+        # @return [Output::Logger] ロガー
+        LOGGER = Output::Logger.new(location: 'medieval_annual_range')
+
+        #
+        # 一覧取得する
+        #
+        #   * 対象年に対して、前年11月-当年11月までを出力する
+        #   * 対象年（西暦）と計算年（元号x年）の紐付けは行わない
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Monthly::AbstractLunarPhase] lunar_phase 月の位相
+        # @param [Solar::AbstractAverage] solar_average 定気（太陽軌道平均）
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def self.get(context:, lunar_phase:, solar_average:)
+          annual_range = initialized_annual_range(context: context, lunar_phase: lunar_phase)
+
+          apply_big_and_small_of_the_month(annual_range: annual_range)
+
+          solar_average.set(annual_range: annual_range)
+
+          # 月間隔を取得するためだけの末尾要素を削除
+          annual_range.pop
+
+          initialize_month_label(annual_range: annual_range)
+        end
+
+        #
+        # 1年データを取得する
+        #
+        # @param [Context] context 暦コンテキスト
+        # @param [Monthly::LunarPhase] lunar_phase 月の位相
+        #
+        # @return [Array<Month>] 1年データ
+        #
+        def self.initialized_annual_range(context:, lunar_phase:)
+          result = []
+
+          # 14ヶ月分を生成する（閏年で最大13ヶ月 + 末月の大小/二十四節気を求めるために必要な月）
+          (0..13).each do |_index|
+            adjusted = lunar_phase.next_month
+
+            result.push(
+              Monthly::InitializedMonth.new(
+                context: context,
+                month_label: Monthly::MonthLabel.new,
+                first_day: Monthly::FirstDay.new(remainder: adjusted),
+                phase_index: 0
+              )
+            )
+          end
+
+          result
+        end
+        private_class_method :initialized_annual_range
+
+        #
+        # 1年データの各月に月の大小を設定する
+        #
+        # @param [Array<Month>] annual_range 1年データ
+        #
+        def self.apply_big_and_small_of_the_month(annual_range:)
+          # NOTE: 最後の月は処理できない（=計算外の余分な月が最後に必要である）
+          annual_range.each_cons(2) do |(current_month, next_month)|
+            current_month.eval_many_days(next_month_day: next_month.remainder.day)
+          end
+        end
+        private_class_method :apply_big_and_small_of_the_month
+
+        #
+        # 月表示情報を更新する
+        #
+        # @param [Array<Month>] annual_range 1年データ
+        #
+        def self.initialize_month_label(annual_range:)
+          annual_range.each(&:rename_month_label_by_solar_term)
+        end
+        private_class_method :initialize_month_label
+      end
+    end
+  end
+end