File::TreeCreate(3)            User Contributed Perl Documentation            File::TreeCreate(3)



NAME
       File::TreeCreate - recursively create a directory tree.

VERSION
       version 0.0.1

SYNOPSIS
           use File::TreeCreate ();

           my $t = File::TreeCreate->new();

           my $tree = {
               'name' => "tree-create--tree-test-1/",
               'subs' => [
                   {
                       'name'     => "b.doc",
                       'contents' => "This file was spotted in the wild.",
                   },
                   {
                       'name' => "a/",
                   },
                   {
                       'name' => "foo/",
                       'subs' => [
                           {
                               'name' => "yet/",
                           },
                       ],
                   },
               ],
           };

           $t->create_tree( "./t/sample-data/", $tree );

           # TEST
           is_deeply(
               $t->ls("./t/sample-data/tree-create--tree-test-1"),
               [ "a", "b.doc", "foo" ],
               "Testing the contents of the root tree"
           );

DESCRIPTION
       This module was extracted from several near-identical copies used in the tests of some of
       my CPAN distributions.

METHODS
   $obj->cat($path)
       Slurp the file.

   $obj->create_tree($unix_init_path, $tree)
       create the tree.

   $obj->exist($path)
       Does the path exist

   $obj->get_path($path)
       Canonicalize the path from UNIX-like.

   $obj->is_dir($path)
       is the path a directory.

   $obj->is_file($path)
       is the path a file.

   $obj->ls($dir_path)
       list files in a directory

   my $obj = File::TreeCreate->new()
       Instantiates a new object.

SUPPORT
   Websites
       The following websites have more information about this module, and may be of help to you.
       As always, in addition to those websites please use your favorite search engine to
       discover more resources.

       ·   MetaCPAN

           A modern, open-source CPAN search engine, useful to view POD in HTML format.

           <https://metacpan.org/release/File-TreeCreate>

       ·   RT: CPAN's Bug Tracker

           The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

           <https://rt.cpan.org/Public/Dist/Display.html?Name=File-TreeCreate>

       ·   CPANTS

           The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

           <http://cpants.cpanauthors.org/dist/File-TreeCreate>

       ·   CPAN Testers

           The CPAN Testers is a network of smoke testers who run automated tests on uploaded
           CPAN distributions.

           <http://www.cpantesters.org/distro/F/File-TreeCreate>

       ·   CPAN Testers Matrix

           The CPAN Testers Matrix is a website that provides a visual overview of the test
           results for a distribution on various Perls/platforms.

           <http://matrix.cpantesters.org/?dist=File-TreeCreate>

       ·   CPAN Testers Dependencies

           The CPAN Testers Dependencies is a website that shows a chart of the test results of
           all dependencies for a distribution.

           <http://deps.cpantesters.org/?module=File::TreeCreate>

   Bugs / Feature Requests
       Please report any bugs or feature requests by email to "bug-file-treecreate at
       rt.cpan.org", or through the web interface at
       <https://rt.cpan.org/Public/Bug/Report.html?Queue=File-TreeCreate>. You will be
       automatically notified of any progress on the request by the system.

   Source Code
       The code is open to the world, and available for you to hack on. Please feel free to
       browse it and play with it, or whatever. If you want to contribute patches, please send me
       a diff or prod me to pull from your repository :)

       <https://github.com/shlomif/perl-File-TreeCreate>

         git clone git://github.com/shlomif/perl-File-TreeCreate.git

AUTHOR
       Shlomi Fish <shlomif AT cpan.org>

BUGS
       Please report any bugs or feature requests on the bugtracker website
       <https://github.com/shlomif/perl-File-TreeCreate/issues>

       When submitting a bug or request, please include a test-file or a patch to an existing
       test-file that illustrates the bug or desired feature.

COPYRIGHT AND LICENSE
       This software is Copyright (c) 2021 by Shlomi Fish.

       This is free software, licensed under:

         The MIT (X11) License



perl v5.20.2                                2024-03-08                        File::TreeCreate(3)