.\" 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::File::ShareDir::Object::Module 3pm"
.TH Test::File::ShareDir::Object::Module 3pm "2022-06-17" "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::File::ShareDir::Object::Module \- Object Oriented ShareDir creation for modules
.SH "VERSION"
.IX Header "VERSION"
version 1.001002
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Test::File::ShareDir::Object::Module;
\&
\&    my $dir = Test::File::ShareDir::Object::Module\->new(
\&        root    => "some/path",
\&        modules => {
\&            "Hello::Nurse" => "share/HN"
\&        },
\&    );
\&
\&    $dir\->install_all_modules;
\&    $dir\->add_to_inc;
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """module_names"""
.el .SS "\f(CWmodule_names\fP"
.IX Subsection "module_names"
.Vb 1
\&    my @names = $instance\->module_names();
.Ve
.PP
Returns the names of all modules listed in the \f(CW\*(C`modules\*(C'\fR set.
.ie n .SS """module_share_target_dir"""
.el .SS "\f(CWmodule_share_target_dir\fP"
.IX Subsection "module_share_target_dir"
.Vb 1
\&    my $dir = $instance\->module_share_target_dir("Module::Name");
.Ve
.PP
Returns the path where the \f(CW\*(C`ShareDir\*(C'\fR will be created for \f(CW\*(C`Module::Name\*(C'\fR
.ie n .SS """module_share_source_dir"""
.el .SS "\f(CWmodule_share_source_dir\fP"
.IX Subsection "module_share_source_dir"
.Vb 1
\&    my $dir = $instance\->module_share_source_dir("Module::Name");
.Ve
.PP
Returns the path where the \f(CW\*(C`ShareDir\*(C'\fR will be \fB\s-1COPIED\s0\fR \fI\s-1FROM\s0\fR for \f(CW\*(C`Module::Name\*(C'\fR
.ie n .SS """install_module"""
.el .SS "\f(CWinstall_module\fP"
.IX Subsection "install_module"
.Vb 1
\&    $instance\->install_module("Module::Name");
.Ve
.PP
Installs \f(CW\*(C`Module::Name\*(C'\fR's \f(CW\*(C`ShareDir\*(C'\fR
.ie n .SS """install_all_modules"""
.el .SS "\f(CWinstall_all_modules\fP"
.IX Subsection "install_all_modules"
.Vb 1
\&    $instance\->install_all_modules();
.Ve
.PP
Installs all \f(CW\*(C`module_names\*(C'\fR.
.ie n .SS """add_to_inc"""
.el .SS "\f(CWadd_to_inc\fP"
.IX Subsection "add_to_inc"
\&\fB\s-1DEPRECATED:\s0\fR Use \f(CW\*(C`register\*(C'\fR instead.
.ie n .SS """register"""
.el .SS "\f(CWregister\fP"
.IX Subsection "register"
.Vb 1
\&    $instance\->register();
.Ve
.PP
Adds the \f(CW\*(C`Tempdir\*(C'\fR \f(CW\*(C`ShareDir\*(C'\fR (  \f(CW\*(C`inc\*(C'\fR ) to the global \f(CW@INC\fR
.PP
\&\fISince 1.001000\fR
.ie n .SS """clear"""
.el .SS "\f(CWclear\fP"
.IX Subsection "clear"
.Vb 1
\&    $instance\->clear();
.Ve
.PP
Removes the \f(CW\*(C`Tempdir\*(C'\fR \f(CW\*(C`ShareDir\*(C'\fR ( \f(CW\*(C`inc\*(C'\fR ) from the global \f(CW@INC\fR
.PP
\&\fISince 1.001000\fR
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .SS """inc"""
.el .SS "\f(CWinc\fP"
.IX Subsection "inc"
A \f(CW\*(C`Test::File::ShareDir::Object::Inc\*(C'\fR object.
.ie n .SS """modules"""
.el .SS "\f(CWmodules\fP"
.IX Subsection "modules"
A hash of :
.PP
.Vb 1
\&    Module::Name => "relative/path"
.Ve
.ie n .SS """root"""
.el .SS "\f(CWroot\fP"
.IX Subsection "root"
The origin all paths's are relative to.
.PP
( Defaults to \f(CW\*(C`cwd\*(C'\fR )
.SH "AUTHOR"
.IX Header "AUTHOR"
Kent Fredric <kentnl@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by Kent Fredric <kentnl@cpan.org>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.