Use git_diff_get_stats in example/diff + refactor

This takes the `--stat` and related example options in the example
diff.c program and converts them to use the `git_diff_get_stats`
API which nicely formats stats for you.

I went to add bar-graph scaling to the stats formatter and noticed
that the `git_diff_stats` structure was holding on to all of the
`git_patch` objects.  Unfortunately, each of these objects keeps
the full text of the diff in memory, so this is very expensive.  I
ended up modifying `git_diff_stats` to keep just the data that it
needs to keep and allowed it to release the patches.  Then, I added
width scaling to the output on top of that.

In making the diff example program match 'git diff' output, I ended
up removing an newline from the sumamry output which I then had to
compensate for in the email formatting to match the expectations.

Lastly, I went through and refactored the tests to use a couple of
helper functions and reduce the overall amount of code there.

examples/diff.c

@@ -34,10 +34,11 @@ static const char *colors[] = {
 };
 
 enum {
-	OUTPUT_DIFF = 0,
-	OUTPUT_STAT = 1,
-	OUTPUT_SHORTSTAT = 2,
-	OUTPUT_NUMSTAT = 3
+	OUTPUT_DIFF = (1 << 0),
+	OUTPUT_STAT = (1 << 1),
+	OUTPUT_SHORTSTAT = (1 << 2),
+	OUTPUT_NUMSTAT = (1 << 3),
+	OUTPUT_SUMMARY = (1 << 4)
 };
 
 enum {
@@ -137,14 +138,13 @@ int main(int argc, char *argv[])
 
 	/** Generate simple output using libgit2 display helper. */
 
-	switch (o.output) {
-	case OUTPUT_STAT:
-	case OUTPUT_NUMSTAT:
-	case OUTPUT_SHORTSTAT:
+	if (!o.output)
+		o.output = OUTPUT_DIFF;
+
+	if (o.output != OUTPUT_DIFF)
 		diff_print_stats(diff, &o);
-		break;
 
-	case OUTPUT_DIFF:
+	if ((o.output & OUTPUT_DIFF) != 0) {
 		if (o.color >= 0)
 			fputs(colors[0], stdout);
 
@@ -154,10 +154,6 @@ int main(int argc, char *argv[])
 
 		if (o.color >= 0)
 			fputs(colors[0], stdout);
-		break;
-
-	default:
-		usage("Unknown output format", "programmer error");
 	}
 
 	/** Cleanup before exiting. */
@@ -233,8 +229,10 @@ static void parse_opts(struct opts *o, int argc, char *argv[])
 				usage("Only one or two tree identifiers can be provided", NULL);
 		}
 		else if (!strcmp(a, "-p") || !strcmp(a, "-u") ||
-			!strcmp(a, "--patch"))
+				 !strcmp(a, "--patch")) {
+			o->output |= OUTPUT_DIFF;
 			o->format = GIT_DIFF_FORMAT_PATCH;
+		}
 		else if (!strcmp(a, "--cached"))
 			o->cache = CACHE_ONLY;
 		else if (!strcmp(a, "--nocache"))
@@ -273,11 +271,13 @@ static void parse_opts(struct opts *o, int argc, char *argv[])
 		else if (!strcmp(a, "--minimal"))
 			o->diffopts.flags |= GIT_DIFF_MINIMAL;
 		else if (!strcmp(a, "--stat"))
-			o->output = OUTPUT_STAT;
+			o->output |= OUTPUT_STAT;
 		else if (!strcmp(a, "--numstat"))
-			o->output = OUTPUT_NUMSTAT;
+			o->output |= OUTPUT_NUMSTAT;
 		else if (!strcmp(a, "--shortstat"))
-			o->output = OUTPUT_SHORTSTAT;
+			o->output |= OUTPUT_SHORTSTAT;
+		else if (!strcmp(a, "--summary"))
+			o->output |= OUTPUT_SUMMARY;
 		else if (match_uint16_arg(
 				&o->findopts.rename_threshold, &args, "-M") ||
 			match_uint16_arg(
@@ -308,59 +308,30 @@ static void parse_opts(struct opts *o, int argc, char *argv[])
 	}
 }
 
-/** Display diff output with "--numstat" or "--shortstat" */
+/** Display diff output with "--stat", "--numstat", or "--shortstat" */
 static void diff_print_stats(git_diff *diff, struct opts *o)
 {
-	git_patch *patch;
-	size_t d, ndeltas = git_diff_num_deltas(diff);
-	size_t nadditions, ndeletions;
-	long nadditions_sum, ndeletions_sum;
+	git_diff_stats *stats;
+	git_buf b = GIT_BUF_INIT_CONST(NULL, 0);
+	git_diff_stats_format_t format = 0;
 
-	nadditions_sum = 0;
-	ndeletions_sum = 0;
-
-	for (d = 0; d < ndeltas; d++){
 	check_lg2(
-			git_patch_from_diff(&patch, diff, d),
-			"generating patch from diff", NULL);
-
-		check_lg2(
-			git_patch_line_stats(NULL, &nadditions, &ndeletions, patch),
-			"generating the number of additions and deletions", NULL);
-
-		if (o->output == OUTPUT_NUMSTAT) {
-			const git_diff_delta *delta = git_patch_get_delta(patch);
-			printf("%ld\t%ld\t%s\n",
-				   (long)nadditions, (long)ndeletions, delta->new_file.path);
-		}
-		else if (o->output == OUTPUT_STAT) {
-			const git_diff_delta *delta = git_patch_get_delta(patch);
-			printf(" %s\t| %ld\t(%ld+ %ld-)\n",
-				   delta->new_file.path, (long)nadditions + (long)ndeletions,
-				   (long)nadditions, (long)ndeletions);
-		}
+		git_diff_get_stats(&stats, diff), "generating stats for diff", NULL);
 
-		nadditions_sum += nadditions;
-		ndeletions_sum += ndeletions;
+	if (o->output & OUTPUT_STAT)
+		format |= GIT_DIFF_STATS_FULL;
+	if (o->output & OUTPUT_SHORTSTAT)
+		format |= GIT_DIFF_STATS_SHORT;
+	if (o->output & OUTPUT_NUMSTAT)
+		format |= GIT_DIFF_STATS_NUMBER;
+	if (o->output & OUTPUT_SUMMARY)
+		format |= GIT_DIFF_STATS_INCLUDE_SUMMARY;
 
-		git_patch_free(patch);
-	}
-
-	if (o->output != OUTPUT_NUMSTAT && ndeltas > 0) {
-	    printf(" %ld %s", (long)ndeltas,
-			1 == ndeltas ? "file changed" : "files changed");
-
-	    if (nadditions_sum) {
-			printf(", %ld ",nadditions_sum);
-			printf("%s", 1 == nadditions_sum ? "insertion(+)" : "insertions(+)");
-	    }
+	check_lg2(
+		git_diff_stats_to_buf(&b, stats, format, 80), "formatting stats", NULL);
 
-	    if (ndeletions_sum) {
-			printf(", %ld ",ndeletions_sum);
-			printf("%s", 1 == ndeletions_sum ? "deletion(-)" : "deletions(-)");
-	    }
+	fputs(b.ptr, stdout);
 
-	    printf("\n");
-	}
+	git_buf_free(&b);
+	git_diff_stats_free(stats);
 }
-

include/git2/diff.h

@@ -1136,12 +1136,14 @@ GIT_EXTERN(size_t) git_diff_stats_deletions(
  * @param out buffer to store the formatted diff statistics in.
  * @param stats A `git_diff_stats` generated by one of the above functions.
  * @param format Formatting option.
+ * @param width Target width for output (only affects GIT_DIFF_STATS_FULL)
  * @return 0 on success; non-zero on error
  */
 GIT_EXTERN(int) git_diff_stats_to_buf(
 	git_buf *out,
 	const git_diff_stats *stats,
-	git_diff_stats_format_t format);
+	git_diff_stats_format_t format,
+	size_t width);
 
 /**
  * Deallocate a `git_diff_stats`.

src/diff.c

@@ -1590,7 +1590,8 @@ int git_diff_format_email(
 
 	if ((error = git_buf_puts(out, "---\n")) < 0 ||
 		(error = git_diff_get_stats(&stats, diff)) < 0 ||
-		(error = git_diff_stats_to_buf(out, stats, format_flags)) < 0 ||
+		(error = git_diff_stats_to_buf(out, stats, format_flags, 0)) < 0 ||
+		(error = git_buf_putc(out, '\n')) < 0 ||
 		(error = git_diff_format_email__append_patches_tobuf(out, diff)) < 0)
 			goto on_error;
 

tests/diff/format_email.c

@@ -17,14 +17,43 @@ void test_diff_format_email__cleanup(void)
 	cl_git_sandbox_cleanup();
 }
 
-void test_diff_format_email__simple(void)
+static void assert_email_match(
+	const char *expected,
+	const char *oidstr,
+	git_diff_format_email_options *opts)
 {
 	git_oid oid;
 	git_commit *commit = NULL;
 	git_diff *diff = NULL;
-	git_diff_format_email_options opts = GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT;
 	git_buf buf = GIT_BUF_INIT;
 
+	git_oid_fromstr(&oid, oidstr);
+
+	cl_git_pass(git_commit_lookup(&commit, repo, &oid));
+
+	opts->id = git_commit_id(commit);
+	opts->author = git_commit_author(commit);
+	if (!opts->summary)
+		opts->summary = git_commit_summary(commit);
+
+	cl_git_pass(git_diff__commit(&diff, repo, commit, NULL));
+	cl_git_pass(git_diff_format_email(&buf, diff, opts));
+
+	cl_assert_equal_s(expected, git_buf_cstr(&buf));
+	git_buf_clear(&buf);
+
+	cl_git_pass(git_diff_commit_as_email(
+		&buf, repo, commit, 1, 1, opts->flags, NULL));
+	cl_assert_equal_s(expected, git_buf_cstr(&buf));
+
+	git_diff_free(diff);
+	git_commit_free(commit);
+	git_buf_free(&buf);
+}
+
+void test_diff_format_email__simple(void)
+{
+	git_diff_format_email_options opts = GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT;
 	const char *email =
 	"From 9264b96c6d104d0e07ae33d3007b6a48246c6f92 Mon Sep 17 00:00:00 2001\n" \
 	"From: Jacques Germishuys <jacquesg@striata.com>\n" \
@@ -64,25 +93,8 @@ void test_diff_format_email__simple(void)
 	"libgit2 " LIBGIT2_VERSION "\n" \
 	"\n";
 
-	git_oid_fromstr(&oid, "9264b96c6d104d0e07ae33d3007b6a48246c6f92");
-
-	cl_git_pass(git_commit_lookup(&commit, repo, &oid));
-
-	opts.id = git_commit_id(commit);
-	opts.author = git_commit_author(commit);
-	opts.summary = git_commit_summary(commit);
-
-	cl_git_pass(git_diff__commit(&diff, repo, commit, NULL));
-	cl_git_pass(git_diff_format_email(&buf, diff, &opts));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_buf_clear(&buf);
-	cl_git_pass(git_diff_commit_as_email(&buf, repo, commit, 1, 1, 0, NULL));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_diff_free(diff);
-	git_commit_free(commit);
-	git_buf_free(&buf);
+	assert_email_match(
+		email, "9264b96c6d104d0e07ae33d3007b6a48246c6f92", &opts);
 }
 
 void test_diff_format_email__multiple(void)
@@ -167,6 +179,7 @@ void test_diff_format_email__multiple(void)
 	"libgit2 " LIBGIT2_VERSION "\n" \
 	"\n";
 
+
 	git_oid_fromstr(&oid, "10808fe9c9be5a190c0ba68d1a002233fb363508");
 	cl_git_pass(git_commit_lookup(&commit, repo, &oid));
 
@@ -196,7 +209,7 @@ void test_diff_format_email__multiple(void)
 	cl_git_pass(git_diff__commit(&diff, repo, commit, NULL));
 	cl_git_pass(git_diff_format_email(&buf, diff, &opts));
 
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
+	cl_assert_equal_s(email, git_buf_cstr(&buf));
 
 	git_diff_free(diff);
 	git_commit_free(commit);
@@ -205,12 +218,7 @@ void test_diff_format_email__multiple(void)
 
 void test_diff_format_email__exclude_marker(void)
 {
-	git_oid oid;
-	git_commit *commit = NULL;
-	git_diff *diff = NULL;
 	git_diff_format_email_options opts = GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT;
-	git_buf buf = GIT_BUF_INIT;
-
 	const char *email =
 	"From 9264b96c6d104d0e07ae33d3007b6a48246c6f92 Mon Sep 17 00:00:00 2001\n" \
 	"From: Jacques Germishuys <jacquesg@striata.com>\n" \
@@ -250,27 +258,10 @@ void test_diff_format_email__exclude_marker(void)
 	"libgit2 " LIBGIT2_VERSION "\n" \
 	"\n";
 
-	git_oid_fromstr(&oid, "9264b96c6d104d0e07ae33d3007b6a48246c6f92");
-	cl_git_pass(git_commit_lookup(&commit, repo, &oid));
-
-	opts.id = git_commit_id(commit);
-	opts.author = git_commit_author(commit);
-	opts.summary = git_commit_summary(commit);
-
 	opts.flags |= GIT_DIFF_FORMAT_EMAIL_EXCLUDE_SUBJECT_PATCH_MARKER;
 
-	cl_git_pass(git_diff__commit(&diff, repo, commit, NULL));
-	cl_git_pass(git_diff_format_email(&buf, diff, &opts));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_buf_clear(&buf);
-	cl_git_pass(git_diff_commit_as_email(&buf, repo, commit, 1, 1,
-		GIT_DIFF_FORMAT_EMAIL_EXCLUDE_SUBJECT_PATCH_MARKER, NULL));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_diff_free(diff);
-	git_commit_free(commit);
-	git_buf_free(&buf);
+	assert_email_match(
+		email, "9264b96c6d104d0e07ae33d3007b6a48246c6f92", &opts);
 }
 
 void test_diff_format_email__invalid_no(void)
@@ -303,12 +294,7 @@ void test_diff_format_email__invalid_no(void)
 
 void test_diff_format_email__mode_change(void)
 {
-	git_oid oid;
-	git_commit *commit = NULL;
-	git_diff *diff = NULL;
 	git_diff_format_email_options opts = GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT;
-	git_buf buf = GIT_BUF_INIT;
-
 	const char *email =
 	"From 7ade76dd34bba4733cf9878079f9fd4a456a9189 Mon Sep 17 00:00:00 2001\n" \
 	"From: Jacques Germishuys <jacquesg@striata.com>\n" \
@@ -330,35 +316,13 @@ void test_diff_format_email__mode_change(void)
 	"libgit2 " LIBGIT2_VERSION "\n" \
 	"\n";
 
-	git_oid_fromstr(&oid, "7ade76dd34bba4733cf9878079f9fd4a456a9189");
-
-	cl_git_pass(git_commit_lookup(&commit, repo, &oid));
-
-	opts.id = git_commit_id(commit);
-	opts.author = git_commit_author(commit);
-	opts.summary = git_commit_summary(commit);
-
-	cl_git_pass(git_diff__commit(&diff, repo, commit, NULL));
-	cl_git_pass(git_diff_format_email(&buf, diff, &opts));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_buf_clear(&buf);
-	cl_git_pass(git_diff_commit_as_email(&buf, repo, commit, 1, 1, 0, NULL));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_diff_free(diff);
-	git_commit_free(commit);
-	git_buf_free(&buf);
+	assert_email_match(
+		email, "7ade76dd34bba4733cf9878079f9fd4a456a9189", &opts);
 }
 
 void test_diff_format_email__rename_add_remove(void)
 {
-	git_oid oid;
-	git_commit *commit = NULL;
-	git_diff *diff = NULL;
 	git_diff_format_email_options opts = GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT;
-	git_buf buf = GIT_BUF_INIT;
-
 	const char *email =
 	"From 6e05acc5a5dab507d91a0a0cc0fb05a3dd98892d Mon Sep 17 00:00:00 2001\n" \
 	"From: Jacques Germishuys <jacquesg@striata.com>\n" \
@@ -422,35 +386,13 @@ void test_diff_format_email__rename_add_remove(void)
 	"libgit2 " LIBGIT2_VERSION "\n" \
 	"\n";
 
-	git_oid_fromstr(&oid, "6e05acc5a5dab507d91a0a0cc0fb05a3dd98892d");
-
-	cl_git_pass(git_commit_lookup(&commit, repo, &oid));
-
-	opts.id = git_commit_id(commit);
-	opts.author = git_commit_author(commit);
-	opts.summary = git_commit_summary(commit);
-
-	cl_git_pass(git_diff__commit(&diff, repo, commit, NULL));
-	cl_git_pass(git_diff_format_email(&buf, diff, &opts));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_buf_clear(&buf);
-	cl_git_pass(git_diff_commit_as_email(&buf, repo, commit, 1, 1, 0, NULL));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_diff_free(diff);
-	git_commit_free(commit);
-	git_buf_free(&buf);
+	assert_email_match(
+		email, "6e05acc5a5dab507d91a0a0cc0fb05a3dd98892d", &opts);
 }
 
 void test_diff_format_email__multiline_summary(void)
 {
-	git_oid oid;
-	git_commit *commit = NULL;
-	git_diff *diff = NULL;
 	git_diff_format_email_options opts = GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT;
-	git_buf buf = GIT_BUF_INIT;
-
 	const char *email =
 	"From 9264b96c6d104d0e07ae33d3007b6a48246c6f92 Mon Sep 17 00:00:00 2001\n" \
 	"From: Jacques Germishuys <jacquesg@striata.com>\n" \
@@ -490,36 +432,15 @@ void test_diff_format_email__multiline_summary(void)
 	"libgit2 " LIBGIT2_VERSION "\n" \
 	"\n";
 
-	git_oid_fromstr(&oid, "9264b96c6d104d0e07ae33d3007b6a48246c6f92");
-
-	cl_git_pass(git_commit_lookup(&commit, repo, &oid));
-
-	opts.id = git_commit_id(commit);
-	opts.author = git_commit_author(commit);
 	opts.summary = "Modify some content\nSome extra stuff here";
 
-	cl_git_pass(git_diff__commit(&diff, repo, commit, NULL));
-	cl_git_pass(git_diff_format_email(&buf, diff, &opts));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_buf_clear(&buf);
-	cl_git_pass(git_diff_commit_as_email(&buf, repo, commit, 1, 1, 0, NULL));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_diff_free(diff);
-	git_commit_free(commit);
-	git_buf_free(&buf);
+	assert_email_match(
+		email, "9264b96c6d104d0e07ae33d3007b6a48246c6f92", &opts);
 }
 
 void test_diff_format_email__binary(void)
 {
-	git_oid oid;
-	git_commit *commit = NULL;
-	git_diff *diff = NULL;
 	git_diff_format_email_options opts = GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT;
-	git_buf buf = GIT_BUF_INIT;
-
-	/* TODO: Actually 0 bytes here should be 5!. Seems like we don't load the new content for binary files? */
 	const char *email =
 	"From 8d7523f6fcb2404257889abe0d96f093d9f524f9 Mon Sep 17 00:00:00 2001\n" \
 	"From: Jacques Germishuys <jacquesg@striata.com>\n" \
@@ -536,21 +457,11 @@ void test_diff_format_email__binary(void)
 	"--\n" \
 	"libgit2 " LIBGIT2_VERSION "\n" \
 	"\n";
+	/* TODO: Actually 0 bytes here should be 5!. Seems like we don't load the new content for binary files? */
 
-	git_oid_fromstr(&oid, "8d7523f6fcb2404257889abe0d96f093d9f524f9");
-
-	cl_git_pass(git_commit_lookup(&commit, repo, &oid));
-
-	opts.id = git_commit_id(commit);
-	opts.author = git_commit_author(commit);
 	opts.summary = "Modified binary file";
 
-	cl_git_pass(git_diff__commit(&diff, repo, commit, NULL));
-	cl_git_pass(git_diff_format_email(&buf, diff, &opts));
-	cl_assert(strcmp(git_buf_cstr(&buf), email) == 0);
-
-	git_diff_free(diff);
-	git_commit_free(commit);
-	git_buf_free(&buf);
+	assert_email_match(
+		email, "8d7523f6fcb2404257889abe0d96f093d9f524f9", &opts);
 }