=================================================================== RCS file: /cvs/todotxt/Text-Todo/lib/Text/Todo.pm,v retrieving revision 1.7 retrieving revision 1.27 diff -u -r1.7 -r1.27 --- todotxt/Text-Todo/lib/Text/Todo.pm 2010/01/09 05:26:51 1.7 +++ 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.6 2010/01/09 05:15:20 andrew Exp $ +# $AFresh1: Todo.pm,v 1.26 2010/02/14 06:08:07 andrew Exp $ use warnings; use strict; @@ -10,15 +10,18 @@ use Text::Todo::Entry; use File::Spec; -use Data::Dumper; +use version; our $VERSION = qv('0.2.0'); -use version; our $VERSION = qv('0.0.1'); - { - my %path_of; - my %list_of; + my @attr_refs = \( + my %path_of, + my %list_of, + my %loaded_of, + my %known_tags_of, + ); + sub new { my ( $class, $options ) = @_; @@ -26,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]"; } } } @@ -56,6 +69,8 @@ } } + $known_tags_of{$ident} = \%tags; + my $file = $self->_path_to('todo_file'); if ( defined $file && -e $file ) { $self->load(); @@ -130,28 +145,43 @@ my ( $self, $file ) = @_; my $ident = ident($self); + $loaded_of{$ident} = undef; + $file = $self->file($file); + if ( $list_of{$ident} = $self->listfile($file) ) { + $self->known_tags; + $loaded_of{$ident} = $file; + return 1; + } + + return; + } + + sub listfile { + my ( $self, $file ) = @_; + + $file = $self->file($file); + if ( !defined $file ) { - croak q{todo file can't be found}; + carp q{file can't be found}; + return; } if ( !-e $file ) { - carp "todo file [$file] does not exist"; + carp "file [$file] does not exist"; return; } my @list; - my $line = 1; open my $fh, '<', $file or croak "Couldn't open [$file]: $!"; while (<$fh>) { s/\r?\n$//xms; push @list, Text::Todo::Entry->new($_); } close $fh or croak "Couldn't close [$file]: $!"; - $list_of{$ident} = \@list; - return 1; + return wantarray ? @list : \@list; } sub save { @@ -170,6 +200,8 @@ } close $fh or croak "Couldn't close [$file]: $!"; + $loaded_of{$ident} = $file; + return 1; } @@ -182,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; } @@ -194,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( @@ -203,6 +250,8 @@ push @{ $list_of{$ident} }, $entry; + $self->known_tags; + return $entry; } @@ -234,25 +283,143 @@ } 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 archive { carp 'unsupported'; return } - sub addto { carp 'unsupported'; return } - sub listfile { carp 'unsupported'; return } + 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); + + if ( !defined $loaded_of{$ident} + || $loaded_of{$ident} ne $self->file('todo_file') ) + { + carp 'todo_file not loaded'; + return; + } + + my $changed = 0; + ENTRY: foreach my $e ( $self->list ) { + if ( $e->done ) { + if ( $self->addto( 'done_file', $e ) && $self->del($e) ) { + $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 ($changed) { + $self->save; + } + + return $changed; + } + + sub addto { + my ( $self, $file, $entry ) = @_; + my $ident = ident($self); + + $file = $self->file($file); + if ( !defined $file ) { + croak q{file can't be found}; + } + + if ( ref $entry ) { + if ( ref $entry eq 'Text::Todo::Entry' ) { + $entry = $entry->text; + } + else { + carp 'Unknown ref [' . ref($entry) . ']'; + return; + } + } + + open my $fh, '>>', $file or croak "Couldn't open [$file]: $!"; + print {$fh} $entry, "\n" + or croak "Couldn't print to [$file]: $!"; + close $fh or croak "Couldn't close [$file]: $!"; + + if ( defined $loaded_of{$ident} && $file eq $loaded_of{$ident} ) { + return $self->load($file); + } + + return 1; + } + sub _find_entry_id { my ( $self, $entry ) = @_; my $ident = ident($self); @@ -277,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 @@ -284,79 +462,235 @@ =head1 NAME -Text::Todo - Perl interface to todo_txt files +Text::Todo - Perl interface to todotxt files + =head1 VERSION -I will have to figure out how to include $VERSION in this somehow. +Since the $VERSION can't be automatically included, +here is the RCS Id instead, you'll have to look up $VERSION. -Perhaps RCS Id is good enough? + $Id: Todo.pm,v 1.27 2010/02/16 01:13:12 andrew Exp $ - $Id: Todo.pm,v 1.7 2010/01/09 05:26:51 andrew Exp $ - =head1 SYNOPSIS use Text::Todo; + + my $todo = Text::Todo->new('todo/todo.txt'); + foreach my $e (sort { lc($_->text) cmp lc($e->text)} $todo->list) { + print $e->text, "\n"; + } + + =head1 DESCRIPTION +This module is a basic interface to the todo.txt files as described by +Lifehacker and extended by members of their community. + For more information see L +This module supports the 3 axes of an effective todo list. +Priority, Project and Context. + +It does not support other notations or many of the more advanced features of +the todo.sh like plugins. + +It should be extensible, but and hopefully will be before a 1.0 release. + + =head1 INTERFACE =head2 new + new({ + [ todo_dir => 'directory', ] + [ todo_file => 'filename in todo_dir', ] + [ done_file => 'filename in todo_dir', ] + [ report_file => 'filename in todo_dir', ] + }); + +Allows you to set each item individually. todo_file defaults to todo.txt. + + new('path/to/todo.txt'); + +Automatically sets todo_dir to 'path/to', todo_file to 'todo.txt' + + new('path/to') + +If you pass an existing directory to new, it will set todo_dir. + + +If you what you set matches (.*)todo(.*).txt it will automatically set +done_file to $1done$2.txt +and +report_file to $1report$2.txt. + +For example, new('todo/todo.shopping.txt') will set +todo_dir to 'todo', +todo_file to 'todo.shopping.txt', +done_file to 'done.shopping.txt', +and +report_file to 'report.shopping.txt'. + +=head2 file + +Allows you to read the paths to the files in use. +If as in the SYNOPSIS above you used $todo = new('todo/todo.txt'). + + $todo_file = $todo->file('todo_file'); + +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. + + $todo->load('done_file'); + +This effects the other functions that act on the list. + =head2 save +- Writes the list to disk. -=head2 file + $todo->save(['new/path/to/todo']); +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; + +Since this is so easy to write as: + + my @priority_list = grep { $_->priority } $todo->list; + +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 -=head1 DIAGNOSTICS +Adds a new entry to the list. +Can either be a Text::Todo::Entry object or plain text. -=for author to fill in: - List every single error and warning message that the module can - generate (even the ones that will "never happen"), with a full - explanation of each problem, one or more likely causes, and any - suggested remedies. + $todo->add('new todo entry'); -=over +It then becomes $todo->list->[-1]; -=item C<< Error message here, perhaps with %s placeholders >> +=head2 del -[Description of error here] +Remove an entry from the list, either the reference or by number. -=item C<< Another error message here >> + $removed_entry = $todo->del($entry); -[Description of error here] +$entry can either be an Text::Todo::Entry in the list or the index of the +entry to delete. -[Et cetera, et cetera] +Note that entries are 0 indexed (as expected in perl) not starting at line 1. -=back +=head2 move + $todo->move($entry, $new_pos); +$entry can either be the number of the entry or the actual entry. +$new_pos is the new position to put it. + +Note that entries are 0 indexed (as expected in perl) not starting at line 1. + +=head2 archive + + $todo->archive + +Iterates over the list and for each done entry, +addto('done_file') +and +del($entry). +If any were archived it will then +save() +and +load(). + +=head2 addto + + $todo->addto($file, $entry); + +Appends text to the file. +$file can be anyting recognized by file(). +$entry can either be a Text::Todo::Entry or plain text. + +=head2 listfile + + @list = $todo->listfile($file); + +Read a file and returns a list like $todo->list but does not update the +internal list that is being worked with. +$file can be anyting recognized by file(). + + +=head1 DIAGNOSTICS + +Most methods return undef on failure. + +Some more important methods are fatal. + + =head1 CONFIGURATION AND ENVIRONMENT Text::Todo requires no configuration files or environment variables. -Someday it should be able to read and use the todo.sh config file. +Someday it should be able to read and use the todo.sh config file. This may +possibly be better done in a client that would use this module. =head1 DEPENDENCIES -=for author to fill in: - A list of all the other modules that this module relies upon, - including any restrictions on versions, and an indication whether - the module is part of the standard Perl distribution, part of the - module's distribution, or must be installed separately. ] +Class::Std::Utils +File::Spec +version -None. - =head1 INCOMPATIBILITIES None reported. @@ -365,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