Merge branch 'master' into purgatory

Conflicts:
	Classes/GTRepository.m
	Classes/GTSubmodule.m

Author: jspahrsummers

.gitignore

@@ -21,6 +21,7 @@ External/libgit2-ios
 
 project.xcworkspace
 */xcuserdata/
+*.xccheckout
 
 ObjectiveGitTests/fixtures/Fixtures/*
 

Classes/GTDiff.h

@@ -185,10 +185,11 @@ typedef enum {
 //
 // The 2 trees must be from the same repository, or an exception will be thrown.
 //
-// oldTree    - The "left" side of the diff. May be nil to represent an empty tree.
+// oldTree    - The "left" side of the diff. May be nil to represent an empty
+//              tree.
 // newTree    - The "right" side of the diff. May be nil to represent an empty
 //              tree.
-// repository - The repository to be used for the diff.
+// repository - The repository to be used for the diff. Cannot be nil.
 // options    - A dictionary containing any of the above options key constants, or
 //              nil to use the defaults.
 // error      - Populated with an `NSError` object on error, if information is
@@ -257,7 +258,12 @@ typedef enum {
 + (GTDiff *)diffWorkingDirectoryToHEADInRepository:(GTRepository *)repository options:(NSDictionary *)options error:(NSError **)error;
 
 // Designated initialiser.
-- (instancetype)initWithGitDiff:(git_diff *)diff;
+//
+// diff       - The diff to represent. Cannot be NULL.
+// repository - The repository in which the diff lives. Cannot be nil.
+//
+// Returns the initialized object.
+- (instancetype)initWithGitDiff:(git_diff *)diff repository:(GTRepository *)repository;
 
 // The libgit2 diff object.
 - (git_diff *)git_diff __attribute__((objc_returns_inner_pointer));

Classes/GTDiff.m

@@ -36,9 +36,7 @@ @interface GTDiff ()
 
 @property (nonatomic, assign, readonly) git_diff *git_diff;
 
-// A cache of the deltas for the diff. Will be populated only after the first
-// call of -enumerateDeltasUsingBlock:.
-@property (atomic, copy) NSArray *cachedDeltas;
+@property (nonatomic, strong, readonly) GTRepository *repository;
 
 @end
 
@@ -82,20 +80,17 @@ + (int)handleParsedOptionsDictionary:(NSDictionary *)dictionary usingBlock:(int
 
 + (GTDiff *)diffOldTree:(GTTree *)oldTree withNewTree:(GTTree *)newTree inRepository:(GTRepository *)repository options:(NSDictionary *)options error:(NSError **)error {
 	NSParameterAssert(repository != nil);
-	NSParameterAssert(newTree == nil || [newTree.repository isEqual:repository]);
-	NSParameterAssert(oldTree == nil || [oldTree.repository isEqual:repository]);
 
 	__block git_diff *diff;
-	int returnValue = [self handleParsedOptionsDictionary:options usingBlock:^(git_diff_options *optionsStruct) {
+	int status = [self handleParsedOptionsDictionary:options usingBlock:^(git_diff_options *optionsStruct) {
 		return git_diff_tree_to_tree(&diff, repository.git_repository, oldTree.git_tree, newTree.git_tree, optionsStruct);
 	}];
-	if (returnValue != GIT_OK) {
-		if (error != NULL) *error = [NSError git_errorFor:returnValue description:@"Failed to create diff between %@ and %@", oldTree.SHA, newTree.SHA];
+	if (status != GIT_OK) {
+		if (error != NULL) *error = [NSError git_errorFor:status description:@"Failed to create diff between %@ and %@", oldTree.SHA, newTree.SHA];
 		return nil;
 	}
 
-	GTDiff *newDiff = [[GTDiff alloc] initWithGitDiff:diff];
-	return newDiff;
+	return [[GTDiff alloc] initWithGitDiff:diff repository:repository];
 }
 
 + (GTDiff *)diffIndexFromTree:(GTTree *)tree inRepository:(GTRepository *)repository options:(NSDictionary *)options error:(NSError **)error {
@@ -111,8 +106,7 @@ + (GTDiff *)diffIndexFromTree:(GTTree *)tree inRepository:(GTRepository *)reposi
 		return nil;
 	}
 
-	GTDiff *newDiff = [[GTDiff alloc] initWithGitDiff:diff];
-	return newDiff;
+	return [[GTDiff alloc] initWithGitDiff:diff repository:repository];
 }
 
 + (GTDiff *)diffIndexToWorkingDirectoryInRepository:(GTRepository *)repository options:(NSDictionary *)options error:(NSError **)error {
@@ -127,8 +121,7 @@ + (GTDiff *)diffIndexToWorkingDirectoryInRepository:(GTRepository *)repository o
 		return nil;
 	}
 
-	GTDiff *newDiff = [[GTDiff alloc] initWithGitDiff:diff];
-	return newDiff;
+	return [[GTDiff alloc] initWithGitDiff:diff repository:repository];
 }
 
 + (GTDiff *)diffWorkingDirectoryFromTree:(GTTree *)tree inRepository:(GTRepository *)repository options:(NSDictionary *)options error:(NSError **)error {
@@ -144,8 +137,7 @@ + (GTDiff *)diffWorkingDirectoryFromTree:(GTTree *)tree inRepository:(GTReposito
 		return nil;
 	}
 
-	GTDiff *newDiff = [[GTDiff alloc] initWithGitDiff:diff];
-	return newDiff;
+	return [[GTDiff alloc] initWithGitDiff:diff repository:repository];
 }
 
 + (GTDiff *)diffWorkingDirectoryToHEADInRepository:(GTRepository *)repository options:(NSDictionary *)options error:(NSError **)error {
@@ -163,13 +155,15 @@ + (GTDiff *)diffWorkingDirectoryToHEADInRepository:(GTRepository *)repository op
 	return HEADIndexDiff;
 }
 
-- (instancetype)initWithGitDiff:(git_diff *)diff {
+- (instancetype)initWithGitDiff:(git_diff *)diff repository:(GTRepository *)repository {
 	NSParameterAssert(diff != NULL);
+	NSParameterAssert(repository != nil);
 
 	self = [super init];
 	if (self == nil) return nil;
 
 	_git_diff = diff;
+	_repository = repository;
 
 	return self;
 }
@@ -188,25 +182,14 @@ - (NSString *)debugDescription {
 - (void)enumerateDeltasUsingBlock:(void (^)(GTDiffDelta *delta, BOOL *stop))block {
 	NSParameterAssert(block != nil);
 
-	if (self.cachedDeltas == nil) {
-		NSMutableArray *deltas = [NSMutableArray arrayWithCapacity:self.deltaCount];
-		for (NSUInteger idx = 0; idx < self.deltaCount; idx ++) {
-			git_patch *patch;
-			int result = git_patch_from_diff(&patch, self.git_diff, idx);
-			if (result != GIT_OK) continue;
-
-			GTDiffDelta *delta = [[GTDiffDelta alloc] initWithGitPatch:patch];
-			if (delta == nil) continue;
+	for (NSUInteger idx = 0; idx < self.deltaCount; idx ++) {
+		GTDiffDelta *delta = [[GTDiffDelta alloc] initWithDiff:self deltaIndex:idx];
+		if (delta == nil) continue;
 
-			[deltas addObject:delta];
-		}
-
-		self.cachedDeltas = deltas;
+		BOOL stop = NO;
+		block(delta, &stop);
+		if (stop) break;
 	}
-
-	[self.cachedDeltas enumerateObjectsUsingBlock:^(GTDiffDelta *delta, NSUInteger idx, BOOL *stop) {
-		block(delta, stop);
-	}];
 }
 
 - (NSUInteger)deltaCount {
@@ -253,8 +236,7 @@ - (BOOL)mergeDiffWithDiff:(GTDiff *)diff error:(NSError **)error {
 		if (error) *error = [NSError git_errorFor:gitError description:@"Merging diffs failed"];
 		return NO;
 	}
-	// Clear our cache of deltas
-	self.cachedDeltas = nil;
+
 	return YES;
 }
 

Classes/GTDiffDelta.h

@@ -7,9 +7,11 @@
 //
 
 #import "git2.h"
+#import "GTDiffFile.h"
 
-@class GTDiffFile;
+@class GTDiff;
 @class GTDiffHunk;
+@class GTDiffPatch;
 
 // The type of change that this delta represents.
 //
@@ -43,11 +45,18 @@ typedef enum {
 // for the types of change represented.
 @interface GTDiffDelta : NSObject
 
-// The underlying libgit2 `git_patch` object.
-@property (nonatomic, assign, readonly) git_patch *git_patch;
+// The `git_diff_delta` represented by the receiver.
+@property (nonatomic, assign, readonly) git_diff_delta git_diff_delta;
 
-// Whether the file(s) are to be treated as binary.
-@property (nonatomic, readonly, getter = isBinary) BOOL binary;
+// The diff in which this delta is contained.
+@property (nonatomic, strong, readonly) GTDiff *diff;
+
+// Any flags set on the delta. See `GTDiffFileFlag` for more info.
+//
+// Note that this may not include `GTDiffFileFlagBinary` _or_
+// `GTDiffFileFlagNotBinary` until the content is loaded for this delta (e.g.,
+// through a call to -generatePatch:).
+@property (nonatomic, assign, readonly) GTDiffFileFlag flags;
 
 // The file to the "left" of the diff.
 @property (nonatomic, readonly, copy) GTDiffFile *oldFile;
@@ -60,46 +69,16 @@ typedef enum {
 // Think "status" as in `git status`.
 @property (nonatomic, readonly) GTDiffDeltaType type;
 
-// The number of hunks represented by this delta.
-@property (nonatomic, readonly) NSUInteger hunkCount;
-
-// The number of added lines in this delta.
-//
-// Undefined if this delta is binary.
-@property (nonatomic, readonly) NSUInteger addedLinesCount;
-
-// The number of deleted lines in this delta.
-//
-// Undefined if this delta is binary.
-@property (nonatomic, readonly) NSUInteger deletedLinesCount;
-
-// The number of context lines in this delta.
-//
-// Undefined if this delta is binary.
-@property (nonatomic, readonly) NSUInteger contextLinesCount;
-
-// Designated initialiser.
-- (instancetype)initWithGitPatch:(git_patch *)patch;
+// Initializes the receiver to wrap the delta at the given index.
+- (instancetype)initWithDiff:(GTDiff *)diff deltaIndex:(NSUInteger)deltaIndex;
 
-// A convenience accessor to fetch the `git_diff_delta` represented by the
-// object.
-- (const git_diff_delta *)git_diff_delta __attribute__((objc_returns_inner_pointer));
-
-// Get the delta size.
-//
-// includeContext     - Include the context lines in the size. Defaults to NO.
-// includeHunkHeaders - Include the hunk header lines in the size. Defaults to NO.
-// includeFileHeaders - Include the file header lines in the size. Defaults to NO.
+// Creates a patch from a text delta.
 //
-// Returns the raw size in bytes of the delta.
-- (NSUInteger)sizeWithContext:(BOOL)includeContext hunkHeaders:(BOOL)includeHunkHeaders fileHeaders:(BOOL)includeFileHeaders;
-
-// Enumerate the hunks contained in the delta.
+// If the receiver represents a binary delta, this method will return an error.
 //
-// Blocks during enumeration.
+// error - If not NULL, set to any error that occurs.
 //
-// block - A block to be executed for each hunk. Setting `stop` to `YES`
-//         immediately stops the enumeration.
-- (void)enumerateHunksUsingBlock:(void (^)(GTDiffHunk *hunk, BOOL *stop))block;
+// Returns a new patch, or nil if an error occurs.
+- (GTDiffPatch *)generatePatch:(NSError **)error;
 
 @end

Classes/GTDiffDelta.m

@@ -8,87 +8,71 @@
 
 #import "GTDiffDelta.h"
 
-#import "GTDiffFile.h"
-#import "GTDiffHunk.h"
 #import "GTDiff.h"
+#import "GTDiffFile.h"
+#import "GTDiffPatch.h"
+#import "NSError+Git.h"
 
-@implementation GTDiffDelta
-
-- (instancetype)initWithGitPatch:(git_patch *)patch {
-	NSParameterAssert(patch != NULL);
-	
-	self = [super init];
-	if (self == nil) return nil;
-
-	_git_patch = patch;
-
-	size_t adds = 0;
-	size_t deletes = 0;
-	size_t contexts = 0;
-	git_patch_line_stats(&contexts, &adds, &deletes, _git_patch);
-
-	_addedLinesCount = adds;
-	_deletedLinesCount = deletes;
-	_contextLinesCount = contexts;
+@interface GTDiffDelta ()
 
-	return self;
-}
+// The index of this delta within its parent `diff`.
+@property (nonatomic, assign, readonly) NSUInteger deltaIndex;
 
-- (NSString *)debugDescription {
-	return [NSString stringWithFormat:@"%@ flags: %u, oldFile: %@, newFile: %@", super.debugDescription, self.git_diff_delta->flags, self.oldFile, self.newFile];
-}
+@end
 
-- (void)dealloc {
-	if (_git_patch) {
-		git_patch_free(_git_patch);
-		_git_patch = NULL;
-	}
-}
+@implementation GTDiffDelta
 
-#pragma mark - Properties
+#pragma mark Properties
 
-- (const git_diff_delta *)git_diff_delta {
-	return git_patch_get_delta(self.git_patch);
+- (git_diff_delta)git_diff_delta {
+	return *(git_diff_get_delta(self.diff.git_diff, self.deltaIndex));
 }
 
-- (BOOL)isBinary {
-	return (self.git_diff_delta->flags & GIT_DIFF_FLAG_BINARY) != 0;
+- (GTDiffFileFlag)flags {
+	return (GTDiffFileFlag)self.git_diff_delta.flags;
 }
 
 - (GTDiffFile *)oldFile {
-	return [[GTDiffFile alloc] initWithGitDiffFile:self.git_diff_delta->old_file];
+	return [[GTDiffFile alloc] initWithGitDiffFile:self.git_diff_delta.old_file];
 }
 
 - (GTDiffFile *)newFile {
-	return [[GTDiffFile alloc] initWithGitDiffFile:self.git_diff_delta->new_file];
+	return [[GTDiffFile alloc] initWithGitDiffFile:self.git_diff_delta.new_file];
 }
 
 - (GTDiffDeltaType)type {
-	return (GTDiffDeltaType)self.git_diff_delta->status;
+	return (GTDiffDeltaType)self.git_diff_delta.status;
 }
 
-- (NSUInteger)hunkCount {
-	return git_patch_num_hunks(self.git_patch);
-}
+#pragma mark Lifecycle
 
-- (NSUInteger)sizeWithContext:(BOOL)includeContext hunkHeaders:(BOOL)includeHunkHeaders fileHeaders:(BOOL)includeFileHeaders {
-	int shouldIncludeContext = (includeContext == YES ? 1 : 0);
-	int shouldIncludeHunkHeaders = (includeHunkHeaders == YES ? 1 : 0);
-	int shouldIncludeFileHeaders = (includeFileHeaders == YES ? 1 : 0);
-	return git_patch_size(self.git_patch, shouldIncludeContext, shouldIncludeHunkHeaders, shouldIncludeFileHeaders);
-}
+- (instancetype)initWithDiff:(GTDiff *)diff deltaIndex:(NSUInteger)deltaIndex {
+	self = [super init];
+	if (self == nil) return nil;
 
-- (void)enumerateHunksUsingBlock:(void (^)(GTDiffHunk *hunk, BOOL *stop))block {
-	NSParameterAssert(block != nil);
+	_diff = diff;
+	_deltaIndex = deltaIndex;
 
-	for (NSUInteger idx = 0; idx < self.hunkCount; idx ++) {
-		GTDiffHunk *hunk = [[GTDiffHunk alloc] initWithDelta:self hunkIndex:idx];
-		if (hunk == nil) return;
+	return self;
+}
+
+#pragma mark Patch Generation
 
-		BOOL shouldStop = NO;
-		block(hunk, &shouldStop);
-		if (shouldStop) return;
+- (GTDiffPatch *)generatePatch:(NSError **)error {
+	git_patch *patch = NULL;
+	int gitError = git_patch_from_diff(&patch, self.diff.git_diff, self.deltaIndex);
+	if (gitError != GIT_OK) {
+		if (error != NULL) *error = [NSError git_errorFor:gitError description:@"Patch generation failed for delta %@", self];
+		return nil;
 	}
+
+	return [[GTDiffPatch alloc] initWithGitPatch:patch delta:self];
+}
+
+#pragma mark NSObject
+
+- (NSString *)description {
+	return [NSString stringWithFormat:@"<%@: %p>{ flags: %u, oldFile: %@, newFile: %@ }", self.class, self, (unsigned)self.git_diff_delta.flags, self.oldFile, self.newFile];
 }
 
 @end

Classes/GTDiffFile.h

@@ -10,11 +10,16 @@
 
 // Flags which may be set on the file.
 //
-// See diff.h for individual documentation.
+// GTDiffFileFlagBinaryMask - A mask to just retrieve the binary/not binary
+//                            information from a set of flags.
+//
+// See diff.h for further documentation.
 typedef enum {
 	GTDiffFileFlagValidID = GIT_DIFF_FLAG_VALID_ID,
 	GTDiffFileFlagBinary = GIT_DIFF_FLAG_BINARY,
 	GTDiffFileFlagNotBinary = GIT_DIFF_FLAG_NOT_BINARY,
+
+	GTDiffFileFlagBinaryMask = GTDiffFileFlagBinary | GTDiffFileFlagNotBinary,
 } GTDiffFileFlag;
 
 @class GTOID;