version 1.9, 2010/01/09 06:54:15 |
version 1.26, 2010/02/14 06:08:07 |
|
|
package Text::Todo; |
package Text::Todo; |
|
|
# $RedRiver: Todo.pm,v 1.6 2010/01/09 05:15:20 andrew Exp $ |
# $AFresh1: Todo.pm,v 1.25 2010/02/13 23:26:44 andrew Exp $ |
|
|
use warnings; |
use warnings; |
use strict; |
use strict; |
|
|
use Text::Todo::Entry; |
use Text::Todo::Entry; |
use File::Spec; |
use File::Spec; |
|
|
use Data::Dumper; |
use version; our $VERSION = qv('0.1.1'); |
|
|
use version; our $VERSION = qv('0.0.1'); |
|
|
|
{ |
{ |
|
|
my %path_of; |
my @attr_refs = \( |
my %list_of; |
my %path_of, |
my %loaded_of; |
|
|
|
|
my %list_of, |
|
my %loaded_of, |
|
my %known_tags_of, |
|
); |
|
|
sub new { |
sub new { |
my ( $class, $options ) = @_; |
my ( $class, $options ) = @_; |
|
|
|
|
my $ident = ident($self); |
my $ident = ident($self); |
|
|
$path_of{$ident} = { |
$path_of{$ident} = { |
todo_dir => undef, |
todo_dir => undef, |
todo_file => 'todo.txt', |
todo_file => 'todo.txt', |
done_file => undef, |
done_file => undef, |
report_file => undef, |
|
}; |
}; |
|
|
|
my %tags = ( |
|
context => q{@}, |
|
project => q{+}, |
|
); |
|
|
if ($options) { |
if ($options) { |
if ( ref $options eq 'HASH' ) { |
if ( ref $options eq 'HASH' ) { |
foreach my $opt ( keys %{$options} ) { |
foreach my $opt ( keys %{$options} ) { |
if ( exists $path_of{$ident}{$opt} ) { |
if ( exists $path_of{$ident}{$opt} ) { |
$self->_path_to( $opt, $options->{$opt} ); |
$self->_path_to( $opt, $options->{$opt} ); |
} |
} |
|
elsif ( $opt eq 'tags' |
|
&& ref $options->{$opt} eq 'HASH' ) |
|
{ |
|
%tags = ( %tags, %{ $options->{$opt} } ); |
|
} |
else { |
else { |
carp "Invalid option [$opt]"; |
|
|
#carp "Invalid option [$opt]"; |
} |
} |
} |
} |
} |
} |
|
|
} |
} |
} |
} |
|
|
|
$known_tags_of{$ident} = \%tags; |
|
|
my $file = $self->_path_to('todo_file'); |
my $file = $self->_path_to('todo_file'); |
if ( defined $file && -e $file ) { |
if ( defined $file && -e $file ) { |
$self->load(); |
$self->load(); |
|
|
$file = $self->file($file); |
$file = $self->file($file); |
|
|
if ( $list_of{$ident} = $self->listfile($file) ) { |
if ( $list_of{$ident} = $self->listfile($file) ) { |
|
$self->known_tags; |
$loaded_of{$ident} = $file; |
$loaded_of{$ident} = $file; |
return 1; |
return 1; |
} |
} |
|
|
open my $fh, '<', $file or croak "Couldn't open [$file]: $!"; |
open my $fh, '<', $file or croak "Couldn't open [$file]: $!"; |
while (<$fh>) { |
while (<$fh>) { |
s/\r?\n$//xms; |
s/\r?\n$//xms; |
next if !length $_; |
|
push @list, Text::Todo::Entry->new($_); |
push @list, Text::Todo::Entry->new($_); |
} |
} |
close $fh or croak "Couldn't close [$file]: $!"; |
close $fh or croak "Couldn't close [$file]: $!"; |
|
|
} |
} |
|
|
sub listpri { |
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; |
return wantarray ? @list : \@list; |
} |
} |
|
|
my $ident = ident($self); |
my $ident = ident($self); |
|
|
if ( !ref $entry ) { |
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' ) { |
elsif ( ref $entry ne 'Text::Todo::Entry' ) { |
croak( |
croak( |
|
|
|
|
push @{ $list_of{$ident} }, $entry; |
push @{ $list_of{$ident} }, $entry; |
|
|
|
$self->known_tags; |
|
|
return $entry; |
return $entry; |
} |
} |
|
|
|
|
} |
} |
|
|
sub listproj { |
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 $ident = ident($self); |
|
|
my %available_projects; |
my $accessor = $tag . 's'; |
|
|
|
my %available; |
foreach my $e ( $self->list ) { |
foreach my $e ( $self->list ) { |
foreach my $p ( $e->projects ) { |
foreach my $p ( $e->$accessor ) { |
$available_projects{$p} = 1; |
$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 { |
sub archive { |
my ($self) = @_; |
my ($self) = @_; |
my $ident = ident($self); |
my $ident = ident($self); |
|
|
return; |
return; |
} |
} |
|
|
my $archived = 0; |
my $changed = 0; |
ENTRY: foreach my $e ( $self->list ) { |
ENTRY: foreach my $e ( $self->list ) { |
if ( $e->done ) { |
if ( $e->done ) { |
if ( $self->addto( 'done_file', $e ) && $self->del($e) ) { |
if ( $self->addto( 'done_file', $e ) && $self->del($e) ) { |
$archived++; |
$changed++; |
} |
} |
else { |
else { |
carp q{Couldn't archive entry [} . $e->text . ']'; |
carp q{Couldn't archive entry [} . $e->text . ']'; |
last ENTRY; |
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; |
$self->save; |
} |
} |
|
|
return $archived; |
return $changed; |
} |
} |
|
|
sub addto { |
sub addto { |
|
|
|
|
croak "Invalid entry [$entry]!"; |
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 |
1; # Magic true value required at end of module |
|
|
|
|
=head1 NAME |
=head1 NAME |
|
|
Text::Todo - Perl interface to todo_txt files |
Text::Todo - Perl interface to todotxt files |
|
|
|
|
=head1 VERSION |
=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$ |
$Id$ |
|
|
=head1 SYNOPSIS |
=head1 SYNOPSIS |
|
|
use Text::Todo; |
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 |
=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<http://todotxt.com> |
For more information see L<http://todotxt.com> |
|
|
|
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 |
=head1 INTERFACE |
|
|
=head2 new |
=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 |
=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 |
=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 |
=head2 save |
|
- Writes the list to disk. |
|
|
|
$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 |
=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 |
=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 |
=head2 listproj |
|
- Shortcut to listtag('project') |
|
|
=head2 add |
=head2 add |
|
|
|
Adds a new entry to the list. |
|
Can either be a Text::Todo::Entry object or plain text. |
|
|
|
$todo->add('new todo entry'); |
|
|
|
It then becomes $todo->list->[-1]; |
|
|
=head2 del |
=head2 del |
|
|
|
Remove an entry from the list, either the reference or by number. |
|
|
|
$removed_entry = $todo->del($entry); |
|
|
|
$entry can either be an Text::Todo::Entry in the list or the index of the |
|
entry to delete. |
|
|
|
Note that entries are 0 indexed (as expected in perl) not starting at line 1. |
|
|
=head2 move |
=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 |
=head2 archive |
|
|
=head2 addto |
$todo->archive |
|
|
=head2 listfile |
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(). |
|
|
=head1 DIAGNOSTICS |
=head2 addto |
|
|
=for author to fill in: |
$todo->addto($file, $entry); |
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. |
|
|
|
=over |
Appends text to the file. |
|
$file can be anyting recognized by file(). |
|
$entry can either be a Text::Todo::Entry or plain text. |
|
|
=item C<< Error message here, perhaps with %s placeholders >> |
=head2 listfile |
|
|
[Description of error here] |
@list = $todo->listfile($file); |
|
|
=item C<< Another error message here >> |
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(). |
|
|
[Description of error here] |
|
|
|
[Et cetera, et cetera] |
=head1 DIAGNOSTICS |
|
|
=back |
Most methods return undef on failure. |
|
|
|
Some more important methods are fatal. |
|
|
|
|
=head1 CONFIGURATION AND ENVIRONMENT |
=head1 CONFIGURATION AND ENVIRONMENT |
|
|
Text::Todo requires no configuration files or environment variables. |
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 |
=head1 DEPENDENCIES |
|
|
=for author to fill in: |
Class::Std::Utils |
A list of all the other modules that this module relies upon, |
File::Spec |
including any restrictions on versions, and an indication whether |
version |
the module is part of the standard Perl distribution, part of the |
|
module's distribution, or must be installed separately. ] |
|
|
|
None. |
|
|
|
|
|
=head1 INCOMPATIBILITIES |
=head1 INCOMPATIBILITIES |
|
|
None reported. |
None reported. |
|
|
=head1 BUGS AND LIMITATIONS |
=head1 BUGS AND LIMITATIONS |
|
|
No bugs have been reported. |
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 |
Please report any bugs or feature requests to |
C<bug-text-todo@rt.cpan.org>, or through the web interface at |
C<bug-text-todo@rt.cpan.org>, or through the web interface at |