libdist-zilla-plugin-emailnotify-perl 0.004-1 / usr / share / perl5 / Dist / Zilla / Plugin / EmailNotify.pm

use strict;
use warnings;
package Dist::Zilla::Plugin::EmailNotify;
# ABSTRACT: send an email on dist release
$Dist::Zilla::Plugin::EmailNotify::VERSION = '0.004';
use Moose;
with 'Dist::Zilla::Role::AfterRelease';

use Email::Stuffer;
use IO::File;

use namespace::autoclean;

has to => (
    is         => 'ro',
    isa        => 'Str',
    lazy_build => 1,
);

has recipient => (
    is        => 'ro',
    isa       => 'ArrayRef[Str]',
    predicate => 'has_recipient',
);

has from => (
    is       => 'ro',
    isa      => 'Str', 
    required => 1,
);

has cc => (
    is      => 'ro',
    isa     => 'ArrayRef[Str]',
    default => sub { [] },
);

has bcc => (
    is      => 'ro',
    isa     => 'ArrayRef[Str]',
    default => sub { [] },
);

has change_file => (
    is       => 'ro',
    isa      => 'Str',
    default => 'Changes',
);

sub mvp_multivalue_args { qw/recipient cc bcc/ }

sub _build_to {
    my $self = shift;

    $self->has_recipient
        or die "Must provide 'recipient' or 'to'\n";

    return join ', ', @{ $self->recipient };
}

sub after_release {
    my $self    = shift;
    my $archive = shift;
    my $name    = $self->zilla->name;
    my $to      = $self->to;
    my $from    = $self->from;
    my $cc      = join ', ', @{ $self->cc  };
    my $bcc     = join ', ', @{ $self->bcc };

    $name =~ s/\.tar\.gz$//;
    my $v = $self->zilla->version;

    #  skip mail for developer's version
    if ($v =~ /_/) {
        $self->log("No e-mail sent for a developer release") ;
        return 1 ;
    }

    my @body ;
    push @body, "New version $v of $name is available with the following changes:";
    push @body, '', $self->extract_last_release($self->change_file);

    my $res = $self->zilla->distmeta
        || die "internal error";

    my $repo = $res->{repository} ;
    push @body,'', "Homepage: ".$res->{homepage} if $res->{homepage} ;
    push @body,"Repository: ".$repo->{web} if $repo->{web};

    push @body,'', "Authors:", map { "  - $_"} @{ $self->zilla->authors };

    my $text_body = join("\n",@body);
    $self->log($text_body);

    my $email
	  = Email::Stuffer->subject("$name $v released!")
	  ->from($from)
	  ->to($to)
	  ->text_body($text_body);

    $cc  and $email->cc($cc);
    $bcc and $email->bcc($bcc);

    $self->log("Sending release email to $to") ;

    return $email->send;
}

sub extract_last_release {
    my $self = shift;
    my $file = shift;

    my $fh = IO::File->new;
    $fh->open($file, 'r') ;

    my $preamble = '';
    while (my $l = $fh->getline ) {
        last if $l =~ /^\w/ ; # first release line, preamble is done
        $preamble .= $l;
    } ;

    my @changes ;
    while (my $l = $fh->getline ) {
        chomp $l;
        if ($l =~ /^\s/ or $l =~ /^$/) {
            # not at a release line
            push @changes, $l;
        }
        elsif (join('',@changes) =~ /\w/ and $l =~ /^[\d\.]+\s+/) {
            # quit if I have change info and a release
            last;
        };
    } ;
    $fh->close;

    # remove empty line from beginning and end of change lines
    shift @changes while not $changes[0] ;
    pop   @changes while not $changes[-1];

    return @changes;
}


__PACKAGE__->meta->make_immutable;
no Moose;

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Dist::Zilla::Plugin::EmailNotify - send an email on dist release

=head1 VERSION

version 0.004

=head1 DESCRIPTION

This plugin allows one to send an email when releasing.

=head1 FIELDS

=head2 from

Who is sending the email?

    [EmailNotify]
    from = xsawyerx@cpan.org

=head2 recipient

Multiple single recipients. These will compose the 'to' field.

    [EmailNotify]
    recipient = jack@myemail.com
    recipient = jill@myemail.com

=head2 to

Direct recipients string. This should be comma separated.

    [EmailNotify]
    to = jack@myemail.com, jill@myemail.com

=head2 cc

Any CC you may want. This should be comma separated.

    [EmailNotify]
    cc = myboss@myemail.com, jacksboss@myemail.com

=head2 bcc

Any BCC you may want. This should be comma separated.

    [EmailNotify]
    bcc = topgun@myemail.com

=head1 ATTRIBUTES

=head2 to(Str)

The 'to' email field.

=head2 recipient(ArrayRef[Str])

This array reference of strings will be used to compose the 'to' email field.

It is used in case you want to comfortably write down the recipients instead of
one long string. This is not provided for other fields.

=head2 from(Str)

The 'from' email field.

=head2 cc(Str)

The 'cc' email field.

=head2 bcc(Str)

The 'bcc' email field.

=head1 METHODS/SUBROUTINES

=head2 after_release

Method to actually send the email right after the 'release' process.
Takes all the arguments, creates a body message text using last change
log entry and sends the email using L<Email::Stuff>.

=head2 _build_to

Builder to take all the recipient attribute values and create a single
string.

=head2 mvp_multivalue_args

Internal, L<Config::MVP> related. Creates a multivalue argument.

=head1 AUTHOR

Sawyer X <xsawyerx@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by Sawyer X.

This is free software, licensed under:

  The MIT (X11) License

=cut