Simple Exporter Interfaces

"Test::File::ShareDir::Dist" provides a simple export interface for making "TempDir" "ShareDir"'s from a given path:

    use Test::File::ShareDir::Dist { "Dist-Name" => "share/" };

This will automatically create a "ShareDir" for "Dist-Name" in a "TempDir" based on the contents of "CWD/share/"

See "Test::File::ShareDir::Dist" for details.

"Test::File::ShareDir::Module"

"Test::File::ShareDir::Module" provides a simple export interface for making "TempDir" "ShareDir"'s from a given path:

    use Test::File::ShareDir::Module { "Module::Name" => "share/" };

This will automatically create a "ShareDir" for "Module::Name" in a "TempDir" based on the contents of "CWD/share/"

See "Test::File::ShareDir::Module" for details.

Simple Object Oriented Interfaces

"Test::File::ShareDir::Object::Dist" provides a simple object oriented interface for making "TempDir" "ShareDir"'s from a given path:

    use Test::File::ShareDir::Object::Dist;

    my $obj = Test::File::ShareDir::Object::Dist->new( dists => { "Dist-Name" => "share/" } );
    $obj->install_all_dists;
    $obj->register;

This will automatically create a "ShareDir" for "Dist-Name" in a "TempDir" based on the contents of "CWD/share/"

See "Test::File::ShareDir::Object::Dist" for details.

"Test::File::ShareDir::Object::Module"

"Test::File::ShareDir::Object::Module" provides a simple object oriented interface for making "TempDir" "ShareDir"'s from a given path:

    use Test::File::ShareDir::Object::Module;

    my $obj = Test::File::ShareDir::Object::Module->new( modules => { "Module::Name" => "share/" } );
    $obj->install_all_modules;
    $obj->register;

This will automatically create a "ShareDir" for "Module::Name" in a "TempDir" based on the contents of "CWD/share/"

See "Test::File::ShareDir::Object::Module" for details.

IMPORT OPTIONS

This parameter is the prefix the other paths are relative to.

If this parameter is not specified, it defaults to the Current Working Directory ( "CWD" ).

In versions prior to 0.3.0, this value was mandatory.

The rationale behind using "CWD" as the default value is as follows.

• Most users of this module are likely to be using it to test distributions
• Most users of this module will be using it in "$project/t/" to load files from "$project/share/"
• Most "CPAN" tools run tests with "CWD" = $project

Therefor, defaulting to "CWD" is a reasonably sane default for most people, but where it is not it can still be overridden.

  -root => "$FindBin::Bin/../" # resolves to project root from t/ regardless of Cwd.

-share

This parameter is mandatory, and contains a "hashref" containing the data that explains what directories you want shared.

  -share =>  { ..... }

-module

"-module" contains a "hashref" mapping Module names to path names for module_dir style share dirs.

  -share => {
    -module => { 'My::Module' => 'share/mymodule/', }
  }

  ...

  module_dir('My::Module')

Notedly, it is a "hashref", which means there is a limitation of one share dir per module. This is simply because having more than one share dir per module makes no sense at all.

-dist

"-dist" contains a "hashref" mapping Distribution names to path names for dist_dir style share dirs. The same limitation applied to "-module" applies here.

  -share => {
    -dist => { 'My-Dist' => 'share/mydist' }
  }
  ...
  dist_dir('My-Dist')

with_dist_dir

  # with_dist_dir(\%config, \&sub);
  with_dist_dir( { 'Dist-Name' => 'share/' } => sub {

      # File::ShareDir resolves to a copy of share/ in this context.

  } );

%config can contain anything "Test::File::ShareDir::Dist" accepts.

"-root": Defaults to $CWD

"$distName": Declare $distName's "ShareDir".

Since 1.001000

with_module_dir

  # with_module_dir(\%config, \&sub);
  with_module_dir( { 'Module::Name' => 'share/' } => sub {

      # File::ShareDir resolves to a copy of share/ in this context.

  } );

%config can contain anything "Test::File::ShareDir::Module" accepts.

"-root": Defaults to $CWD

"$moduleName": Declare $moduleName's "ShareDir".

Since 1.001000