File Coverage

blib/lib/Text/Echelon.pm

Criterion	Covered	Total	%
statement	32	32	100.0
branch	2	2	100.0
condition	8	12	66.6
subroutine	8	8	100.0
pod	5	5	100.0
total	55	59	93.2

package Text::Echelon;

=head1 NAME

Text::Echelon - get random Echelon related words.

=head1 SYNOPSIS

  use Text::Echelon;
  my $te = Text::Echelon->new();
  print $te->get();
  print $te->getmany($num); #or $te->getmany($num, $delimiter);
  print $te->makeheader();
  print $te->makecustom($pre, $num, $post, $delim);

=head1 Using with mutt

If you want to generate an X-Echelon header on your outgoing mail, put the
following in your .muttrc:
C

F is supplied in this distribution.

=head1 DESCRIPTION

Text::Echelon is a small program that will return Echelon
'I', as per

F

If you don't know why you might want this, look at:

F

F

=head1 METHODS

=cut

use strict;
use warnings;
use vars qw($VERSION);

$VERSION = '0.02';
my @Wordlist = ;
chomp @Wordlist;

=head2 new

Creates a new instance of Text::Echelon

=cut

sub new {
    my $class = shift;
    my $self  = bless {}, $class;
    return $self;
}#new

=head2 get

Returns one random spook word or phrase as a scalar

=cut

sub get {
    my $self = shift;
	return $Wordlist[rand($#Wordlist)];
}#get

=head2 getmany

Takes a number of spook words or phrases to be returned and the delimiter
between words as parameters. Returns a scalar string of spookwords.

=cut

sub getmany {
    my $self = shift;
    my ($num, $delim) = @_;
    $num   ||= '3';
    $delim ||= ', ';
    #join $delim, map $self->get (1 .. $num);
    my $str = '';
    for(my $currnum = 1; $currnum <= $num; $currnum++)
    {
        $str .= $self->get();
        $str .= $delim unless ($currnum == $num);
    }
    return $str;
}#getmany

=head2 makecustom

Takes four parameters - the prefix to use, the number of words or
phrases to include, the postfix to use and the delimiter between words.
Returns a scalar string.

=cut

sub makecustom {
    my $self = shift;
    my ($pre, $num, $post, $delim) = @_;
    $pre ||= '';
    $num ||= '3';
    $post ||= '';
    $delim ||= ', ';
    return $pre . $self->getmany($num, $delim) . $post;
}#makecustom

=head2 makeheader

Creates a header suitable for putting in your outgoing email.
The scalar returned is in the format:

C

=cut

sub makeheader {
    my $self = shift;
    return $self->makecustom('X-Echelon: ');
}#makeheader

=head1 AVAILABILITY

It should be available for download from
F
or from CPAN

=head1 AUTHOR

Russell Matbouli [e-mail]

F

=head1 TODO

Create something more plausable - generate natural language.
Ideally, a sentence generated randomly that contains spook words.

=head1 LICENSE

Distributed under GPL v2. See COPYING included with this distibution.

=head1 SEE ALSO

perl(1).

=cut

#End, return true
1;
__DATA__