Push branches and notes in one operation

Added -[GTRepository pushBranches:toRemote:withOptions:withNotesReferenceName:error:progress:] to push both a set of branches and stored Git notes at the same operation to save on network ops.

Author: slavikus

ObjectiveGit/GTNote.h

@@ -77,6 +77,16 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (instancetype)init NS_UNAVAILABLE;
 
+
+/// Return a default reference name (that is used if you pass nil to any referenceName parameter)
+///
+/// repository    - Repository for which to get the default notes reference name.
+/// error         - Will be filled with a git error code in case of error.
+///                 May be NULL.
+///
+/// Returns default reference name (usually "refs/notes/commits").
++ (NSString*)defaultReferenceNameForRepository:(GTRepository *)repository error:(NSError **)error;
+
 @end
 
 NS_ASSUME_NONNULL_END

ObjectiveGit/GTNote.m

@@ -89,4 +89,25 @@ - (instancetype)init {
 	return nil;
 }
 
++ (NSString*)defaultReferenceNameForRepository:(GTRepository *)repository error:(NSError **)error {
+	NSString* noteRef = nil;
+	
+	git_buf default_ref_name = { 0 };
+	int gitErr = git_note_default_ref(&default_ref_name, repository.git_repository);
+	if (gitErr != GIT_OK) {
+		git_buf_free(&default_ref_name);
+		
+		if (error != NULL) {
+			*error = [NSError git_errorFor:gitErr description:@"Unable to get default git notes reference name"];
+		}
+		
+		return nil;
+	}
+	
+	noteRef = [NSString stringWithUTF8String:default_ref_name.ptr];
+	
+	git_buf_free(&default_ref_name);
+	
+	return noteRef;
+}
 @end

ObjectiveGit/GTRepository+RemoteOperations.h

@@ -97,19 +97,39 @@ typedef NS_ENUM(NSInteger, GTFetchPruneOption) {
 /// will point to an error describing what happened).
 - (BOOL)pushBranches:(NSArray<GTBranch *> *)branches toRemote:(GTRemote *)remote withOptions:(nullable NSDictionary *)options error:(NSError **)error progress:(nullable void (^)(unsigned int current, unsigned int total, size_t bytes, BOOL *stop))progressBlock;
 
-/// Push a given Git notes reference name to a remote.
+/// Push an array of branches to a remote, together with notes (in one push).
+/// Normally, if you use Git notes functionality, to push the notes to remote, you would have to
+/// do two operations: pushBranches followed by pushNotes. This is unrational, so we offer you a handy
+/// shortcut that allows to push the branches together with the notes.
 ///
-/// noteRef       - Name of the notes reference. If NULL, will default to whatever the default is (e.g. "refs/notes/commits")
+/// branches      - An array of branches to push. Must not be nil.
 /// remote        - The remote to push to. Must not be nil.
 /// options       - Options applied to the push operation. Can be NULL.
 ///                 Recognized options are:
 ///                 `GTRepositoryRemoteOptionsCredentialProvider`
+/// referenceName - Reference name for notes, if they should be pushed together with the branches.
+///                 Use +[GTNote defaultReferenceNameWithError:] to push the default note reference.
+///                 Passing NULL here will make notes NOT to be pushed.
 /// error         - The error if one occurred. Can be NULL.
 /// progressBlock - An optional callback for monitoring progress. May be NULL.
 ///
 /// Returns YES if the push was successful, NO otherwise (and `error`, if provided,
 /// will point to an error describing what happened).
-- (BOOL)pushNotes:(nullable NSString *)noteRef toRemote:(GTRemote *)remote withOptions:(nullable NSDictionary *)options error:(NSError **)error progress:(nullable void (^)(unsigned int current, unsigned int total, size_t bytes, BOOL *stop))progressBlock;
+- (BOOL)pushBranches:(NSArray<GTBranch *> *)branches toRemote:(GTRemote *)remote withOptions:(nullable NSDictionary *)options withNotesReferenceName:(nullable NSString*)notesReferenceName error:(NSError **)error progress:(nullable void (^)(unsigned int current, unsigned int total, size_t bytes, BOOL *stop))progressBlock;
+
+/// Push a given Git notes reference name to a remote.
+///
+/// noteReferenceName - Name of the notes reference. If NULL, will default to whatever the default is (e.g. "refs/notes/commits")
+/// remote            - The remote to push to. Must not be nil.
+/// options           - Options applied to the push operation. Can be NULL.
+///                     Recognized options are:
+///                     `GTRepositoryRemoteOptionsCredentialProvider`
+/// error             - The error if one occurred. Can be NULL.
+/// progressBlock     - An optional callback for monitoring progress. May be NULL.
+///
+/// Returns YES if the push was successful, NO otherwise (and `error`, if provided,
+/// will point to an error describing what happened).
+- (BOOL)pushNotes:(nullable NSString *)noteReferenceName toRemote:(GTRemote *)remote withOptions:(nullable NSDictionary *)options error:(NSError **)error progress:(nullable void (^)(unsigned int current, unsigned int total, size_t bytes, BOOL *stop))progressBlock;
 
 /// Delete a remote branch
 ///

ObjectiveGit/GTRepository+RemoteOperations.m

@@ -18,6 +18,7 @@
 #import "NSArray+StringArray.h"
 #import "NSError+Git.h"
 #import "GTRepository+References.h"
+#import "GTNote.h"
 
 #import "git2/errors.h"
 #import "git2/remote.h"
@@ -174,51 +175,48 @@ - (BOOL)pushBranch:(GTBranch *)branch toRemote:(GTRemote *)remote withOptions:(N
 }
 
 - (BOOL)pushBranches:(NSArray *)branches toRemote:(GTRemote *)remote withOptions:(NSDictionary *)options error:(NSError **)error progress:(GTRemotePushTransferProgressBlock)progressBlock {
+	return [self pushBranches:branches toRemote:remote withOptions:options withNotesReferenceName:nil error:error progress:progressBlock];
+}
+
+- (BOOL)pushBranches:(NSArray *)branches toRemote:(GTRemote *)remote withOptions:(NSDictionary *)options withNotesReferenceName:(NSString*)referenceName error:(NSError **)error progress:(GTRemotePushTransferProgressBlock)progressBlock {
 	NSParameterAssert(branches != nil);
 	NSParameterAssert(branches.count != 0);
 	NSParameterAssert(remote != nil);
-
+	
 	NSMutableArray *refspecs = nil;
 	// Build refspecs for the passed in branches
 	refspecs = [NSMutableArray arrayWithCapacity:branches.count];
 	for (GTBranch *branch in branches) {
 		// Default remote reference for when branch doesn't exist on remote - create with same short name
 		NSString *remoteBranchReference = [NSString stringWithFormat:@"refs/heads/%@", branch.shortName];
-
+		
 		BOOL success = NO;
 		GTBranch *trackingBranch = [branch trackingBranchWithError:error success:&success];
-
+		
 		if (success && trackingBranch != nil) {
 			// Use remote branch short name from trackingBranch, which could be different
 			// (e.g. refs/heads/master:refs/heads/my_master)
 			remoteBranchReference = [NSString stringWithFormat:@"refs/heads/%@", trackingBranch.shortName];
 		}
-
+		
 		[refspecs addObject:[NSString stringWithFormat:@"refs/heads/%@:%@", branch.shortName, remoteBranchReference]];
 	}
-
+	
+	// Also push the notes reference, if needed.
+	if (referenceName != nil) {
+		[refspecs addObject:[NSString stringWithFormat:@"%@:%@", referenceName, referenceName]];
+	}
+	
 	return [self pushRefspecs:refspecs toRemote:remote withOptions:options error:error progress:progressBlock];
 }
 
 - (BOOL)pushNotes:(NSString *)noteRef toRemote:(GTRemote *)remote withOptions:(NSDictionary *)options error:(NSError **)error progress:(GTRemotePushTransferProgressBlock)progressBlock {
 	NSParameterAssert(remote != nil);
 
 	if (noteRef == nil) {
-		git_buf default_ref_name = { 0 };
-		int gitErr = git_note_default_ref(&default_ref_name, self.git_repository);
-		if (gitErr != GIT_OK) {
-			git_buf_free(&default_ref_name);
-			
-			if (error != NULL) {
-				*error = [NSError git_errorFor:gitErr description:@"Unable to get default git notes reference name"];
-			}
-			
-			return NO;
-		}
-		
-		noteRef = [NSString stringWithUTF8String:default_ref_name.ptr];
+		noteRef = [GTNote defaultReferenceNameForRepository:self error:error];
 
-		git_buf_free(&default_ref_name);
+		if (noteRef == nil) return NO;
 	}
 
 	return [self pushRefspecs:@[[NSString stringWithFormat:@"%@:%@", noteRef, noteRef]] toRemote:remote withOptions:options error:error progress:progressBlock];