zakuro 0.1.2 → 0.1.3

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

@@ -0,0 +1,151 @@
+# 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
+
+        def index?(index)
+          result = ORDER.fetch(index, -1)
+
+          result != -1
+        end
+
+        #
+        # 次の二十四節気に進める
+        #
+        def next!
+          @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 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 index?(index)
+
+          loop do
+            return if @index == index
+
+            prev!
+          end
+        end
+
+        #
+        # 前の二十四節気に戻る
+        #
+        def prev!
+          @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/first_day.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../../era/western'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Monthly
+      #
+      # FirstDay 月初日（朔日）
+      #
+      class FirstDay
+        # @return [Western::Calendar] 西暦日
+        attr_reader :western_date
+        # @return [Remainder] 大余小余
+        attr_reader :remainder
+
+        #
+        # 初期化
+        #
+        # @param [Remainder] remainder 西暦日
+        # @param [Western::Calendar] western_date 大余小余
+        #
+        def initialize(western_date: Western::Calendar.new, remainder: Remainder.new)
+          # 西暦日
+          @western_date = western_date
+          # 大余小余
+          @remainder = remainder
+        end
+
+        #
+        # ディープコピー
+        #
+        # @param [FirstDay] obj 自身
+        #
+        def initialize_copy(obj)
+          @western_date = obj.western_date.clone
+          @remainder = obj.remainder.clone
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require_relative './month'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Monthly
+      #
+      # InitializedMonth 初期月情報
+      #
+      class InitializedMonth < Month
+        # @return [True] 昨年の月
+        # @return [False] 今年の月
+        # @note 冬至基準で1年データを作成するため昨年の11月-12月である可能性がある
+        attr_reader :is_last_year
+        # @return [Integer] 月齢（朔月、上弦、望月、下弦）
+        attr_reader :phase_index
+
+        # :reek:ControlParameter and :reek:BooleanParameter
+
+        #
+        # 初期化
+        #
+        # @param [MonthLabel] month_label 月表示名
+        # @param [Array<SolarTerm>] solar_terms 二十四節気
+        # @param [FirstDay] first_day 月初日（朔日）
+        # @param [True, False] is_last_year 昨年の月/今年の月
+        # @param [Integer] phase_index 月齢（朔月、上弦、望月、下弦）
+        #
+        def initialize(month_label: MonthLabel.new, solar_terms: [], first_day: FirstDay.new,
+                       is_last_year: false, phase_index: -1)
+          super(month_label: month_label, solar_terms: solar_terms, first_day: first_day)
+          @is_last_year = is_last_year
+          @phase_index = phase_index
+        end
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 現在の二十四節気に合わせて月表示情報を書き換える
+        #
+        def rename_month_label_by_solar_term
+          return ArgumentError.new, 'solar term must not be empty.' if empty_solar_term?
+
+          even = even_term
+
+          is_many_days = month_label.is_many_days
+          if even.invalid?
+            @month_label = MonthLabel.new(
+              number: InitializedMonth.month_number_by_odd_term_index(odd_term.index),
+              leaped: true, is_many_days: is_many_days
+            )
+            return
+          end
+
+          @month_label = MonthLabel.new(
+            number: InitializedMonth.month_number_by_even_term_index(even.index),
+            leaped: false, is_many_days: is_many_days
+          )
+        end
+
+        #
+        # 中気の連番に合わせて月を返す
+        #
+        # @example
+        #   20: 9月
+        #   22: 10月
+        #   0: 11月
+        #   2: 12月
+        #   4: 1月
+        #
+        # @param [Integer] index 中気番号
+        #
+        # @return [Integer] 月
+        #
+        def self.month_number_by_even_term_index(index)
+          half_index = index / 2
+
+          # 11月、12月
+          return half_index + 11 if half_index < 2
+
+          # 1月～10月
+          half_index - 1
+        end
+
+        #
+        # 節気の連番に合わせて月を返す
+        #
+        # @param [Integer] index 節気番号
+        #
+        # @return [Integer] 月
+        #
+        def self.month_number_by_odd_term_index(index)
+          even_index = index - 1
+
+          month_number_by_even_term_index(even_index)
+        end
+
+        #
+        # 一ヶ月戻す
+        #
+        def back_to_last_month
+          @is_last_year = true if month_label.back_to_last_month
+        end
+
+        #
+        # 二十四節気の数を返す
+        #
+        # @return [Integer] 二十四節気の数
+        #
+        def solar_term_size
+          solar_terms.size
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require_relative '../cycle/abstract_solar_term'
+
+require_relative './first_day'
+require_relative './month_label'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Monthly
+      #
+      # Month 月情報
+      #
+      class Month
+        # @return [MonthLabel] 月表示名
+        attr_reader :month_label
+        # @return [FirstDay] 月初日（朔日）
+        attr_reader :first_day
+        # @return [Array<SolarTerm>] 二十四節気
+        attr_reader :solar_terms
+
+        #
+        # 初期化
+        #
+        # @param [MonthLabel] month_label 月表示名
+        # @param [FirstDay] first_day 月初日（朔日）
+        # @param [Array<SolarTerm>] solar_terms 二十四節気
+        #
+        def initialize(month_label: MonthLabel.new, first_day: FirstDay.new, solar_terms: [])
+          @month_label = month_label
+          @first_day = first_day
+          @solar_terms = solar_terms
+        end
+
+        #
+        # 中気なしは閏月とする
+        #
+        def eval_leaped
+          leaped = even_term.invalid?
+
+          @month_label = MonthLabel.new(number: number, is_many_days: many_days?, leaped: leaped)
+        end
+
+        #
+        # 月初日の西暦日を返す
+        #
+        # @return [Western::Calendar] 西暦日
+        #
+        def western_date
+          @first_day.western_date
+        end
+
+        #
+        # 月初日の大余小余を返す
+        #
+        # @return [Remainder] 大余小余
+        #
+        def remainder
+          @first_day.remainder
+        end
+
+        #
+        # 月の大小を返す
+        #
+        # @return [True] 大の月（30日）
+        # @return [False] 小の月（29日）
+        #
+        def many_days?
+          @month_label.is_many_days
+        end
+
+        #
+        # 月の日数を返す
+        #
+        # @return [Integer] 日数
+        #
+        def days
+          @month_label.days
+        end
+
+        #
+        # 月の名前（大小）を返す
+        #
+        # @return [String] 月の名前（大小）
+        #
+        def days_name
+          @month_label.days_name
+        end
+
+        #
+        # 月を返す
+        #
+        # @return [Integer] 月（xx月のxx）
+        #
+        def number
+          @month_label.number
+        end
+
+        #
+        # 閏を返す
+        #
+        # @return [True] 閏月
+        # @return [False] 平月
+        #
+        def leaped?
+          @month_label.leaped
+        end
+
+        #
+        # 次月の大余から月の日数を定める
+        #
+        # @param [Integer] next_month_day 次月の大余
+        #
+        def eval_many_days(next_month_day:)
+          is_many_days = remainder.same_remainder_divided_by_ten?(other: next_month_day)
+
+          @month_label = MonthLabel.new(
+            number: number, is_many_days: is_many_days, leaped: leaped?
+          )
+        end
+
+        #
+        # 二十四節気が未設定かどうかを検証する
+        #
+        # @return [True] 設定なし
+        # @return [False] 設定あり
+        #
+        def empty_solar_term?
+          @solar_terms.empty?
+        end
+
+        #
+        # 中気を返す
+        #
+        # @return [SolarTerm] 中気
+        #
+        def even_term
+          @solar_terms.each do |term|
+            return term if term.index.even?
+          end
+
+          Cycle::AbstractSolarTerm.new
+        end
+
+        #
+        # 節気を返す
+        #
+        # @return [SolarTerm] 節気
+        #
+        def odd_term
+          @solar_terms.each do |term|
+            return term if term.index.odd?
+          end
+
+          Cycle::AbstractSolarTerm.new
+        end
+
+        #
+        # 二十四節気を追加する
+        #
+        # @param [SolarTerm] term 二十四節気
+        #
+        def add_term(term:)
+          @solar_terms.push(term)
+        end
+
+        #
+        # 同一の月情報かを検証する
+        #
+        # @param [Month] other 他の月情報
+        #
+        # @return [True] 同一の月
+        # @return [False] 異なる月
+        #
+        def same?(other:)
+          number == other.number && leaped? == other.leaped?
+        end
+      end
+    end
+  end
+end