zakuro 0.6.1 → 0.8.0

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

@@ -4,7 +4,7 @@ require_relative '../cycle/zodiac'
 
 require_relative '../../era/western/calendar'
 
-require_relative '../../version/context'
+require_relative '../../context/context'
 
 # :nodoc:
 module Zakuro
@@ -16,7 +16,7 @@ module Zakuro
       # Year 年
       #
       class Year
-        # @return [Context] 暦コンテキスト
+        # @return [Context::Context] 暦コンテキスト
         attr_reader :context
         # @return [Array<Month>] 年内の全ての月
         attr_reader :months
@@ -26,11 +26,11 @@ module Zakuro
         #
         # 初期化
         #
-        # @param [Context] context 暦コンテキスト
+        # @param [Context::Context] context 暦コンテキスト
         # @param [Array<Month>] months 年内の全ての月
         # @param [Integer] total_days 年の日数
         #
-        def initialize(context: Context.new, months: [], total_days: 0)
+        def initialize(context: Context::Context.new, months: [], total_days: 0)
           @context = context
           @months = months
           @total_days = total_days
@@ -72,7 +72,7 @@ module Zakuro
 
           return Western::Calendar.new if months.size.zero?
 
-          @months[0].western_date
+          months[0].western_date
         end
 
         #
@@ -95,7 +95,7 @@ module Zakuro
         def push(month:)
           return if duplicated?(month: month)
 
-          @months.push(month)
+          months.push(month)
 
           nil
         end
@@ -111,7 +111,7 @@ module Zakuro
         # @return [True] 重複していない
         #
         def duplicated?(month:)
-          @months.each do |existed|
+          months.each do |existed|
             return true if existed.same?(other: month)
           end
           false

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

@@ -43,16 +43,16 @@ module Zakuro
         # 初期化
         #
         # @param [Integer] base_day 1大余に必要な小余（暦によって基数が異なる）
-        # @param [Integer] base_mitune 1小余に必要な秒（暦によって基数が異なる）
+        # @param [Integer] base_minute 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)
+        def initialize(base_day: -1, base_minute: -1, day: -1, minute: -1, second: -1, total: -1)
           @base_limit = LIMIT
           @base_day = base_day
-          @base_minute = base_mitune
+          @base_minute = base_minute
           @limited = true
 
           set(day: day, minute: minute, second: second, total: total)
@@ -75,8 +75,8 @@ module Zakuro
           @second = second
 
           if total != -1
-            @day = (total.to_f / @base_day).floor
-            @minute = (total % @base_day)
+            @day = (total.to_f / base_day).floor
+            @minute = (total % base_day)
             @second = 0
           end
 
@@ -113,6 +113,8 @@ module Zakuro
         # @return [True] 無効
         # @return [False] 有効
         #
+        # @raise [ArgumentError] 引数エラー
+        #
         def invalid?(param: self)
           raise ArgumentError, 'unmatch parameter type' unless param.is_a?(AbstractRemainder)
 
@@ -125,7 +127,7 @@ module Zakuro
         # @return [String] 十干十二支名
         #
         def zodiac_name
-          Cycle::Zodiac.day_name(day: @day)
+          Cycle::Zodiac.day_name(day: day)
         end
 
         #
@@ -137,9 +139,9 @@ module Zakuro
         # @return [False] 当月朔日と翌月朔日が異なる十干（「小」の月）
         #
         def same_remainder_divided_by_ten?(other:)
-          day = @day % LIMIT
+          remainder_day = day % LIMIT
 
-          (day % 10) == (other % 10)
+          (remainder_day % 10) == (other % 10)
         end
 
         #
@@ -151,12 +153,14 @@ module Zakuro
         #
         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)
+          sum_day = day + other.day
+          sum_minute = minute + other.minute
+          sum_second = second + other.second
+          sum_day, sum_minute, sum_second = carry(
+            sum_day, sum_minute, sum_second
+          )
 
-          clone.set(day: day, minute: minute, second: second)
+          clone.set(day: sum_day, minute: sum_minute, second: sum_second)
         end
 
         #
@@ -184,12 +188,14 @@ module Zakuro
         #
         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)
+          sum_day = day - other.day
+          sum_minute = minute - other.minute
+          sum_second = second - other.second
+          sum_day, sum_minute, sum_second = carry(
+            sum_day, sum_minute, sum_second
+          )
 
-          clone.set(day: day, minute: minute, second: second)
+          clone.set(day: sum_day, minute: sum_minute, second: sum_second)
         end
 
         #
@@ -298,9 +304,9 @@ module Zakuro
         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)
+          if minute >= limit
+            sum_day, sum_minute, sum_second = carry((day + 1), minute, second)
+            return cloned.set(day: sum_day, minute: sum_minute, second: sum_second)
           end
 
           cloned
@@ -331,7 +337,7 @@ module Zakuro
         # @return [Integer] 小余
         #
         def to_minute
-          @day * @base_day + @minute
+          day * base_day + minute
         end
 
         #
@@ -352,7 +358,7 @@ module Zakuro
         # @return [Float] 小余
         #
         def float_minute
-          @minute + @second.to_f / @base_minute
+          minute + second.to_f / base_minute
         end
 
         #
@@ -361,10 +367,10 @@ module Zakuro
         # @return [AbstractRemainder] 大余
         #
         def round
-          day = @day
-          day += 1 if @minute >= (@base_day / 2)
+          sum_day = day
+          sum_day += 1 if minute >= (base_day / 2)
 
-          initialize(day, 0, 0)
+          initialize(sum_day, 0, 0)
         end
 
         #
@@ -373,7 +379,7 @@ module Zakuro
         # @return [String] 文字化
         #
         def to_s
-          "大余（日）: #{@day}, 小余（分）: #{@minute}, 小余（秒）: #{@second}"
+          "大余（日）: #{day}, 小余（分）: #{minute}, 小余（秒）: #{second}"
         end
 
         #
@@ -382,7 +388,7 @@ module Zakuro
         # @return [AbstractRemainder] 繰り上げ結果
         #
         def carry!
-          @day, @minute, @second = carry(@day, @minute, @second)
+          @day, @minute, @second = carry(day, minute, second)
 
           self
         end
@@ -404,11 +410,11 @@ module Zakuro
         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)
+          minute = param_minute + (sign * (abs / base_minute).floor)
+          second = sign * (abs % base_minute)
 
           if sign.negative?
-            second += @base_minute
+            second += base_minute
             minute -= 1
           end
 
@@ -419,11 +425,11 @@ module Zakuro
           sign = param_minute.negative? ? -1 : 1
           abs = sign * param_minute
 
-          day = param_day + (sign * (abs / @base_day).floor)
-          minute = sign * (abs % @base_day)
+          day = param_day + (sign * (abs / base_day).floor)
+          minute = sign * (abs % base_day)
 
           if sign.negative?
-            minute += @base_day
+            minute += base_day
             day -= 1
           end
 
@@ -433,37 +439,39 @@ module Zakuro
         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 = 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.float_minute
+          other_day = other.day
+          other_minute = other.float_minute
+
+          return true if day > other_day
 
-          return true if @day > day
-          return false if @day < day
+          return false if day < other_day
 
-          float_minute > minute
+          float_minute > other_minute
         end
 
         def eql?(other)
           invalid?(param: other)
 
-          (@day == other.day && float_minute == other.float_minute)
+          (day == other.day && float_minute == other.float_minute)
         end
 
         def down?(other)
           invalid?(param: other)
-          day = other.day
-          minute = other.float_minute
+          other_day = other.day
+          other_minute = other.float_minute
+
+          return true if day < other_day
 
-          return true if @day < day
-          return false if @day > day
+          return false if day > other_day
 
-          float_minute < minute
+          float_minute < other_minute
         end
       end
     end

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

@@ -67,7 +67,7 @@ module Zakuro
         # @return [False] 正しい
         #
         def invalid?
-          (@index == -1 || @remainder.invalid?)
+          (index == -1 || remainder.invalid?)
         end
 
         #
@@ -77,21 +77,7 @@ module Zakuro
         # @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
+          (index == -1 && remainder.invalid?)
         end
 
         #
@@ -106,9 +92,9 @@ module Zakuro
         #
         def next_term
           @index += 1
-          @index = 0 if @index >= ORDER.size
+          @index = 0 if index >= ORDER.size
 
-          @remainder.add(@average)
+          remainder.add(average)
         end
 
         #
@@ -119,8 +105,9 @@ module Zakuro
         def next_by_index(index)
           return ArgumentError.new, 'invalid index' unless AbstractSolarTerm.index?(index)
 
-          loop do
-            return if @index == index
+          (0..(ORDER.size - 1)).each do |_index|
+            inner_index = @index
+            break if inner_index == index
 
             next!
           end
@@ -134,8 +121,9 @@ module Zakuro
         def prev_by_index(index)
           return ArgumentError.new, 'invalid index' unless AbstractSolarTerm.index?(index)
 
-          loop do
-            return if @index == index
+          (0..(ORDER.size - 1)).each do |_index|
+            inner_index = @index
+            break if inner_index == index
 
             prev_term!
           end
@@ -153,9 +141,9 @@ module Zakuro
         #
         def prev_term
           @index -= 1
-          @index = 23 if @index.negative?
+          @index = 23 if index.negative?
 
-          @remainder.sub(@average)
+          remainder.sub(average)
         end
 
         #
@@ -167,6 +155,22 @@ module Zakuro
           @index = obj.index.clone
           @remainder = obj.remainder.clone
         end
+
+        class << self
+          #
+          # 有効な二十四節気番号か
+          #
+          # @param [Integer] index 連番
+          #
+          # @return [True] 有効
+          # @return [False] 無効
+          #
+          def index?(index)
+            result = ORDER.fetch(index, -1)
+
+            result != -1
+          end
+        end
       end
     end
   end

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

@@ -77,28 +77,30 @@ module Zakuro
         # @return [Integer] 組み合わせ数
         LENGTH = ZODIAC_NAME_PATTERNS.length
 
-        #
-        # 大余を十干十二支に変換する
-        #
-        # @param [Integer] day 大余
-        #
-        # @return [String] 十干十二支
-        #
-        def self.day_name(day:)
-          index = day % LENGTH
+        class << self
+          #
+          # 大余を十干十二支に変換する
+          #
+          # @param [Integer] day 大余
+          #
+          # @return [String] 十干十二支
+          #
+          def day_name(day:)
+            index = day % LENGTH
 
-          ZODIAC_NAME_PATTERNS[index]
-        end
+            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]
+          #
+          # 西暦年を十干十二支に変換する
+          #
+          # @param [Integer] western_year 西暦年
+          #
+          # @return [String] 十干十二支
+          #
+          def year_name(western_year: 0)
+            ZODIAC_NAME_PATTERNS[(western_year - 4) % LENGTH]
+          end
         end
       end
     end

data/lib/zakuro/calculation/era/gengou/{scroll.rb → abstract_scroll.rb}

@@ -3,7 +3,6 @@
 require_relative '../../../era/western/calendar'
 require_relative '../../base/gengou'
 require_relative '../../base/linear_gengou'
-require_relative './internal/reserve/range'
 require_relative './internal/connector'
 require_relative './internal/publisher'
 
@@ -13,16 +12,16 @@ module Zakuro
   module Calculation
     # :nodoc:
     module Gengou
-      # Scroll
+      # AbstractScroll
       #
       # 元号スクロール
       #
-      class Scroll
+      class AbstractScroll
         # @return [Western::Calendar] 月初日
         attr_reader :monthly_start_date
         # @return [Western::Calendar] 月末日
         attr_reader :monthly_last_date
-        # @return [Reserve::Range] 予約範囲
+        # @return [Reserve::AbstractRange] 予約範囲
         attr_reader :range
         # @return [Array<Counte>] 1行目元号
         attr_reader :first_gengou
@@ -34,13 +33,12 @@ module Zakuro
         #
         # 初期化
         #
-        # @param [Western::Calendar] start_date 西暦開始日（最大範囲）
-        # @param [Western::Calendar] last_date 西暦終了日（最大範囲）
+        # @param [Reserve::AbstractRange] range 予約範囲
         #
-        def initialize(start_date: Western::Calendar.new, last_date: Western::Calendar.new)
+        def initialize(range:)
           @monthly_start_date = Western::Calendar.new
           @monthly_last_date = Western::Calendar.new
-          @range = Reserve::Range.new(start_date: start_date, last_date: last_date)
+          @range = range
           @first_gengou = []
           @second_gengou = []
           @ignited = false
@@ -74,15 +72,7 @@ module Zakuro
         def ignite(month:)
           return false unless ignitable?(month: month)
 
-          japan_start_date = @range.japan_start_date
-
-          western_start_date = @range.western_start_date
-
-          # 今月初日（和暦日が1月2日であれば、開始日の1日前が初日）
-          @monthly_start_date = western_start_date.clone - japan_start_date.day + 1
-
-          # 今月末
-          @monthly_last_date = @monthly_start_date.clone + month.days - 1
+          first_monthly_date(month: month)
 
           update_current_gengou
 
@@ -95,9 +85,9 @@ module Zakuro
         # @param [Monthly::Month] month 月
         #
         def advance(month:)
-          @monthly_start_date = @monthly_last_date.clone + 1
+          @monthly_start_date = monthly_last_date.clone + 1
 
-          @monthly_last_date = @monthly_start_date.clone + month.days - 1
+          @monthly_last_date = monthly_start_date.clone + month.days - 1
 
           next_year if month.number == 1 && !month.leaped?
 
@@ -110,15 +100,15 @@ module Zakuro
         # @return [Base::Gengou] 元号
         #
         def to_gengou
-          start_date = @monthly_start_date.clone
-          last_date = @monthly_last_date.clone
+          start_date = monthly_start_date.clone
+          last_date = monthly_last_date.clone
 
           # 行を超えた元号切り替え処理
           continue_year
 
           Publisher.run(
             start_date: start_date, last_date: last_date,
-            first_gengou: @first_gengou, second_gengou: @second_gengou
+            first_gengou: first_gengou, second_gengou: second_gengou
           )
         end
 
@@ -128,7 +118,7 @@ module Zakuro
         # @return [Integer] 開始西暦年
         #
         def western_start_year
-          @range.western_start_year
+          range.western_start_year
         end
 
         #
@@ -137,30 +127,47 @@ module Zakuro
         # @return [Integer] 終了西暦年
         #
         def western_last_year
-          @range.western_last_year
+          range.western_last_year
         end
 
         private
 
+        #
+        # 最初の月初日/末日を設定する
+        #
+        # @param [Monthly::Month] month 月
+        #
+        def first_monthly_date(month:)
+          japan_start_date = range.japan_start_date
+
+          western_start_date = range.western_start_date
+
+          # 今月初日（和暦日が1月2日であれば、開始日の1日前が初日）
+          @monthly_start_date = western_start_date.clone - japan_start_date.day + 1
+
+          # 今月末
+          @monthly_last_date = monthly_start_date.clone + month.days - 1
+        end
+
         #
         # 行を跨ぐ元号年を継続させる
         #
         def continue_year
-          @connector.update(lines: [@first_gengou, @second_gengou])
+          connector.update(lines: [first_gengou, second_gengou])
         end
 
         #
         # 現在月に合わせて元号を更新する
         #
         def update_current_gengou
-          start_date = @monthly_start_date
-          last_date = @monthly_last_date
-          first_gengou = @range.collect_first(start_date: start_date, last_date: last_date)
-          second_gengou = @range.collect_second(start_date: start_date,
-                                                last_date: last_date)
-
-          @first_gengou = replace_gengou(source: @first_gengou, destination: first_gengou)
-          @second_gengou = replace_gengou(source: @second_gengou, destination: second_gengou)
+          start_date = monthly_start_date
+          last_date = monthly_last_date
+          dest_first_gengou = range.collect_first(start_date: start_date, last_date: last_date)
+          dest_second_gengou = range.collect_second(start_date: start_date,
+                                                    last_date: last_date)
+
+          @first_gengou = replace_gengou(source: first_gengou, destination: dest_first_gengou)
+          @second_gengou = replace_gengou(source: second_gengou, destination: dest_second_gengou)
         end
 
         #
@@ -191,9 +198,9 @@ module Zakuro
         # @return [True] 開始不可
         #
         def ignitable?(month:)
-          return false unless @monthly_start_date.invalid?
+          return false unless monthly_start_date.invalid?
 
-          japan_start_date = @range.japan_start_date
+          japan_start_date = range.japan_start_date
 
           japan_start_date.same_month?(leaped: month.leaped?, month: month.number)
         end
@@ -202,8 +209,8 @@ module Zakuro
         # 次年にする
         #
         def next_year
-          @first_gengou.each(&:next_year)
-          @second_gengou.each(&:next_year)
+          first_gengou.each(&:next_year)
+          second_gengou.each(&:next_year)
         end
       end
     end

data/lib/zakuro/calculation/era/gengou/dated_scroll.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative './abstract_scroll'
+require_relative './internal/reserve/dated_range'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # DatedScroll
+      #
+      # 元号スクロール
+      #
+      class DatedScroll < AbstractScroll
+        #
+        # 初期化
+        #
+        # @param [Western::Calendar] start_date 西暦開始日（最大範囲）
+        # @param [Western::Calendar] last_date 西暦終了日（最大範囲）
+        #
+        def initialize(start_date: Western::Calendar.new, last_date: Western::Calendar.new)
+          range = Reserve::DatedRange.new(start_date: start_date, last_date: last_date)
+          super(range: range)
+        end
+      end
+    end
+  end
+end