Perl::Dist::Asset::File - "Single File" asset for a Win32 Perl

Perl-Dist documentation Contained in the Perl-Dist distribution.

Index

Code Index:

NAME

Top

Perl::Dist::Asset::File - "Single File" asset for a Win32 Perl

SYNOPSIS

Top

  my $binary = Perl::Dist::Asset::File->new(
      url        => 'http://host/path/file',
      install_to => 'perl/foo.txt',
  );

DESCRIPTION

Top

Perl::Dist::Asset::File is a data class that provides encapsulation and error checking for a single file to be installed unmodified into a Perl::Dist-based Perl distribution.

It is normally created on the fly by the <Perl::Dist::Inno> install_file method (and other things that call it).

This asset exists to allow for cases where very small tweaks need to be done to distributions by dropping in specific single files.

The specification of the location to retrieve the package is done via the standard mechanism implemented in Perl::Dist::Asset.

METHODS

Top

This class inherits from Perl::Dist::Asset and shares its API.

new

The new constructor takes a series of parameters, validates then and returns a new Perl::Dist::Asset::Binary object.

It inherits all the params described in the Perl::Dist::Asset new method documentation, and adds some additional params.

install_to

The required install_to param describes the location that the package will be installed to.

The install_to param should be a simple string that represents the entire destination path (including file name).

The new constructor returns a Perl::Dist::Asset::File object, or throws an exception (dies) if an invalid param is provided.

SUPPORT

Top

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Perl-Dist

For other issues, contact the author.

AUTHOR

Top

Adam Kennedy <adamk@cpan.org>

SEE ALSO

Top

Perl::Dist, Perl::Dist::Inno, Perl::Dist::Asset

COPYRIGHT

Top

Copyright 2007 - 2009 Adam Kennedy.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

Perl-Dist documentation Contained in the Perl-Dist distribution. 
package Perl::Dist::Asset::File;


use strict;
use Carp              ();
use Params::Util      qw{ _STRING };
use Perl::Dist::Asset ();

use vars qw{$VERSION @ISA};
BEGIN {
	$VERSION = '1.16';
	@ISA     = 'Perl::Dist::Asset';
}

use Object::Tiny qw{
	install_to
};





#####################################################################
# Constructor


sub new {
	my $self = shift->SUPER::new(@_);

	# Check params
	unless ( _STRING($self->install_to) ) {
		Carp::croak("Missing or invalid install_to param");
	}

	return $self;
}

1;