File Coverage

blib/lib/Date/Remind/Event.pm

Criterion	Covered	Total	%
statement	44	45	97.7
branch	8	8	100.0
condition	2	6	33.3
subroutine	12	13	92.3
pod	6	6	100.0
total	72	78	92.3

package Date::Remind::Event;
use strict;
use warnings;
use Carp qw/croak/;
use DateTime;
use DateTime::Duration;
use POSIX qw/floor/;
use constant { MINUTES_PER_HOUR => 60, };

our $VERSION = '0.06';
our $ERROR   = '';
our $BFLAG   = 0;

sub new {
    my $proto = shift;
    my $text = shift || croak 'usage: new($text)';

    my ( $date, $special, $tag, $duration, $time, $body ) =
      split( / /, $text, 6 );

    my ( $y, $mon, $d ) = split( /\//, $date );

    my $dt = DateTime->new(
        year   => $y,
        month  => $mon,
        day    => $d,
        hour   => $time eq '*' ? 0 : floor( $time / MINUTES_PER_HOUR ),
        minute => $time eq '*' ? 0 : $time % MINUTES_PER_HOUR,
    );

    my $dtduration;

    if ( $duration eq '*' ) {
        my $end = $dt->clone;
        $end->add( days => 1 );
        $end->truncate( to => 'day' );
        $dtduration = $end - $dt;
    }
    else {
        $dtduration = DateTime::Duration->new( minutes => $duration, );

        # Depending on what value of -b remind is called with, the body
        # is prefixed with human-readable duration text. Lets remove
        # (only) that text if it is there.
        if ( $BFLAG != 2 ) {
            $body =~ s/^.*? //;
        }
    }

    my $self = {
        dt       => $dt,
        tag      => $tag,
        body     => $body,
        duration => $dtduration,
    };

    my $class = ref($proto) || $proto;
    bless( $self, $class );
    return $self;
}

sub date     { shift->{dt} }
sub tag      { shift->{tag} }
sub body     { shift->{body} }
sub duration { shift->{duration} }

sub end {
    my $self = shift;
    return $self->{dt}->clone->add_duration( $self->{duration} );
}

1;

__END__

=head1 NAME

Date::Remind::Event - Manipulate 'remind' output with Perl

=head1 SYNOPSIS

  use Date::Remind::Event;
  $Date::Remind::Event::BFLAG = 1;

  my $e = Date::Remind::Event->new(
    '2010/07/06 * * 60 1080 18:00-19:00 My Event'
  );

  print 'Start:       '. $e->date->hms         ."\n";
  print 'Duration:    '. $e->duration->hours   ." hour\n";
  print 'Description: '. $e->body              ."\n";

=head1 DESCRIPTION

B<Date::Remind::Event> provides a Perl object interface to textual
events emitted by the L<remind>(1) calendar program. The expected
format of the input is the same as what is produced by "remind -s" (as
defined in the L<rem2ps>(1) manpage under "REM2PS INPUT FORMAT").

L<remind>(1) produces slightly different output depending on the value
of the -b flag. To make sure that Date::Remind::Event handles this
correctly you should set $Date::Remind::Event::BFLAG to the same value
(default is 0).

See the "example/remind-simple" file in the distribution for one
possible way of calling L<remind>(1) from within Perl and parsing its
output.

=head1 CONSTRUCTOR

=over 4

=item new($text) => Date::Remind::Event

Converts $text into a single Date::Remind::Event object.

=back

=head1 ATTRIBUTES

=over 4

=item date -> DateTime

The start of the event.

=item duration -> DateTime::Duration

The length of the event.

=item end -> DateTime

The end of the remind event.

=item tag -> string

The TAG value of the event.

=item body -> string

The body of the remind event.

=back

=head1 SEE ALSO

L<DateTime>, L<DateTime::Duration>, L<remind>(1), L<rem2ps>(1),
http://www.roaringpenguin.com/products/remind

=head1 AUTHOR

Mark Lawrence E<lt>[e-mail]<gt>

=head1 COPYRIGHT AND LICENSE

Copyright 2010-2011 Mark Lawrence

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

=cut