NAME

Mojo::ShareDir - Shared files and directories as Mojo::File objects

SYNOPSIS

Example use of Mojo::ShareDir

  use Mojo::ShareDir;

  # This will result in the same thing
  my $path = Mojo::ShareDir->new('My-Application');
  my $path = Mojo::ShareDir->new('My::Application');
  my $path = Mojo::ShareDir->new(My::Application->new);

Example Makefile.PL

  use strict;
  use warnings;
  use ExtUtils::MakeMaker;
  use File::ShareDir::Install;

  install_share 'share';
  WriteMakefile(...);

  package MY;
  use File::ShareDir::Install qw(postamble);

DESCRIPTION

Mojo::ShareDir is a module that allows you to find shared files. This module works together with File::ShareDir::Install, which allow you to install assets that are not Perl related. In addition, Mojo::ShareDir makes it very easy to find the files that you have not yet installed by looking for projects after resolving @INC.

FUNCTIONS

Mojo::ShareDir implements the following functions, which can be imported individually.

dist_path

  my $path = dist_path;
  my $path = dist_path "Some-Dist", @path;
  my $path = dist_path "Some::Module", @path;
  my $path = dist_path $some_object, @path;

Construct a new Mojo::ShareDir object. Follows the same rules as "new".

METHODS

Mojo::ShareDir inherits all methods from Mojo::File and implements the following new ones.

new

  my $path = Mojo::ShareDir->new;
  my $path = Mojo::ShareDir->new("Some-Dist", @path);
  my $path = Mojo::ShareDir->new("Some::Module", @path);
  my $path = Mojo::ShareDir->new($some_object, @path);

Construct a new Mojo::ShareDir object with $path set to either the local "share/" path or the installed for a given distribution.

Will throw an exception if the distribution cannot be found.

To resolve the shared path, these rules will apply:

• No arguments

  Will use the caller package name.

• A dist name

  To resolve the local path, by converting the dist name into a module name, and look it up in %INC. This means the module need to be loaded.

• A module name

  See "A dist name" above.

• An object

  Will find the class name for the object and apply the same rule as for "A module name".

AUTHOR

Jan Henning Thorsen

COPYRIGHT AND LICENSE

Copyright (C), Jan Henning Thorsen.

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.

SEE ALSO

File::ShareDir::Install

File::ShareDir

File::Share

cpanm Mojo::ShareDir

perl -MCPAN -e shell
install Mojo::ShareDir