git/t/t4018-diff-funcname.sh
Jonathan Nieder f12c66b9bb userdiff/perl: anchor "sub" and "package" patterns on the left
The userdiff funcname mechanism has no concept of nested scopes ---
instead, "git diff" and "git grep --show-function" simply label the
diff header with the most recent matching line.  Unfortunately that
means text following a subroutine in a POD section:

	=head1 DESCRIPTION

	You might use this facility like so:

		sub example {
			foo;
		}

	Now, having said that, let's say more about the facility.
	Blah blah blah ... etc etc.

gets the subroutine name instead of the POD header in its diff/grep
funcname header, making it harder to get oriented when reading a
diff without enough context.

The fix is simple: anchor the funcname syntax to the left margin so
nested subroutines and packages like this won't get picked up.  (The
builtin C++ funcname pattern already does the same thing.)  This means
the userdiff driver will misparse the idiom

	{
		my $static;
		sub foo {
			... use $static ...
		}
	}

but I think that's worth it; we can revisit this later if the userdiff
mechanism learns to keep track of the beginning and end of nested
scopes.

Reported-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-05-21 22:29:31 -07:00

153 lines
3.3 KiB
Bash
Executable file

#!/bin/sh
#
# Copyright (c) 2007 Johannes E. Schindelin
#
test_description='Test custom diff function name patterns'
. ./test-lib.sh
LF='
'
cat >Beer.java <<\EOF
public class Beer
{
int special;
public static void main(String args[])
{
String s=" ";
for(int x = 99; x > 0; x--)
{
System.out.print(x + " bottles of beer on the wall "
+ x + " bottles of beer\n"
+ "Take one down, pass it around, " + (x - 1)
+ " bottles of beer on the wall.\n");
}
System.out.print("Go to the store, buy some more,\n"
+ "99 bottles of beer on the wall.\n");
}
}
EOF
sed 's/beer\\/beer,\\/' <Beer.java >Beer-correct.java
cat >Beer.perl <<\EOF
package Beer;
use strict;
use warnings;
use parent qw(Exporter);
our @EXPORT_OK = qw(round);
sub round {
my ($n) = @_;
print "$n bottles of beer on the wall ";
print "$n bottles of beer\n";
print "Take one down, pass it around, ";
$n = $n - 1;
print "$n bottles of beer on the wall.\n";
}
__END__
=head1 NAME
Beer - subroutine to output fragment of a drinking song
=head1 SYNOPSIS
use Beer qw(round);
sub song {
for (my $i = 99; $i > 0; $i--) {
round $i;
}
}
song;
=cut
EOF
sed -e '
s/beer\\/beer,\\/
s/song;/song();/
' <Beer.perl >Beer-correct.perl
test_config () {
git config "$1" "$2" &&
test_when_finished "git config --unset $1"
}
test_expect_funcname () {
lang=${2-java}
test_expect_code 1 git diff --no-index -U1 \
"Beer.$lang" "Beer-correct.$lang" >diff &&
grep "^@@.*@@ $1" diff
}
for p in bibtex cpp csharp fortran html java objc pascal perl php python ruby tex
do
test_expect_success "builtin $p pattern compiles" '
echo "*.java diff=$p" >.gitattributes &&
test_expect_code 1 git diff --no-index \
Beer.java Beer-correct.java 2>msg &&
! grep fatal msg &&
! grep error msg
'
test_expect_success "builtin $p wordRegex pattern compiles" '
echo "*.java diff=$p" >.gitattributes &&
test_expect_code 1 git diff --no-index --word-diff \
Beer.java Beer-correct.java 2>msg &&
! grep fatal msg &&
! grep error msg
'
done
test_expect_success 'default behaviour' '
rm -f .gitattributes &&
test_expect_funcname "public class Beer\$"
'
test_expect_success 'set up .gitattributes declaring drivers to test' '
cat >.gitattributes <<-\EOF
*.java diff=java
*.perl diff=perl
EOF
'
test_expect_success 'preset java pattern' '
test_expect_funcname "public static void main("
'
test_expect_success 'preset perl pattern' '
test_expect_funcname "sub round {\$" perl
'
test_expect_success 'perl pattern is not distracted by sub within POD' '
test_expect_funcname "=head" perl
'
test_expect_success 'custom pattern' '
test_config diff.java.funcname "!static
!String
[^ ].*s.*" &&
test_expect_funcname "int special;\$"
'
test_expect_success 'last regexp must not be negated' '
test_config diff.java.funcname "!static" &&
test_expect_code 128 git diff --no-index Beer.java Beer-correct.java 2>msg &&
grep ": Last expression must not be negated:" msg
'
test_expect_success 'pattern which matches to end of line' '
test_config diff.java.funcname "Beer\$" &&
test_expect_funcname "Beer\$"
'
test_expect_success 'alternation in pattern' '
test_config diff.java.funcname "Beer$" &&
test_config diff.java.xfuncname "^[ ]*((public|static).*)$" &&
test_expect_funcname "public static void main("
'
test_done