.\" 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 "Directory::Scratch::Structured 3pm" .TH Directory::Scratch::Structured 3pm "2010-03-22" "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" .Vb 1 \& Directory::Scratch::Structured \- creates temporary files and directories from a structured description .Ve .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 10 \& my %tree_structure = \& ( \& dir_1 => \& { \& subdir_1 =>{}, \& file_1 =>[], \& file_a => [], \& }, \& dir_2 => \& { \& subdir_2 => \& { \& file_22 =>[], \& file_2a =>[], \& }, \& file_2 =>[], \& file_a =>[\*(Aq12345\*(Aq], \& file_b =>[], \& }, \& \& file_0 => [] , \& ) ; \& \& use Directory::Scratch::Structured qw(create_structured_tree) ; \& my $temporary_directory = create_structured_tree(%tree_structure) ; \& \& or \& \& use Directory::Scratch ; \& use Directory::Scratch::Structured qw(piggyback_directory_scratch) ; \& \& my $temporary_directory = Directory::Scratch\->new; \& $temporary_directory\->create_structured_tree(%tree_structure) ; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module adds a \fIcreate_structured_tree\fR subroutine to the Directory::Scratch. .SH "DOCUMENTATION" .IX Header "DOCUMENTATION" I needed a subroutine to create a bunch of temporary directories and files while running tests. I used the excellent Directory::Scratch to implement such a functionality. I proposed the subroutine to the Directory::Scratch author but he preferred to implement a subroutine using an unstructured input data based on the fact that Directory::Scratch didn't use structured data. This is, \s-1IMHO\s0, flawed design, though it may require slightly less typing. .PP I proposed a hybrid solution to reduce the amount of subroutines and integrate the subroutine using structured input into Directory::Scratch but we didn't reach an agreement on the \s-1API\s0. Instead I decided that I would piggyback on Directory::Scratch. .PP You can access \fIcreate_structured_tree\fR through a subroutine or a method through a Directory::Scratch object. .PP Whichever interface you choose, the argument to the \fIcreate_structured_tree\fR consists of tuples (hash entries). The key represents the name of the object to create in the directory. .PP If the value is of type: .IP "\s-1ARRAY\s0" 2 .IX Item "ARRAY" A file will be created, it's contents are the contents of the array (See Directory::Scratch) .IP "\s-1HASH\s0" 2 .IX Item "HASH" A directory will be created. the element of the hash will also be , recursively, created .IP "\s-1OTHER\s0" 2 .IX Item "OTHER" The subroutine will croak. .SH "SUBROUTINES/METHODS" .IX Header "SUBROUTINES/METHODS" .SS "create_structured_tree" .IX Subsection "create_structured_tree" .Vb 1 \& use Directory::Scratch::Structured qw(create_structured_tree) ; \& \& my $temporary_directory = create_structured_tree(%tree_structure) ; \& my $base = $temporary_directory\->base() ; .Ve .PP Returns a default Directory::Scratch object. .SS "directory_scratch_create_structured_tree" .IX Subsection "directory_scratch_create_structured_tree" Adds \fIcreate_structured_tree\fR to Directory::Scratch when you Load \fBDirectory::Scratch::Structured\fR with the \fBpiggyback_directory_scratch\fR option. .PP .Vb 2 \& use Directory::Scratch ; \& use Directory::Scratch::Structured qw(piggyback_directory_scratch) ; \& \& my $temporary_directory = Directory::Scratch\->new; \& $temporary_directory\->create_structured_tree(%tree_structure) ; .Ve .SS "_create_structured_tree" .IX Subsection "_create_structured_tree" Used internally by both interfaces .SS "piggyback" .IX Subsection "piggyback" Used internally to piggyback Directory::Scratch. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" None so far. .SH "AUTHOR" .IX Header "AUTHOR" .Vb 3 \& Khemir Nadim ibn Hamouda \& CPAN ID: NKH \& mailto:nadim@khemir.net .Ve .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SUPPORT" .IX Header "SUPPORT" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc Directory::Scratch::Structured .Ve .PP You can also look for information at: .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp .IP "\(bu" 4 \&\s-1RT:\s0 \s-1CPAN\s0's request tracker .Sp Please report any bugs or feature requests to L . .Sp We will be notified, and then you'll automatically be notified of progress on your bug as we make changes. .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp .SH "SEE ALSO" .IX Header "SEE ALSO" Directory::Scratch