Split GTRepository API

Classes/GTBlob.h

@@ -31,15 +31,37 @@
 #import "GTObject.h"
 
 
-@interface GTBlob : GTObject {}
+@interface GTBlob : GTObject
 
-+ (id)blobWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error;
-+ (id)blobWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error;
-+ (id)blobWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error;
+// Convenience class methods
++ (instancetype)blobWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error;
++ (instancetype)blobWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error;
++ (instancetype)blobWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error;
 
-- (id)initWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error;
-- (id)initWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error;
-- (id)initWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error;
+// Convenience wrapper around `-initWithData:inRepository:error` that converts the string to UTF8 data
+- (instancetype)initWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error;
+
+// Creates a new blob from the passed data.
+//
+// This writes data to the repository's object database.
+//
+// data       - The data to write.
+// repository - The repository to put the object in.
+// error      - Will be set if an error occurs.
+//
+// Returns a newly created blob object, or nil if an error occurs.
+- (instancetype)initWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error;
+
+// Creates a new blob from the specified file.
+//
+// This copies the data from the file to the repository's object database.
+//
+// data       - The file to copy contents from.
+// repository - The repository to put the object in.
+// error      - Will be set if an error occurs.
+//
+// Returns a newly created blob object, or nil if an error occurs.
+- (instancetype)initWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error;
 
 // The underlying `git_object` as a `git_blob` object.
 - (git_blob *)git_blob __attribute__((objc_returns_inner_pointer));

Classes/GTBlob.m

@@ -55,6 +55,9 @@ + (id)blobWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(
 }
 
 - (id)initWithOid:(const git_oid *)oid inRepository:(GTRepository *)repository error:(NSError **)error {
+	NSParameterAssert(oid != NULL);
+	NSParameterAssert(repository != nil);
+
 	git_object *obj;
     int gitError = git_object_lookup(&obj, repository.git_repository, oid, (git_otype) GTObjectTypeBlob);
     if (gitError < GIT_OK) {
@@ -73,6 +76,9 @@ - (id)initWithString:(NSString *)string inRepository:(GTRepository *)repository
 }
 
 - (id)initWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error {
+	NSParameterAssert(data != nil);
+	NSParameterAssert(repository != nil);
+
 	git_oid oid;
 	int gitError = git_blob_create_frombuffer(&oid, repository.git_repository, [data bytes], data.length);
 	if(gitError < GIT_OK) {
@@ -86,8 +92,11 @@ - (id)initWithData:(NSData *)data inRepository:(GTRepository *)repository error:
 }
 
 - (id)initWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error {
+	NSParameterAssert(file != nil);
+	NSParameterAssert(repository != nil);
+
 	git_oid oid;
-	int gitError = git_blob_create_fromworkdir(&oid, repository.git_repository, [[file path] UTF8String]);
+	int gitError = git_blob_create_fromdisk(&oid, repository.git_repository, [[file path] fileSystemRepresentation]);
 	if(gitError < GIT_OK) {
 		if(error != NULL) {
 			*error = [NSError git_errorFor:gitError description:@"Failed to create blob from NSURL"];

Classes/GTBranch.h

@@ -30,53 +30,68 @@
 @class GTRepository;
 
 typedef enum {
-    GTBranchTypeLocal = 1,
-    GTBranchTypeRemote
+    GTBranchTypeLocal = GIT_BRANCH_LOCAL,
+    GTBranchTypeRemote = GIT_BRANCH_REMOTE,
+	GTBranchTypeAny = GIT_BRANCH_REMOTE|GIT_BRANCH_LOCAL,
 } GTBranchType;
 
 @interface GTBranch : NSObject
 
+@property (nonatomic, readonly, strong) GTRepository *repository;
+@property (nonatomic, readonly, strong) GTReference *reference;
 @property (nonatomic, readonly) NSString *name;
 @property (nonatomic, readonly) NSString *shortName;
-@property (nonatomic, readonly) NSString *SHA;
 @property (nonatomic, readonly) NSString *remoteName;
+@property (nonatomic, readonly) NSString *SHA;
 @property (nonatomic, readonly) GTBranchType branchType;
-@property (nonatomic, readonly, strong) GTRepository *repository;
-@property (nonatomic, readonly, strong) GTReference *reference;
+@property (nonatomic, assign) GTBranch *trackingBranch;
+@property (nonatomic, readonly, getter=isHead) BOOL head;
+
+// Lookup a branch by name. Performs a `GTBranchTypeAny` lookup.
+// See `+branchByLookingUpBranchNamed:type:inRepository:error:`.
++ (instancetype)branchByLookingUpBranchNamed:(NSString *)name inRepository:(GTRepository *)repository error:(NSError **)error;
+
+// Lookup a branch by name and branch type.
+//
+// name       - The branch name to lookup.
+// type       - The type of lookup to perform. If `GTBranchTypeAny` is passed,
+//              local branches are checked first.
+// repository - The repository to lookup the branch in.
+// error      - A pointer which will point to a valid error if the lookup fails.
+//
+// Returns the branch object with that name, or nil if an error occurred.
++ (instancetype)branchByLookingUpBranchNamed:(NSString *)name type:(GTBranchType)type inRepository:(GTRepository *)repository error:(NSError **)error;
 
-+ (NSString *)localNamePrefix;
-+ (NSString *)remoteNamePrefix;
+// Create a branch from a name and target.
+//
+// name       - The name of the branch to create.
+// commit     - The commit the branch should point to.
+// force      - If set to YES, a branch with same name would be deleted.
+// repository - The repository to create the branch in.
+// error      - A pointer which will point to a valid error if the creation fails.
+//
+// Returns a newly created branch object, or nil if the branch couldn't be created.
++ (instancetype)branchByCreatingBranchNamed:(NSString *)name target:(GTCommit *)commit force:(BOOL)force inRepository:(GTRepository *)repository error:(NSError **)error;
 
 // Convenience initializers
-- (id)initWithName:(NSString *)branchName repository:(GTRepository *)repo error:(NSError **)error;
-+ (id)branchWithName:(NSString *)branchName repository:(GTRepository *)repo error:(NSError **)error;
++ (id)branchWithReferenceNamed:(NSString *)referenceName inRepository:(GTRepository *)repo error:(NSError **)error;
++ (id)branchWithReference:(GTReference *)ref;
 
-- (id)initWithReference:(GTReference *)ref repository:(GTRepository *)repo;
-+ (id)branchWithReference:(GTReference *)ref repository:(GTRepository *)repo;
+// Designated initializer
+- (id)initWithReference:(GTReference *)ref;
 
 // Get the target commit for this branch
 // 
-// error(out) - will be filled if an error occurs
+// error - A pointer which will point to a valid error if the target can't be found.
 // 
-// returns a GTCommit object or nil if an error occurred
+// Returns a GTCommit object or nil if an error occurred.
 - (GTCommit *)targetCommitAndReturnError:(NSError **)error;
 
-// Count all commits in this branch
-//
-// error(out) - will be filled if an error occurs
-//
-// returns number of commits in the branch or NSNotFound if an error occurred
-- (NSUInteger)numberOfCommitsWithError:(NSError **)error;
-
-- (NSArray *)uniqueCommitsRelativeToBranch:(GTBranch *)otherBranch error:(NSError **)error;
-
 // Deletes the local branch and nils out the reference.
 - (BOOL)deleteWithError:(NSError **)error;
 
-// If the receiver is a local branch, looks up and returns its tracking branch.
-// If the receiver is a remote branch, returns self. If no tracking branch was
-// found, returns nil and sets `success` to YES.
-- (GTBranch *)trackingBranchWithError:(NSError **)error success:(BOOL *)success;
+// Renames the branch. Setting `force` to YES to delete another branch with the same name.
+- (BOOL)rename:(NSString *)name force:(BOOL)force error:(NSError **)error;
 
 // Reloads the branch's reference and creates a new branch based off that newly
 // loaded reference.
@@ -88,6 +103,37 @@ typedef enum {
 // Returns the reloaded branch, or nil if an error occurred.
 - (GTBranch *)reloadedBranchWithError:(NSError **)error;
 
+// Fetch the branch's remote tracking branch.
+//
+// If the receiver is a local branch, looks up and returns its tracking branch.
+// If the receiver is a remote branch, returns self.
+// If no tracking branch was found, returns nil with a nil error.
+//
+// error - The error if one occurred.
+//
+// Returns the tracking branch for the reciever if it's a local branch,
+// nil if the receiver is a remote branch but without an error set,
+// or nil if there was an error (and the error pointer will be set.
+- (GTBranch *)trackingBranchWithError:(NSError **)error;
+
+// Count all commits in this branch
+//
+// error - will be filled if an error occurs
+//
+// Returns the number of commits in the receiver or `NSNotFound` if an error occurred
+- (NSUInteger)numberOfCommitsWithError:(NSError **)error;
+
+// Get the unique commits between branches.
+//
+// This method returns an array representing the unique commits
+// that exist between the receiver and `otherBranch`.
+//
+// otherBranch - The branch to compare against.
+// error       - Will be set if an error occurs.
+//
+// Returns an array of GTCommits, or nil if an error occurred.
+- (NSArray *)uniqueCommitsRelativeToBranch:(GTBranch *)otherBranch error:(NSError **)error;
+
 // Calculate the ahead/behind count from this branch to the given branch.
 //
 // ahead  - The number of commits which are unique to the receiver. Cannot be