lib/uk_financial_year.rb in fyuk-0.0.1 vs lib/uk_financial_year.rb in fyuk-0.1.0

@@ -1,45 +1,69 @@
 require 'date'
 
+# Makes working with the UK financial or fiscal year easier.
 class UkFinancialYear
   include Comparable
 
+  # creates a new UkFinancialYear as the financial year which
+  # includes the given date
+  # @param [Date] date the date to create a financial year for
+  # @return [UkFinancialYear] the financial year which covers the date
   def initialize date
     start_date = start_date date
     @range = start_date...start_date.next_year
   end
 
+  # creates a new UkFinancialYear from a string in the form '2000/01'
+  # @param [String] s the two years of the financial year in the form
+  # of the first year as four digits, a '/', then the last year as
+  # two digits
+  # @return [UkFinancialYear] the financial year specified by the string
   def UkFinancialYear.from_s s
-    if /^20(?<year1>\d{2})\/(?<year2>\d{2})$/ =~ s
-      year1 = 2000 + year1.to_i
-      year2 = 2000 + year2.to_i
-      raise %{"#{year1}" and "#{year2}" are not consecutive years} unless year1 + 1 == year2
-      return new(Date.parse "6 Apr #{year1}")
+    if /^(?<year1>\d{4})\/(?<year2>\d{2})$/ =~ s
+      year1 = year1.to_i
+      year1_century = year1 / 100
+      year2_century = year1 % 100 == 99 ? year1_century + 1 : year1_century
+      year2 = year2_century * 100 + year2.to_i
+      raise %{"#{year1}" and "#{year2}" are not consecutive years} unless year2 == year1 + 1
+      return new(Date.new year1, 4, 6)
     end
 
     raise %{"#{s}" does not match FY string format}
   end
 
+  # returns the date of the first day of the financial year
+  # @return [Date] the first day
   def first_day
     @range.min
   end
 
+  # returns the date of the last day of the financial year
+  # @return [Date] the last day
   def last_day
     @range.max
   end
 
+  # tells if the financial year includes the given date
+  # @param [Date] date the date to check
+  # @return [Boolean] to indicate if the date is within the financial year
   def include? date
     @range.include? date
   end
 
+  # returns string representation of the financial year in the form '2000/01'
+  # @return [String] representation in the form of the first year as four
+  # digits, a '/', then the last year as two digits
   def to_s
     "#{self.first_day.year}/#{self.last_day.year.to_s[-2..-1]}"
   end
 
+  # equality method
   def ==(other)
     self.first_day == other.first_day
   end
 
+  # lesser financial years are those which occur first in time
   def <=>(other)
     self.first_day <=> other.first_day
   end
 
   private
\ No newline at end of file