Fixes per @tiennou feedback

Some stylistic and other fixes based on @tiennou feedback on the pull request.

Author: slavikus

ObjectiveGit/GTNote.h

@@ -51,11 +51,31 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, readonly, strong) GTObject *target;
 
 /// The underlying `git_note` object.
-- (git_note * _Nullable)git_note __attribute__((objc_returns_inner_pointer));
+- (git_note *)git_note __attribute__((objc_returns_inner_pointer));
 
-/// These initializers may fail if there's no note attached to the provided oid.
-- (nullable instancetype)initWithTargetOID:(GTOID*)oid repository:(GTRepository*)repository ref:(nullable NSString*)ref;
-- (nullable instancetype)initWithTargetGitOID:(git_oid*)oid repository:(git_repository *)repository ref:(const char* _Nullable)ref;
+/// Create a note with target OID in the given repository.
+///
+/// oid           - OID of the target to attach to
+/// repository    - Repository containing the target OID refers to
+/// referenceName - Name for the notes reference in the repo, or nil for default ("refs/notes/commits")
+/// error         - Will be filled with a NSError object in case of error.
+///                 May be NULL.
+///
+/// Returns initialized GTNote instance or nil on failure (error will be populated, if passed).
+- (nullable instancetype)initWithTargetOID:(GTOID *)oid repository:(GTRepository *)repository referenceName:(nullable NSString *)referenceName error:(NSError **)error;
+
+/// Create a note with target libgit2 oid in the given repository.
+///
+/// oid           - git_oid of the target to attach to
+/// repository    - Repository containing the target OID refers to
+/// referenceName - Name for the notes reference in the repo, or NULL for default ("refs/notes/commits")
+/// error         - Will be filled with a git error code in case of error.
+///                 May be NULL.
+///
+/// Returns initialized GTNote instance or nil on failure (error will be populated, if passed).
+- (nullable instancetype)initWithTargetGitOID:(git_oid *)oid repository:(git_repository *)repository referenceName:(const char * _Nullable)referenceName error:(int * _Nullable)error;
+
+- (instancetype)init NS_UNAVAILABLE;
 
 @end
 

ObjectiveGit/GTNote.m

@@ -57,19 +57,36 @@ - (GTOID*)targetOID {
 	return [GTOID oidWithGitOid:git_note_id(self.git_note)];
 }
 
-- (instancetype)initWithTargetOID:(GTOID*)oid repository:(GTRepository*)repository ref:(NSString*)ref {
-	return [self initWithTargetGitOID:(git_oid *)oid.git_oid repository:repository.git_repository ref:ref.UTF8String];
+- (instancetype)initWithTargetOID:(GTOID *)oid repository:(GTRepository *)repository referenceName:(NSString *)referenceName error:(NSError **)error {
+	int err = GIT_OK;
+	
+	id object = [self initWithTargetGitOID:(git_oid *)oid.git_oid repository:repository.git_repository referenceName:referenceName.UTF8String error:&err];
+	
+	if (err != GIT_OK && error != NULL) {
+		*error = [NSError git_errorFor:err description:@"Failed to create a note."];
+	}
+	
+	return object;
 }
 
-- (instancetype)initWithTargetGitOID:(git_oid*)oid repository:(git_repository *)repository ref:(const char*)ref {
-	if (self = [super init]) {
-		int gitErr = git_note_read(&_note, repository, ref, oid);
+- (instancetype)initWithTargetGitOID:(git_oid *)oid repository:(git_repository *)repository referenceName:(const char *)referenceName error:(int *)error {
+	self = [super init];
+	if (self == nil) return nil;
+	
+	int gitErr = git_note_read(&_note, repository, referenceName, oid);
+	
+	if (gitErr != GIT_OK) {
+		if (error != NULL) *error = gitErr;
 
-		if (gitErr != GIT_OK)
-			return nil;		// Cannot read the note, means it either doesn't exists for this object, this object is not found, or whatever else.
+		return nil;
 	}
 
 	return self;
 }
 
+- (instancetype)init {
+	NSAssert(NO, @"Call to an unavailable initializer.");
+	return nil;
+}
+
 @end

ObjectiveGit/GTRepository+RemoteOperations.m

@@ -217,6 +217,8 @@ - (BOOL)pushNotes:(NSString *)noteRef toRemote:(GTRemote *)remote withOptions:(N
 		}
 
 		noteRef = [NSString stringWithUTF8String:default_ref_name.ptr];
+		
+		git_buf_free(&default_ref_name);
 	}
 
 	return [self pushRefspecs:@[[NSString stringWithFormat:@"%@:%@", noteRef, noteRef]] toRemote:remote withOptions:options error:error progress:progressBlock];

ObjectiveGit/GTRepository.h

@@ -607,45 +607,45 @@ typedef NS_ENUM(NSInteger, GTRepositoryStateType) {
 
 /// Creates a new note in this repo (using a default notes reference, e.g. "refs/notes/commits")
 ///
-/// note      - Note text.
-/// theTarget - Object (usually a commit) to which this note attaches to.
-///             This object must belong to this repository.
-/// ref       - Name for the notes reference in the repo, or nil for default ("refs/notes/commits")
-/// author    - Signature of the author for this note, and
-///             of the note creation time
-/// committer - Signature of the committer for this note.
-/// overwrite - If set to YES, the note will be overwritten if it already exists.
-/// error     - Will be filled with a NSError object in case of error.
-///             May be NULL.
+/// note          - Note text.
+/// theTarget     - Object (usually a commit) to which this note refers to.
+///                 This object must belong to this repository.
+/// referenceName - Name for the notes reference in the repo, or nil for default ("refs/notes/commits")
+/// author        - Signature of the author for this note, and
+///                 of the note creation time
+/// committer     - Signature of the committer for this note.
+/// overwrite     - If set to YES, the note will be overwritten if it already exists.
+/// error         - Will be filled with a NSError object in case of error.
+///                 May be NULL.
 ///
 /// Returns the newly created note or nil on error.
-- (nullable GTNote *)createNote:(NSString *)note target:(GTObject *)theTarget ref:(nullable NSString *)ref author:(GTSignature *)author committer:(GTSignature *)committer overwriteIfExists:(BOOL)overwrite error:(NSError **)error;
+- (nullable GTNote *)createNote:(NSString *)note target:(GTObject *)theTarget referenceName:(nullable NSString *)referenceName author:(GTSignature *)author committer:(GTSignature *)committer overwriteIfExists:(BOOL)overwrite error:(NSError **)error;
 
 /// Removes a note attached to object in this repo (using a default notes reference, e.g. "refs/notes/commits")
 ///
-/// parentObject - Object (usually a commit) to which the note to be removed is attached to.
-///                This object must belong to this repository.
-/// ref          - Name for the notes reference in the repo, or nil for default ("refs/notes/commits")
-/// author       - Signature of the author for this note removal, and
-///                of the note removal time
-/// committer    - Signature of the committer for this note removal.
-/// error        - Will be filled with a NSError object in case of error.
-///                May be NULL.
+/// parentObject  - Object (usually a commit) to which the note to be removed is attached to.
+///                 This object must belong to this repository.
+/// referenceName - Name for the notes reference in the repo, or nil for default ("refs/notes/commits")
+/// author        - Signature of the author for this note removal, and
+///                 of the note removal time
+/// committer     - Signature of the committer for this note removal.
+/// error         - Will be filled with a NSError object in case of error.
+///                 May be NULL.
 ///
 /// Returns the YES on success and NO on error.
-- (BOOL)removeNoteFromObject:(GTObject *)parentObject ref:(nullable NSString *)ref author:(GTSignature *)author committer:(GTSignature *)committer error:(NSError **)error;
+- (BOOL)removeNoteFromObject:(GTObject *)parentObject referenceName:(nullable NSString *)referenceName author:(GTSignature *)author committer:(GTSignature *)committer error:(NSError **)error;
 
 /// Enumerates through all stored notes in this repo (using a default notes reference, e.g. "refs/notes/commits")
 ///
-/// error     - Will be filled with a NSError object in case of error.
-///             May be null.
-/// ref       - Name for the notes reference in the repo, or nil for default ("refs/notes/commits")
-/// block     - A block to be called on each encountered note object. The block accepts
-///             a reference to `note`, an `object` that is annotated with the note.
-///             If the block sets `stop` to YES, the iterator is finished.
+/// referenceName - Name for the notes reference in the repo, or nil for default ("refs/notes/commits")
+/// error         - Will be filled with a NSError object in case of error.
+///                 May be NULL.
+/// block         - A block to be called on each encountered note object. The block accepts
+///                 a reference to `note`, an `object` that is annotated with the note.
+///                 If the block sets `stop` to YES, the iterator is finished.
 ///
 /// Returns YES on overall success or NO on error of any kind.
-- (BOOL)enumerateNotesWithError:(NSError **)error ref:(nullable NSString *)ref usingBlock:(void (^)(GTNote *note, GTObject *object, BOOL *stop))block;
+- (BOOL)enumerateNotesWithReferenceName:(nullable NSString *)referenceName error:(NSError **)error usingBlock:(void (^)(GTNote *note, GTObject *object, BOOL *stop))block;
 
 @end
 

ObjectiveGit/GTRepository.m

@@ -922,21 +922,21 @@ - (BOOL)cleanupStateWithError:(NSError * _Nullable __autoreleasing *)error {
 
 #pragma mark Notes
 
-- (GTNote *)createNote:(NSString *)note target:(GTObject *)theTarget ref:(NSString *)ref author:(GTSignature *)author committer:(GTSignature *)committer overwriteIfExists:(BOOL)overwrite error:(NSError **)error {
+- (GTNote *)createNote:(NSString *)note target:(GTObject *)theTarget referenceName:(NSString *)referenceName author:(GTSignature *)author committer:(GTSignature *)committer overwriteIfExists:(BOOL)overwrite error:(NSError **)error {
 	git_oid oid;
 
-	int gitError = git_note_create(&oid, self.git_repository, ref.UTF8String, author.git_signature, committer.git_signature, theTarget.OID.git_oid, [note UTF8String], overwrite ? 1 : 0);
+	int gitError = git_note_create(&oid, self.git_repository, referenceName.UTF8String, author.git_signature, committer.git_signature, theTarget.OID.git_oid, [note UTF8String], overwrite ? 1 : 0);
 	if (gitError != GIT_OK) {
 		if (error != NULL) *error = [NSError git_errorFor:gitError description:@"Failed to create a note in repository"];
 
 		return nil;
 	}
 
-	return [[GTNote alloc] initWithTargetOID:theTarget.OID repository:self ref:ref];
+	return [[GTNote alloc] initWithTargetOID:theTarget.OID repository:self referenceName:referenceName error:error];
 }
 
-- (BOOL)removeNoteFromObject:(GTObject *)parentObject ref:(NSString *)ref author:(GTSignature *)author committer:(GTSignature *)committer error:(NSError **)error {
-	int gitError = git_note_remove(self.git_repository, ref.UTF8String, author.git_signature, committer.git_signature, parentObject.OID.git_oid);
+- (BOOL)removeNoteFromObject:(GTObject *)parentObject referenceName:(NSString *)referenceName author:(GTSignature *)author committer:(GTSignature *)committer error:(NSError **)error {
+	int gitError = git_note_remove(self.git_repository, referenceName.UTF8String, author.git_signature, committer.git_signature, parentObject.OID.git_oid);
 	if (gitError != GIT_OK) {
 		if(error != NULL) *error = [NSError git_errorFor:gitError description:@"Failed to delete note from %@", parentObject];
 		return NO;
@@ -945,11 +945,11 @@ - (BOOL)removeNoteFromObject:(GTObject *)parentObject ref:(NSString *)ref author
 	return YES;
 }
 
-- (BOOL)enumerateNotesWithError:(NSError **)error ref:(NSString *)ref usingBlock:(void (^)(GTNote *note, GTObject *object, BOOL *stop))block
+- (BOOL)enumerateNotesWithReferenceName:(NSString *)referenceName error:(NSError **)error usingBlock:(void (^)(GTNote *note, GTObject *object, BOOL *stop))block
 {
-	git_note_iterator* iter = NULL;
+	git_note_iterator *iter = NULL;
 
-	int gitError = git_note_iterator_new(&iter, self.git_repository, ref.UTF8String);
+	int gitError = git_note_iterator_new(&iter, self.git_repository, referenceName.UTF8String);
 
 	if (gitError != GIT_OK)
 	{
@@ -960,22 +960,21 @@ - (BOOL)enumerateNotesWithError:(NSError **)error ref:(NSString *)ref usingBlock
 	git_oid note_id;
 	git_oid object_id;
 	BOOL success = YES;
+	int iterError = GIT_OK;
 
-	while (git_note_next(&note_id, &object_id, iter) == GIT_OK) {
+	while ((iterError = git_note_next(&note_id, &object_id, iter)) == GIT_OK) {
 		NSError* lookupErr = nil;
 
-		GTNote* note = 	[[GTNote alloc] initWithTargetGitOID:&object_id repository:self.git_repository ref:ref.UTF8String];
+		GTNote* note = [[GTNote alloc] initWithTargetGitOID:&object_id repository:self.git_repository referenceName:referenceName.UTF8String error:&gitError];
 		if (note == nil) {
-			if (error != NULL)
-				*error = [NSError git_errorFor:GIT_ENOTFOUND description:@"Cannot create note"];
+			if (error != NULL) *error = [NSError git_errorFor:gitError description:@"Cannot find a note"];
 			success = NO;
 			break;
 		}
 
 		GTObject* obj = [self lookUpObjectByGitOid:&object_id error:&lookupErr];
 		if (obj == nil && lookupErr != nil) {
-			if (error != NULL)
-				*error = lookupErr;
+			if (error != NULL) *error = lookupErr;
 			success = NO;
 			break;
 		}
@@ -989,6 +988,11 @@ - (BOOL)enumerateNotesWithError:(NSError **)error ref:(NSString *)ref usingBlock
 
 	git_note_iterator_free(iter);
 
+	if (iterError != GIT_OK && iterError != GIT_ITEROVER) {
+		if (error != NULL)
+			*error = [NSError git_errorFor:iterError description:@"Iterator error"];
+	}
+	
 	return success;
 }
 

ObjectiveGitTests/GTNoteSpec.m

@@ -42,11 +42,11 @@
 
 	NSError* err = nil;
 
-	GTNote *note = [repository createNote:@"Note text" target:initialCommit ref:nil author:sig committer:sig overwriteIfExists:YES error:&err];
+	GTNote *note = [repository createNote:@"Note text" target:initialCommit referenceName:nil author:sig committer:sig overwriteIfExists:YES error:&err];
 	expect(note).notTo(beNil());
 	expect(err).to(beNil());
 
-	[repository enumerateNotesWithError:&err ref:nil usingBlock:^(GTNote *note, GTObject *object, BOOL *stop) {
+	[repository enumerateNotesWithReferenceName:nil error:&err usingBlock:^(GTNote *note, GTObject *object, BOOL *stop) {
 		expect(note).notTo(beNil());
 		expect(object).notTo(beNil());
 
@@ -62,17 +62,17 @@
 
 	NSError* err = nil;
 
-	GTNote *note = [repository createNote:@"Note text" target:initialCommit ref:nil author:sig committer:sig overwriteIfExists:YES error:&err];
+	GTNote *note = [repository createNote:@"Note text" target:initialCommit referenceName:nil author:sig committer:sig overwriteIfExists:YES error:&err];
 	expect(note).notTo(beNil());
 	expect(err).to(beNil());
 
-	BOOL res = [repository removeNoteFromObject:initialCommit ref:nil author:sig committer:sig error:&err];
+	BOOL res = [repository removeNoteFromObject:initialCommit referenceName:nil author:sig committer:sig error:&err];
 	expect(@(res)).to(beTrue());
 	expect(err).to(beNil());
 
 	NSMutableArray* notes = [NSMutableArray arrayWithCapacity:0];
 
-	[repository enumerateNotesWithError:&err ref:nil usingBlock:^(GTNote *note, GTObject *object, BOOL *stop) {
+	[repository enumerateNotesWithReferenceName:nil error:&err usingBlock:^(GTNote *note, GTObject *object, BOOL *stop) {
 		[notes addObject:note];
 	}];