=================================================================== RCS file: /cvs/todotxt/Text-Todo/lib/Text/Todo/Entry.pm,v retrieving revision 1.13 retrieving revision 1.30 diff -u -r1.13 -r1.30 --- todotxt/Text-Todo/lib/Text/Todo/Entry.pm 2010/01/10 01:03:02 1.13 +++ todotxt/Text-Todo/lib/Text/Todo/Entry.pm 2010/02/16 01:13:12 1.30 @@ -1,39 +1,41 @@ package Text::Todo::Entry; -# $RedRiver: Entry.pm,v 1.12 2010/01/10 00:13:14 andrew Exp $ +# $AFresh1: Entry.pm,v 1.29 2010/02/14 06:08:07 andrew Exp $ use warnings; use strict; use Carp; use Class::Std::Utils; -use List::Util qw/ first /; -use version; our $VERSION = qv('0.0.1'); +use version; our $VERSION = qv('0.2.0'); { - my %text_of; - my %tags_of; - my %priority_of; - my %completion_status_of; - my %known_tags_of; + my @attr_refs = \( + my %text_of, + my %tags_of, + my %priority_of, + my %completion_status_of, + my %known_tags_of, + ); + # XXX Should the completion (x) be case sensitive? - my $priority_completion_regex = qr/ + my $priority_completion_regex = qr{ ^ \s* - (?i: (x) \s+)? - (?i:\( ([A-Z]) \) \s+)? - /xms; + (?i:(x \s* [\d-]* ) \s*)? + (?i:\( ([A-Z]) \) \s*)? + }xms; - sub replace { _update_entry(@_) } - sub new { my ( $class, $options ) = @_; my $self = bless anon_scalar(), $class; my $ident = ident($self); + $text_of{$ident} = q{}; + if ( !ref $options ) { $options = { text => $options }; } @@ -41,44 +43,77 @@ croak 'Invalid parameter passed!'; } - $known_tags_of{$ident} = { + my %tags = ( context => q{@}, project => q{+}, - }; + ); if ( exists $options->{tags} && ref $options->{tags} eq 'HASH' ) { - foreach my $k ( keys %{ $options->{tags} } ) { - $known_tags_of{$ident}{$k} = $options->{tags}->{$k}; - } + %tags = ( %tags, %{ $options->{tags} } ); } - for my $tag ( keys %{ $known_tags_of{$ident} } ) { - ## no critic strict - no strict - 'refs'; # Violates use strict, but allows code generation - ## use critic + for my $tag ( keys %tags ) { + $self->learn_tag( $tag, $tags{$tag} ); + } - if ( !$self->can( $tag . 's' ) ) { - *{ $tag . 's' } = sub { - my ($self) = @_; - return $self->_tags($tag); - }; - } + $self->replace( $options->{text} ); - if ( !$self->can( 'in_' . $tag ) ) { - *{ 'in_' . $tag } = sub { - my ( $self, $item ) = @_; - return $self->_is_in( $tag . 's', $item ); - }; - } + return $self; + } + + sub _parse_entry { + my ($self) = @_; + my $ident = ident($self); + + delete $tags_of{$ident}; + delete $completion_status_of{$ident}; + delete $priority_of{$ident}; + + my $text = $self->text || q{}; + my $known_tags = $self->known_tags || {}; + + foreach my $tag ( keys %{$known_tags} ) { + next if !defined $known_tags->{$tag}; + next if !length $known_tags->{$tag}; + + my $sigal = quotemeta $known_tags->{$tag}; + $tags_of{$ident}{$tag} + = { map { $_ => q{} } $text =~ / (?:^|\s) $sigal (\S*)/gxms }; } - $self->_update_entry( $options->{text} ); + my ( $completed, $priority ) + = $text =~ / $priority_completion_regex /xms; - return $self; + $completion_status_of{$ident} = _clean_completed($completed); + $priority_of{$ident} = $priority; + + return 1; } - sub _update_entry { + sub _clean_completed { + my ($completed) = @_; + + $completed ||= q{}; + $completed =~ s/^\s+|\s+$//gxms; + + if ( !$completed ) { + return; + } + + if ( $completed =~ s/(x)\s*//ixms ) { + my $status = $1; + if ($completed) { + return $completed; + } + else { + return $status; + } + } + + return; + } + + sub replace { my ( $self, $text ) = @_; my $ident = ident($self); @@ -86,39 +121,54 @@ $text_of{$ident} = $text; - foreach my $tag ( keys %{ $known_tags_of{$ident} } ) { - my $symbol = quotemeta $known_tags_of{$ident}{$tag}; - $tags_of{$ident}{$tag} = { map { $_ => q{} } - $text =~ / (?:^|\s) $symbol (\S+)/gxms }; + return $self->_parse_entry; + } + + sub learn_tag { + my ( $self, $tag, $sigal ) = @_; + $known_tags_of{ ident $self}{$tag} = $sigal; + + ## no critic strict + no strict 'refs'; # Violates use strict, but allows code generation + ## use critic + + if ( !$self->can( $tag . 's' ) ) { + *{ $tag . 's' } = sub { + my ($self) = @_; + return $self->_tags($tag); + }; } - ( $completion_status_of{$ident}, $priority_of{$ident} ) - = $text =~ / $priority_completion_regex /xms; - return 1; + if ( !$self->can( 'in_' . $tag ) ) { + *{ 'in_' . $tag } = sub { + my ( $self, $item ) = @_; + return $self->_is_in( $tag . 's', $item ); + }; + } + + return $self->_parse_entry; } sub _tags { my ( $self, $tag ) = @_; my $ident = ident($self); - my @tags = sort keys %{ $tags_of{$ident}{$tag} }; + my @tags; + if ( defined $tags_of{$ident}{$tag} ) { + @tags = sort keys %{ $tags_of{$ident}{$tag} }; + } return wantarray ? @tags : \@tags; } sub _is_in { my ( $self, $tags, $item ) = @_; - return defined first { $_ eq $item } $self->$tags; + return if !defined $item; + foreach ( $self->$tags ) { + return 1 if $_ eq $item; + } + return 0; } - sub text { - my ($self) = @_; - my $ident = ident($self); - - return $text_of{$ident}; - } - - sub depri { pri( $_[0], '' ) } - sub pri { my ( $self, $new_pri ) = @_; my $ident = ident($self); @@ -132,13 +182,6 @@ return $self->prepend(); } - sub priority { - my ( $self, $new_pri ) = @_; - my $ident = ident($self); - - return $priority_of{$ident}; - } - sub prepend { my ( $self, $addition ) = @_; @@ -148,6 +191,9 @@ $new =~ s/$priority_completion_regex//xms; if ( $self->done ) { + if ( $self->done !~ /^x/ixms ) { + push @new, 'x'; + } push @new, $self->done; } @@ -159,15 +205,17 @@ push @new, $addition; } - return $self->_update_entry( join q{ }, @new, $new ); + return $self->replace( join q{ }, @new, $new ); } sub append { my ( $self, $addition ) = @_; - return $self->_update_entry( join q{ }, $self->text, $addition ); + return $self->replace( join q{ }, $self->text, $addition ); } - sub do { + ## no critic 'homonym' + sub do { # This is what it is called in todo.sh + ## use critic my ($self) = @_; my $ident = ident($self); @@ -175,18 +223,30 @@ return 1; } - $completion_status_of{$ident} = 'x'; + $completion_status_of{$ident} = sprintf "%04d-%02d-%02d", + ( (localtime)[5] + 1900 ), + ( (localtime)[4] + 1 ), + ( (localtime)[3] ); return $self->prepend(); } sub done { my ($self) = @_; - my $ident = ident($self); - - return $completion_status_of{$ident}; + return $completion_status_of{ ident($self) }; } + sub known_tags { my ($self) = @_; return $known_tags_of{ ident($self) }; } + sub priority { my ($self) = @_; return $priority_of{ ident($self) }; } + sub text { my ($self) = @_; return $text_of{ ident($self) }; } + sub depri { my ($self) = @_; return $self->pri(q{}) } + sub DESTROY { + my ($self) = @_; + my $ident = ident $self; + foreach my $attr_ref (@attr_refs) { + delete $attr_ref->{$ident}; + } + } } 1; # Magic true value required at end of module __END__ @@ -201,7 +261,7 @@ Since the $VERSION can't be automatically included, here is the RCS Id instead, you'll have to look up $VERSION. - $Id: Entry.pm,v 1.13 2010/01/10 01:03:02 andrew Exp $ + $Id: Entry.pm,v 1.30 2010/02/16 01:13:12 andrew Exp $ =head1 SYNOPSIS @@ -273,7 +333,7 @@ Each tag type generates two accessor functions {tag}s and in_{tag}. -Current tags are context (@) and project (+). +Default tags are context (@) and project (+). When creating a new object you can pass in new tags to recognize. @@ -284,7 +344,7 @@ my @due_dates = $entry->due_dates; -then @due_dates eq ( '2011-01-01' ); +then @due_dates is ( '2011-01-01' ); and you could also: @@ -309,6 +369,27 @@ =back +=head2 learn_tag($tag, $sigal) + + $entry->learn_tag('due_date', 'DUE:'); + +Teaches the entry about an additional tag, same as passing a tags argument to +new(). See tags() + +You can simulate forgetting a tag by setting the sigal to undef or an empty +string. + +=head2 known_tags + + $known_tags = $entry->known_tags; + +$known_tags by default would be: + + { context => '@', + project => '+', + } + + =head3 context These are matched as a word beginning with @. @@ -360,16 +441,19 @@ $entry->do; -Does this by prepending an 'x' to the beginning of the entry. +Does this by prepending "x `date '%Y-%m-%d'`" to the beginning of the entry. =head2 done Returns true if an entry is marked complete and false if not. - - if (!$entry->done) { + + if (!my $status = $entry->done) { # remind me to do it } +If the entry starts as 'x date', for example 'x 2010-01-01', $status is now +'2010-01-01'. +If the entry just starts with 'x', then $status will be 'x'. =head1 DIAGNOSTICS