1. Manuals
  2. Tumbleweed
  3. perl-Test-File-ShareDir
  4. Test::File::ShareDir::Object::Dist(3pm)

Scroll to navigation

Test::File::ShareDir::Object::Dist(3) User Contributed Perl Documentation Test::File::ShareDir::Object::Dist(3)

NAME

Test::File::ShareDir::Object::Dist - Object Oriented ShareDir creation for distributions

VERSION

version 1.001002

SYNOPSIS

    use Test::File::ShareDir::Object::Dist;
    my $dir = Test::File::ShareDir::Object::Dist->new(
        root    => "some/path",
        dists => {
            "Hello-Nurse" => "share/HN"
        },
    );
    $dir->install_all_dists;
    $dir->add_to_inc;

METHODS

"dist_names"

    my @names = $instance->dist_names();

Returns the names of all distributions listed in the "dists" set.

"dist_share_target_dir"

    my $dir = $instance->dist_share_target_dir("Dist-Name");

Returns the path where the "ShareDir" will be created for "Dist-Name"

"dist_share_source_dir"

    my $dir = $instance->dist_share_source_dir("Dist-Name");

Returns the path where the "ShareDir" will be COPIED FROM for "Dist-Name"

"install_dist"

    $instance->install_dist("Dist-Name");

Installs "Dist-Name"'s "ShareDir"

"install_all_dists"

    $instance->install_all_dists();

Installs all "dist_names"

"add_to_inc"

DEPRECATED: Use "register" instead.

"register"

    $instance->register();

Adds the "Tempdir" "ShareDir" ( "inc" ) to the global @INC

Since 1.001000

"clear"

    $instance->clear();

Removes the "Tempdir" "ShareDir" ( "inc" ) from the global @INC

Since 1.001000

ATTRIBUTES

"inc"

A "Test::File::ShareDir::Object::Inc" object.

"dists"

A hash of :

    Dist-Name => "relative/path"

"root"

The origin all paths's are relative to.

( Defaults to "cwd" )

AUTHOR

Kent Fredric <kentnl@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Kent Fredric <kentnl@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2017-03-03 perl v5.40.0