version 1.1, 2009/07/09 19:21:34 |
version 1.4, 2010/01/06 20:07:16 |
|
|
package Text::Todo; |
package Text::Todo; |
|
|
# $RedRiver$ |
# $RedRiver: Todo.pm,v 1.3 2010/01/06 19:54:56 andrew Exp $ |
|
|
use warnings; |
use warnings; |
use strict; |
use strict; |
use Carp; |
use Carp; |
|
|
|
use Class::Std::Utils; |
|
use Text::Todo::Entry; |
|
|
use version; our $VERSION = qv('0.0.1'); |
use version; our $VERSION = qv('0.0.1'); |
|
|
# Other recommended modules (uncomment to use): |
{ |
# use IO::Prompt; |
|
# use Perl6::Export; |
|
# use Perl6::Slurp; |
|
# use Perl6::Say; |
|
|
|
|
my %file_of; |
|
my %list_of; |
|
|
# Module implementation here |
sub new { |
|
my ( $class, $file ) = @_; |
|
|
|
my $self = bless anon_scalar(), $class; |
|
my $ident = ident($self); |
|
|
1; # Magic true value required at end of module |
if ($file) { $self->load($file); } |
__END__ |
|
|
|
=head1 NAME |
return $self; |
|
} |
|
|
Text::Todo - [One line description of module's purpose here] |
sub file { |
|
my ( $self, $file ) = @_; |
|
my $ident = ident($self); |
|
|
|
if ($file) { |
|
$file_of{$ident} = $file; |
|
} |
|
|
=head1 VERSION |
return $file_of{$ident}; |
|
} |
|
|
This document describes Text::Todo version 0.0.1 |
sub load { |
|
my ( $self, $file ) = @_; |
|
my $ident = ident($self); |
|
|
|
$file = $self->file($file) || croak 'load requires a filename'; |
|
|
|
my @list; |
|
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; |
|
} |
|
|
|
sub save { |
|
my ( $self, $file ) = @_; |
|
my $ident = ident($self); |
|
|
|
$file = $self->file($file) || croak 'save requires a filename'; |
|
|
|
open my $fh, '>', $file or croak "Couldn't open [$file]: $!"; |
|
foreach my $e ( @{ $list_of{$ident} } ) { |
|
print {$fh} $e->text . "\n" |
|
or croak "Couldn't print to [$file]: $!"; |
|
} |
|
close $fh or croak "Couldn't close [$file]: $!"; |
|
|
|
return 1; |
|
} |
|
|
|
sub list { |
|
my ($self) = @_; |
|
my $ident = ident($self); |
|
return if !$list_of{$ident}; |
|
|
|
return $list_of{$ident}; |
|
|
|
#my $id = 1; |
|
#my @l; |
|
#foreach my $e ( @{ $list_of{$ident} } ) { |
|
# push @l, $e; #{ %{$e}, id => $id }; |
|
# $id++; |
|
#} |
|
# |
|
#my @list = sort { $a->priority cmp $b->priority } |
|
# grep { defined $_->priority } @l; |
|
# |
|
#push @list, grep { !defined $_->priority } @l; |
|
# |
|
#return \@list; |
|
} |
|
|
|
sub add { |
|
my ( $self, $entry ) = @_; |
|
my $ident = ident($self); |
|
|
|
if ( ref $entry ) { |
|
if ( ref $entry ne 'Text::Todo::Entry' ) { |
|
croak( 'entry is a ' |
|
. ref($entry) |
|
. ' not a Text::Todo::Entry!' ); |
|
} |
|
} |
|
else { |
|
$entry = Text::Todo::Entry->new($entry); |
|
} |
|
|
|
push @{ $list_of{$ident} }, $entry; |
|
|
|
return $entry; |
|
} |
|
} |
|
|
|
1; # Magic true value required at end of module |
|
__END__ |
|
|
|
=head1 NAME |
|
|
|
Text::Todo - Perl interface to todo_txt files |
|
|
|
|
=head1 SYNOPSIS |
=head1 SYNOPSIS |
|
|
use Text::Todo; |
use Text::Todo; |
|
|
=for author to fill in: |
|
Brief code example(s) here showing commonest usage(s). |
|
This section will be as far as many users bother reading |
|
so make it as educational and exeplary as possible. |
|
|
|
|
|
=head1 DESCRIPTION |
=head1 DESCRIPTION |
|
|
=for author to fill in: |
For more information see L<http://todotxt.com> |
Write a full description of the module and its features here. |
|
Use subsections (=head2, =head3) as appropriate. |
|
|
|
|
|
=head1 INTERFACE |
=head1 INTERFACE |
|
|
=for author to fill in: |
=head2 new |
Write a separate section listing the public components of the modules |
|
interface. These normally consist of either subroutines that may be |
|
exported, or methods that may be called on objects belonging to the |
|
classes provided by the module. |
|
|
|
|
=head2 load |
|
|
|
=head2 save |
|
|
|
=head2 file |
|
|
|
=head2 list |
|
|
|
=head2 add |
|
|
=head1 DIAGNOSTICS |
=head1 DIAGNOSTICS |
|
|
=for author to fill in: |
=for author to fill in: |
|
|
|
|
=head1 CONFIGURATION AND ENVIRONMENT |
=head1 CONFIGURATION AND ENVIRONMENT |
|
|
=for author to fill in: |
|
A full explanation of any configuration system(s) used by the |
|
module, including the names and locations of any configuration |
|
files, and the meaning of any environment variables or properties |
|
that can be set. These descriptions must also include details of any |
|
configuration language used. |
|
|
|
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. |
|
|
|
|
=head1 DEPENDENCIES |
=head1 DEPENDENCIES |
|
|
=for author to fill in: |
=for author to fill in: |
|
|
|
|
=head1 INCOMPATIBILITIES |
=head1 INCOMPATIBILITIES |
|
|
=for author to fill in: |
|
A list of any modules that this module cannot be used in conjunction |
|
with. This may be due to name conflicts in the interface, or |
|
competition for system or program resources, or due to internal |
|
limitations of Perl (for example, many modules that use source code |
|
filters are mutually incompatible). |
|
|
|
None reported. |
None reported. |
|
|
|
|
=head1 BUGS AND LIMITATIONS |
=head1 BUGS AND LIMITATIONS |
|
|
=for author to fill in: |
|
A list of known problems with the module, together with some |
|
indication Whether they are likely to be fixed in an upcoming |
|
release. Also a list of restrictions on the features the module |
|
does provide: data types that cannot be handled, performance issues |
|
and the circumstances in which they may arise, practical |
|
limitations on the size of data sets, special cases that are not |
|
(yet) handled, etc. |
|
|
|
No bugs have been reported. |
No bugs have been reported. |
|
|