Merge pull request #224 from libgit2/fetch

Fetch support.

Author: jspahrsummers

Classes/Categories/NSError+Git.h

@@ -68,4 +68,22 @@ extern NSString * const GTGitErrorDomain;
 /// Returns a non-nil NSError.
 + (NSError *)git_errorFor:(int)code description:(NSString *)desc, ... NS_FORMAT_FUNCTION(2, 3);
 
+
+/// Describes the given libgit2 error code, using `desc` as the error's
+/// description, and a failure reason from `reason` and the arguments that
+/// follow.
+///
+/// The created error will also have an `NSUnderlyingErrorKey` that contains the
+/// result of +git_errorFor: on the same error code.
+///
+/// code     - The error code returned from libgit2.
+/// desc     - The description to use in the created NSError. This may be nil.
+/// userInfo - A dictionary of additional values to insert in the NSError userInfo.
+///            This may be nil.
+/// reason   - A format string to use for the created NSError's failure reason.
+///            This may be nil.
+/// ...      - Format arguments to insert into `reason`.
+///
+/// Returns a non-nil NSError.
++ (NSError *)git_errorFor:(int)code description:(NSString *)desc userInfo:(NSDictionary *)userInfo failureReason:(NSString *)reason, ... NS_FORMAT_FUNCTION(4, 5);
 @end

Classes/Categories/NSError+Git.m

@@ -67,6 +67,26 @@ + (NSError *)git_errorFor:(int)code description:(NSString *)desc failureReason:(
 	return [NSError errorWithDomain:GTGitErrorDomain code:code userInfo:userInfo];
 }
 
++ (NSError *)git_errorFor:(int)code description:(NSString *)desc userInfo:(NSDictionary *)additionalUserInfo failureReason:(NSString *)reason, ... {
+	NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:additionalUserInfo];
+
+	if (desc != nil) userInfo[NSLocalizedDescriptionKey] = desc;
+	if (reason != nil) {
+		va_list args;
+		va_start(args, reason);
+
+		NSString *formattedReason = [[NSString alloc] initWithFormat:reason arguments:args];
+		va_end(args);
+
+		userInfo[NSLocalizedFailureReasonErrorKey] = formattedReason;
+	}
+
+	NSError *underError = [self git_errorFor:code];
+	if (underError != nil) userInfo[NSUnderlyingErrorKey] = underError;
+
+	return [NSError errorWithDomain:GTGitErrorDomain code:code userInfo:userInfo];
+}
+
 + (NSError *)git_errorFor:(int)code {
 	NSDictionary *userInfo = nil;
 

Classes/GTBranch.h

@@ -27,6 +27,7 @@
 
 @class GTCommit;
 @class GTReference;
+@class GTRemote;
 @class GTRepository;
 
 typedef NS_ENUM(NSInteger, GTBranchType) {

Classes/GTBranch.m

@@ -28,6 +28,7 @@
 #import "GTEnumerator.h"
 #import "GTRepository.h"
 #import "GTCommit.h"
+#import "GTRemote.h"
 #import "NSError+Git.h"
 
 @implementation GTBranch

Classes/GTConfiguration.m

@@ -128,7 +128,7 @@ - (NSArray *)remotes {
 		git_remote *remote = NULL;
 
 		if (git_remote_load(&remote, repository.git_repository, name) == 0) {
-			[remotes addObject:[[GTRemote alloc] initWithGitRemote:remote]];
+			[remotes addObject:[[GTRemote alloc] initWithGitRemote:remote inRepository:repository]];
 		}
 	}
 

Classes/GTFetchHeadEntry.h

@@ -0,0 +1,38 @@
+//
+//  GTFetchHeadEntry.h
+//  ObjectiveGitFramework
+//
+//  Created by Pablo Bendersky on 8/14/14.
+//  Copyright (c) 2014 GitHub, Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@class GTRepository;
+@class GTOID;
+@class GTReference;
+
+/// A class representing an entry on the FETCH_HEAD file, as returned by the callback of git_repository_fetchhead_foreach.
+@interface GTFetchHeadEntry : NSObject
+
+/// The reference of this fetch entry.
+@property (nonatomic, readonly, strong) GTReference *reference;
+
+/// The remote URL where this entry was originally fetched from.
+@property (nonatomic, readonly, copy) NSString *remoteURLString;
+
+/// The target OID of this fetch entry (what we need to merge with)
+@property (nonatomic, readonly, copy) GTOID *targetOID;
+
+/// Flag indicating if we need to merge this entry or not.
+@property (nonatomic, getter = isMerge, readonly) BOOL merge;
+
+/// Initializes a GTFetchHeadEntry.
+///
+/// reference       - Reference on the repository. Cannot be nil.
+/// remoteURLString - URL String where this was originally fetched from. Cannot be nil.
+/// targetOID       - Target OID. Cannot be nil.
+/// merge           - Indicates if this is pending a merge.
+- (instancetype)initWithReference:(GTReference *)reference remoteURLString:(NSString *)remoteURLString targetOID:(GTOID *)targetOID isMerge:(BOOL)merge;
+
+@end

Classes/GTFetchHeadEntry.m

@@ -0,0 +1,36 @@
+//
+//  GTFetchHeadEntry.m
+//  ObjectiveGitFramework
+//
+//  Created by Pablo Bendersky on 8/14/14.
+//  Copyright (c) 2014 GitHub, Inc. All rights reserved.
+//
+
+#import "GTFetchHeadEntry.h"
+#import "GTOID.h"
+
+@implementation GTFetchHeadEntry
+
+- (instancetype)initWithReference:(GTReference *)reference remoteURLString:(NSString *)remoteURLString targetOID:(GTOID *)targetOID isMerge:(BOOL)merge {
+	NSParameterAssert(reference != nil);
+	NSParameterAssert(remoteURLString != nil);
+	NSParameterAssert(targetOID != nil);
+	
+	self = [super init];
+	if (self == nil) return nil;
+
+	_reference = reference;
+	_remoteURLString = [remoteURLString copy];
+	_targetOID = [targetOID copy];
+	_merge = merge;
+
+	return self;
+}
+
+#pragma mark NSObject
+
+- (NSString *)description {
+	return [NSString stringWithFormat:@"<%@: %p>{ reference: %@, remoteURL: %@, targetOID: %@, merge: %i }", self.class, self, self.reference, self.remoteURLString, self.targetOID, (int)self.merge];
+}
+
+@end

Classes/GTRemote.h

@@ -8,31 +8,106 @@
 
 #import "git2.h"
 
+@class GTRepository;
+@class GTOID;
+@class GTReference;
+@class GTCredentialProvider;
+
+extern NSString * const GTRemoteRenameProblematicRefSpecs;
+
+// Auto Tag settings. See `git_remote_autotag_option_t`.
+typedef enum {
+	GTRemoteDownloadTagsAuto = GIT_REMOTE_DOWNLOAD_TAGS_AUTO,
+	GTRemoteDownloadTagsNone = GIT_REMOTE_DOWNLOAD_TAGS_NONE,
+	GTRemoteDownloadTagsAll = GIT_REMOTE_DOWNLOAD_TAGS_ALL,
+} GTRemoteAutoTagOption;
+
 /// A class representing a remote for a git repository.
 ///
-/// Analagous to `git_remote` in libgit2.
+/// Analogous to `git_remote` in libgit2.
 @interface GTRemote : NSObject
 
-/// Initializes a new GTRemote to represent an underlying `git_remote`.
-///
-/// remote - The underlying `git_remote` object.
-- (id)initWithGitRemote:(git_remote *)remote;
-
-/// The underlying `git_remote` object.
-- (git_remote *)git_remote __attribute__((objc_returns_inner_pointer));
+/// The repository owning this remote.
+@property (nonatomic, readonly, strong) GTRepository *repository;
 
 /// The name of the remote.
 @property (nonatomic, readonly, copy) NSString *name;
 
 /// The URL string for the remote.
 @property (nonatomic, readonly, copy) NSString *URLString;
 
+/// The push URL for the remote, if provided.
+@property (nonatomic, copy) NSString *pushURLString;
+
+/// Whether the remote is connected or not.
+@property (nonatomic, readonly, getter=isConnected) BOOL connected;
+
+/// Whether the remote updates FETCH_HEAD when fetched.
+/// Defaults to YES.
+@property (nonatomic) BOOL updatesFetchHead;
+
+/// The auto-tag setting for the remote.
+@property (nonatomic) GTRemoteAutoTagOption autoTag;
+
 /// The fetch refspecs for this remote.
 ///
 /// This array will contain NSStrings of the form
 /// `+refs/heads/*:refs/remotes/REMOTE/*`.
 @property (nonatomic, readonly, copy) NSArray *fetchRefspecs;
 
+/// The push refspecs for this remote.
+///
+/// This array will contain NSStrings of the form
+/// `+refs/heads/*:refs/remotes/REMOTE/*`.
+@property (nonatomic, readonly, copy) NSArray *pushRefspecs;
+
+/// Tests if a URL is supported (e.g. it's a supported URL scheme)
++ (BOOL)isSupportedURLString:(NSString *)URLString;
+
+/// Tests if a URL is valid (e.g. it actually makes sense as a URL)
++ (BOOL)isValidURLString:(NSString *)URLString;
+
+/// Tests if a name is valid
++ (BOOL)isValidRemoteName:(NSString *)name;
+
+/// Create a new remote in a repository.
+///
+/// name      - The name for the new remote. Cannot be nil.
+/// URLString - The origin URL for the remote. Cannot be nil.
+/// repo      - The repository the remote should be created in. Cannot be nil.
+/// error     - Will be set if an error occurs.
+///
+/// Returns a new remote, or nil if an error occurred
++ (instancetype)createRemoteWithName:(NSString *)name URLString:(NSString *)URLString inRepository:(GTRepository *)repo error:(NSError **)error;
+
+/// Load a remote from a repository.
+///
+/// name - The name for the new remote. Cannot be nil.
+/// repo - The repository the remote should be looked up in. Cannot be nil.
+/// error - Will be set if an error occurs.
+///
+/// Returns the loaded remote, or nil if an error occurred.
++ (instancetype)remoteWithName:(NSString *)name inRepository:(GTRepository *)repo error:(NSError **)error;
+
+/// Initialize a remote from a `git_remote`.
+///
+/// remote - The underlying `git_remote` object. Cannot be nil.
+/// repo   - The repository the remote belongs to. Cannot be nil.
+- (instancetype)initWithGitRemote:(git_remote *)remote inRepository:(GTRepository *)repo;
+
+/// The underlying `git_remote` object.
+- (git_remote *)git_remote __attribute__((objc_returns_inner_pointer));
+
+/// Rename the remote.
+///
+/// name  - The new name for the remote. Cannot be nil.
+/// error - Will be set if an error occurs. If there was an error renaming some
+///         refspecs, their names will be available as an arry under the
+///         `GTRemoteRenameProblematicRefSpecs` key.
+///
+/// Return YES if successful, NO otherwise.
+- (BOOL)rename:(NSString *)name error:(NSError **)error;
+
 /// Updates the URL string for this remote.
 ///
 /// URLString - The URLString to update to. May not be nil.