fyuk 0.4.0 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/fyuk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "fyuk"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nigel Lowry"]
-  s.date = "2012-05-05"
+  s.date = "2012-05-12"
   s.description = "Small library with methods for finding the financial or fiscal year for a particular date and suchlike"
   s.email = "nigel-lowry@ultra.eclipse.co.uk"
   s.extra_rdoc_files = [

data/lib/uk_financial_year.rb

@@ -19,7 +19,7 @@ class UkFinancialYear
   # @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]}"
+    "#{self.first_day.year}/#{self.last_day.year.to_s.last(2)}"
   end
 
   # creates a new UkFinancialYear from a string in the form '2000/01'
@@ -73,22 +73,56 @@ class UkFinancialYear
   end
 
   def adjacent? other_financial_year
-    self.first_day.next_year == other_financial_year.first_day || self.first_day.prev_year == other_financial_year.first_day
+    self.first_day.next_year == other_financial_year.first_day or self.first_day.prev_year == other_financial_year.first_day
+  end
+
+  # tells if the given date or financial year is before this one
+  # @param [Date] date_or_fy date or financial year to check
+  # @return [Boolean] to indicate if this financial year is before
+  def before? date_or_fy
+    self.first_day.before?(date_to_compare date_or_fy)
+  end
+
+  # tells if the given date or financial year is after this one
+  # @param (see FixedOdds#before?)
+  # @return [Boolean] to indicate if this financial year is after
+  def after? date_or_fy
+    self.first_day.after?(date_to_compare date_or_fy)
   end
 
   # equality method
-  def ==(other)
+  def == other
     self.first_day == other.first_day
   end
 
   # lesser financial years are those which occur earliest
-  def <=>(other)
+  def <=> other
     self.first_day <=> other.first_day
   end
 
   private
+    def date_to_compare other
+      if other.is_a?(Date) then other else other.first_day end
+    end
+
     def start_date date
       swap_date_that_year = Date.new date.year, 4, 6
-      date >= swap_date_that_year ? swap_date_that_year : swap_date_that_year.prev_year
+      (date.after?(swap_date_that_year) or date == swap_date_that_year) ? swap_date_that_year : swap_date_that_year.prev_year
     end
+end
+
+class String
+  def last n
+    self[-n, n]
+  end
+end
+
+class Date
+  def before? other
+    self < other
+  end
+
+  def after? other
+    self > other
+  end
 end

data/spec/uk_financial_year_spec.rb

@@ -1,40 +1,39 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe UkFinancialYear do
-  describe "#first_day" do
-    it "is 6 Apr of the previous year if 4 Apr" do
-      UkFinancialYear.new(Date.parse '4 Apr 2011').first_day.should == Date.parse('6 Apr 2010')
-    end
-
-    it "is 6 Apr of the previous year if 5 Apr" do
-      UkFinancialYear.new(Date.parse '5 Apr 2011').first_day.should == Date.parse('6 Apr 2010')
-    end
-    
-    it "is 6 Apr for the same year if 6 Apr" do
-      UkFinancialYear.new(Date.parse '6 Apr 2011').first_day.should == Date.parse('6 Apr 2011')
-    end
 
-    it "is 6 Apr for the same year if 7 Apr" do
-      UkFinancialYear.new(Date.parse '7 Apr 2011').first_day.should == Date.parse('6 Apr 2011')
-    end
+  before :all do
+    @fy = UkFinancialYear.from_s '2012/13'
   end
 
-  describe "#last_day" do
-    it "is 5 Apr of the current year if 4 Apr" do
-      UkFinancialYear.new(Date.parse '4 Apr 2011').last_day.should == Date.parse('5 Apr 2011')
-    end
+  subject { @fy }
 
-    it "is 5 Apr of the current year if 5 Apr" do
-      UkFinancialYear.new(Date.parse '5 Apr 2011').last_day.should == Date.parse('5 Apr 2011')
-    end
+  its(:first_day) { should == Date.parse('6 Apr 2012') }
+  its(:last_day) { should == Date.parse('5 Apr 2013') }
+  its(:next) { should == UkFinancialYear.from_s('2013/14') }
+  its(:previous) { should == UkFinancialYear.from_s('2011/12') }
+  its(:to_s) { should == '2012/13' }
 
-    it "is 5 Apr next year if 6 Apr" do
-      UkFinancialYear.new(Date.parse '6 Apr 2011').last_day.should == Date.parse('5 Apr 2012')
-    end
+  specify { UkFinancialYear.new(Date.parse '6 Apr 2011').should == UkFinancialYear.new(Date.parse '7 Apr 2011') }
+  specify { UkFinancialYear.new(Date.parse '5 Apr 2011').should_not == UkFinancialYear.new(Date.parse '6 Apr 2011') }
 
-    it "is 5 Apr next year if 7 Apr" do
-      UkFinancialYear.new(Date.parse '7 Apr 2011').last_day.should == Date.parse('5 Apr 2012')
-    end
+  specify { UkFinancialYear.new(Date.parse '5 Apr 2011').should be < UkFinancialYear.new(Date.parse '6 Apr 2011') }
+
+  specify { UkFinancialYear.new(Date.parse('7 Apr 2011')).to_s.should == '2011/12' }
+  specify { UkFinancialYear.new(Date.parse('7 Apr 1999')).to_s.should == '1999/00' }
+
+  describe "#first_day" do
+    specify { UkFinancialYear.new(Date.parse '4 Apr 2011').first_day.should == Date.parse('6 Apr 2010') }
+    specify { UkFinancialYear.new(Date.parse '5 Apr 2011').first_day.should == Date.parse('6 Apr 2010') }
+    specify { UkFinancialYear.new(Date.parse '6 Apr 2011').first_day.should == Date.parse('6 Apr 2011') }
+    specify { UkFinancialYear.new(Date.parse '7 Apr 2011').first_day.should == Date.parse('6 Apr 2011') }
+  end
+
+  describe "#last_day" do
+    specify { UkFinancialYear.new(Date.parse '4 Apr 2011').last_day.should == Date.parse('5 Apr 2011') }
+    specify { UkFinancialYear.new(Date.parse '5 Apr 2011').last_day.should == Date.parse('5 Apr 2011') }
+    specify { UkFinancialYear.new(Date.parse '6 Apr 2011').last_day.should == Date.parse('5 Apr 2012') }
+    specify { UkFinancialYear.new(Date.parse '7 Apr 2011').last_day.should == Date.parse('5 Apr 2012') }
   end
 
   describe "#.include?" do
@@ -50,56 +49,10 @@ describe UkFinancialYear do
     it { should_not include Date.parse '6 Apr 2013' } 
   end
 
-  describe "equality" do
-    it "is the same for values falling in the same FY" do
-      fy1 = UkFinancialYear.new(Date.parse '6 Apr 2011')
-      fy2 = UkFinancialYear.new(Date.parse '7 Apr 2011')
-      fy1.should == fy2
-    end
-
-    it "is different for values in different FYs" do
-      fy1 = UkFinancialYear.new(Date.parse '5 Apr 2011')
-      fy2 = UkFinancialYear.new(Date.parse '6 Apr 2011')
-      fy1.should_not == fy2
-    end   
-  end
-  
-  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.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.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.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.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.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
+    specify { UkFinancialYear.from_s('1998/99').to_s.should == '1998/99' }
+    specify { UkFinancialYear.from_s('1999/00').to_s.should == '1999/00' }
+    specify { UkFinancialYear.from_s('2000/01').to_s.should == '2000/01' }
 
     it "raises error if years not consecutive" do
       expect {
@@ -120,54 +73,33 @@ 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 "#adjacent" do
-    it "is true for two consecutive financial years in date order" do
-      fy1 = UkFinancialYear.from_s '2011/12'
-      fy2 = UkFinancialYear.from_s '2012/13'
-
-      fy1.should be_adjacent fy2
-      fy2.should be_adjacent fy1
-    end
-
-    it "is false for financial years which do not run together" do
-      fy1 = UkFinancialYear.from_s '2011/12'
-      fy2 = UkFinancialYear.from_s '2013/14'
-
-      fy1.should_not be_adjacent fy2
-      fy2.should_not be_adjacent fy1
+    before :each do
+      @fy2011_12 = UkFinancialYear.from_s '2011/12'
+      @fy2012_13 = @fy2011_12.next
+      @fy2013_14 = @fy2012_13.next
+      @fy2013_15 = @fy2013_14.next
     end
 
-    it "is false for the same financial year" do
-      fy1 = UkFinancialYear.from_s '2011/12'
-      fy2 = UkFinancialYear.from_s '2011/12'
+    subject { @fy2012_13 }
 
-      fy1.should_not be_adjacent fy2
-      fy2.should_not be_adjacent fy1
-    end
+    it { should be_adjacent @fy2011_12 }
+    it { should be_adjacent @fy2013_14 }
+    it { should_not be_adjacent @fy2013_15 }
+    it { should_not be_adjacent @fy2012_13 }
   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')
+  describe "#before? and #after?" do
+    before :each do
+      @fy = UkFinancialYear.from_s '2011/12'
     end
 
-    it "is greater than for later FYs" do
-      UkFinancialYear.new(Date.parse '6 Apr 2011').should be > UkFinancialYear.new(Date.parse '5 Apr 2011')
-    end
+    subject { @fy }
+
+    it { should be_before UkFinancialYear.from_s('2012/13') }
+    it { should be_after UkFinancialYear.from_s('2010/11') }
+    it { should be_before UkFinancialYear.from_s('2012/13').last_day }
+    it { should be_after UkFinancialYear.from_s('2010/11').first_day }
   end
 
   describe "creation without date" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fyuk
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-05 00:00:00.000000000 Z
+date: 2012-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -128,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 876027332983164761
+      hash: -2786941839308588920
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: