/ 
App-GenModEmbedder-0.001
River stage zero No dependents
/ App::GenModEmbedder

NAME

App::GenModEmbedder - Generate a piece of Perl code that embeds a module

VERSION

This document describes version 0.001 of App::GenModEmbedder (from Perl distribution App-GenModEmbedder), released on 2016-12-26.

FUNCTIONS

gen_mod_embedder(%args) -> [status, msg, result, meta]

Generate a piece of Perl code that embeds a module.

Suppose your code depends on a (trivial, single file, stable) module and wants to eliminate dependency on that module by embedding it into your code. To do that, just put the output of this tool (the embedding code) somewhere in your source code. The structure of the embedding code is as follows:

unless (eval { require Foo::Bar; 1 }) {
    my $source = <<'END_OF_SOURCE';
    ...
    ...
END_OF_SOURCE
    eval $source; die if $@;
    $INC{'Foo/Bar.pm'} = '(set by ' . __FILE__ . ')';
}

Compared to fatpacking, this technique tries to load the original module first, does not use require hook, and is suitable for use inside .pm file as well as script.

Compared to datapacking, this technique tries to load the original module first, does not use require hook nor DATA section, and is suitable for use inside .pm file as well as script.

This function is not exported.

Arguments ('*' denotes required arguments):

  • indent_level => int (default: 0)

  • module* => perl::modname

  • strip_pod => bool (default: 1)

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-GenModEmbedder.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-GenModEmbedder.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-GenModEmbedder

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.

SEE ALSO

Module::FatPack.

Module::DataPack.

App::FatPacker.

App::depak.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by perlancar@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.