DateTime-Fiscal-Retail454

 view release on metacpan or  search on metacpan

CREDITS  view on Meta::CPAN

The API was inspired by the parent module DateTime.  The source for DateTime
was reviewed numerous times to gleen ideas for implementation techniques and
to insure compatibility.

This module is indebted to the all of the work that has previously gone into
DateTime and the associated modules it depends upon.

Kudos to the National Retail Federation for granting persmission to reference
their webiste in the module's documentaiton for details on the
Retail 4-5-4 calendar.  The NRF was very helpful with details on how
merchants deal with years in the calendar that have 53 weeks.

Jim Bacon
North Texas Consulting

ChangeLog  view on Meta::CPAN

2012-07-05 20:26  jim

	* t/90_misc.t: Added explanatory comments.

2012-07-05 07:25  jim

	* t/01_sanity.t: Changed how number of tests is calculated.

2012-07-05 07:01  jim

	* t/r454_testdata: Updated to current calendars available at NRF

2006-12-02 00:25  jim

	* ChangeLog: Rename "Changes" to "ChangeLog" for easier use of
	  svn2cl

2006-12-02 00:21  jim

	* CREDITS: Added proper ackowledgement for National Retail
	  Federation

README  view on Meta::CPAN

DateTime-Fiscal-Retail454 version 0.03
===================================

NOTE!!! This module has been deprecated!
Please use DateTimeX::Fiscal::Fiscal5253 instead. That module has better
methods, more functionality, and support for 52/53 week fiscal years in
general beyond the NRF 4-5-4 calendar.

Compute dates used to create a 4-5-4 calendar from a DateTime object.

The 4-5-4 calendar is a fiscal calendar standard widely used by merchandisers
to allow easy comparisons between sales periods from year to year.  The
calendar is described at the National Retail Federation website.

http://www.nrf.com/content/default.asp?folder=services&file=finance_454.htm

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test

lib/DateTime/Fiscal/Retail454.pm  view on Meta::CPAN

 my $fp_end = $r454->r454_period_publish;	# period publish date
 
See the details below for each method for options.

=head1 DESCRIPTION

This module is a sub-class of C<DateTime> and inherits all methods and
capabilities, including constructors, of that module.

The purpose of this module is to make it easy to work with the 4-5-4
calendar that is common among merchandisers.  Details of the calendar itself
can be found at the National Retail Federation (NRF) website.
L<http://www.nrf.com/modules.php?name=Pages&sp_id=391>

All objects returned by any of the methods in this module or of the class
C<DateTime::Fiscal::Retail454> unless otherwise specified.

=head1 EXPORTS

None.

lib/DateTime/Fiscal/Retail454.pm  view on Meta::CPAN

=head2 r454_year

 my $r454 = DateTime::Fiscal::Retail454->new( year => 2006, month = 4 );
 print $r454->r454_year;	# print "2006"
 
 my $r454_2 = DateTime::Fiscal::Retail454->new( year => 2006, month = 1 );
 print $r454->r454_year;	# print "2005"

Returns a scalar containing the Fiscal Year that the object is in.  This is
not always the same as the calendar year, especially for dates in January and
occasionally in February.  This is because the start of the Fiscal Year is
tied to what day of the week Jan 31 of any given year falls on.

=head2 is_r454_leap_year

 my $r454 = DateTime::Fiscal::Retail454->new( r454year => 2006 );
 print "This is a Fiscal Leap Year" if $r454->is_r454_leap_year;

Returns a Boolean value indicating whether or not the Fiscal Year for the
object has 53 weeks instead of the standard 52 weeks.

t/r454_testdata  view on Meta::CPAN

# $Id$

# This structure contains the expected results for various tests.
# See 01_sanity.t for a good example of how it is used.
#
# The data has been compiled by looking at all available 4-5-4 calendars
# on the NRF website.  Please update this data as new ones become available
# over the years.

%r454_data = (
  2001 => {
    r454_year => 2001,
    r454_start => '2001-02-04T00:00:00',
    r454_end => '2002-02-02T23:59:59',
    is_r454_leap_year => 0,
    periods => {