fyuk 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,6 @@
 = fyuk
 
-Description goes here.
+Small Ruby gem for dealing with the UK financial year.
 
 == Contributing to fyuk
  

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.1

data/fyuk.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "fyuk"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   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

@@ -17,6 +17,7 @@ class UkFinancialYear
   # @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
+  # @raise [RuntimeError] if the string cannot be parsed to a financial year
   # @return [UkFinancialYear] the financial year specified by the string
   def UkFinancialYear.from_s s
     if /^(?<year1>\d{4})\/(?<year2>\d{2})$/ =~ s
@@ -50,6 +51,18 @@ class UkFinancialYear
     @range.include? date
   end
 
+  # returns the next financial year
+  # @return [UkFinancialYear] the next financial year
+  def next
+    UkFinancialYear.new self.first_day.next_year
+  end
+
+  # returns the previous financial year
+  # @return [UkFinancialYear] the previous financial year
+  def previous
+    UkFinancialYear.new self.first_day.prev_year
+  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
@@ -62,7 +75,7 @@ class UkFinancialYear
     self.first_day == other.first_day
   end
 
-  # lesser financial years are those which occur first in time
+  # lesser financial years are those which occur earliest
   def <=>(other)
     self.first_day <=> other.first_day
   end

data/spec/uk_financial_year_spec.rb

@@ -66,37 +66,37 @@ describe UkFinancialYear do
   
   describe "#to_s" do
     it "is the four-digit year then a '/' then a two-digit year" do
-      fy = UkFinancialYear.new(Date.parse '7 Apr 2011')
+      fy = UkFinancialYear.new Date.parse '7 Apr 2011'
       fy.to_s.should == '2011/12'
     end
 
     it "is 1999/00 for the turn of the millenium" do
-      fy = UkFinancialYear.new(Date.parse '7 Apr 1999')
+      fy = UkFinancialYear.new Date.parse '7 Apr 1999'
       fy.to_s.should == '1999/00'
     end
   end
 
   describe "#from_s" do
     it "is 2010/11 for '2010/11'" do
-      fy = UkFinancialYear.from_s('2010/11')
+      fy = UkFinancialYear.from_s '2010/11'
       fy.first_day.should == Date.parse('6 Apr 2010')
       fy.last_day.should == Date.parse('5 Apr 2011')
     end
 
     it "is 2002/03 for '2002/03'" do
-      fy = UkFinancialYear.from_s('2002/03')
+      fy = UkFinancialYear.from_s '2002/03'
       fy.first_day.should == Date.parse('6 Apr 2002')
       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 = 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 = UkFinancialYear.from_s '1999/00'
       fy.first_day.should == Date.parse('6 Apr 1999')
       fy.last_day.should == Date.parse('5 Apr 2000')
     end
@@ -120,6 +120,20 @@ describe UkFinancialYear do
     end
   end
 
+  describe "#next" do
+    it "returns the next financial year" do
+      fy = UkFinancialYear.from_s '2011/12'
+      fy.next.should == UkFinancialYear.from_s('2012/13')
+    end
+  end 
+
+  describe "#previous" do
+    it "returns the previous financial year" do
+      fy = UkFinancialYear.from_s '2011/12'
+      fy.previous.should == UkFinancialYear.from_s('2010/11')
+    end
+  end 
+
   describe "object comparison" do
     it "is less than for earlier FYs" do
       UkFinancialYear.new(Date.parse '5 Apr 2011').should be < UkFinancialYear.new(Date.parse '6 Apr 2011')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fyuk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70191725721420 !ruby/object:Gem::Requirement
+  requirement: &70299305466680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70191725721420
+  version_requirements: *70299305466680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70191725720840 !ruby/object:Gem::Requirement
+  requirement: &70299305466200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70191725720840
+  version_requirements: *70299305466200
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70191725720260 !ruby/object:Gem::Requirement
+  requirement: &70299305465700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70191725720260
+  version_requirements: *70299305465700
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70191725719640 !ruby/object:Gem::Requirement
+  requirement: &70299305465180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70191725719640
+  version_requirements: *70299305465180
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70191725719100 !ruby/object:Gem::Requirement
+  requirement: &70299305464660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70191725719100
+  version_requirements: *70299305464660
 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: -881557483887040957
+      hash: 4011342982725739789
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: