fyuk 0.0.1 → 0.1.0

data/fyuk.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "fyuk"
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nigel Lowry"]

data/lib/uk_financial_year.rb

@@ -1,44 +1,68 @@
 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

data/spec/uk_financial_year_spec.rb

@@ -1,5 +1,4 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'date'
 
 describe UkFinancialYear do
   describe "#first_day" do
@@ -90,6 +89,18 @@ describe UkFinancialYear do
       fy.last_day.should == Date.parse('5 Apr 2003')
     end
 
+    it "is 1998/99 for '1998/99'" do
+      fy = UkFinancialYear.from_s('1998/99')
+      fy.first_day.should == Date.parse('6 Apr 1998')
+      fy.last_day.should == Date.parse('5 Apr 1999')
+    end
+
+    it "is 1999/00 for '1999/00'" do
+      fy = UkFinancialYear.from_s('1999/00')
+      fy.first_day.should == Date.parse('6 Apr 1999')
+      fy.last_day.should == Date.parse('5 Apr 2000')
+    end
+
     it "raises error if years not consecutive" do
       expect {
         UkFinancialYear.from_s '2002/04'
@@ -107,14 +118,6 @@ describe UkFinancialYear do
         /"20001\/02" does not match FY string format/
       ) 
     end
-
-    it "raises error on 20th century FY" do
-      expect {
-        UkFinancialYear.from_s '1998/99'
-      }.to raise_error(
-        RuntimeError
-      ) 
-    end
   end
 
   describe "object comparison" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fyuk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70355023697860 !ruby/object:Gem::Requirement
+  requirement: &70191725721420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70355023697860
+  version_requirements: *70191725721420
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70355023697340 !ruby/object:Gem::Requirement
+  requirement: &70191725720840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70355023697340
+  version_requirements: *70191725720840
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70355023696760 !ruby/object:Gem::Requirement
+  requirement: &70191725720260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70355023696760
+  version_requirements: *70191725720260
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70355023696180 !ruby/object:Gem::Requirement
+  requirement: &70191725719640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70355023696180
+  version_requirements: *70191725719640
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70355023695600 !ruby/object:Gem::Requirement
+  requirement: &70191725719100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70355023695600
+  version_requirements: *70191725719100
 description: Small library with methods for finding the financial or fiscal year for
   a particular date and suchlike
 email: nigel-lowry@ultra.eclipse.co.uk
@@ -102,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2520681571740634187
+      hash: -881557483887040957
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: