Merge pull request #420 from libgit2/better-branches

Better -branches:.

Author: jspahrsummers

ObjectiveGit/GTRepository.h

@@ -242,13 +242,18 @@ extern NSString * const GTRepositoryInitOptionsOriginURLString;
 
 - (GTReference *)headReferenceWithError:(NSError **)error;
 
-/// Convenience methods to return branches in the repository
-- (NSArray *)allBranchesWithError:(NSError **)error;
-
 - (NSArray *)localBranchesWithError:(NSError **)error;
 - (NSArray *)remoteBranchesWithError:(NSError **)error;
 - (NSArray *)branchesWithPrefix:(NSString *)prefix error:(NSError **)error;
 
+/// Get the local and remote branches and merge them together by combining local
+/// branches with their remote branch, if they have one.
+///
+/// error - The error if one occurs.
+///
+/// Returns the branches or nil if an error occurs.
+- (NSArray *)branches:(NSError **)error;
+
 /// List all remotes in the repository
 ///
 /// error - will be filled if an error occurs

ObjectiveGit/GTRepository.m

@@ -401,28 +401,23 @@ - (NSArray *)branchesWithPrefix:(NSString *)prefix error:(NSError **)error {
 	return branches;
 }
 
-- (NSArray *)allBranchesWithError:(NSError **)error {
-	NSMutableArray *allBranches = [NSMutableArray array];
+- (NSArray *)branches:(NSError **)error {
 	NSArray *localBranches = [self localBranchesWithError:error];
-	NSArray *remoteBranches = [self remoteBranchesWithError:error];
-	if (localBranches == nil || remoteBranches == nil) return nil;
+	if (localBranches == nil) return nil;
 
-	[allBranches addObjectsFromArray:localBranches];
+	NSMutableArray *remoteBranches = [[self remoteBranchesWithError:error] mutableCopy];
+	if (remoteBranches == nil) return nil;
 
-	// we want to add the remote branches that we don't already have as a local branch
-	NSMutableDictionary *shortNamesToBranches = [NSMutableDictionary dictionary];
+	NSMutableArray *branches = [NSMutableArray array];
 	for (GTBranch *branch in localBranches) {
-		[shortNamesToBranches setObject:branch forKey:branch.shortName];
+		GTBranch *trackingBranch = [branch trackingBranchWithError:NULL success:NULL];
+		if (trackingBranch != nil) [remoteBranches removeObject:trackingBranch];
+		[branches addObject:branch];
 	}
 
-	for (GTBranch *branch in remoteBranches) {
-		GTBranch *localBranch = [shortNamesToBranches objectForKey:branch.shortName];
-		if (localBranch == nil) {
-			[allBranches addObject:branch];
-		}
-	}
+	[branches addObjectsFromArray:remoteBranches];
 
-    return allBranches;
+	return branches;
 }
 
 - (NSArray *)remoteNamesWithError:(NSError **)error {

ObjectiveGitTests/GTIndexSpec.m

@@ -52,7 +52,7 @@
 
 it(@"should write to a specific repository and return a tree", ^{
 	GTRepository *repository = self.bareFixtureRepository;
-	NSArray *branches = [repository allBranchesWithError:NULL];
+	NSArray *branches = [repository branches:NULL];
 	GTCommit *masterCommit = [branches[0] targetCommitAndReturnError:NULL];
 	GTCommit *packedCommit = [branches[1] targetCommitAndReturnError:NULL];
 

ObjectiveGitTests/GTRepositorySpec.m

@@ -490,6 +490,58 @@
 	});
 });
 
+describe(@"-branches:", ^{
+	__block NSArray *branches;
+
+	beforeEach(^{
+		GTRepository *repository = [self testAppForkFixtureRepository];
+		branches = [repository branches:NULL];
+		expect(branches).notTo(beNil());
+	});
+
+	it(@"should combine a local branch with its remote branch", ^{
+		NSMutableArray *localBranches = [NSMutableArray array];
+		NSMutableArray *remoteBranches = [NSMutableArray array];
+		for (GTBranch *branch in branches) {
+			if ([branch.shortName isEqual:@"BranchA"]) {
+				if (branch.branchType == GTBranchTypeLocal) {
+					[localBranches addObject:branch];
+				} else {
+					[remoteBranches addObject:branch];
+				}
+			}
+		}
+
+		expect(@(localBranches.count)).to(equal(@1));
+
+		GTBranch *localBranchA = localBranches[0];
+		GTBranch *trackingBranch = [localBranchA trackingBranchWithError:NULL success:NULL];
+		expect(trackingBranch.remoteName).to(equal(@"origin"));
+
+		expect(@(remoteBranches.count)).to(equal(@1));
+
+		GTBranch *remoteBranchA = remoteBranches[0];
+		expect(remoteBranchA.remoteName).to(equal(@"github"));
+	});
+
+	it(@"should contain local branches", ^{
+		NSInteger index = [branches indexOfObjectPassingTest:^(GTBranch *branch, NSUInteger idx, BOOL *stop) {
+			return [branch.shortName isEqual:@"new-shite"];
+		}];
+		expect(@(index)).notTo(equal(@(NSNotFound)));
+	});
+
+	it(@"should contain remote branches which exist on multiple remotes", ^{
+		NSUInteger matches = 0;
+		for (GTBranch *branch in branches) {
+			if ([branch.shortName isEqual:@"blah"] && branch.branchType == GTBranchTypeRemote) {
+				matches++;
+			}
+		}
+		expect(@(matches)).to(equal(@2));
+	});
+});
+
 afterEach(^{
 	[self tearDown];
 });

ObjectiveGitTests/QuickSpec+GTFixtures.h

@@ -22,6 +22,9 @@
 // A fully fledged repository, great for testing nearly everything.
 - (GTRepository *)testAppFixtureRepository;
 
+/// A fork of Test_App.
+- (GTRepository *)testAppForkFixtureRepository;
+
 // A bare repository with a minimal history.
 - (GTRepository *)bareFixtureRepository;
 

ObjectiveGitTests/QuickSpec+GTFixtures.m

@@ -123,6 +123,10 @@ - (GTRepository *)testAppFixtureRepository {
 	return [self fixtureRepositoryNamed:@"Test_App"];
 }
 
+- (GTRepository *)testAppForkFixtureRepository {
+	return [self fixtureRepositoryNamed:@"Test_App_fork"];
+}
+
 - (GTRepository *)testUnicodeFixtureRepository {
 	return [self fixtureRepositoryNamed:@"unicode-files-repo"];
 }