zakuro 0.0.2 → 0.1.3

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative '../../era/japan/gengou'
+require_relative '../../era/western'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Base
+      #
+      # MultiGengou 複数元号
+      #
+      class MultiGengou
+        # @return [Japan::Gengou] 元号（1行目）
+        attr_reader :first_line
+        # @return [Japan::Gengou] 元号（2行目）
+        attr_reader :second_line
+        # @return [Western::Calendar] 元旦
+        attr_reader :new_year_date
+
+        def initialize(first_line: Japan::Gengou.new, second_line: Japan::Gengou.new,
+                       new_year_date: Western::Calendar.new)
+          @first_line = first_line
+          @second_line = second_line
+          @new_year_date = new_year_date
+        end
+
+        # :reek:TooManyStatements { max_statements: 7 }
+
+        #
+        # 改元する
+        #
+        # @param [Japan::Gengou] first_line 元号（1行目）
+        # @param [Japan::Gengou] second_line 元号（2行目）
+        #
+        # @return [MultiGengou] 自身
+        #
+        def transfer(first_line: Japan::Gengou.new, second_line: Japan::Gengou.new)
+          cloned_first_line = first_line.clone
+          cloned_second_line = second_line.clone
+
+          if integrated?(first_line: cloned_first_line, second_line: cloned_second_line)
+            @first_line = @second_line.clone
+            @second_line = cloned_second_line
+          end
+
+          @first_line = cloned_first_line if @first_line.name != first_line.name
+          @second_line = cloned_second_line if @second_line.name != second_line.name
+
+          self
+        end
+
+        #
+        # 次年にする
+        #
+        # @param [Japan::Gengou] first_line 元号（1行目）
+        # @param [Japan::Gengou] second_line 元号（2行目）
+        #
+        # @return [MultiGengou] 自身
+        #
+        def next_year
+          @first_line.next_year
+          @second_line.next_year
+
+          self
+        end
+
+        #
+        # ディープコピー
+        #
+        # @param [MultiGengou] obj 自身
+        #
+        def initialize_copy(obj)
+          @first_line = obj.first_line.clone
+          @second_line = obj.second_line.clone
+        end
+
+        private
+
+        #
+        # 複数元号を統一するかどうか
+        #
+        # @param [Japan::Gengou] first_line 元号（1行目）
+        # @param [Japan::Gengou] second_line 元号（2行目）
+        #
+        # @return [True] 統一する
+        # @return [False] 統一しない
+        #
+        def integrated?(first_line: Japan::Gengou.new, second_line: Japan::Gengou.new)
+          return false if @second_line.name != first_line.name
+
+          return false unless second_line.invalid?
+
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require_relative './multi_gengou'
+
+require_relative '../../era/japan/gengou'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Base
+      #
+      # MultiGengouRoller 改元処理
+      #
+      class MultiGengouRoller
+        # @return [MultiGengou] 複数元号
+        attr_reader :multi_gengou
+        # @return [Western::Calendar] 元旦（元号が2つある場合は再過去の日付になる）
+        attr_reader :oldest_date
+        # @return [Western::Calendar] 元号内での最未来日（元号が2つある場合は再未来の日付になる）
+        attr_reader :newest_date
+        # @return [Western::Calendar] 現在日
+        attr_reader :current_date
+
+        def initialize(start_date: Western::Calendar.new, end_date: Western::Calendar.new)
+          end_date = start_date if end_date.invalid?
+
+          @oldest_date = MultiGengouRoller.choise_oldest_gengou_date(
+            first_line: MultiGengouRoller.first_line(date: start_date),
+            second_line: MultiGengouRoller.second_line(date: start_date)
+          )
+          @current_date = @oldest_date.clone
+          @newest_date = MultiGengouRoller.choise_newest_gengou_date(
+            first_line: MultiGengouRoller.first_line(date: end_date),
+            second_line: MultiGengouRoller.second_line(date: end_date)
+          )
+
+          @multi_gengou = MultiGengou.new(
+            first_line: current_first_line,
+            second_line: current_second_line,
+            new_year_date: @oldest_date
+          )
+        end
+
+        #
+        # 現在日付を未来に進める
+        #
+        # @param [<Type>] days <description>
+        #
+        # @return [<Type>] <description>
+        #
+        def next(days: 0)
+          @current_date += days
+        end
+
+        #
+        # 現在日から元号（1行目）を取得する
+        #
+        # @return [Japan::Gengou] 元号（1行目）
+        #
+        def current_first_line
+          MultiGengouRoller.first_line(date: @current_date)
+        end
+
+        #
+        # 現在日から元号（2行目）を取得する
+        #
+        # @return [Japan::Gengou] 元号（2行目）
+        #
+        def current_second_line
+          MultiGengouRoller.second_line(date: @current_date)
+        end
+
+        #
+        # 改元する
+        #
+        # @return [MultiGengou] 複数元号
+        #
+        def transfer
+          MultiGengouRoller.transfer(multi_gengou: @multi_gengou, date: @current_date)
+        end
+
+        #
+        # 次年にする
+        #
+        # @return [MultiGengou] 複数元号
+        #
+        def next_year
+          @multi_gengou.next_year
+        end
+
+        #
+        # 元号（1行目）を取得する
+        #
+        # @return [Japan::Gengou] 元号（1行目）
+        #
+        def self.first_line(date: Western::Calender.new)
+          Japan::GengouResource.first_line(date: date)
+        end
+
+        #
+        # 元号（2行目）を取得する
+        #
+        # @return [Japan::Gengou] 元号（2行目）
+        #
+        def self.second_line(date: Western::Calender.new)
+          Japan::GengouResource.second_line(date: date)
+        end
+
+        #
+        # 改元する
+        #
+        # @param [MultiGengou] multi_gengou 複数元号
+        # @param [Western::Calendar] date 対象日
+        #
+        # @return [MultiGengou] 改元済み複数元号
+        #
+        def self.transfer(multi_gengou:, date:)
+          multi_gengou.transfer(
+            first_line: first_line(date: date),
+            second_line: second_line(date: date)
+          )
+
+          multi_gengou
+        end
+
+        #
+        # 現在日からみて直近の未来に対する元号の切替前日を求める
+        # @note 2つの元号が重複した場合はより過去の日となる
+        #
+        # @param [Japan::Gengou] first_line 元号（1行目）
+        # @param [Japan::Gengou] second_line 元号（2行目）
+        #
+        # @return [Western::Calendar] 元号の切替前日
+        #
+        def choise_nearest_end_date
+          condition = lambda do |first_date, second_date|
+            first_date < second_date ? first_date : second_date
+          end
+
+          second_line = current_second_line
+
+          MultiGengouRoller.choise_date(condition: condition, second_line: second_line,
+                                        first_date: current_first_line.end_date.clone,
+                                        second_date: second_line.end_date.clone)
+        end
+
+        #
+        # 最過去の元旦を求める
+        # @note 2つの元号が重複した場合はより過去の日となる
+        #
+        # @param [Japan::Gengou] first_line 元号（1行目）
+        # @param [Japan::Gengou] second_line 元号（2行目）
+        #
+        # @return [Western::Calendar] 最過去の元旦
+        #
+        def self.choise_oldest_gengou_date(first_line:, second_line:)
+          condition = lambda do |first_date, second_date|
+            first_date < second_date ? first_date : second_date
+          end
+          choise_date(condition: condition, second_line: second_line,
+                      first_date: first_line.new_year_date.clone,
+                      second_date: second_line.new_year_date.clone)
+        end
+
+        #
+        # 元号内での最未来日を求める
+        # @note 2つの元号が重複した場合はより未来の日となる
+        #
+        # @param [Japan::Gengou] first_line 元号（1行目）
+        # @param [Japan::Gengou] second_line 元号（2行目）
+        #
+        # @return [Western::Calendar] 最未来日
+        #
+        def self.choise_newest_gengou_date(first_line:, second_line:)
+          condition = lambda do |first_date, second_date|
+            first_date > second_date ? first_date : second_date
+          end
+          choise_date(condition: condition, second_line: second_line,
+                      first_date: first_line.end_date.clone,
+                      second_date: second_line.end_date.clone)
+        end
+
+        # :reek:LongParameterList {max_params: 4}
+
+        #
+        # 条件を元に日付を求める
+        #
+        # @param [Proc] condition 比較条件
+        # @param [Japan::Gengou] second_line 元号（2行目）
+        # @param [Western::Calendar] first_date 比較対象（1行目）
+        # @param [Western::Calendar] second_date 比較対象（2行目）
+        #
+        # @return [Western::Calendar] 比較結果
+        #
+        def self.choise_date(condition:, second_line:, first_date:, second_date:)
+          # first_lineは常に存在する
+          return first_date if second_line.invalid?
+
+          condition.call(first_date, second_date)
+        end
+
+        #
+        # ディープコピー
+        #
+        # @param [MultiGengou] obj 自身
+        #
+        def initialize_copy(obj)
+          @oldest_date = obj.oldest_date.clone
+          @current_date = obj.current_date.clone
+          @newest_date = obj.newest_date.clone
+          @multi_gengou = obj.multi_gengou.clone
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative '../cycle/zodiac'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Base
+      #
+      # Year 年
+      #
+      class Year
+        # @return [Gengou] 元号
+        attr_reader :multi_gengou
+        # @return [Array<Month>] 年内の全ての月
+        attr_reader :months
+        # @return [Integer] 年の日数
+        attr_reader :total_days
+        # @return [Western::Calendar] 元旦
+        attr_reader :new_year_date
+
+        #
+        # 初期化
+        #
+        # @param [Gengou] multi_gengou 元号
+        #
+        def initialize(multi_gengou: MultiGengou.new, new_year_date: Western::Calendar.new,
+                       months: [], total_days: 0)
+          @multi_gengou = multi_gengou
+          @months = months
+          @new_year_date = new_year_date
+          @total_days = total_days
+        end
+
+        #
+        # 年の日数を確定する
+        #
+        def commit
+          @total_days = 0
+          months.each do |month|
+            @total_days += month.days
+          end
+
+          self
+        end
+
+        #
+        # 次年にする
+        #
+        # @param [Japan::Gengou] first_line 元号（1行目）
+        # @param [Japan::Gengou] second_line 元号（2行目）
+        #
+        # @return [MultiGengou] 自身
+        #
+        def next_year
+          @multi_gengou.next_year
+
+          @new_year_date += @total_days
+          @total_days = 0
+
+          self
+        end
+
+        #
+        # 十干十二支を取得する
+        #
+        # @return [String] 十干十二支
+        #
+        def zodiac_name
+          Cycle::Zodiac.year_name(western_year: @new_year_date.year)
+        end
+
+        #
+        # 月を追加する
+        #
+        # @param [Month] month 月
+        #
+        def push(month:)
+          return if duplicated?(month: month)
+
+          @months.push(month)
+
+          nil
+        end
+
+        #
+        # すでに登録済みの月と重複しているか判定する
+        #
+        # @note 昨年11月1日から今年1月1日の前日までで、去年データと重複する場合は登録スキップする
+        #
+        # @param [Month] month 月
+        #
+        # @return [True] 重複している
+        # @return [True] 重複していない
+        #
+        def duplicated?(month:)
+          @months.each do |existed|
+            return true if existed.same?(other: month)
+          end
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,459 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Cycle
+      #
+      # 大余小余（時刻情報）
+      # @abstract 大余小余計算に必要な処理を行う、暦に依存しない汎用的なクラス
+      #
+      class AbstractRemainder # rubocop:disable Metrics/ClassLength
+        # @return [Integer] 大余上限
+        LIMIT = 60
+
+        # @return [Integer] 大余（"日"に相当）
+        attr_reader :day
+        # @return [Integer] 小余（"分"に相当）
+        attr_reader :minute
+        # @return [Integer] 秒
+        attr_reader :second
+        # @return [Integer] 繰り上げなしの小余
+        attr_reader :base_limit
+        # @return [Integer] 1大余に必要な小余（暦によって基数が異なる）
+        attr_reader :base_day
+        # @return [Integer] 1小余に必要な秒（暦によって基数が異なる）
+        attr_reader :base_minute
+        # 繰り上げ有無
+        # @return [True] 繰り上げあり
+        # @return [False] 繰り上げなし
+        attr_reader :limited
+
+        # :reek:instanceVariableAssumption
+        # rubocop:disable Metrics/ParameterLists
+
+        #
+        # 初期化
+        #
+        # @param [Integer] base_day 1大余に必要な小余（暦によって基数が異なる）
+        # @param [Integer] base_mitune 1小余に必要な秒（暦によって基数が異なる）
+        # @param [Integer] day 大余（"日"に相当）
+        # @param [Integer] minute 小余（"分"に相当）
+        # @param [Integer] second 秒
+        # @param [Integer] total 繰り上げなしの小余
+        #
+        def initialize(base_day: -1, base_mitune: -1, day: -1, minute: -1, second: -1, total: -1)
+          @base_limit = LIMIT
+          @base_day = base_day
+          @base_minute = base_mitune
+          @limited = true
+
+          set(day: day, minute: minute, second: second, total: total)
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        #
+        # 値を設定する
+        #
+        # @param [Integer] day 大余（"日"に相当）
+        # @param [Integer] minute 小余（"分"に相当）
+        # @param [Integer] second 秒
+        # @param [Integer] total 繰り上げなしの小余
+        #
+        # @return [AbstractRemainder] 自身の参照
+        #
+        def set(day: -1, minute: -1, second: -1, total: -1)
+          @day = day
+          @minute = minute
+          @second = second
+
+          if total != -1
+            @day = (total.to_f / @base_day).floor
+            @minute = (total % @base_day)
+            @second = 0
+          end
+
+          self
+        end
+
+        #
+        # 繰り上げ処理を外す
+        #
+        # @return [AbstractRemainder] 自身の参照
+        #
+        def lift_limit
+          @limited = false
+
+          self
+        end
+
+        #
+        # 繰り上げ処理を設定する
+        #
+        # @return [AbstractRemainder] 自身の参照
+        #
+        def set_limit
+          @limited = true
+
+          self
+        end
+
+        #
+        # 無効かどうか
+        #
+        # @param [AbstractRemainder] param 自クラスのインスタンス（デフォルトは自身の参照）
+        #
+        # @return [True] 無効
+        # @return [False] 有効
+        #
+        def invalid?(param: self)
+          raise ArgumentError, 'unmatch parameter type' unless param.is_a?(AbstractRemainder)
+
+          param.day == -1 || param.minute == -1 || param.second == -1
+        end
+
+        #
+        # 十干十二支名
+        #
+        # @return [String] 十干十二支名
+        #
+        def zodiac_name
+          Cycle::Zodiac.day_name(day: @day)
+        end
+
+        #
+        # 日が同じ十干かどうか（大小の月判定）
+        #
+        # @param [Integer] other 大余
+        #
+        # @return [True] 当月朔日と翌月朔日が同じ十干（「大」の月）
+        # @return [False] 当月朔日と翌月朔日が異なる十干（「小」の月）
+        #
+        def same_remainder_divided_by_ten?(other:)
+          day = @day % LIMIT
+
+          (day % 10) == (other % 10)
+        end
+
+        #
+        # （非破壊的に）加算する
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [AbstractRemainder] 加算結果
+        #
+        def add(other)
+          invalid?(param: other)
+          day = @day + other.day
+          minute = @minute + other.minute
+          second = @second + other.second
+          day, minute, second = carry(day, minute, second)
+
+          clone.set(day: day, minute: minute, second: second)
+        end
+
+        #
+        # （破壊的に）加算する
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [AbstractRemainder] 加算結果
+        #
+        def add!(other)
+          result = add(other)
+          @day = result.day
+          @minute = result.minute
+          @second = result.second
+
+          self
+        end
+
+        #
+        # （非破壊的に）除算する
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [AbstractRemainder] 除算結果
+        #
+        def sub(other)
+          invalid?(param: other)
+          day = @day - other.day
+          minute = @minute - other.minute
+          second = @second - other.second
+          day, minute, second = carry(day, minute, second)
+
+          clone.set(day: day, minute: minute, second: second)
+        end
+
+        #
+        # （破壊的に）除算する
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [AbstractRemainder] 除算結果
+        #
+        def sub!(other)
+          result = sub(other)
+          @day = result.day
+          @minute = result.minute
+          @second = result.second
+
+          self
+        end
+
+        #
+        # 大小比較（>）
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [True] より大きい
+        # @return [False] 以下
+        #
+        def >(other)
+          up?(other)
+        end
+
+        #
+        # 大小比較（>=）
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [True] 以上
+        # @return [False] より小さい
+        #
+        def >=(other)
+          up?(other) || \
+            (@day == other.day && @minute == other.minute && @second == other.second)
+        end
+
+        #
+        # 大小比較（<）
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [True] より小さい
+        # @return [False] 以上
+        #
+        def <(other)
+          down?(other)
+        end
+
+        #
+        # 大小比較（<=）
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [True] 以下
+        # @return [False] より大きい
+        #
+        def <=(other)
+          down?(other) || \
+            (@day == other.day && @minute == other.minute && @second == other.second)
+        end
+
+        #
+        # 大小比較（==）
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [True] 等しい
+        # @return [False] 等しくない
+        #
+        def ==(other)
+          eql?(other)
+        end
+
+        #
+        # 大小比較（!=）
+        #
+        # @param [AbstractRemainder] other 他の大余小余
+        #
+        # @return [True] 等しくない
+        # @return [False] 等しい
+        #
+        def !=(other)
+          !eql?(other)
+        end
+
+        # 進朔
+        # @see 進朔 http://eco.mtk.nao.ac.jp/koyomi/wiki/C2C0B1A2C2C0CDDBCEF12FBFCABAF3.html
+        # 進朔とは、朔の瞬間が1日の3/4すなわち夕方以降となる場合に、その日ではなく1日進めて翌日を1日目にする方法のことです。
+        # 進朔するかどうかの基準時刻を進朔限といいます。宣明暦では1日8400分ですから、進朔限は6300分で、それ以降だと進朔されます。
+
+        #
+        # （非破壊的に）進朔する
+        #
+        # @see http://eco.mtk.nao.ac.jp/koyomi/wiki/C2C0B1A2C2C0CDDBCEF12FBFCABAF3.html
+        #
+        # 進朔とは、朔の瞬間が1日の3/4すなわち夕方以降となる場合に、その日ではなく1日進めて翌日を1日目にする方法のことです。
+        # 進朔するかどうかの基準時刻を進朔限といいます。宣明暦では1日8400分ですから、進朔限は6300分で、それ以降だと進朔されます。
+        #
+        # @return [AbstractRemainder] 進朔結果
+        #
+        def up_on_new_moon
+          cloned = clone
+          limit = (base_day * 3) / 4
+          if @minute >= limit
+            day, minute, second = carry((@day + 1), @minute, @second)
+            return cloned.set(day: day, minute: minute, second: second)
+          end
+
+          cloned
+        end
+
+        #
+        # （破壊的に）進朔する
+        #
+        # @see http://eco.mtk.nao.ac.jp/koyomi/wiki/C2C0B1A2C2C0CDDBCEF12FBFCABAF3.html
+        #
+        # 進朔とは、朔の瞬間が1日の3/4すなわち夕方以降となる場合に、その日ではなく1日進めて翌日を1日目にする方法のことです。
+        # 進朔するかどうかの基準時刻を進朔限といいます。宣明暦では1日8400分ですから、進朔限は6300分で、それ以降だと進朔されます。
+        #
+        # @return [AbstractRemainder] 進朔結果
+        #
+        def up_on_new_moon!
+          result = up_on_new_moon
+          @day = result.day
+          @minute = result.minute
+          @second = result.second
+
+          self
+        end
+
+        #
+        # 小余に揃えた結果を返す（秒は除外する）
+        #
+        # @return [Integer] 小余
+        #
+        def to_minute
+          @day * @base_day + @minute
+        end
+
+        #
+        # 大余に四捨五入した結果を返す（秒は除外する）
+        #
+        # @return [AbstractRemainder] 大余
+        #
+        def round
+          day = @day
+          day += 1 if @minute >= (@base_day / 2)
+
+          initialize(day, 0, 0)
+        end
+
+        #
+        # 文字化する
+        #
+        # @return [String] 文字化
+        #
+        def to_s
+          "大余（日）: #{@day}, 小余（分）: #{@minute}, 小余（秒）: #{@second}"
+        end
+
+        #
+        # 特定の文字フォーマットにして出力する
+        #
+        # @param [String] form フォーマット（大余、小余、秒それぞれを%dで指定する）
+        #
+        # @return [String] フォーマットした結果
+        #
+        def format(form: '%d-%d')
+          return '' if invalid?
+
+          super(form, @day, @minute, @second)
+        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: 計算方法としてマイナスでも徐算・剰余算の結果をプラス同様に扱う
+          minute, second = carry_second(param_minute, param_second)
+
+          day, minute = carry_minute(param_day, minute)
+
+          day = carry_day(day, @limited)
+
+          [day, minute, second]
+        end
+
+        def carry_second(param_minute, param_second)
+          sign = param_second.negative? ? -1 : 1
+          abs = sign * param_second
+          minute = param_minute + (sign * (abs / @base_minute).floor)
+          second = sign * (abs % @base_minute)
+
+          if sign.negative?
+            second += @base_minute
+            minute -= 1
+          end
+
+          [minute, second]
+        end
+
+        def carry_minute(param_day, param_minute)
+          sign = param_minute.negative? ? -1 : 1
+          abs = sign * param_minute
+
+          day = param_day + (sign * (abs / @base_day).floor)
+          minute = sign * (abs % @base_day)
+
+          if sign.negative?
+            minute += @base_day
+            day -= 1
+          end
+
+          [day, minute]
+        end
+
+        def carry_day(day, limited)
+          sign = day.negative? ? -1 : 1
+          abs = sign * day
+          carried = sign * (abs % @base_limit) if limited
+          carried += @base_limit if sign.negative?
+          carried
+        end
+
+        def up?(other)
+          invalid?(param: other)
+          day = other.day
+          minute = other.minute
+          return true if @day > day
+          return false if @day < day
+
+          return true if @minute > minute
+          return false if @minute < minute
+
+          @second > other.second
+        end
+
+        def eql?(other)
+          invalid?(param: other)
+
+          (@day == other.day && @minute == other.minute && @second == other.second)
+        end
+
+        def down?(other)
+          invalid?(param: other)
+          day = other.day
+          minute = other.minute
+          return true if @day < day
+          return false if @day > day
+
+          return true if @minute < minute
+          return false if @minute > minute
+
+          @second < other.second
+        end
+      end
+    end
+  end
+end