File Coverage

blib/lib/CPAN/YACSmoke/Plugin/PlainTextList.pm

Criterion	Covered	Total	%
statement	32	38	84.2
branch	5	8	62.5
condition	1	2	50.0
subroutine	7	7	100.0
pod	2	2	100.0
total	47	57	82.4

package CPAN::YACSmoke::Plugin::PlainTextList;

use 5.006001;
use strict;
use warnings;

our $VERSION = '0.01';

# -------------------------------------

=head1 NAME

CPAN::YACSmoke::Plugin::PlainTextList - Plain text file plugin for CPAN::YACSmoke

=head1 SYNOPSIS

  use CPAN::YACSmoke;
  my $config = {
      list_from => 'PlainTextList',
      data => 'datafile.txt'
  };
  my $foo = CPAN::YACSmoke->new(config => $config);
  my @list = $foo->download_list();

=head1 DESCRIPTION

This module provides the backend ability to access a list of current
distributions available for testing, in a plain text data file. Each
distribution should appear on a separate line, with the complete CPAN
author name path, eg:

  B/BA/BARBIE/CPAN-YACSmoke-Plugin-PlainTextList-0.01

This module should be use together with CPAN::YACSmoke.

=cut

# -------------------------------------
# Library Modules

use CPAN::YACSmoke;
use IO::File;

# -------------------------------------
# The Subs

=head1 CONSTRUCTOR

=over 4

=item new()

Creates the plugin object.

=back

=cut

sub new {
    my $class = shift || __PACKAGE__;
    my $hash  = shift;

    my $self = {};
    foreach my $field (qw( smoke data )) {
        $self->{$field} = $hash->{$field}   if(exists $hash->{$field});
    }

	unless($self->{data}) {
		$self->{smoke}->error("No data file specified");
		return undef;
	}

	unless(-f $self->{data}) {
		$self->{smoke}->error("Cannot access data file [$self->{data}]");
		return undef;
	}

    bless $self, $class;
}

=head1 METHODS

=over 4

=item download_list()

Return the list of distributions within the data file.

=cut

sub download_list {
    my $self = shift;
    my @distros;

	my $fh = IO::File->new($self->{data});
	unless($fh) {
		$self->{smoke}->error("Cannot open data file [$self->{data}]");
		return undef;
	}

	while(<$fh>) { chomp; push @distros, $_; }
	$fh->close();

	return @distros;
}

1;
__END__