.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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 "Locale::Maketext::Utils::Mock 3"
.TH Locale::Maketext::Utils::Mock 3 "2014-11-18" "perl v5.16.3" "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"
Locale::Maketext::Utils::Mock \- mock locale object
.SH "VERSION"
.IX Header "VERSION"
This document describes Locale::Maketext::Utils::Mock version 0.1
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Locale::Maketext::Utils::Mock;
\&    my $lh = Locale::Maketext::Utils::Mock\->get_handle();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Often we need to create a class so we can do a Locale::Maketext[::Utils] testing but Locale::Maketext is not designed for direct use. Instead you need to create a class with a lexicon and at least the 'en' subclass of that.
.PP
This module does all the work for you and behaves like a typical Locale::Maketext::Utils object.
.PP
You can also add additional locales at will.
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "\fIget_handle()\fP"
.IX Subsection "get_handle()"
Requires the Locale::Maketext::Utils::Mock based locale handle.
.SS "\fIinit_mock_locales()\fP"
.IX Subsection "init_mock_locales()"
If you want more than 'en' you can initialize them using \fIinit_mock_locales()\fR;
.PP
It takes a list of locales tags, passes them through \fILocales::normalize_tag()\fR and creates the subclass for each one that can be used to create a Locales object or that is an “i_” tag (e.g. i_yoda).
.PP
.Vb 4
\&    use Locale::Maketext::Utils::Mock ();
\&    Locale::Maketext::Utils::Mock\->init_mock_locales(\*(Aqfr\*(Aq, \*(Aqit\*(Aq, \*(Aqen_gb\*(Aq);
\&    my $it = Locale::Maketext::Utils::Mock\->get_handle(\*(Aqit\*(Aq); # Locale::Maketext::Utils::Mock::it object.
\&    my $ja = Locale::Maketext::Utils::Mock\->get_handle(\*(Aqjs\*(Aq); # Locale::Maketext::Utils::Mock::en object since there is no \*(Aqja\*(Aq subclass.
.Ve
.PP
It can be called as a function, a class method, or object method.
.PP
It returns the number of subclasses successfully created.
.SS "\fIcreate_method()\fP"
.IX Subsection "create_method()"
Takes a hashref whose keys are the methods to make for mocked objects.
.PP
The values are either a coderef for the method or undef. Undef will result in a coderef that returns “I am $\fIkey()\fR”.
.PP
.Vb 4
\&    use Locale::Maketext::Utils::Mock ();
\&    Locale::Maketext::Utils::Mock\->create_method({ method_x => undef, method_y => sub { return "YABBA DABBA $_[1]" } });
\&    my $lh = Locale::Maketext::Utils::Mock\->get_handle();
\&    print $lh\->maketext("Blah [method_x] blah [method_y,_1] blah.", 42); $ Blah I am method_x() blah YABBA DABBA 42 blah.
.Ve
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
\&\fIinit_mock_locales()\fR \fIcarp()\fRs if there was a problem createing the subclass.
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
Locale::Maketext::Utils::Mock requires no configuration files or environment variables.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Locale::Maketext::Utils
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None reported.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
No bugs have been reported.
.PP
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-locale\-maketext\-utils\-mock@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org>.
.SH "TODO"
.IX Header "TODO"
Depending on need/demand:
.PP
1. Add a way to define lexicon for specifical locales.
.PP
2. ? ability to create object in it's own class (so subclass modification are separate) ?
.SH "AUTHOR"
.IX Header "AUTHOR"
Daniel Muey  \f(CW\*(C`<http://drmuey.com/cpan_contact.pl>\*(C'\fR
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2012, Daniel Muey \f(CW\*(C`<http://drmuey.com/cpan_contact.pl>\*(C'\fR. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE \s0(\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0