Footprintless::Mixins - A utility package for mixins for standard object
version 1.15
This class is NOT to be used directly. It can be used by any class which has at minimum:
$self->{coordinate} $self->{factory}
The including class should:
use Exporter qw( _sub_coordinate _deployment ... );
Returns command_options. If $sub_coordinate is supplied, it will be used as the base spec, otherwise, this $self-<{coordinate} will be used.
command_options
$sub_coordinate
$self-<{coordinate}
Returns a deployment from the factory. If $name is supplied, the deployment will be a singleton stored at $self-{$name}>.
deployment
$name
$self-
Downloads $resource and returns the path to the downloaded file. If $to is specified, the file will be downloaded to $to.
$resource
$to
Returns the entity located at $coordinate. If $required is truthy, and the entity does not exist, an InvalidEntityException is thrown.
$coordinate
$required
Returns a truthy value if the value at $hostname_sub_coordinate is an alias for the local system.
$hostname_sub_coordinate
Will check if the entity at $self->{coordinate} has a hostname that is local, and if not, it will create a temp directory, call &local_work with that directory, and call "_push_to_destination($source, $destination, [%options])" in _push_to_destination with the temp directory as the source, and to_dir as the destination when complete. If hostname is not local, then &local_work is called with to_dir.
$self->{coordinate}
hostname
&local_work
to_dir
Returns a overlay from the factory. If $name is supplied, the overlay will be a singleton stored at $self-{$name}>.
overlay
Pushes $source to $destination. Supported options are:
$source
$destination
If truthy, then the resource will be extracted using extract before getting pushed to $destination.
If truthy, then a status indicator will be printed to STDERR (uses the pv command).
STDERR
pv
Resolves $resource.
Returns a service from the factory. If $name is supplied, the service will be a singleton stored at $self-{$name}>.
service
Returns the coordinate of the descendent at $sub_coordinate.
Returns the descendent entity located at $sub_coordinate. If $required is truthy, and the entity does not exist, an InvalidEntityException is thrown.
Will throw an InvalidEntityException if any of @sub_coordinates refer to entities that do not exist.
@sub_coordinates
Lucas Theisen <lucastheisen@pastdev.com>
This software is copyright (c) 2016 by Lucas Theisen.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Please see those modules/websites for more information related to this module.
Footprintless
To install Footprintless, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Footprintless
CPAN shell
perl -MCPAN -e shell install Footprintless
For more information on module installation, please visit the detailed CPAN module installation guide.