fiscali 1.2.5

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 asanghi
+
+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.markdown

@@ -0,0 +1,170 @@
+# Fiscali: Fiscal Year based calculations
+
+Fiscali provides ONE thing:
+
+ * Additional methods on your Date and Time classes to jump around dates in your Financial Year.
+ * Not sure it's a point to be said, but YES, you can specify your financial year zone and if you dont know your zone, just provide the first month your financial year to the Date/Time class.
+
+## Quick Links
+
+ * [Wiki](http://wiki.github.com/asanghi/fiscali)
+ * [Bugs](http://github.com/asanghi/fiscali/issues)
+ * [Donate](http://pledgie.org/campaigns/5400)
+
+## Installing
+
+    # Install the gem:
+    sudo gem install asanghi-fiscali
+    
+## Using in your Rails project
+
+It's easy to get up and running. Update your config/environment.rb file with this gem
+
+    config.gem "asanghi-fiscali", :lib => 'fiscali', :sources => 'http://gems.github.com'
+
+Next step is to provide your Date/Time class your start zone. Stick this in an initializer file. (If you didnt understand that, put it in $ENV[RAILS_ROOT]/config/initializers/fiscali.rb)
+
+    Date.fiscal_zone = :india
+    Time.fiscal_zone = :india
+or
+    Date.start_month = 4
+    
+
+### Default options
+
+By default, the financial year start in January. (Correct me but thats not a common start of financial year!)
+Known Zones are  -
+    	{:india => 4, :uk => 4, :us => 10, :pakistan => 7,
+         :australia => 7, :ireland => 1, :nz => 7, :japan => 4}
+
+## Date or Time Class Methods
+    
+    Date.fy_start_month
+    => 1
+    Date.fiscal_zone = :india
+    => :india
+    Date.fy_start_month
+    => 4
+    Date.fiscal_zone
+    => :india
+    Date.fy_start_month = 7
+    => 7
+    Date.fy_start_month
+    => 7
+    Date.fiscal_zone
+    => nil
+
+If you want to add your own fiscal zone
+
+    RisingSun::Fiscali::FISCAL_ZONE.merge!(:my_own_zone => 2)
+
+should do the trick.
+
+## Date or Time Instance Methods
+
+    Date.fiscal_zone = :india
+    => :india
+    Date.fy_start_month
+    => 4
+    
+Indian Fiscal Year starts from 1st of April
+Assume Date.today is 1st May 2009
+
+ 
+##### financial_year -> Returns the financial year of the date/time
+    Date.today.financial_year
+    => 2009
+    Date.today.beginning_of_year.financial_year
+    => 2008
+ Since 1st Jan 2009 in India falls in the 2008-09 financial year
+
+##### beginning_of_financial_year -> Returns the beginning of financial year
+    Date.today.beginning_of_financial_year
+    => 1st April 2009
+    Date.today.beginning_of_year.beginning_of_financial_year
+    => 1st April 2008
+
+##### end_of_financial_year
+
+##### beginning_of_financial_q1
+##### end_of_financial_q1
+
+##### beginning_of_financial_q2
+##### end_of_financial_q2
+
+##### beginning_of_financial_q3
+##### end_of_financial_q3
+
+##### beginning_of_financial_q4
+##### end_of_financial_q4
+
+##### beginning_of_financial_h1
+##### end_of_financial_h1
+
+##### beginning_of_financial_h2
+##### end_of_financial_h2
+
+##### financial_quarter -> Returns Q1, Q2, Q3, Q4 depending on where the date falls
+	
+    Date.today.financial_quarter
+    => Q1
+    Date.today.beginning_of_year.financial_quarter
+    => Q4
+  
+##### financial_half -> Returns H1, H2 depending on where the date falls
+  
+    Date.today.financial_half
+    => H1
+    Date.today.beginning_of_year.financial_half
+    => H2
+  
+##### next_financial_quarter -> Takes you to the beginning of the next financial quarter
+
+    Date.today.next_financial_quarter
+    => 1st July 2009
+    
+##### next_financial_half -> Takes you to the beginning of the next financial half
+
+    Date.today.next_financial_half
+    => 1st October 2009
+
+##### beginning_of_financial_quarter -> Takes you to the beginning of the current financial quarter
+
+    Date.today.beginning_of_financial_quarter
+    => 1st April 2009
+    Date.today.beginning_of_year.beginning_of_financial_quarter
+    => 1st Jan 2009
+
+##### beginning_of_financial_half -> Takes you to the beginning of the current financial half
+
+    Date.today.beginning_of_financial_half
+    => 1st April 2009
+    Date.today.beginning_of_year.beginning_of_financial_quarter
+    => 1st Oct 2008
+
+##### previous_financial_quarter -> Takes you to the beginning of the previous financial quarter
+
+    Date.today.previous_financial_quarter
+    => 1st Jan 2009
+    Date.today.beginning_of_year.previous_financial_quarter
+    => 1st Oct 2008
+
+##### previous_financial_half -> Takes you to the beginning of the previous financial half
+
+    Date.today.previous_financial_half
+    => 1st Oct 2008
+    Date.today.beginning_of_year.previous_financial_quarter
+    => 1st Apr 2008
+    
+
+    
+
+
+
+  
+  
+
+
+  
+ 
+ 

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fiscali"
+    gem.summary = %Q{Fiscal Year Date Functions}
+    gem.email = "aditya.sanghi@risingsunbilling.com"
+    gem.homepage = "http://asanghi.github.com/fiscali"
+    gem.authors = ["Aditya Sanghi"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency('activesupport')
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fiscali #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.2.5

data/fiscali.gemspec

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fiscali}
+  s.version = "1.2.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aditya Sanghi"]
+  s.date = %q{2009-08-07}
+  s.email = %q{aditya.sanghi@risingsunbilling.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "fiscali.gemspec",
+     "install.rb",
+     "lib/fiscali.rb",
+     "lib/rising_sun/fiscali.rb",
+     "test/fiscali_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://asanghi.github.com/fiscali}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Fiscal Year Date Functions}
+  s.test_files = [
+    "test/fiscali_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/fiscali.rb

@@ -0,0 +1,3 @@
+require 'rising_sun/fiscali'
+Date.send(:include, RisingSun::Fiscali)
+Time.send(:include, RisingSun::Fiscali)

data/lib/rising_sun/fiscali.rb

@@ -0,0 +1,142 @@
+module RisingSun
+  module Fiscali
+    def self.included(base)
+      base.extend ClassMethods
+      unless included_modules.include? InstanceMethods
+        base.send(:include, InstanceMethods)
+      end
+    end
+
+    FISCAL_ZONE = {:india => 4, :uk => 4, :us => 10, :pakistan => 7,
+                   :australia => 7, :ireland => 1, :nz => 7, :japan => 4}
+    FY_START_MONTH = 1
+
+    module ClassMethods
+      def fiscal_zone=(zone)
+        write_inheritable_attribute(:start_month, FISCAL_ZONE[zone] || FY_START_MONTH)
+        write_inheritable_attribute(:zone,zone)
+      end
+
+      def fy_start_month
+        read_inheritable_attribute(:start_month) || FY_START_MONTH
+      end
+
+      def fiscal_zone
+        read_inheritable_attribute(:zone)
+      end
+
+      def fy_start_month=(month)
+      	write_inheritable_attribute(:zone, nil)
+        write_inheritable_attribute(:start_month,month)
+      end
+     
+      def financial_year_start(year=Date.today.year)
+        Date.new(year,fy_start_month,1)
+      end
+      
+      def financial_months
+        (1..12).map{|m| ((m - 1 + fy_start_month)%12.1).ceil }
+      end
+
+    end
+
+    module InstanceMethods
+      def financial_year
+        self.month < start_month ? self.year - 1 : self.year
+      end
+
+      def beginning_of_financial_year
+        change(:year => financial_year, :month => start_month, :day => 1)
+      end
+
+      def end_of_financial_year
+        (beginning_of_financial_year + 1.year - 1.month).end_of_month
+      end
+
+      alias :beginning_of_financial_q1 :beginning_of_financial_year
+      def end_of_financial_q1
+        end_of_financial_year - 9.months
+      end
+
+      def beginning_of_financial_q2
+        beginning_of_financial_year + 3.months
+      end
+
+      def end_of_financial_q2
+        end_of_financial_year - 6.months
+      end
+
+      def beginning_of_financial_q3
+        beginning_of_financial_year + 6.months
+      end
+
+      def end_of_financial_q3
+        end_of_financial_year - 3.months
+      end
+
+      def beginning_of_financial_q4
+        beginning_of_financial_year + 9.months
+      end
+      alias :end_of_financial_q4 :end_of_financial_year
+
+      alias :beginning_of_financial_h1 :beginning_of_financial_year
+      alias :end_of_financial_h1 :end_of_financial_q2
+
+      alias :beginning_of_financial_h2 :beginning_of_financial_q3
+      alias :end_of_financial_h2 :end_of_financial_year
+
+      def financial_quarter
+        "Q#{( months_between / 3 ).floor + 1} #{financial_year}"
+      end
+
+      def financial_half
+        "H#{( months_between / 6 ).floor + 1} #{financial_year}"
+      end
+
+      def next_financial_quarter
+        beginning_of_financial_year.months_since(((months_between / 3).floor + 1 ) * 3)
+      end
+
+      def next_financial_half
+        beginning_of_financial_year.months_since(((months_between / 6).floor + 1) * 6)
+      end
+
+      def beginning_of_financial_quarter
+        beginning_of_financial_year.months_since(((months_between / 3).floor) * 3)
+      end
+
+      def beginning_of_financial_half
+        beginning_of_financial_year.months_since(((months_between / 6).floor) * 6)
+      end
+
+      def previous_financial_quarter
+        beginning_of_financial_quarter.months_ago(3)
+      end
+
+      def previous_financial_half
+        beginning_of_financial_half.months_ago(6)
+      end
+
+      def financial_month_of(month)
+        if month < start_month
+          Date.new(year+1,month,1) 
+        else
+          Date.new(year,month,1) 
+        end
+      end
+ 
+      private
+
+      def months_between
+        soy = self.beginning_of_financial_year
+        (self.month - soy.month) + 12 * (self.year - soy.year)
+      end
+
+      def start_month
+        self.class.read_inheritable_attribute(:start_month) || FY_START_MONTH
+      end
+
+    end
+
+  end
+end

data/test/fiscali_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+class FiscaliTest < ActiveSupport::TestCase
+  test "date test" do
+    Date.fiscal_zone = :india
+    assert_equal(Date.fiscal_zone,:india)
+    assert_equal(Date.fy_start_month,4)
+    Date.fy_start_month = 2
+    assert_equal(Date.fy_start_month,2)
+
+    Date.fiscal_zone = :india
+    
+    d = Date.financial_year_start(2009)
+    assert_equal(d,Date.new(2009,4,1),'Financial Year start not correct')
+
+    d = Date.new(2009,1,1)
+    assert_equal(d.financial_year,2008,'Financial Year is not correct')
+    assert_equal(d.beginning_of_financial_year,Date.new(2008,4,1),'Beginning of FY is not correct')
+    assert_equal(d.beginning_of_financial_h1,Date.new(2008,4,1),'Beginning of h1 is not correct')
+    assert_equal(d.beginning_of_financial_h2,Date.new(2008,10,1),'Beginning of h2 is not correct')
+    assert_equal(d.beginning_of_financial_q1,Date.new(2008,4,1),'Beginning of q1 is not correct')
+    assert_equal(d.beginning_of_financial_q2,Date.new(2008,7,1),'Beginning of q2 is not correct')
+    assert_equal(d.beginning_of_financial_q3,Date.new(2008,10,1),'Beginning of q3 is not correct')
+    assert_equal(d.beginning_of_financial_q4,Date.new(2009,1,1),'Beginning of q4 is not correct')
+
+    assert_equal(d.end_of_financial_year,Date.new(2009,3,31),'End of FY is not correct')
+    assert_equal(d.end_of_financial_h1,Date.new(2008,9,30),'End of h1 is not correct')
+    assert_equal(d.end_of_financial_h2,Date.new(2009,3,31),'End of h2 is not correct')
+    assert_equal(d.end_of_financial_q1,Date.new(2008,6,30),'End of q1 is not correct')
+    assert_equal(d.end_of_financial_q2,Date.new(2008,9,30),'End of q2 is not correct')
+    assert_equal(d.end_of_financial_q3,Date.new(2008,12,31),'End of q3 is not correct')
+    assert_equal(d.end_of_financial_q4,Date.new(2009,3,31),'End of q4 is not correct')
+
+    assert_equal(d.financial_quarter,'Q4 2008','Financial Quarter is not correct')
+    assert_equal(Date.new(2008,4,1).financial_quarter,'Q1 2008','Financial Quarter is not correct')
+    assert_equal(d.financial_half,'H2 2008','Financial Half is not correct')
+    assert_equal(Date.new(2009,11,30).financial_half,'H2 2009','Financial Half is not correct')
+
+    assert_equal(d.next_financial_half,Date.new(2009,4,1),'Next Financial Half is not correct')
+    assert_equal(d.next_financial_quarter,Date.new(2009,4,1),'Next Financial Quarter is not correct')
+    assert_equal(Date.new(2009,6,1).next_financial_half,Date.new(2009,10,1), 'Next Financial Half is not correct')
+    assert_equal(Date.new(2009,10,30).next_financial_quarter,Date.new(2010,1,1),'Next Financial Quarter is not correct')
+
+    assert_equal(d.beginning_of_financial_half,
+                 Date.new(2008,10,1),'Beginning of Financial Half is not correct')
+    assert_equal(d.beginning_of_financial_quarter,
+                 Date.new(2009,1,1),'Beginning of Financial Quarter is not correct')
+    assert_equal(Date.new(2009,6,1).beginning_of_financial_half,
+                 Date.new(2009,4,1), 'Beginning of Financial Half is not correct')
+    assert_equal(Date.new(2009,10,30).beginning_of_financial_quarter,
+                 Date.new(2009,10,1),'Beginning of Financial Quarter is not correct')
+
+    assert_equal(d.previous_financial_half,
+                 Date.new(2008,4,1),'Previous Financial Half is not correct')
+    assert_equal(d.previous_financial_quarter,
+                 Date.new(2008,10,1),'Previous Financial Quarter is not correct')
+    assert_equal(Date.new(2009,6,1).previous_financial_half,
+                 Date.new(2008,10,1), 'Previous Financial Half is not correct')
+    assert_equal(Date.new(2009,10,30).previous_financial_quarter,
+                 Date.new(2009,7,1),'Previous Financial Quarter is not correct')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: fiscali
+version: !ruby/object:Gem::Version 
+  version: 1.2.5
+platform: ruby
+authors: 
+- Aditya Sanghi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-07 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: aditya.sanghi@risingsunbilling.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- fiscali.gemspec
+- install.rb
+- lib/fiscali.rb
+- lib/rising_sun/fiscali.rb
+- test/fiscali_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://asanghi.github.com/fiscali
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Fiscal Year Date Functions
+test_files: 
+- test/fiscali_test.rb
+- test/test_helper.rb