Test::Environment::Plugin::Dump - Dump files reader plugin

Test-Environment documentation Contained in the Test-Environment distribution.

Index

Code Index:

NAME

Top

Test::Environment::Plugin::Dump - Dump files reader plugin

SYNOPSIS

Top

	use Test::Environment qw{
		Dump
	};

	dump_with_name('some_file.txt');

	set_dumps_folder($FindBin::Bin.'/dumps2');
	dump_with_name('some_other_file.txt');

DESCRIPTION

Top

This plugin will export 'dump_with_name' and 'set_dumps_folder' functions.

set_dumps_folder($path) will set the root path where dump files will be looked up.

dump_with_name($file_name) will return

	File::Slurp::read_file($dump_folder.'/'.$file_name)

Default $dump_folder is $FindBin::Bin.'/dumps'.

FUNCTIONS

Top

import

All functions are exported 2 levels up. That is to the use Test::Environment caller.

dump_with_name($name)

Returns read_file($dumps_folder.'/'.$name).

set_dumps_folder($folder_name)

Set dumps root folder to $folder_name.

SEE ALSO

Top

Test::Environment http://search.cpan.org/perldoc?Test::Environment

AUTHOR

Top

Jozef Kutej - <jozef@kutej.net>

Test-Environment documentation Contained in the Test-Environment distribution. 
package Test::Environment::Plugin::Dump;



use strict;
use warnings;

our $VERSION = 0.01;

use base qw{ Exporter };
our @EXPORT = qw{
	dump_with_name
	set_dumps_folder
};

use Carp::Clan;
use File::Slurp;
use FindBin;



sub import {
	my $package = shift;

	# export symbols two levels up - to the Test::Environment caller
	__PACKAGE__->export_to_level(2, $package, @EXPORT);
}



our $dumps_folder = $FindBin::Bin.'/dumps';
sub dump_with_name {
	my $name = shift;
	
	croak 'please set dump name' if not defined $name;
	
	$name = $dumps_folder.'/'.$name;
	croak 'file not found "'.$name.'"' if not -f $name;
	
	return read_file($name);
}



sub set_dumps_folder {
	my $folder_name = shift;
	
	croak 'pass folder name' if not defined $folder_name;
	croak 'folder not found' if not -d $folder_name;
	
	$dumps_folder = $folder_name;
}

1;