[BACK]Return to Entry.pm CVS log [TXT][DIR] Up to [local] / todotxt / Text-Todo / lib / Text / Todo

Diff for /todotxt/Text-Todo/lib/Text/Todo/Entry.pm between version 1.12 and 1.25

version 1.12, 2010/01/10 00:13:14 version 1.25, 2010/01/20 21:53:01
Line 1 
Line 1 
 package Text::Todo::Entry;  package Text::Todo::Entry;
   
 # $RedRiver: Entry.pm,v 1.11 2010/01/09 07:08:45 andrew Exp $  # $AFresh1: Entry.pm,v 1.24 2010/01/19 18:53:36 andrew Exp $
   
 use warnings;  use warnings;
 use strict;  use strict;
 use Carp;  use Carp;
   
 use Class::Std::Utils;  use Class::Std::Utils;
 use List::Util qw/ first /;  
   
 use version; our $VERSION = qv('0.0.1');  use version; our $VERSION = qv('0.1.0');
   
 {  {
     my %text_of;  
   
     my %tags_of;      my @attr_refs = \(
     my %priority_of;          my %text_of,
     my %completion_status_of;  
   
     my %tags = (          my %tags_of,
         context => q{@},          my %priority_of,
         project => q{+},          my %completion_status_of,
           my %known_tags_of,
     );      );
   
     # XXX Should the completion (x) be case sensitive?      # XXX Should the completion (x) be case sensitive?
     my $priority_completion_regex = qr/      my $priority_completion_regex = qr{
         ^ \s*          ^ \s*
         (?i:   (x)        \s+)?          (?i:(x \s* [\d-]* ) \s*)?
         (?i:\( ([A-Z]) \) \s+)?          (?i:\( ([A-Z]) \)   \s*)?
     /xms;      }xms;
   
     for my $tag ( keys %tags ) {      sub new {
         ## no critic strict          my ( $class, $options ) = @_;
         no strict 'refs';    # Violates use strict, but allows code generation  
         ## use critic  
   
         *{ $tag . 's' } = sub {          my $self = bless anon_scalar(), $class;
             my ($self) = @_;          my $ident = ident($self);
             return $self->_tags($tag);  
         };  
   
         *{ 'in_' . $tag } = sub {          if ( !ref $options ) {
             my ( $self, $item ) = @_;              $options = { text => $options };
             return $self->_is_in( $tag . 's', $item );          }
           elsif ( ref $options ne 'HASH' ) {
               croak 'Invalid parameter passed!';
           }
   
           $known_tags_of{$ident} = {
               context => q{@},
               project => q{+},
         };          };
     }  
   
     sub replace { _update_entry(@_) }          if ( exists $options->{tags} && ref $options->{tags} eq 'HASH' ) {
               foreach my $k ( keys %{ $options->{tags} } ) {
                   $known_tags_of{$ident}{$k} = $options->{tags}->{$k};
               }
           }
   
     sub new {          for my $tag ( keys %{ $known_tags_of{$ident} } ) {
         my ( $class, $text ) = @_;              ## no critic strict
               no strict
                   'refs';    # Violates use strict, but allows code generation
               ## use critic
   
         my $self = bless anon_scalar(), $class;              if ( !$self->can( $tag . 's' ) ) {
         my $ident = ident($self);                  *{ $tag . 's' } = sub {
                       my ($self) = @_;
                       return $self->_tags($tag);
                   };
               }
   
         $self->_update_entry($text);              if ( !$self->can( 'in_' . $tag ) ) {
                   *{ 'in_' . $tag } = sub {
                       my ( $self, $item ) = @_;
                       return $self->_is_in( $tag . 's', $item );
                   };
               }
           }
   
           $self->replace( $options->{text} );
   
         return $self;          return $self;
     }      }
   
     sub _update_entry {      sub replace {
         my ( $self, $text ) = @_;          my ( $self, $text ) = @_;
         my $ident = ident($self);          my $ident = ident($self);
   
Line 67 
Line 86 
   
         $text_of{$ident} = $text;          $text_of{$ident} = $text;
   
         foreach my $tag ( keys %tags ) {          foreach my $tag ( keys %{ $known_tags_of{$ident} } ) {
             my $symbol = quotemeta $tags{$tag};              my $symbol = quotemeta $known_tags_of{$ident}{$tag};
             $tags_of{$ident}{$tag} = { map { $_ => q{} }              $tags_of{$ident}{$tag} = { map { $_ => q{} }
                     $text =~ / (?:^|\s) $symbol  (\S+)/gxms };                      $text =~ / (?:^|\s) $symbol  (\S*)/gxms };
         }          }
         ( $completion_status_of{$ident}, $priority_of{$ident} )          my ( $completed, $priority )
             = $text =~ / $priority_completion_regex /xms;              = $text =~ / $priority_completion_regex /xms;
   
           $completion_status_of{$ident} = _clean_completed($completed);
           $priority_of{$ident}          = $priority;
   
         return 1;          return 1;
     }      }
   
       sub _clean_completed {
           my ($completed) = @_;
   
           $completed ||= q{};
           $completed =~ s/^\s+|\s+$//gxms;
   
           if ( !$completed ) {
               return;
           }
   
           if ( $completed =~ s/(x)\s*//ixms ) {
               my $status = $1;
               if ($completed) {
                   return $completed;
               }
               else {
                   return $status;
               }
           }
   
           return;
       }
   
     sub _tags {      sub _tags {
         my ( $self, $tag ) = @_;          my ( $self, $tag ) = @_;
         my $ident = ident($self);          my $ident = ident($self);
Line 88 
Line 133 
   
     sub _is_in {      sub _is_in {
         my ( $self, $tags, $item ) = @_;          my ( $self, $tags, $item ) = @_;
         return defined first { $_ eq $item } $self->$tags;          foreach ($self->$tags) {
               return 1 if $_ eq $item;
           }
           return 0;
     }      }
   
     sub text {      sub text {
Line 98 
Line 146 
         return $text_of{$ident};          return $text_of{$ident};
     }      }
   
     sub depri { pri( $_[0], '' ) }      sub depri { my ($self) = @_; return $self->pri(q{}) }
   
     sub pri {      sub pri {
         my ( $self, $new_pri ) = @_;          my ( $self, $new_pri ) = @_;
Line 129 
Line 177 
         $new =~ s/$priority_completion_regex//xms;          $new =~ s/$priority_completion_regex//xms;
   
         if ( $self->done ) {          if ( $self->done ) {
               if ( $self->done !~ /^x/ixms ) {
                   push @new, 'x';
               }
             push @new, $self->done;              push @new, $self->done;
         }          }
   
Line 140 
Line 191 
             push @new, $addition;              push @new, $addition;
         }          }
   
         return $self->_update_entry( join q{ }, @new, $new );          return $self->replace( join q{ }, @new, $new );
     }      }
   
     sub append {      sub append {
         my ( $self, $addition ) = @_;          my ( $self, $addition ) = @_;
         return $self->_update_entry( join q{ }, $self->text, $addition );          return $self->replace( join q{ }, $self->text, $addition );
     }      }
   
     sub do {      ## no critic 'homonym'
       sub do {    # This is what it is called in todo.sh
           ## use critic
         my ($self) = @_;          my ($self) = @_;
         my $ident = ident($self);          my $ident = ident($self);
   
Line 156 
Line 209 
             return 1;              return 1;
         }          }
   
         $completion_status_of{$ident} = 'x';          $completion_status_of{$ident} = sprintf "%04d-%02d-%02d",
               ( (localtime)[5] + 1900 ),
               ( (localtime)[4] + 1 ),
               ( (localtime)[3] );
   
         return $self->prepend();          return $self->prepend();
     }      }
Line 168 
Line 224 
         return $completion_status_of{$ident};          return $completion_status_of{$ident};
     }      }
   
       sub DESTROY {
           my ($self) = @_;
           my $ident = ident $self;
           foreach my $attr_ref (@attr_refs) {
               delete $attr_ref->{$ident};
           }
       }
 }  }
 1;    # Magic true value required at end of module  1;    # Magic true value required at end of module
 __END__  __END__
Line 212 
Line 275 
   
 Creates an entry that can be manipulated.  Creates an entry that can be manipulated.
   
     my $entry = Text::Todo::Entry->new(['text of entry']);      my $entry = Text::Todo::Entry->new([
       'text of entry' | {
           [ text => 'text of entry' ,]
           [ tags => { additional_arg => 'identfier' }, ]
       } ]);
   
 If you don't pass any text, creates a blank entry.  If you don't pass any text, creates a blank entry.
   
   See tags below for a description of additional tags.
   
 =head2 text  =head2 text
   
 Returns the text of the entry.  Returns the text of the entry.
Line 250 
Line 319 
   
 Current tags are context (@) and project (+).  Current tags are context (@) and project (+).
   
   When creating a new object you can pass in new tags to recognize.
   
       my $entry = Text::Todo::Entry->new({
           text => 'do something DUE:2011-01-01',
           tags => { due_date => 'DUE:' }
       });
   
       my @due_dates = $entry->due_dates;
   
   then @due_dates eq ( '2011-01-01' );
   
   and you could also:
   
       if ($entry->in_due_date('2011-01-01')) {
           # do something
       }
   
   
 =over  =over
   
 =item {tag}s  =item {tag}s
Line 317 
Line 404 
   
     $entry->do;      $entry->do;
   
 Does this by prepending an 'x' to the beginning of the entry.  Does this by prepending "x `date '%Y-%m-%d'`" to the beginning of the entry.
   
 =head2 done  =head2 done
   
 Returns true if an entry is marked complete and false if not.  Returns true if an entry is marked complete and false if not.
   
     if (!$entry->done) {      if (!my $status = $entry->done) {
         # remind me to do it          # remind me to do it
     }      }
   
   If the entry starts as 'x date', for example 'x 2010-01-01', $status is now
   '2010-01-01'.
   If the entry just starts with 'x', then $status will be 'x'.
   
 =head1 DIAGNOSTICS  =head1 DIAGNOSTICS
   
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.25
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>