use Term::ANSIColor;
use Pod::Usage;
-BEGIN { struct( git => '$', last_tag => '$', opt => '%' ) }
+BEGIN { struct( git => '$', last_tag => '$', opt => '%', original_stdout => '$' ) }
__PACKAGE__->run;
$opt{type} //= 'pending';
$gdt->render;
}
+ elsif ( $opt{mode} eq 'summary' ) {
+ $opt{type} //= 'pending';
+ $gdt->summary;
+ }
elsif ( $opt{mode} eq 'update' ) {
die "Explicit --type argument required for update mode\n"
unless defined $opt{type};
my @choices = ( $self->section_choices, $self->action_choices );
$self->_iterate_commits(
sub {
- my $log = shift;
- say "";
+ my ($log, $i, $count) = @_;
+ say "\n### Commit @{[$i+1]} of $count ###";
say "-" x 75;
$self->show_header($log);
$self->show_body($log, 1);
my @choices = ( $self->review_choices, $self->action_choices );
$self->_iterate_commits(
sub {
- my $log = shift;
- say "";
+ my ($log, $i, $count) = @_;
+ say "\n### Commit @{[$i+1]} of $count ###";
say "-" x 75;
$self->show_header($log);
$self->show_notes($log, 1);
return;
}
+sub summary {
+ my ($self) = @_;
+ $self->_iterate_commits(
+ sub {
+ my $log = shift;
+ $self->show_header($log);
+ return 1;
+ }
+ );
+ return;
+}
+
sub update {
my ($self) = @_;
sub _iterate_commits {
my ($self, $fcn) = @_;
my $type = $self->opt('type');
- say "Scanning for $type commits since " . $self->last_tag . "...";
- for my $log ( $self->find_commits($type) ) {
- redo unless $fcn->($log);
+ say STDERR "Scanning for $type commits since " . $self->last_tag . "...";
+ my $list = [ $self->find_commits($type) ];
+ my $count = @$list;
+ while ( my ($i,$log) = each @$list ) {
+ redo unless $fcn->($log, $i, $count);
}
return 1;
}
$args //= {};
my $tempfh = File::Temp->new;
$tempfh->printflush( $text );
- if ( my (@editor) = $ENV{VISUAL} || $ENV{EDITOR} ) {
+ if ( my @editor = split /\s+/, ($ENV{VISUAL} || $ENV{EDITOR}) ) {
push @editor, "-f" if $editor[0] =~ /^gvim/;
system(@editor, "$tempfh");
}
my ($self, $log) = @_;
my $header = $log->short_id;
$header .= " " . $log->subject if length $log->subject;
+ $header .= sprintf(' (%s)', $log->author) if $log->author;
say colored( $header, "yellow");
return;
}
# handlers
#--------------------------------------------------------------------------#
+sub do_blocking {
+ my ($self, $choice, $log) = @_;
+ my $note = "perldelta: Unknown [blocking]\n";
+ $self->add_note( $log->id, $note );
+ return 1;
+}
+
+sub do_examine {
+ my ($self, $choice, $log) = @_;
+ $self->start_pager;
+ say $self->get_diff($log);
+ $self->end_pager;
+ return;
+}
+
sub do_cherry {
my ($self, $choice, $log) = @_;
my $id = $log->short_id;
my $section = _strip_parens($choice->{name});
my $subject = $log->subject;
my $body = $log->body;
- my $id = $log->short_id;
my $template = $self->note_template( $log,
- "perldelta: $section [pending]\n\n=head2 $subject\n\n$body ($id)\n"
+ "perldelta: $section [pending]\n\n=head2 $subject\n\n$body\n"
);
my $note = $self->edit_text( $template );
my $section = _strip_parens($choice->{name});
my $subject = $log->subject;
my $body = $log->body;
- my $id = $log->short_id;
my $template = $self->note_template( $log,
- "perldelta: $section [pending]\n\n=head3 L<LINK>\n\n=over\n\n=item *\n\n$subject ($id)\n\n$body\n\n=back\n"
+ "perldelta: $section [pending]\n\n=head3 L<LINK>\n\n=over\n\n=item *\n\n$subject\n\n$body\n\n=back\n"
);
my $note = $self->edit_text($template);
my $section = _strip_parens($choice->{name});
my $subject = $log->subject;
my $body = $log->body;
- my $id = $log->short_id;
my $template = $self->note_template( $log,
- "perldelta: $section [pending]\n\n=item *\n\n$subject ($id)\n\n$body\n"
+ "perldelta: $section [pending]\n\n=item *\n\n$subject\n\n$body\n"
);
my $note = $self->edit_text($template);
my $section = _strip_parens($choice->{name});
my $subject = $log->subject;
my $body = $log->body;
- my $id = $log->short_id;
my $template = $self->note_template( $log,
- "perldelta: $section [pending]\n\n=item PLATFORM-NAME\n\n$subject ($id)\n\n$body\n"
+ "perldelta: $section [pending]\n\n=item PLATFORM-NAME\n\n$subject\n\n$body\n"
);
my $note = $self->edit_text($template);
my $section = _strip_parens($choice->{name});
my $subject = $log->subject;
my $body = $log->body;
- my $id = $log->short_id;
my $template = $self->note_template( $log, << "HERE" );
perldelta: $section [pending]
$subject
-$body ($id)
+$body
HERE
my $note = $self->edit_text( $template );
sub action_choices {
my ($self) = @_;
state $action_choices = [
+ { name => 'E(x)amine', handler => 'examine' },
{ name => '(+)Cherrymaint', handler => 'cherry' },
+ { name => '(?)NeedHelp', handler => 'blocking' },
{ name => 'S(k)ip', handler => 'skip' },
{ name => '(Q)uit', handler => 'quit' },
];
}
#--------------------------------------------------------------------------#
+# Pager handling
+#--------------------------------------------------------------------------#
+
+sub get_pager { $ENV{'PAGER'} || `which less` || `which more` }
+
+sub in_pager { shift->original_stdout ? 1 : 0 }
+
+sub start_pager {
+ my $self = shift;
+ my $content = shift;
+ if (!$self->in_pager) {
+ local $ENV{'LESS'} ||= '-FXe';
+ local $ENV{'MORE'};
+ $ENV{'MORE'} ||= '-FXe' unless $^O =~ /^MSWin/;
+
+ my $pager = $self->get_pager;
+ return unless $pager;
+ open (my $cmd, "|-", $pager) || return;
+ $|++;
+ $self->original_stdout(*STDOUT);
+
+ # $pager will be closed once we restore STDOUT to $original_stdout
+ *STDOUT = $cmd;
+ }
+}
+
+sub end_pager {
+ my $self = shift;
+ return unless ($self->in_pager);
+ *STDOUT = $self->original_stdout;
+
+ # closes the pager
+ $self->original_stdout(undef);
+}
+
+#--------------------------------------------------------------------------#
# Utility functions
#--------------------------------------------------------------------------#
sub subject { shift->attr->{subject} }
sub body { shift->attr->{body} }
sub short_id { shift->attr->{short_id} }
+sub author { shift->attr->{author} }
sub from_log {
my ($class, $log) = @_;
$ git-deltatool --mode review
- # summarize annotations by section to STDOUT
+ # review commits needing help
+
+ $ git-deltatool --mode review --type blocking
+
+ # summarize commits needing help
+
+ $ git-deltatool --mode summary --type blocking
+
+ # assemble annotations by section to STDOUT
$ git-deltatool --mode render
+ # Get a list of commits needing further review, e.g. for peer review
+
+ $ git-deltatool --mode summary --type blocking
+
# mark 'pending' annotations as 'done' (i.e. added to perldelta)
$ git-deltatool --mode update --type pending --status done
Indicates the run mode for the program. The default is 'assign' which
assigns categories and marks the notes as 'pending' (or 'ignored'). Other
-modes are 'review', 'render' and 'update'.
+modes are 'review', 'render', 'summary' and 'update'.
=item B<--type>|B<-t> TYPE
-Indicates what types of commits to process. The default for 'assign' mode
-is 'new', which processes commits without any perldelta notes. The
-default for 'review' and 'render' modes is 'pending'. The options
-must be set explicitly for 'update' mode.
+Indicates what types of commits to process. The default for 'assign' mode is
+'new', which processes commits without any perldelta notes. The default for
+'review', 'summary' and 'render' modes is 'pending'. The options must be set
+explicitly for 'update' mode.
+
+The type 'blocking' is reserved for commits needing further review.
=item B<--status>|B<-s> STATUS
For 'update' mode only, sets a new status. While there is no restriction,
-it should be one of 'new', 'pending', 'ignored' or 'done'.
+it should be one of 'new', 'pending', 'blocking', 'ignored' or 'done'.
=item B<--since> REVISION
https://perl5.git.perl.org / perl5.git / blobdiff