https://github.com/jhthorsen/mojo-sharedir

Shared files and directories as Mojo::File objects
https://github.com/jhthorsen/mojo-sharedir

Last synced: 27 days ago
JSON representation

Shared files and directories as Mojo::File objects

• Host: GitHub
• URL: https://github.com/jhthorsen/mojo-sharedir
• Owner: jhthorsen
• Created: 2022-10-22T15:33:08.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-23T02:05:37.000Z (almost 2 years ago)
• Last Synced: 2024-10-16T11:58:22.962Z (3 months ago)
• Language: Perl
• Size: 21.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes

Awesome Lists containing this project

README

        
# 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](https://metacpan.org/pod/Mojo%3A%3AShareDir) is a module that allows you to find shared files. This

module works together with [File::ShareDir::Install](https://metacpan.org/pod/File%3A%3AShareDir%3A%3AInstall), which allow you to

install assets that are not Perl related. In addition, [Mojo::ShareDir](https://metacpan.org/pod/Mojo%3A%3AShareDir)

makes it very easy to find the files that you have not yet installed by

looking for projects after resolving `@INC`.

# FUNCTIONS

[Mojo::ShareDir](https://metacpan.org/pod/Mojo%3A%3AShareDir) 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](https://metacpan.org/pod/Mojo%3A%3AShareDir) object. Follows the same rules as ["new"](#new).

# METHODS

[Mojo::ShareDir](https://metacpan.org/pod/Mojo%3A%3AShareDir) inherits all methods from [Mojo::File](https://metacpan.org/pod/Mojo%3A%3AFile) 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](https://metacpan.org/pod/Mojo%3A%3AShareDir) 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](https://metacpan.org/pod/File%3A%3AShareDir%3A%3AInstall)

[File::ShareDir](https://metacpan.org/pod/File%3A%3AShareDir)

[File::Share](https://metacpan.org/pod/File%3A%3AShare)