Merge pull request #623 from libgit2/brianmario/update-patch-lines

Change Rugged::Patch#lines to accept count exclusion options

Author: arthurschreiber

ext/rugged/rugged_patch.c

@@ -175,47 +175,107 @@ static VALUE rb_git_diff_patch_stat(VALUE self)
 
 /*
  *  call-seq:
- *    patch.lines -> int
+ *    patch.lines(options = {}) -> int
  *
- *  Returns the total number of lines in the patch.
+ *  The following options can be passed in the +options+ Hash:
+ *
+ *  :exclude_context ::
+ *    Boolean value specifying that context line counts should be excluded from
+ *    the returned total.
+ *
+ *  :exclude_additions ::
+ *    Boolean value specifying that addition line counts should be excluded from
+ *    the returned total.
+ *
+ *  :exclude_deletions ::
+ *    Boolean value specifying that deletion line counts should be excluded from
+ *    the returned total.
+ *
+ *  Returns the total number of lines in the patch, depending on the options
+ *  specified.
  */
-static VALUE rb_git_diff_patch_lines(VALUE self)
+static VALUE rb_git_diff_patch_lines(int argc, VALUE *argv, VALUE self)
 {
 	git_patch *patch;
-	size_t context, adds, dels;
+	size_t context_lines, additions, deletions;
+	size_t total_out;
+	VALUE rb_options;
 	Data_Get_Struct(self, git_patch, patch);
 
-	git_patch_line_stats(&context, &adds, &dels, patch);
+	context_lines = 0;
+	additions = 0;
+	deletions = 0;
 
-	return INT2FIX(context + adds + dels);
-}
+	git_patch_line_stats(&context_lines, &additions, &deletions, patch);
+
+	total_out = context_lines + additions + deletions;
+
+	rb_scan_args(argc, argv, "0:", &rb_options);
+	if (!NIL_P(rb_options)) {
+		if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("exclude_context")))) {
+			total_out -= context_lines;
+		}
+
+		if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("exclude_additions")))) {
+			total_out -= additions;
+		}
 
+		if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("exclude_deletions")))) {
+			total_out -= deletions;
+		}
+	}
+
+	return INT2FIX(total_out);
+}
+/*
+ *  call-seq:
+ *    patch.bytesize(options = {}) -> int
+ *
+ *  The following options can be passed in the +options+ Hash:
+ *
+ *  :exclude_context ::
+ *    Boolean value specifying that context lines should be excluded when
+ *    counting the number of bytes in the patch.
+ *
+ *  :exclude_hunk_headers ::
+ *    Boolean value specifying that hunk headers should be excluded when
+ *    counting the number of bytes in the patch.
+ *
+ *  :exclude_file_headers ::
+ *    Boolean value specifying that file headers should be excluded when
+ *    counting the number of bytes in the patch.
+ *
+ *  Returns the number of bytes in the patch, depending on which options are
+ *  specified.
+ */
 static VALUE rb_git_diff_patch_bytesize(int argc, VALUE *argv, VALUE self)
 {
 	git_patch *patch;
 	size_t bytesize;
 	VALUE rb_options;
-	int options[3];
+	int include_context, include_hunk_headers, include_file_headers;
 	Data_Get_Struct(self, git_patch, patch);
 
-	memset(options, 0, sizeof(options));
+	include_context = 1;
+	include_hunk_headers = 1;
+	include_file_headers = 1;
 
 	rb_scan_args(argc, argv, "0:", &rb_options);
 	if (!NIL_P(rb_options)) {
-		if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("include_context")))) {
-			options[0] = 1;
+		if (rb_hash_aref(rb_options, CSTR2SYM("include_context")) == Qfalse) {
+			include_context = 0;
 		}
 
-		if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("include_hunk_headers")))) {
-			options[1] = 1;
+		if (rb_hash_aref(rb_options, CSTR2SYM("include_hunk_headers")) == Qfalse) {
+			include_hunk_headers = 0;
 		}
 
-		if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("include_file_headers")))) {
-			options[2] = 1;
+		if (rb_hash_aref(rb_options, CSTR2SYM("include_file_headers")) == Qfalse) {
+			include_file_headers = 0;
 		}
 	}
 
-	bytesize = git_patch_size(patch, options[0], options[1], options[2]);
+	bytesize = git_patch_size(patch, include_context, include_hunk_headers, include_file_headers);
 
 	return INT2FIX(bytesize);
 }
@@ -264,7 +324,7 @@ void Init_rugged_patch(void)
 	rb_define_singleton_method(rb_cRuggedPatch, "from_strings", rb_git_patch_from_strings, -1);
 
 	rb_define_method(rb_cRuggedPatch, "stat", rb_git_diff_patch_stat, 0);
-	rb_define_method(rb_cRuggedPatch, "lines", rb_git_diff_patch_lines, 0);
+	rb_define_method(rb_cRuggedPatch, "lines", rb_git_diff_patch_lines, -1);
 	rb_define_method(rb_cRuggedPatch, "bytesize", rb_git_diff_patch_bytesize, -1);
 
 	rb_define_method(rb_cRuggedPatch, "delta", rb_git_diff_patch_delta, 0);

test/diff_test.rb

@@ -73,12 +73,12 @@ def test_with_oid_string
     patches = diff.patches
     hunks = patches.map(&:hunks).flatten
     lines = hunks.map(&:lines).flatten
-    bytesize = patches.inject(0) {|n, p| n += p.bytesize(include_context: true)}
+    bytesize = patches.inject(0) {|n, p| n += p.bytesize(include_context: false)}
 
     assert_equal 5, diff.size
     assert_equal 5, deltas.size
     assert_equal 5, patches.size
-    assert_equal 975, bytesize
+    assert_equal 1589, bytesize
 
     assert_equal 2, deltas.select(&:added?).size
     assert_equal 1, deltas.select(&:deleted?).size
@@ -373,15 +373,15 @@ def test_stats
 
     # expected per-file values from the diff --stat output plus total lines
     expected_patch_stat = [
-      [ 0, 1, 1 ], [ 1, 0, 2 ], [ 1, 0, 2 ], [ 0, 1, 1 ], [ 2, 0, 3 ],
-      [ 0, 1, 1 ], [ 0, 1, 1 ], [ 1, 0, 1 ], [ 2, 0, 2 ], [ 0, 1, 1 ],
-      [ 1, 0, 2 ]
+      [ 0, 1, 1, 1 ], [ 1, 0, 2, 1 ], [ 1, 0, 2, 1 ], [ 0, 1, 1, 1 ], [ 2, 0, 3, 2 ],
+      [ 0, 1, 1, 1 ], [ 0, 1, 1, 1 ], [ 1, 0, 1, 1 ], [ 2, 0, 2, 2 ], [ 0, 1, 1, 1 ],
+      [ 1, 0, 2, 1 ]
     ]
 
     diff.each_patch do |patch|
       next if [:unmodified, :ignored, :untracked].include? patch.delta.status
 
-      expected_adds, expected_dels, expected_lines = expected_patch_stat.shift
+      expected_adds, expected_dels, expected_lines, lines_wo_context = expected_patch_stat.shift
 
       actual_adds, actual_dels = patch.stat
 
@@ -390,6 +390,7 @@ def test_stats
       assert_equal expected_adds + expected_dels, patch.changes
 
       assert_equal expected_lines, patch.lines
+      assert_equal lines_wo_context, patch.lines(exclude_context: true)
     end
   end
 end