.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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" ''
'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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Dist::Zilla::Role::Tempdir 3"
.TH Dist::Zilla::Role::Tempdir 3 "2012-05-26" "perl v5.10.1" "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"
Dist::Zilla::Role::Tempdir \- Shell Out and collect the result in a DZ plug\-in.
.SH "VERSION"
.IX Header "VERSION"
version 0.01053721
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& package #
\& Dist::Zilla::Plugin::FooBar;
\&
\& use Moose;
\& with \*(AqDist::Zilla::Role::Tempdir\*(Aq;
\& with \*(AqDist::Zilla::Role::FileInjector\*(Aq;
\& with \*(AqDist::Zilla::Role::InstallTool\*(Aq;
\&
\& sub setup_installer {
\& my ( $self, $arg ) = @_ ;
\&
\& my ( @generated_files ) = $self\->capture_tempdir(sub{
\& system( $somecommand );
\& });
\&
\& for ( @generated_files ) {
\& if( $_\->is_new && $_\->name =~ qr/someregex/ ){
\& $self\->add_file( $_\->file );
\& }
\& }
\& }
.Ve
.PP
This role is a convenience role for factoring into other plug-ins to use the power of Unix
in any plug-in.
.PP
If for whatever reason you need to shell out and run your own app that is not Perl ( i.e.: Java )
to go through the code and make modifications, produce documentation, etc, then this role is for you.
.PP
Important to note however, this role \fB\s-1ONLY\s0\fR deals with getting \f(CW\*(C`Dist::Zilla\*(C'\fR's state written out to disk,
executing your given arbitrary code, and then collecting the results. At no point does it attempt to re-inject
those changes back into \f(CW\*(C`Dist::Zilla\*(C'\fR. That is left as an exercise to the plug-in developer.
.SH "METHODS"
.IX Header "METHODS"
.SS "capture_tempdir"
.IX Subsection "capture_tempdir"
Creates a File::Tempdir and dumps the current state of Dist::Zilla's files into it.
.PP
Runs the specified code sub \f(CW\*(C`chdir\*(C'\fR'ed into that \f(CW\*(C`tmpdir\*(C'\fR, and captures the changed files.
.PP
.Vb 1
\& my ( @array ) = $self\->capture_tempdir(sub{
\&
\& });
.Ve
.PP
Response is an array of \f(CW\*(C`::Tempdir::Item\*(C'\fR
.PP
.Vb 4
\& [ bless( { name => \*(Aqfile/Name/Here\*(Aq ,
\& status => \*(AqO\*(Aq # O = Original, N = New, M = Modified, D = Deleted
\& file => Dist::Zilla::Role::File object
\& }, \*(AqDist::Zilla::Tempdir::Item\*(Aq ) , bless ( ... ) ..... ]
.Ve
.PP
Make sure to look at \f(CW\*(C`Dist::Zilla::Tempdir::Item\*(C'\fR for usage.
.SS "digest_for"
.IX Subsection "digest_for"
.Vb 1
\& my $hash = $self\->digest_for( \e$content );
.Ve
.PP
Hashes content and returns the result in b64.
.SH "PRIVATE ATTRIBUTES"
.IX Header "PRIVATE ATTRIBUTES"
.SS "_digester"
.IX Subsection "_digester"
.Vb 3
\& isa => Digest::base,
\& is => rw,
\& lazy_build => 1
.Ve
.PP
Used for Digesting the contents of files.
.SH "PRIVATE METHODS"
.IX Header "PRIVATE METHODS"
.SS "_build_\|_digester"
.IX Subsection "_build__digester"
returns an instance of Digest::SHA with 512bit hashes.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
\&\f(CW\*(C`Dist::Zilla::Tempdir::Item\*(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) 2012 by Kent Fredric.
.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.