Skip to content

fluxxlabs/fiscal

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fiscal

Get the fiscal period attributes for any company's fiscal date.

The gem extends the Date and Time classes to add a fiscal object, which in turn provides additional objects and methods to find fiscal year, half year, quarter and month, along with start and end dates.

Additionally, prev and next methods are available to step through fiscal periods.

The gem also supports fiscal calendars of different countries. Please see examples for more details.

Installation

Add this line to your application's Gemfile:

gem 'fiscal'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fiscal

Usage

The methods for fiscal periods are available both in Date and Time classes as well as in the instances.

A typical usage would be:

Date.today.fiscal.year.start
Date.today.fiscal.quarter.prev.end

Date.today.fiscal(mm: 4, dd: 6).quarter.next.start
Date.today.fiscal(mm: 3, dd: 1).month.number

Alternatively a fiscal object can be created for further use.

fiscal = Date.fiscal(date: '2014-01-01', mm: 4, dd: 6)
fiscal.year.start

fiscal_month = Date.fiscal(date: '2014-01-01', mm: 4, dd: 6).month
fiscal_month.start
fiscal_month.prev.end

See the fiscal_spec.rb file for more examples of usage

Contributing

  1. Fork it ( http://github.com/samyukti/fiscal/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%