-
-
26 Jun 2014 22:59:10 UTC
- Distribution: Sub-Install
- Module version: 0.928
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (1)
- Testers (14218 / 14 / 0)
- Kwalitee
Bus factor: 1- 93.71% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (18.23KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- NAME
- VERSION
- SYNOPSIS
- DESCRIPTION
- FUNCTIONS
- EXPORTS
- SEE ALSO
- EXTRA CREDITS
- AUTHOR
- COPYRIGHT AND LICENSE
NAME
Sub::Install - install subroutines into packages easily
VERSION
version 0.928
SYNOPSIS
use Sub::Install; Sub::Install::install_sub({ code => sub { ... }, into => $package, as => $subname });
DESCRIPTION
This module makes it easy to install subroutines into packages without the unsightly mess of
no strict
or typeglobs lying about where just anyone can see them.FUNCTIONS
install_sub
Sub::Install::install_sub({ code => \&subroutine, into => "Finance::Shady", as => 'launder', });
This routine installs a given code reference into a package as a normal subroutine. The above is equivalent to:
no strict 'refs'; *{"Finance::Shady" . '::' . "launder"} = \&subroutine;
If
into
is not given, the sub is installed into the calling package.If
code
is not a code reference, it is looked for as an existing sub in the package named in thefrom
parameter. Iffrom
is not given, it will look in the calling package.If
as
is not given, and ifcode
is a name,as
will default tocode
. Ifas
is not given, but ifcode
is a code ref, Sub::Install will try to find the name of the given code ref and use that asas
.That means that this code:
Sub::Install::install_sub({ code => 'twitch', from => 'Person::InPain', into => 'Person::Teenager', as => 'dance', });
is the same as:
package Person::Teenager; Sub::Install::install_sub({ code => Person::InPain->can('twitch'), as => 'dance', });
reinstall_sub
This routine behaves exactly like
"install_sub"
, but does not emit a warning if warnings are on and the destination is already defined.install_installers
This routine is provided to allow Sub::Install compatibility with Sub::Installer. It installs
install_sub
andreinstall_sub
methods into the package named by its argument.Sub::Install::install_installers('Code::Builder'); # just for us, please Code::Builder->install_sub({ name => $code_ref }); Sub::Install::install_installers('UNIVERSAL'); # feeling lucky, punk? Anything::At::All->install_sub({ name => $code_ref });
The installed installers are similar, but not identical, to those provided by Sub::Installer. They accept a single hash as an argument. The key/value pairs are used as the
as
andcode
parameters to theinstall_sub
routine detailed above. The package name on which the method is called is used as theinto
parameter.Unlike Sub::Installer's
install_sub
will not eval strings into code, but will look for named code in the calling package.EXPORTS
Sub::Install exports
install_sub
andreinstall_sub
only if they are requested.exporter
Sub::Install has a never-exported subroutine called
exporter
, which is used to implement itsimport
routine. It takes a hashref of named arguments, only one of which is currently recognize:exports
. This must be an arrayref of subroutines to offer for export.This routine is mainly for Sub::Install's own consumption. Instead, consider Sub::Exporter.
SEE ALSO
- Sub::Installer
-
This module is (obviously) a reaction to Damian Conway's Sub::Installer, which does the same thing, but does it by getting its greasy fingers all over UNIVERSAL. I was really happy about the idea of making the installation of coderefs less ugly, but I couldn't bring myself to replace the ugliness of typeglobs and loosened strictures with the ugliness of UNIVERSAL methods.
- Sub::Exporter
-
This is a complete Exporter.pm replacement, built atop Sub::Install.
EXTRA CREDITS
Several of the tests are adapted from tests that shipped with Damian Conway's Sub-Installer distribution.
AUTHOR
Ricardo SIGNES <rjbs@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2005 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Module Install Instructions
To install Sub::Install, copy and paste the appropriate command in to your terminal.
cpanm Sub::Install
perl -MCPAN -e shell install Sub::Install
For more information on module installation, please visit the detailed CPAN module installation guide.