full_range.rb in zakuro-0.0.3

- old
+ new

@@ -18,13 +18,11 @@
     # NOTE: 割り当てた元号は年初を基準にした元号年である
     #   * 元旦を基準にした時の正しい元号を設定している
     #   * 引き当てたい日付が元旦ではない場合、その月日に従い元号を再度求める
     #   * この再計算が必要になるのは、元号が切り替わる年のみである
     class FullRange
-      attr_reader :multi_gengou_roller
-      attr_reader :new_year_date
-      attr_reader :western_year
+      attr_reader :multi_gengou_roller, :new_year_date, :western_year
 
       # @return [Logger] ロガー
       LOGGER = Logger.new(location: 'full_range')
 
       def initialize(start_date: Western::Calendar.new, end_date: Western::Calendar.new)
@@ -38,12 +36,11 @@
       #
       # @return [Array<Year>] 完全範囲
       #
       def get
         years = FullRange.rearranged_years(annual_ranges: annual_ranges)
-        years = update_gengou(years: years)
-        years
+        update_gengou(years: years)
       end
 
       # :reek:TooManyStatements { max_statements: 6 }
 
       #
@@ -113,10 +110,15 @@
       end
 
       #
       # 当年データを生成する
       #
+      # @param [Array<Year>] annual_ranges 年データ（冬至基準）
+      # @param [Year] year 対象年
+      #
+      # @return [Year] 当年月ありの対象年
+      #
       def self.push_current_year(annual_range:, year: Year.new)
         annual_range.each do |month|
           next if month.is_last_year
 
           year.push(month: month)
@@ -124,12 +126,17 @@
 
         year
       end
 
       #
-      # 当年データを生成する
+      # 昨年データを生成する
       #
+      # @param [Array<Year>] annual_ranges 年データ（冬至基準）
+      # @param [Year] year 対象年
+      #
+      # @return [Year] 昨年月ありの対象年
+      #
       def self.push_last_year(annual_range:, year: Year.new)
         annual_range.each do |month|
           next unless month.is_last_year
 
           year.push(month: month)
@@ -140,9 +147,10 @@
 
       #
       # 年データの開始月を変更する
       #
       # @param [Array<Year>] annual_ranges 年データ（冬至基準）
+      # @param [Integer] index 対象年の要素番号
       #
       # @return [Year] 年データ（元旦基準）
       #
       def self.rearranged_year(annual_ranges:, index:)
         current_annual_range = annual_ranges[index]