version 1.15, 2010/01/11 19:52:06 |
version 1.27, 2010/02/16 01:13:12 |
|
|
package Text::Todo; |
package Text::Todo; |
|
|
# $AFresh1: Todo.pm,v 1.14 2010/01/10 22:39:26 andrew Exp $ |
# $AFresh1: Todo.pm,v 1.26 2010/02/14 06:08:07 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 version; our $VERSION = qv('0.0.1'); |
use version; our $VERSION = qv('0.2.0'); |
|
|
{ |
{ |
|
|
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 ) = @_; |
|
|
|
|
done_file => undef, |
done_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; |
} |
} |
|
|
if ($pri) { |
if ($pri) { |
$pri = uc $pri; |
$pri = uc $pri; |
if ( $pri !~ /^[A-Z]$/xms ) { |
if ( $pri !~ /^[A-Z]$/xms ) { |
croak "PRIORITY must a single letter from A to Z."; |
croak 'PRIORITY must a single letter from A to Z.'; |
} |
} |
@list = grep { defined $_->priority && $_->priority eq $pri } |
@list = grep { defined $_->priority && $_->priority eq $pri } |
$self->list; |
$self->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 ) = @_; |
my ($self) = @_; |
return $self->listtag('project'); |
return $self->listtag('project'); |
} |
} |
|
|
sub listcon { |
sub listcon { |
my ( $self ) = @_; |
my ($self) = @_; |
return $self->listtag('context'); |
return $self->listtag('context'); |
} |
} |
|
|
sub listtag { |
sub listtag { |
my ( $self, $tag ) = @_; |
my ( $self, $tag ) = @_; |
my $ident = ident($self); |
my $ident = ident($self); |
|
|
my $accessor = $tag . 's'; |
my $accessor = $tag . 's'; |
|
|
my %available; |
my %available; |
|
|
|
|
my @tags = sort keys %available; |
my @tags = sort keys %available; |
|
|
return wantarray ? @tags: \@tags; |
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); |
|
|
|
|
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 |
|
|
then, $todo_file eq 'todo/todo.txt' |
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. |
Allows you to load a different file into the object. |
|
|
|
|
This effects the other functions that act on the list. |
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']); |
$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(). |
that can be recognized by file(). |
|
|
If you specify a filename it will save to that file and update the paths. |
If you specify a filename it will save to that file and update the paths. |
Additional changes to the object work on that file. |
Additional changes to the object work on that file. |
|
|
=head2 list |
=head2 list |
|
- get the curently loaded list |
|
|
my @todo_list = $todo->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. |
Like list, but only returns entries that have priority set. |
|
|
my @priority_list = $todo->listpri; |
my @priority_list = $todo->listpri; |
|
|
=head2 listproj |
Since this is so easy to write as: |
|
|
Returns projects in the list sorted by name. |
my @priority_list = grep { $_->priority } $todo->list; |
If there were projects +GarageSale and +Shopping |
|
|
|
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 |
is the same as |
|
|
@projects = ( 'GarageSale', 'Shopping' ); |
@projects = ( 'GarageSale', 'Shopping' ); |
|
|
|
=head2 listcon |
|
- Shortcut to listtag('context') |
|
|
|
=head2 listproj |
|
- Shortcut to listtag('project') |
|
|
=head2 add |
=head2 add |
|
|