lib/fiscal_year/half.rb in fiscal_year-0.5.0 vs lib/fiscal_year/half.rb in fiscal_year-0.7.0

@@ -1,32 +1,40 @@
 # frozen_string_literal: true
 
 module FiscalYear
   class Half
     class << self
+      # @return [Array<Integer>] the first half of the fiscal year.
       def first
         first = FiscalYear.halfs.first
         return first if first.is_a? Array
 
         []
       end
 
+      # @return [Array<Integer>] the second half of the fiscal year.
       def second
         second = FiscalYear.halfs.second
         return second if second.is_a? Array
 
         []
       end
 
+      # @param month [Integer] the month
+      # @return [Boolean] true if the month is in the first half of the fiscal year.
       def first?(month)
         FiscalYear.halfs.first.include?(month)
       end
 
+      # @param month [Integer] the month
+      # @return [Boolean] true if the month is in the second half of the fiscal year.
       def second?(month)
         !first?(month)
       end
 
+      # @param year [Integer] the calendar year
+      # @return [Range<Date>] the range of the first half of the fiscal year.
       def first_range_by(year)
         # care Date#parse 2 digit year auto complete.
         # 99 + 1 = 100, but expect 2000 this context.
         year = 1999 if year == 99
         end_month = first.last
@@ -35,10 +43,12 @@
         end_year = FiscalYear.increase_year_by_month(year, end_month)
 
         Date.parse("#{year}/#{first.first}/01")..Date.parse("#{end_year}/#{end_month}/01").end_of_month
       end
 
+      # @param year [Integer] the calendar year
+      # @return [Range<Date>] the range of the second half of the fiscal year.
       def second_range_by(year)
         # care Date#parse 2 digit year auto complete.
         # 99 + 1 = 100, but expect 2000 this context.
         year = 1999 if year == 99
         first_month = second.first
@@ -49,18 +59,22 @@
         end_year = FiscalYear.increase_year_by_month(year, end_month)
 
         Date.parse("#{start_year}/#{first_month}/01")..Date.parse("#{end_year}/#{end_month}/01").end_of_month
       end
 
+      # @param date [Date] the date
+      # @return [Range<Date>] the range of the half of the fiscal year by the date.
       def range_by(date)
         month = date.month
         year = date.year
         # if passed crossed year value, normalize to not crossed year value
         year = FiscalYear.decrease_year_by_month(year, month)
 
         first?(month) ? first_range_by(year) : second_range_by(year)
       end
 
+      # @param half [Array<Integer>] the half of the fiscal year
+      # @return [Boolean] true if the any month of half are crossed calendar year.
       def cross_year_in_half?(half)
         FiscalYear.cross_year? && half.any? { |month| month == 12 }
       end
     end
   end