zakuro 0.9.1 → 0.9.3

data/lib/zakuro/calculation/monthly/meta/meta_collector.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative '../../../era/western/calendar'
+
+require_relative '../month'
+
+require_relative './all_solar_term'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Monthly
+      #
+      # MetaCollector メタ情報の収集
+      #
+      # 前月データを次のように扱う
+      # 1. 範囲内の最初の月は無視する
+      #   * 元号範囲は常に余裕を持って取っている
+      #   * 求めたい日付よりは常に1ヶ月以上を計算範囲にしている
+      #   * 元嘉暦の最初の月は無視する
+      #     * 元嘉暦は正月始まり
+      #     * 初めの月は手前の月がないため前月がない
+      #     * 没日・滅日の対象外のため不要とする
+      # 2. 年境界を解決した後の1年データで再度移行する
+      #   * 冬至データの最初の月には前月がない
+      #   * 1年データにすることで前月が生まれるので再度移行する
+      # 3. 暦の切り替えを考慮する
+      #   * 手前の月が異なる暦であれば、その月のデータを参照する
+      module MetaCollector
+        class << self
+          #
+          # メタ情報を取得する
+          #
+          # @param [Monthly::Month] before_month 前月
+          # @param [Monthly::Month] current_month 当月
+          #
+          # @return [Monthly::Meta] 当月のメタ情報
+          #
+          def get(before_month:, current_month:)
+            Monthly::Meta.new(
+              all_solar_terms: all_solar_terms(
+                before_month: before_month, current_month: current_month
+              ),
+              last_average_remainder: last_average_remainder(
+                before_month: before_month
+              )
+            )
+          end
+
+          private
+
+          #
+          # 全ての二十四節気を取得する
+          #
+          # @param [Monthly::Month] before_month 前月
+          # @param [Monthly::Month] current_month 当月
+          #
+          # @return [Array<Cycle::AbstractSolarTerm>] その月の全ての二十四節気
+          #
+          def all_solar_terms(before_month:, current_month:)
+            AllSolarTerm.get(before_month: before_month, current_month: current_month)
+          end
+
+          #
+          # 前月の経朔を取得する
+          #
+          # @param [Monthly::Month] before_month 前月
+          #
+          # @return [Cycle::AbstractRemainder] 前月の経朔
+          #
+          def last_average_remainder(before_month:)
+            before_month.first_day.average_remainder
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative '../cycle/abstract_remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Monthly
+      #
+      # Meta 付加情報
+      #
+      class Meta
+        # @return [Array<Cycle::AbstractSolarTerm>] 月の全ての二十四節気
+        # @note 前提として、『日本暦日原典』にある月ごとの二十四節気は、その月の全ての二十四節気ではない
+        #
+        # 下表を例に取った場合、『日本暦日原典』の二十四節気連番のうち、2と3がその月の二十四節気となる
+        # ここで、当月のうち2より手前の日は前月の1の二十四節気に属しており、当月だけでは参照できない
+        # この参照を可能とするための情報となる
+        #
+        # |No| 項目          | 前月                |  当月              | 次月                |
+        # |1 | 月            | month[index - 1]   |   month[index]    |   month[index + 1]  |
+        # |2 | 考えられる範囲  |                    |-------------------|                     |
+        # |3 | 二十四節気連番  | 0          1       |   2        3      |   4          5      |
+        # |4 | 二十四節気大余  | 55         10      |   25       40     |   55         5      |
+        #
+        attr_reader :all_solar_terms
+
+        # @return [Cycle::AbstractRemainder] 前月の平朔
+        # @note 滅日計算に用いる
+        #
+        #   月の1日目で前月からの平朔が用いられている
+        #
+        attr_reader :last_average_remainder
+
+        #
+        # 初期化
+        #
+        # @param [Array<AbstractSolarTerm>] all_solar_terms 月の全ての二十四節気
+        # @param [Cycle::AbstractRemainder] last_average_remainder 前月の平朔
+        #
+        def initialize(all_solar_terms: [], last_average_remainder: Cycle::AbstractRemainder.new)
+          @all_solar_terms = all_solar_terms
+          @last_average_remainder = last_average_remainder
+        end
+
+        #
+        # ディープコピー
+        #
+        # @param [Meta] obj 自身
+        #
+        def initialize_copy(obj)
+          @all_solar_terms = obj.all_solar_terms.clone
+          @last_average_remainder = obj.last_average_remainder.clone
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,9 @@
 
 require_relative '../base/gengou'
 require_relative './first_day'
+require_relative './meta'
 require_relative './month_label'
+require_relative './meta/meta_collector'
 
 # :nodoc:
 module Zakuro
@@ -20,10 +22,14 @@ module Zakuro
         attr_reader :month_label
         # @return [FirstDay] 月初日（朔日）
         attr_reader :first_day
-        # @return [Array<SolarTerm>] 二十四節気
+        # @return [Array<AbstractSolarTerm>] 二十四節気
         attr_reader :solar_terms
         # @return [Base::Gengou] 元号
         attr_reader :gengou
+        # @return [Meta] 付加情報
+        attr_reader :meta
+
+        # rubocop:disable Metrics/ParameterLists
 
         #
         # 初期化
@@ -31,18 +37,23 @@ module Zakuro
         # @param [Context::Context] context 暦コンテキスト
         # @param [MonthLabel] month_label 月表示名
         # @param [FirstDay] first_day 月初日（朔日）
-        # @param [Array<SolarTerm>] solar_terms 二十四節気
+        # @param [Array<AbstractSolarTerm>] solar_terms 二十四節気
         # @param [Base::Gengou] gengou 元号
+        # @param [Meta] meta 付加情報
         #
         def initialize(context: Context::Context.new, month_label: MonthLabel.new,
-                       first_day: FirstDay.new, solar_terms: [], gengou: Base::Gengou.new)
+                       first_day: FirstDay.new, solar_terms: [], gengou: Base::Gengou.new,
+                       meta: Meta.new)
           @context = context
           @month_label = month_label
           @first_day = first_day
           @solar_terms = solar_terms
           @gengou = gengou
+          @meta = meta
         end
 
+        # rubocop:enable Metrics/ParameterLists
+
         #
         # 不正か
         #
@@ -153,7 +164,7 @@ module Zakuro
         #
         # 中気を返す
         #
-        # @return [SolarTerm] 中気
+        # @return [Cycle::AbstractSolarTerm] 中気
         #
         def even_term
           solar_terms.each do |term|
@@ -166,7 +177,7 @@ module Zakuro
         #
         # 節気を返す
         #
-        # @return [SolarTerm] 節気
+        # @return [Cycle::AbstractSolarTerm] 節気
         #
         def odd_term
           solar_terms.each do |term|
@@ -250,6 +261,50 @@ module Zakuro
           same_by_japan_date?(date: date)
         end
 
+        #
+        # 大余に対応する二十四節気
+        #
+        # @param [Integer] day 大余
+        #
+        # @return [Cycle::AbstractSolarTerm] 二十四節気
+        #
+        def solar_term_by_day(day:)
+          # TODO: refactor
+          target = context.resolver.remainder.new(day: day, minute: 0, second: 0)
+
+          meta.all_solar_terms.each_cons(2) do |current_solar_term, next_solar_term|
+            in_range = Tools::RemainderComparer.in_range?(
+              target: target, start: current_solar_term.remainder, last: next_solar_term.remainder
+            )
+            return current_solar_term if in_range
+          end
+
+          last_solar_term = meta.all_solar_terms[-1]
+
+          empty_solar_term = context.resolver.solar_term.new
+
+          return empty_solar_term unless last_solar_term
+          # NOTE: 大余20を上限として範囲チェックする
+          if Tools::RemainderComparer.in_limit?(target: target, start: last_solar_term.remainder,
+                                                limit: 20)
+            return last_solar_term
+          end
+
+          empty_solar_term
+        end
+
+        #
+        # メタ情報を再設定する
+        #
+        # @param [Month] last 前月
+        #
+        def reset_meta(last: Month.new)
+          @meta = MetaCollector.get(
+            before_month: last,
+            current_month: self
+          )
+        end
+
         private
 
         #

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

@@ -33,12 +33,13 @@ module Zakuro
         # @param [FirstDay] first_day 月初日（朔日）
         # @param [Array<SolarTerm>] solar_terms 二十四節気
         # @param [Operation::MonthHistory] history 変更履歴（月）
+        # @param [Meta] meta 付加情報
         #
         def initialize(context:, operated_solar_term:, month_label: MonthLabel.new,
                        first_day: FirstDay.new, solar_terms: [], gengou: Base::Gengou.new,
-                       history: Operation::MonthHistory.new)
+                       history: Operation::MonthHistory.new, meta: Meta.new)
           super(context: context, month_label: month_label, first_day: first_day,
-                solar_terms: solar_terms, gengou: gengou)
+                solar_terms: solar_terms, gengou: gengou, meta: meta)
           @history = history
           @operated_solar_term = operated_solar_term
           @moved = false
@@ -101,7 +102,9 @@ module Zakuro
 
           @first_day = FirstDay.new(
             western_date: rewrite_western_date(days: days),
-            remainder: rewrite_remainder(days: days)
+            remainder: rewrite_remainder(days: days),
+            # NOTE: 『日本暦日便覧』では滅日を計算値で求めている。運用値への書き換えは実施しない
+            average_remainder: first_day.average_remainder.clone
           )
         end
 

data/lib/zakuro/calculation/option/dropped_date/location.rb

@@ -24,8 +24,8 @@ module Zakuro
           attr_reader :limit
           # @return [Integer] 年
           attr_reader :year
-          # @return [Array<Cycle::AbstractSolarTerm>] 二十四節気
-          attr_reader :solar_terms
+          # @return [Cycle::AbstractSolarTerm] 二十四節気
+          attr_reader :solar_term
           # @return [Class] 没余クラス
           attr_reader :remainder_class
 
@@ -33,16 +33,16 @@ module Zakuro
           # 初期化
           #
           # @param [Context::Context] context 暦コンテキスト
-          # @param [Array<Cycle::AbstractSolarTerm>] solar_terms 二十四節気
+          # @param [Cycle::AbstractSolarTerm] solar_term 二十四節気
           #
-          def initialize(context:, solar_terms: [])
+          def initialize(context:, solar_term:)
             parameter = context.resolver.dropped_date_parameter.new
             @context = context
             @valid = parameter.valid
             @limit = parameter.limit
             @year = parameter.year
             @remainder_class = parameter.remainder_class
-            @solar_terms = solar_terms
+            @solar_term = solar_term
           end
 
           #
@@ -73,36 +73,25 @@ module Zakuro
           def get
             # 1. 二十四節気の大余小余を取り出す
             remainder = solar_term_remainder
+
+            # p "remainder: #{remainder.format(form: '%d-%d.%.5f')}"
+
             # 2. 小余360、秒45（360/8）で乗算する
             total = multiple_ideal_year(remainder: remainder)
+            # p "total: #{total}"
             # 3. 上記2と章歳（3068055）の差を求める
             diff = (year - total).abs
+            # p "year: #{year}"
+            # p "diff: #{diff}"
             # 4. 上記3を通余で徐算する
             result = remainder_class.new(total: diff)
+            # p "result: #{result.format(form: '%d-%d.%.5f')}"
             # 5. 上記4の商と上記1の大余が没日大余、余りが小余（没余）
             day = remainder_class.new(day: remainder.day, minute: 0, second: 0)
 
             day.add(result)
           end
 
-          #
-          # 該当の二十四節気を取得する
-          #
-          # @return [Cycle::AbstractSolarTerm] 二十四節気
-          #
-          def solar_term
-            solar_terms.each do |solar_term|
-              remainder = solar_term.remainder.clone
-              minute_later = remainder.class.new(
-                day: 0, minute: remainder.minute, second: remainder.second
-              )
-
-              return solar_term if minute_later >= limit
-            end
-
-            context.resolver.solar_term.new
-          end
-
           private
 
           #

data/lib/zakuro/calculation/option/vanished_date/location.rb

@@ -72,10 +72,17 @@ module Zakuro
           #
           def get
             # 経朔の小余 * 30
-            minute = remainder_class.new(day: 0, minute: IDEAL_MONTH * average_remainder.minute, second: 0)
+            minute = remainder_class.new(
+              day: 0, minute: IDEAL_MONTH * average_remainder.minute, second: 0
+            )
+
             day = remainder_class.new(day: average_remainder.day, minute: 0, second: 0)
 
-            minute.add(day)
+            minute.add!(day)
+
+            # p "location.minute: #{minute.format}"
+
+            minute
           end
         end
       end

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

@@ -20,8 +20,6 @@ module Zakuro
   module Calculation
     # :nodoc:
     module Range
-      # :reek:TooManyInstanceVariables { max_instance_variables: 6 }
-
       #
       # FullRange 完全範囲
       #   ある日からある日の範囲を計算可能な年月範囲
@@ -89,6 +87,8 @@ module Zakuro
 
           Transfer::GengouScroller.set(scroll: scroll, years: years)
 
+          reset_meta(years: years)
+
           years
         end
 
@@ -104,6 +104,7 @@ module Zakuro
           last_year = scroll.western_last_year
 
           # TODO: context にデフォルト暦名が設定されている場合は使用しない
+          #  現在は暦ごとの元号情報がないため使用できない
           versions = Version.get(start_year: start_year, last_year: last_year)
 
           collect_version_ranges(versions: versions, start_year: start_year, last_year: last_year)
@@ -181,6 +182,22 @@ module Zakuro
 
           result
         end
+
+        #
+        # メタ情報を更新する
+        #
+        # @param [Array<Base::Year>] years 完全範囲
+        #
+        def reset_meta(years: [])
+          months = []
+          years.each do |year|
+            months |= year.months
+          end
+
+          months.each_cons(2) do |last, current|
+            current.reset_meta(last: last)
+          end
+        end
       end
     end
   end

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

@@ -53,6 +53,8 @@ module Zakuro
 
           Transfer::GengouScroller.set(scroll: @scroll, years: operated_years)
 
+          self.class.reset_meta(years: operated_years)
+
           operated_years
         end
 
@@ -172,20 +174,36 @@ module Zakuro
           # @param [Operation::MonthHistory] history 変更履歴
           # @param [OperatedSolarTerm] operated_solar_term 運用時二十四節気
           #
-          # @return [Month] 月（運用結果）
+          # @return [Monthly::Month] 月（運用結果）
           #
           def rewrite_month(context:, month:, history:, operated_solar_term:)
             operated_month = Monthly::OperatedMonth.new(
               context: context,
               month_label: month.month_label, first_day: month.first_day,
               solar_terms: month.solar_terms, history: history, gengou: month.gengou,
-              operated_solar_term: operated_solar_term
+              operated_solar_term: operated_solar_term, meta: month.meta
             )
 
             operated_month.rewrite unless history.invalid?
 
             operated_month
           end
+
+          #
+          # メタ情報を更新する
+          #
+          # @param [Array<Base::Year>] years 完全範囲
+          #
+          def reset_meta(years: [])
+            months = []
+            years.each do |year|
+              months |= year.months
+            end
+
+            months.each_cons(2) do |last, current|
+              current.reset_meta(last: last)
+            end
+          end
         end
       end
     end

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

@@ -22,7 +22,9 @@ module Zakuro
         #
         def initialize(context:,
                        start_date: Western::Calendar.new, last_date: Western::Calendar.new)
-          scroll = Gengou::DatedScroll.new(start_date: start_date, last_date: last_date)
+          scroll = Gengou::DatedScroll.new(
+            start_date: start_date, last_date: last_date, operated: false
+          )
 
           super(context: context, scroll: scroll, start_date: start_date, last_date: last_date)
         end

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

@@ -24,7 +24,9 @@ module Zakuro
         #
         def initialize(context:, start_date: Western::Calendar.new,
                        last_date: Western::Calendar.new, years: [])
-          scroll = Gengou::DatedScroll.new(start_date: start_date, last_date: last_date)
+          scroll = Gengou::DatedScroll.new(
+            start_date: start_date, last_date: last_date, operated: true
+          )
           super(context: context, scroll: scroll, years: years)
         end
       end

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

@@ -63,7 +63,7 @@ module Zakuro
             result = []
 
             # 14ヶ月分を生成する（閏年で最大13ヶ月 + 末月の大小/二十四節気を求めるために必要な月）
-            (0..13).each do |_index|
+            14.times.each do |_index|
               average_remainder = lunar_phase.average_remainder.clone
               adjusted = lunar_phase.next_month
 

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

@@ -24,7 +24,9 @@ module Zakuro
         # @param [String] last_name 終了元号名
         #
         def initialize(context:, start_name: INVALID_NAME, last_name: INVALID_NAME)
-          scroll = Gengou::NamedScroll.new(start_name: start_name, last_name: last_name)
+          scroll = Gengou::NamedScroll.new(
+            start_name: start_name, last_name: last_name, operated: false
+          )
           range = scroll.range
 
           super(

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

@@ -26,7 +26,9 @@ module Zakuro
         # @param [Array<Year>] years 年データ（完全範囲）
         #
         def initialize(context:, start_name: INVALID_NAME, last_name: INVALID_NAME, years: [])
-          scroll = Gengou::NamedScroll.new(start_name: start_name, last_name: last_name)
+          scroll = Gengou::NamedScroll.new(
+            start_name: start_name, last_name: last_name, operated: true
+          )
 
           super(context: context, scroll: scroll, years: years)
         end

data/lib/zakuro/calculation/range/transfer/gengou_scroller.rb

@@ -46,7 +46,8 @@ module Zakuro
                     average_remainder: month.first_day.average_remainder,
                     western_date: gengou.start_date.clone
                   ),
-                  solar_terms: month.solar_terms, gengou: gengou
+                  solar_terms: month.solar_terms, gengou: gengou,
+                  meta: month.meta
                 )
               end
             end

data/lib/zakuro/calculation/range/transfer/year_boundary.rb

@@ -21,12 +21,13 @@ module Zakuro
             # 年間範囲内の年データの開始月を変更する
             #
             # @param [Context::Context] context 暦コンテキスト
-            # @param [Array<Base::Year>] annual_ranges 年データ（冬至基準）
+            # @param [Array<Array<Monthly::Month>>] annual_ranges 年データ（冬至基準）
             #
             # @return [Array<Base::Year>] 年データ（元旦基準）
             #
             def get(context:, annual_ranges:)
               categorize(context: context, annual_ranges: annual_ranges)
+
               rearranged_years(context: context, annual_ranges: annual_ranges)
             end
 
@@ -36,7 +37,7 @@ module Zakuro
             # 年間範囲内の年データの開始月を変更する
             #
             # @param [Context::Context] context 暦コンテキスト
-            # @param [Array<Base::Year>] annual_ranges 年データ（冬至基準）
+            # @param [Array<Array<Monthly::Month>>] annual_ranges 年データ（冬至基準）
             #
             # @return [Array<Base::Year>] 年データ（元旦基準）
             #
@@ -57,7 +58,7 @@ module Zakuro
             # 年間範囲を昨年/今年で分類する
             #
             # @param [Context::Context] context 暦コンテキスト
-            # @param [Array<Base::Year>] annual_range 1年データ
+            # @param [Array<Array<Monthly::Month>>] annual_range 1年データ
             #
             def categorize(context:, annual_ranges:)
               annual_ranges.each do |annual_range|
@@ -69,7 +70,7 @@ module Zakuro
             # 各月を昨年/今年で分類する
             #
             # @param [Context::Context] context 暦コンテキスト
-            # @param [Array<Month>] annual_range 1年データ
+            # @param [Array<Monthly::Month>] annual_range 1年データ
             #
             def categorize_year(context:, annual_range:)
               is_last_year = true
@@ -80,7 +81,8 @@ module Zakuro
                   context: context,
                   month_label: month.month_label, first_day: month.first_day,
                   solar_terms: month.solar_terms, phase_index: month.phase_index,
-                  is_last_year: is_last_year
+                  is_last_year: is_last_year,
+                  meta: month.meta
                 )
               end
             end
@@ -89,7 +91,7 @@ module Zakuro
             # 年データの開始月を変更する
             #
             # @param [Context::Context] context 暦コンテキスト
-            # @param [Array<Base::Year>] annual_ranges 年データ（冬至基準）
+            # @param [Array<Array<Monthly::Month>>] annual_ranges 年データ（冬至基準）
             # @param [Integer] index 対象年の要素番号
             #
             # @return [Base::Year] 年データ（元旦基準）
@@ -108,7 +110,7 @@ module Zakuro
             # 当年データを生成する
             #
             # @param [Context::Context] context 暦コンテキスト
-            # @param [Array<Month>] annual_range 1年データ
+            # @param [Array<Monthly::Month>] annual_range 1年データ
             #
             # @return [Base::Year] 当年月ありの対象年
             #
@@ -126,7 +128,7 @@ module Zakuro
             #
             # 昨年データを生成する
             #
-            # @param [Array<Month>] annual_range 1年データ
+            # @param [Array<Monthly::Month>] annual_range 1年データ
             # @param [Base::Year] year 対象年
             #
             # @return [Base::Year] 昨年月ありの対象年