fiscal_date 0.1.0

data/.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "fiscal_date"
+
+Gem::Specification.new do |s|
+  s.name        = "fiscal_date"
+  s.version     = "0.1.0"
+  s.authors     = ["Brian Smith"]
+  s.email       = ["bsmith@swig505.com"]
+  s.homepage    = "https://github.com/Estimize/fiscal_date"
+  s.summary     = %q{Ruby gem for working with fiscal dates}
+  s.description = %q{Ruby gem for working with fiscal dates}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('minitest', [">= 2.6.2"])
+end 

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.swp
+fiscal_date-*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    fiscal_date (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    minitest (4.4.0)
+    rake (10.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fiscal_date!
+  minitest (>= 2.6.2)
+  rake

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.pattern = "test/**/*_test.rb"
+end
+

data/lib/fiscal_date/arithmetic_ext.rb

@@ -0,0 +1,34 @@
+class FiscalDate
+  module ArithmeticExt
+
+    def -(fd_or_integer)
+      case fd_or_integer
+      when Integer
+        self.+(-fd_or_integer)
+      when FiscalDate
+        year_diff = year - fd_or_integer.year
+        quarter_diff = quarter - fd_or_integer.quarter
+        year_diff * 4 + quarter_diff
+      else
+        raise(ArgumentError, "must pass an integer or another FiscalDate")
+      end
+    end
+
+    def +(quarters)
+      return self if quarters.zero?
+      
+      years = quarters / 4
+      quarters = (quarters % 4) + self.quarter
+
+      # We can use modulo but we'd have to map the quarters 1-4 to 0-3,
+      # this seemed easier.
+      if quarters > 4
+        years += 1
+        quarters -= 4
+      end
+
+      self.class.new(self.year + years, quarters)
+    end
+
+  end
+end

data/lib/fiscal_date/comparable_ext.rb

@@ -0,0 +1,18 @@
+class FiscalDate
+  module ComparableExt
+
+    def self.included(base)
+      base.send(:include, Comparable)
+    end
+
+    def <=>(fd)
+      if year < fd.year || (year == fd.year && quarter < fd.quarter)
+        -1
+      elsif year > fd.year || (year == fd.year && quarter > fd.quarter)
+        1
+      else
+        0
+      end
+    end
+  end
+end

data/lib/fiscal_date/date_ext.rb

@@ -0,0 +1,37 @@
+class FiscalDate
+  class InconsistentCalendar < StandardError; end
+
+  module DateExt
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+
+      def by_quarter_date(quarter_end_date, year_end_month = 12)
+        quarter_end_month = quarter_end_date.month - 1
+        year_end_month = year_end_month - 1
+
+        fiscal_year = quarter_end_date.year
+        fiscal_quarter = nil
+
+        if year_end_month == quarter_end_month
+          fiscal_quarter = 4
+        elsif (year_end_month + 3) % 12 == quarter_end_month
+          fiscal_quarter = 1
+        elsif (year_end_month + 6) % 12 == quarter_end_month
+          fiscal_quarter = 2
+        elsif (year_end_month + 9) % 12 == quarter_end_month
+          fiscal_quarter = 3
+        else
+          raise(InconsistentCalendar, "quarter ends month #{quarter_end_month} and year ends month #{year_end_month}")
+        end
+
+        fiscal_year += 1 if quarter_end_month > year_end_month
+
+        return new(fiscal_year, fiscal_quarter)
+      end
+
+    end
+  end
+end

data/lib/fiscal_date.rb

@@ -0,0 +1,29 @@
+require 'date'
+require 'fiscal_date/comparable_ext'
+require 'fiscal_date/arithmetic_ext'
+require 'fiscal_date/date_ext'
+
+class FiscalDate
+  include ComparableExt
+  include ArithmeticExt
+  include DateExt
+
+  class InvalidQuarter < StandardError; end
+  class InvalidYear < StandardError; end
+
+  attr_reader :year, :quarter
+
+  VALID_QUARTERS = (1..4)
+  VALID_YEARS = { min: 1, max: 9999 }
+
+  def initialize(year, quarter)
+    @year, @quarter = year.to_i, quarter.to_i
+    raise(InvalidQuarter, "`#{quarter}` is not a valid quarter") unless VALID_QUARTERS.include?(@quarter)
+    raise(InvalidYear, "`#{year}` is not a valid year") unless VALID_YEARS[:min] < @year && VALID_YEARS[:max] > @year
+  end
+
+  def to_s
+    "Q#{quarter.to_s} #{year.to_s}"
+  end
+
+end

data/test/fiscal_date/arithmetic_ext_test.rb

@@ -0,0 +1,39 @@
+require_relative '../test_helper'
+
+describe FiscalDate do
+  describe "#-" do
+    describe "when argument is FiscalDate" do
+      it "should return the difference in quarters for same year" do
+        (FiscalDate.new(2012, 4) - FiscalDate.new(2012, 2)).must_equal 2
+      end
+      
+      it "should return the difference in quarters for different years" do
+        (FiscalDate.new(2012, 4) - FiscalDate.new(2010, 3)).must_equal 9
+      end
+      
+      it "should return negative difference when appropriate" do
+        (FiscalDate.new(2012, 2) - FiscalDate.new(2012, 4)).must_equal -2
+      end
+    end
+
+    describe "when argument is integer" do
+      it "should subtract quarters and return FiscalDate" do
+        (FiscalDate.new(2012,2) - 1).must_equal FiscalDate.new(2012,1)
+      end
+
+      it "should roll back to previous year when necessary" do
+        (FiscalDate.new(2012,2) - 2).must_equal FiscalDate.new(2011,4)
+      end
+    end
+  end
+
+  describe "#+" do
+    it "should add quarters" do
+      (FiscalDate.new(2012,2) + 1).must_equal FiscalDate.new(2012,3)
+    end
+
+    it "should roll over to next year when necessary" do
+      (FiscalDate.new(2012,2) + 3).must_equal FiscalDate.new(2013,1)
+    end
+  end
+end

data/test/fiscal_date/comparable_ext_test.rb

@@ -0,0 +1,25 @@
+require_relative '../test_helper'
+
+describe FiscalDate do
+  describe "#<=>" do
+    it "should return -1 when less than (same years)" do
+      (FiscalDate.new(2012,2) <=> FiscalDate.new(2012,3)).must_equal -1
+    end
+
+    it "should return -1 when less than (different years)" do
+      (FiscalDate.new(2011,4) <=> FiscalDate.new(2012,3)).must_equal -1
+    end
+
+    it "should return 0 when equal" do
+      (FiscalDate.new(2012,3) <=> FiscalDate.new(2012,3)).must_equal 0
+    end
+
+    it "should return 1 when greater than (same years)" do
+      (FiscalDate.new(2012,4) <=> FiscalDate.new(2012,3)).must_equal 1
+    end
+
+    it "should return 1 when greater than (different years)" do
+      (FiscalDate.new(2013,1) <=> FiscalDate.new(2012,3)).must_equal 1
+    end
+  end
+end

data/test/fiscal_date/date_ext_test.rb

@@ -0,0 +1,37 @@
+require_relative '../test_helper'
+
+describe FiscalDate do
+  describe ".from_quarter_date" do
+    describe "with default end of fiscal year (December)" do
+      it "should return Q4 for same year" do
+        FiscalDate.by_quarter_date(Date.new(2012,12,31)).must_equal FiscalDate.new(2012, 4)
+      end
+      
+      it "should return Q1 for same year" do
+        FiscalDate.by_quarter_date(Date.new(2012,3,31)).must_equal FiscalDate.new(2012, 1)
+      end
+    end
+
+    describe "with specified end of fiscal year" do
+      it "should return Q4 for same year" do
+        FiscalDate.by_quarter_date(Date.new(2012,9,30), 9).must_equal FiscalDate.new(2012, 4)
+      end
+      
+      it "should return Q1 for same year" do
+        FiscalDate.by_quarter_date(Date.new(2011,12,31), 9).must_equal FiscalDate.new(2012, 1)
+      end
+
+      it "should return Q1 for following year" do
+        FiscalDate.by_quarter_date(Date.new(2012,12,31), 9).must_equal FiscalDate.new(2013, 1)
+      end
+    end
+
+    describe "with bogus calendar" do
+      it "should raise InconsistentCalendar" do
+        -> {
+          FiscalDate.by_quarter_date(Date.new(2012,11,30), 12)
+        }.must_raise(FiscalDate::InconsistentCalendar)
+      end
+    end
+  end
+end

data/test/fiscal_date_test.rb

@@ -0,0 +1,35 @@
+require_relative 'test_helper'
+
+describe FiscalDate do
+  let(:fiscal_date) { FiscalDate.new(2012, 1) }
+
+  it "should have year" do
+    fiscal_date.year.must_equal 2012
+  end
+
+  it "should have quarter" do
+    fiscal_date.quarter.must_equal 1
+  end
+
+  it "should not allow quarters other than 1-4" do
+    ["a",5,0].each do |q|
+      -> {
+        FiscalDate.new(2012, q)
+      }.must_raise(FiscalDate::InvalidQuarter)
+    end
+  end
+
+  it "should not allow years outside of 1-9999" do
+    ["a",0,10000].each do |y|
+      -> {
+        FiscalDate.new(y, 1)
+      }.must_raise(FiscalDate::InvalidYear)
+    end
+  end
+
+  describe "#to_s" do
+    it "should return Q<quarter> YYYY format" do
+      fiscal_date.to_s.must_equal "Q1 2012"
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+
+require_relative '../lib/fiscal_date'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: fiscal_date
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+description: Ruby gem for working with fiscal dates
+email:
+- bsmith@swig505.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemspec
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/fiscal_date.rb
+- lib/fiscal_date/arithmetic_ext.rb
+- lib/fiscal_date/comparable_ext.rb
+- lib/fiscal_date/date_ext.rb
+- test/fiscal_date/arithmetic_ext_test.rb
+- test/fiscal_date/comparable_ext_test.rb
+- test/fiscal_date/date_ext_test.rb
+- test/fiscal_date_test.rb
+- test/test_helper.rb
+homepage: https://github.com/Estimize/fiscal_date
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby gem for working with fiscal dates
+test_files:
+- test/fiscal_date/arithmetic_ext_test.rb
+- test/fiscal_date/comparable_ext_test.rb
+- test/fiscal_date/date_ext_test.rb
+- test/fiscal_date_test.rb
+- test/test_helper.rb