=================================================================== RCS file: /cvs/todotxt/Text-Todo/lib/Text/Todo.pm,v retrieving revision 1.10 retrieving revision 1.27 diff -u -r1.10 -r1.27 --- todotxt/Text-Todo/lib/Text/Todo.pm 2010/01/09 20:41:45 1.10 +++ todotxt/Text-Todo/lib/Text/Todo.pm 2010/02/16 01:13:12 1.27 @@ -1,6 +1,6 @@ package Text::Todo; -# $RedRiver: Todo.pm,v 1.9 2010/01/09 06:54:15 andrew Exp $ +# $AFresh1: Todo.pm,v 1.26 2010/02/14 06:08:07 andrew Exp $ use warnings; use strict; @@ -10,14 +10,18 @@ use Text::Todo::Entry; use File::Spec; -use version; our $VERSION = qv('0.0.1'); +use version; our $VERSION = qv('0.2.0'); { - my %path_of; - my %list_of; - my %loaded_of; + my @attr_refs = \( + my %path_of, + my %list_of, + my %loaded_of, + my %known_tags_of, + ); + sub new { my ( $class, $options ) = @_; @@ -25,20 +29,30 @@ my $ident = ident($self); $path_of{$ident} = { - todo_dir => undef, - todo_file => 'todo.txt', - done_file => undef, - report_file => undef, + todo_dir => undef, + todo_file => 'todo.txt', + done_file => undef, }; + my %tags = ( + context => q{@}, + project => q{+}, + ); + if ($options) { if ( ref $options eq 'HASH' ) { foreach my $opt ( keys %{$options} ) { if ( exists $path_of{$ident}{$opt} ) { $self->_path_to( $opt, $options->{$opt} ); } + elsif ( $opt eq 'tags' + && ref $options->{$opt} eq 'HASH' ) + { + %tags = ( %tags, %{ $options->{$opt} } ); + } else { - carp "Invalid option [$opt]"; + + #carp "Invalid option [$opt]"; } } } @@ -55,6 +69,8 @@ } } + $known_tags_of{$ident} = \%tags; + my $file = $self->_path_to('todo_file'); if ( defined $file && -e $file ) { $self->load(); @@ -134,6 +150,7 @@ $file = $self->file($file); if ( $list_of{$ident} = $self->listfile($file) ) { + $self->known_tags; $loaded_of{$ident} = $file; return 1; } @@ -160,7 +177,6 @@ open my $fh, '<', $file or croak "Couldn't open [$file]: $!"; while (<$fh>) { s/\r?\n$//xms; - next if !length $_; push @list, Text::Todo::Entry->new($_); } close $fh or croak "Couldn't close [$file]: $!"; @@ -198,9 +214,20 @@ } sub listpri { - my ($self) = @_; + my ( $self, $pri ) = @_; - my @list = grep { $_->priority } $self->list; + my @list; + if ($pri) { + $pri = uc $pri; + if ( $pri !~ /^[A-Z]$/xms ) { + croak 'PRIORITY must a single letter from A to Z.'; + } + @list = grep { defined $_->priority && $_->priority eq $pri } + $self->list; + } + else { + @list = grep { $_->priority } $self->list; + } return wantarray ? @list : \@list; } @@ -210,7 +237,11 @@ my $ident = ident($self); if ( !ref $entry ) { - $entry = Text::Todo::Entry->new($entry); + $entry = Text::Todo::Entry->new( + { text => $entry, + tags => $known_tags_of{$ident}, + } + ); } elsif ( ref $entry ne 'Text::Todo::Entry' ) { croak( @@ -219,6 +250,8 @@ push @{ $list_of{$ident} }, $entry; + $self->known_tags; + return $entry; } @@ -250,21 +283,72 @@ } sub listproj { - my ( $self, $entry, $dst ) = @_; + my ($self) = @_; + return $self->listtag('project'); + } + + sub listcon { + my ($self) = @_; + return $self->listtag('context'); + } + + sub listtag { + my ( $self, $tag ) = @_; my $ident = ident($self); - my %available_projects; + my $accessor = $tag . 's'; + + my %available; foreach my $e ( $self->list ) { - foreach my $p ( $e->projects ) { - $available_projects{$p} = 1; + foreach my $p ( $e->$accessor ) { + $available{$p} = 1; } } - my @projects = sort keys %available_projects; + my @tags = sort keys %available; - return wantarray ? @projects : \@projects; + return wantarray ? @tags : \@tags; } + sub learn_tag { + my ( $self, $tag, $sigal ) = @_; + + $known_tags_of{ ident $self}{$tag} = $sigal; + $self->known_tags; + + return 1; + } + + sub known_tags { + my ($self) = @_; + my $ident = ident($self); + + my @list = $self->list; + my %tags = %{ $known_tags_of{$ident} }; + + foreach my $e (@list) { + my $kt = $e->known_tags; + foreach my $t ( keys %{$kt} ) { + if ( !exists $tags{$t} ) { + $tags{$t} = $kt->{$t}; + } + } + } + + foreach my $e (@list) { + my $kt = $e->known_tags; + foreach my $t ( keys %tags ) { + if ( !exists $kt->{$t} || $tags{$t} ne $kt->{$t} ) { + $e->learn_tag( $t, $tags{$t} ); + } + } + } + + $known_tags_of{$ident} = \%tags; + + return $known_tags_of{$ident}; + } + sub archive { my ($self) = @_; my $ident = ident($self); @@ -276,24 +360,33 @@ return; } - my $archived = 0; + my $changed = 0; ENTRY: foreach my $e ( $self->list ) { if ( $e->done ) { if ( $self->addto( 'done_file', $e ) && $self->del($e) ) { - $archived++; + $changed++; } else { carp q{Couldn't archive entry [} . $e->text . ']'; last ENTRY; } } + elsif ( $e->text eq q{} ) { + if ( $self->del($e) ) { + $changed++; + } + else { + carp q{Couldn't delete blank entry}; + last ENTRY; + } + } } - if ($archived) { + if ($changed) { $self->save; } - return $archived; + return $changed; } sub addto { @@ -351,6 +444,17 @@ croak "Invalid entry [$entry]!"; } + + sub DESTROY { + my ($self) = @_; + my $ident = ident $self; + + foreach my $attr_ref (@attr_refs) { + delete $attr_ref->{$ident}; + } + + return; + } } 1; # Magic true value required at end of module @@ -358,7 +462,7 @@ =head1 NAME -Text::Todo - Perl interface to todo_txt files +Text::Todo - Perl interface to todotxt files =head1 VERSION @@ -366,7 +470,7 @@ Since the $VERSION can't be automatically included, here is the RCS Id instead, you'll have to look up $VERSION. - $Id: Todo.pm,v 1.10 2010/01/09 20:41:45 andrew Exp $ + $Id: Todo.pm,v 1.27 2010/02/16 01:13:12 andrew Exp $ =head1 SYNOPSIS @@ -439,6 +543,7 @@ then, $todo_file eq 'todo/todo.txt' =head2 load +- Reads a list from a file into the current object. Allows you to load a different file into the object. @@ -447,36 +552,64 @@ This effects the other functions that act on the list. =head2 save +- Writes the list to disk. $todo->save(['new/path/to/todo']); -Writes the list to the file. Either the current working file or something +Either writes the current working file or the passed in argument that can be recognized by file(). If you specify a filename it will save to that file and update the paths. Additional changes to the object work on that file. =head2 list +- get the curently loaded list my @todo_list = $todo->list; +In list context returns a list, it scalar context returns an array reference to the list. + =head2 listpri +- get the list items that are marked priority Like list, but only returns entries that have priority set. my @priority_list = $todo->listpri; -=head2 listproj +Since this is so easy to write as: -Returns projects in the list sorted by name. -If there were projects +GarageSale and +Shopping + my @priority_list = grep { $_->priority } $todo->list; - my @projects = $todo->listproj; +I think it may become depreciated unless there is demand. +=head2 known_tags + +Returns a reference to a hash of the tags known to the list. + +=head2 learn_tag($tag, $sigal) + +Let the entire list learn a new tag. +If you are working with a list you should use this instead of +$entry->learn_tag because it will update all entries. + +=head2 listtag($tag) + +Returns tags found in the list sorted by name. + +If there were projects +GarageSale and +Shopping then + + my @projects = $todo->listtag('project'); + is the same as @projects = ( 'GarageSale', 'Shopping' ); +=head2 listcon +- Shortcut to listtag('context') + +=head2 listproj +- Shortcut to listtag('project') + =head2 add Adds a new entry to the list. @@ -566,6 +699,10 @@ =head1 BUGS AND LIMITATIONS No bugs have been reported. + +Limitations: + +Currently there isn't an easy way to print out line numbers with the entry. Please report any bugs or feature requests to C, or through the web interface at