.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Test::MockTime::DateCalc 3pm" .TH Test::MockTime::DateCalc 3pm "2022-10-16" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Test::MockTime::DateCalc \-\- fake time for Date::Calc functions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& use Test::MockTime; \& use Test::MockTime::DateCalc; # before Date::Calc loads \& # ... \& use My::Module::Using::Date::Calc; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`Test::MockTime::DateCalc\*(C'\fR arranges for the functions in \f(CW\*(C`Date::Calc\*(C'\fR to follow the Perl level \f(CW\*(C`time()\*(C'\fR function (see perlfunc) and in particular any fake date/time set there by \f(CW\*(C`Test::MockTime\*(C'\fR. The following \&\f(CW\*(C`Date::Calc\*(C'\fR functions are changed .PP .Vb 5 \& System_Clock \& Today \& Now \& Today_and_Now \& This_Year \& \& Gmtime \& Localtime \& Timezone \& Time_to_Date .Ve .PP \&\f(CW\*(C`Gmtime\*(C'\fR, \f(CW\*(C`Localtime\*(C'\fR, \f(CW\*(C`Timezone\*(C'\fR and \f(CW\*(C`Time_to_Date\*(C'\fR are made to default to the Perl-level current \f(CW\*(C`time()\*(C'\fR. When called with an explicit time argument, they're unchanged. .SS "Module Load Order" .IX Subsection "Module Load Order" \&\f(CW\*(C`Test::MockTime\*(C'\fR or similar fakery must be loaded first, before anything with a \f(CW\*(C`time()\*(C'\fR call, which includes \f(CW\*(C`Test::MockTime::DateCalc\*(C'\fR. This is the same as for any \f(CW\*(C`CORE::GLOBAL\*(C'\fR override, see \*(L"\s-1OVERRIDING CORE FUNCTIONS\*(R"\s0 in \s-1CORE\s0. .PP \&\f(CW\*(C`Test::MockTime::DateCalc\*(C'\fR must be loaded before \f(CW\*(C`Date::Calc\*(C'\fR. If \&\f(CW\*(C`Date::Calc\*(C'\fR is already loaded then its functions might have been imported into other modules and such imports are not affected by the redefinitions made. For that reason, \f(CW\*(C`Test::MockTime::DateCalc\*(C'\fR demands it be the one to load \f(CW\*(C`Date::Calc\*(C'\fR for the first time. Usually this simply means having \&\f(CW\*(C`Test::MockTime::DateCalc\*(C'\fR at the start of a test script, before the things you're going to test. .PP .Vb 4 \& use strict; \& use warnings; \& use Test::MockTime \*(Aq:all\*(Aq; \& use Test::MockTime::DateCalc; \& \& use My::Foo::Bar; \& \& set_fixed_time(\*(Aq1981\-01\-01T00:00:00Z\*(Aq); \& is (My::Foo::Bar::something(), 1981); \& restore_time(); .Ve .PP In a test script, it's often good to have your own modules early to check they correctly load their pre-requisites. You might want a separate test script for that so as not to accidentally rely on \&\f(CW\*(C`Test::MockTime::DateCalc\*(C'\fR loading \f(CW\*(C`Date::Calc\*(C'\fR. .SS "Other Faking Modules" .IX Subsection "Other Faking Modules" \&\f(CW\*(C`Test::MockTime::DateCalc\*(C'\fR can be used with other modules which mangle the Perl-level \f(CW\*(C`time\*(C'\fR too. For example \f(CW\*(C`Time::Fake\*(C'\fR, .PP .Vb 2 \& use Time::Fake; # fakery first \& use Test::MockTime::DateCalc; .Ve .PP Or \f(CW\*(C`Time::Mock\*(C'\fR, .PP .Vb 2 \& use Time::Mock; # fakery first \& use Test::MockTime::DateCalc; .Ve .PP \&\f(CW\*(C`Time::Warp\*(C'\fR (as of version 0.5) only exports a new \f(CW\*(C`time\*(C'\fR, it's not a core override and so can't be used with \f(CW\*(C`Test::MockTime::DateCalc\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" Date::Calc, Test::MockTime, Time::Fake, Time::Mock .PP \&\fBfaketime\fR\|(1) .SH "HOME PAGE" .IX Header "HOME PAGE" http://user42.tuxfamily.org/test\-mocktime\-datecalc/index.html .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2009, 2010, 2011, 2019 Kevin Ryde .PP Test-MockTime-DateCalc is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. .PP Test-MockTime-DateCalc is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with Test-MockTime-DateCalc. If not, see .