fiscali 2.1.0 → 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f096b0e625d535cfab0ef4fb042d8a84c156d04
+  data.tar.gz: c79a080e90633c17243feb00ca795b08cb56d8ef
+SHA512:
+  metadata.gz: cdfd4a1bdfaf3db71a9beb6c45309a59c24421a2893ed7ea7fd2d25b9b0202e5cc4bf00ed90c3ded5194cf283f9c9fa46890bccb899fa0b3d5a9e072ce06762c
+  data.tar.gz: 3ffae119410db7eb24c80d73c7059b6ee25bd498b4e25a255916eef4f7c682e9b41427ff8a1c70860ff5929ca10c1ce7212862415a411f2fd94df2506ff33ffb

data/CHANGELOG

@@ -0,0 +1,14 @@
+v2.2.0
+======
+
+* Added forward year support
+
+By default the financial year is reported as the year in which the financial year starts. e.g. 2008-09 is reported as 2008.
+However, some countries it is reported as 2008-09 is reported as 2009. You can now make this setting using
+
+Date.use_forward_year! and report the currently set as Date.uses_forward_year?
+The value can be reset using Date.reset_forward_year!
+
+* Added Changelog
+
+* Added Contributors

data/README.markdown

@@ -15,7 +15,7 @@ Fiscali provides ONE thing:
 
     # Install the gem (from gemcutter.org):
     sudo gem install fiscali
-    
+
 ## Using in your Rails project
 
 It's easy to get up and running. Update your config/environment.rb file with this gem
@@ -32,17 +32,34 @@ Next step is to provide your Date/Time class your start zone. Stick this in an i
     Time.fiscal_zone = :india
 or
     Date.start_month = 4
-    
+
+you can also determine the default for Year Forward by adding this to the same initializer file:
+
+    Date.use_forward_year!
+    Time.use_forward_year!
+
+or if you wish to revert back to the default
+
+    Date.reset_forward_year!
+    Time.reset_forward_year!
+
+Year Forward refers to the standard name for a fiscal year. For example:
+* If FY 2008 spans 2008 - 2009, set to false or don't include in initializer file.
+* If FY 2008 spans 2007 - 2008, set to true in initializer file.
 
 ### Default options
 
-By default, the financial year start in January. (Correct me but thats not a common start of financial year!)
+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}
+
+    {:india => 4, :uk => 4, :us => 10, :pakistan => 7, :australia => 7, :ireland => 1, :nz => 7, :japan => 4}
+
+By default, the Year Forward option is set to false, meaning the term FY 2008 spans 2008-2009 years.
 
 ## Date or Time Class Methods
-    
+
+### Fiscal Zone and FY Start Month
+
     Date.fy_start_month
     => 1
     Date.fiscal_zone = :india
@@ -58,6 +75,22 @@ Known Zones are  -
     Date.fiscal_zone
     => nil
 
+### Year Forward (Assume Date.today is 1st May 2009 and the fy_start_month = 4)
+
+    Date.uses_forward_year?
+    => false
+    Date.today.financial_year
+    => 2009
+
+    Date.use_forward_year!
+    => true
+    Date.today.financial_year
+    => 2010
+    Date.uses_forward_year?
+    => true
+
+
+
 If you want to add your own fiscal zone
 
     RisingSun::Fiscali::FISCAL_ZONE.merge!(:my_own_zone => 2)
@@ -70,11 +103,11 @@ should do the trick.
     => :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
@@ -109,24 +142,24 @@ Assume Date.today is 1st May 2009
 ##### 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
@@ -159,16 +192,21 @@ Assume Date.today is 1st May 2009
     => 1st Oct 2008
     Date.today.beginning_of_year.previous_financial_quarter
     => 1st Apr 2008
-    
 
-    
+
+## Contributors
+
+@asanghi
+@chiperific
+Rachel Shallit
+
+
+
+
+
+
 
 
 
-  
-  
 
 
-  
- 
- 

data/lib/rising_sun/fiscali.rb

@@ -3,11 +3,11 @@ module RisingSun
     def self.included(base)
       base.extend ClassMethods
     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)
@@ -27,19 +27,35 @@ module RisingSun
         @fiscali_zone = nil
         @fiscali_start_month = month
       end
-     
+
       def financial_year_start(year=Date.today.year)
         new(year,fy_start_month,1)
       end
-      
+
       def financial_months
         (1..12).map{|m| ((m - 1 + fy_start_month)%12.1).ceil }
       end
 
+      def use_forward_year!
+        @fy_forward = true
+      end
+
+      def reset_forward_year!
+        @fy_forward = false
+      end
+
+      def uses_forward_year?
+        @fy_forward || false
+      end
+
     end
 
     def financial_year
-      self.month < start_month ? self.year - 1 : self.year
+      if self.class.uses_forward_year?
+        self.month < start_month ? self.year : self.year + 1
+      else
+        self.month < start_month ? self.year - 1 : self.year
+      end
     end
 
     def beginning_of_financial_year
@@ -116,12 +132,12 @@ module RisingSun
 
     def financial_month_of(month)
       if month < start_month
-        Date.new(year+1,month,1) 
+        Date.new(year+1,month,1)
       else
-        Date.new(year,month,1) 
+        Date.new(year,month,1)
       end
     end
- 
+
     private
 
     def months_between

data/lib/rising_sun/version.rb

@@ -1,5 +1,5 @@
 module RisingSun
   module Fiscali
-    VERSION = "2.1.0"
+    VERSION = "2.2.0"
   end
 end

data/spec/fiscali_spec.rb

@@ -4,17 +4,17 @@ describe "fiscali" do
   it "should be possible to read fiscal zone" do
     Date.fiscal_zone.should be_nil
   end
-  
+
   it "should be possible to write fiscal zone" do
     Date.fiscal_zone = :india
     Date.fiscal_zone.should eql(:india)
   end
-  
+
   it "should be possible to read fiscal start month" do
     Date.fy_start_month = 2
     Date.fy_start_month.should eql(2)
   end
-  
+
   it "should report financial year start" do
     Date.fiscal_zone = :india
     this_year = Date.today.year
@@ -23,6 +23,29 @@ describe "fiscali" do
     Date.financial_year_start(2009).should eql(Date.new(2009,4,1))
   end
 
+  context "Forward Year settings" do
+    after(:each) do
+      Date.reset_forward_year!
+    end
+
+    it "should be possible to read year forward field" do
+      Date.uses_forward_year?.should eql(false)
+    end
+
+    it "should be possible to set year forward field" do
+      Date.use_forward_year!
+      Date.uses_forward_year?.should eql(true)
+    end
+
+    it "should report the correct financial eyar if forward year is being used" do
+      Date.use_forward_year!
+      @d = Date.new(2009,1,1)
+      @d.financial_year.should eql(2009)
+      @d = Date.new(2009,4,1)
+      @d.financial_year.should eql(2010)
+    end
+  end
+
   context "should report correct date field" do
     before(:each) do
       @d = Date.new(2009,1,1)
@@ -30,12 +53,12 @@ describe "fiscali" do
     it "should report correct financial year" do
       @d.financial_year.should eql(2008)
     end
-    
+
     it "should report correct beginning and of financial year" do
       @d.beginning_of_financial_year.should eql(Date.new(2008,4,1))
       @d.end_of_financial_year.should eql(Date.new(2009,3,31))
     end
-    
+
     it "should report correct beginning of financial halves and quarters" do
       @d.beginning_of_financial_h1.should eql(Date.new(2008,4,1))
       @d.beginning_of_financial_h2.should eql(Date.new(2008,10,1))
@@ -44,7 +67,7 @@ describe "fiscali" do
       @d.beginning_of_financial_q3.should eql(Date.new(2008,10,1))
       @d.beginning_of_financial_q4.should eql(Date.new(2009,1,1))
     end
-      
+
     it "should report correct end of financial halves and quarters" do
       @d.end_of_financial_h1.should eql(Date.new(2008,9,30))
       @d.end_of_financial_h2.should eql(Date.new(2009,3,31))
@@ -62,7 +85,7 @@ describe "fiscali" do
       @d.financial_half.should eql('H2 2008')
       Date.new(2009,11,30).financial_half.should eql("H2 2009")
     end
-    
+
     it "should report next half and quarter" do
       @d.next_financial_half.should eql(Date.new(2009,4,1))
       Date.new(2009,6,1).next_financial_half.should eql(Date.new(2009,10,1))
@@ -70,14 +93,14 @@ describe "fiscali" do
       @d.next_financial_quarter.should eql(Date.new(2009,4,1))
       Date.new(2009,10,30).next_financial_quarter.should eql(Date.new(2010,1,1))
     end
-    
+
     it "should report beginning of financial half and quarter" do
       @d.beginning_of_financial_half.should eql(Date.new(2008,10,1))
       @d.beginning_of_financial_quarter.should eql(Date.new(2009,1,1))
       Date.new(2009,6,1).beginning_of_financial_half.should eql(Date.new(2009,4,1))
       Date.new(2009,10,30).beginning_of_financial_quarter.should eql(Date.new(2009,10,1))
     end
-      
+
     it "should report previous financial half and quarter" do
       @d.previous_financial_half.should eql(Date.new(2008,4,1))
       @d.previous_financial_quarter.should eql(Date.new(2008,10,1))

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: fiscali
 version: !ruby/object:Gem::Version
-  version: 2.1.0
-  prerelease: 
+  version: 2.2.0
 platform: ruby
 authors:
 - Aditya Sanghi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !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: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
 description: Fiscal Year Date Functions
@@ -66,9 +59,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .travis.yml
+- ".document"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.markdown
@@ -82,27 +76,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/asanghi/fiscali
 licenses: []
+metadata: {}
 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.21
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fiscal Year Date Functions
 test_files:
 - spec/fiscali_spec.rb