fyuk 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Nigel Lowry
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= fyuk
+
+Description goes here.
+
+== Contributing to fyuk
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Nigel Lowry. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fyuk"
+  gem.homepage = "http://github.com/nigel-lowry/fyuk"
+  gem.license = "MIT"
+  gem.summary = %Q{Small Ruby gem for dealing with dates in the UK financial year}
+  gem.description = %Q{Small library with methods for finding the financial or fiscal year for a particular date and suchlike}
+  gem.email = "nigel-lowry@ultra.eclipse.co.uk"
+  gem.authors = ["Nigel Lowry"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/fyuk.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "fyuk"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nigel Lowry"]
+  s.date = "2012-01-21"
+  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 = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fyuk.gemspec",
+    "lib/uk_financial_year.rb",
+    "spec/spec_helper.rb",
+    "spec/uk_financial_year_spec.rb"
+  ]
+  s.homepage = "http://github.com/nigel-lowry/fyuk"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Small Ruby gem for dealing with dates in the UK financial year"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/uk_financial_year.rb

@@ -0,0 +1,51 @@
+require 'date'
+
+class UkFinancialYear
+  include Comparable
+
+  def initialize date
+    start_date = start_date date
+    @range = start_date...start_date.next_year
+  end
+
+  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}")
+    end
+
+    raise %{"#{s}" does not match FY string format}
+  end
+
+  def first_day
+    @range.min
+  end
+
+  def last_day
+    @range.max
+  end
+
+  def include? date
+    @range.include? date
+  end
+
+  def to_s
+    "#{self.first_day.year}/#{self.last_day.year.to_s[-2..-1]}"
+  end
+
+  def ==(other)
+    self.first_day == other.first_day
+  end
+
+  def <=>(other)
+    self.first_day <=> other.first_day
+  end
+
+  private
+    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
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'date'
+require 'uk_financial_year'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/uk_financial_year_spec.rb

@@ -0,0 +1,129 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'date'
+
+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
+  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
+
+    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
+
+    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
+
+    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
+  end
+
+  describe "#.include?" do
+    before :each do
+      @fy = UkFinancialYear.from_s '2012/13'
+    end
+
+    subject { @fy }
+
+    it { should_not include Date.parse '5 Apr 2012' }
+    it { should include Date.parse '6 Apr 2012' }
+    it { should include Date.parse '5 Apr 2013' }
+    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 "raises error if years not consecutive" do
+      expect {
+        UkFinancialYear.from_s '2002/04'
+      }.to raise_error(
+        RuntimeError,
+        /"2002" and "2004" are not consecutive years/
+      ) 
+    end
+
+    it "raises error with wrong format" do
+      expect {
+        UkFinancialYear.from_s '20001/02'
+      }.to raise_error(
+        RuntimeError,
+        /"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
+    it "is less than for earlier FYs" do
+      UkFinancialYear.new(Date.parse '5 Apr 2011').should be < UkFinancialYear.new(Date.parse '6 Apr 2011')
+    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
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: fyuk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nigel Lowry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70355023697860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70355023697860
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70355023697340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70355023697340
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70355023696760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70355023696760
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70355023696180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70355023696180
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70355023695600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70355023695600
+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
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- fyuk.gemspec
+- lib/uk_financial_year.rb
+- spec/spec_helper.rb
+- spec/uk_financial_year_spec.rb
+homepage: http://github.com/nigel-lowry/fyuk
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2520681571740634187
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Small Ruby gem for dealing with dates in the UK financial year
+test_files: []