Merge pull request #452 from phatblat/phatblat/pr/swift1.2

Support for Swift 1.2 (Spec dependencies) and new Objective-C nullability qualifiers

Author: joshaber

Cartfile.private

@@ -1,3 +1,3 @@
 github "jspahrsummers/xcconfigs" >= 0.7.1
-github "Quick/Quick" ~> 0.2
-github "Quick/Nimble" ~> 0.2
+github "Quick/Quick" ~> 0.3
+github "Quick/Nimble" ~> 0.4

Cartfile.resolved

@@ -1,3 +1,3 @@
-github "Quick/Nimble" "v0.2.0"
-github "Quick/Quick" "v0.2.2"
-github "jspahrsummers/xcconfigs" "0.7.1"
+github "Quick/Nimble" "v0.4.2"
+github "Quick/Quick" "v0.3.1"
+github "jspahrsummers/xcconfigs" "0.7.2"

Carthage/Checkouts/Nimble

@@ -12,11 +12,17 @@
 @class GTBlameHunk;
 @class GTRepository;
 
-/// A `GTBlame` provides authorship info, through `GTBlameHunk` for each line of a file.
+NS_ASSUME_NONNULL_BEGIN
+
+/// A `GTBlame` provides authorship info, through `GTBlameHunk` for each line of a file. Analogous to `git_blame` in libgit2.
 @interface GTBlame : NSObject
 
 /// Designated initializer.
-- (instancetype)initWithGitBlame:(git_blame *)blame NS_DESIGNATED_INITIALIZER;
+///
+/// blame - A git_blame to wrap. May not be NULL.
+///
+/// Returns a blame, or nil if initialization failed.
+- (nullable instancetype)initWithGitBlame:(git_blame *)blame NS_DESIGNATED_INITIALIZER;
 
 /// Get all the hunks in the blame. A convenience wrapper around `enumerateHunksUsingBlock:`
 @property (nonatomic, strong, readonly) NSArray *hunks;
@@ -29,12 +35,13 @@
 /// index - The index to retrieve the hunk from.
 ///
 /// Returns a `GTBlameHunk` or nil if an error occurred.
-- (GTBlameHunk *)hunkAtIndex:(NSUInteger)index;
+- (nullable GTBlameHunk *)hunkAtIndex:(NSUInteger)index;
 
 /// Enumerate the hunks in the blame.
 ///
 /// block - A block invoked for every hunk in the blame.
 ///         Setting stop to `YES` instantly stops the enumeration.
+///         May not be NULL.
 ///
 - (void)enumerateHunksUsingBlock:(void (^)(GTBlameHunk *hunk, NSUInteger index, BOOL *stop))block;
 
@@ -43,10 +50,11 @@
 /// lineNumber - The (1 based) line number to find a hunk for.
 ///
 /// Returns a `GTBlameHunk` or nil if an error occurred.
-- (GTBlameHunk *)hunkAtLineNumber:(NSUInteger)lineNumber;
+- (nullable GTBlameHunk *)hunkAtLineNumber:(NSUInteger)lineNumber;
 
 /// The underlying `git_blame` object.
 - (git_blame *)git_blame __attribute__((objc_returns_inner_pointer));
 
 @end
 
+NS_ASSUME_NONNULL_END

Carthage/Checkouts/Quick

@@ -12,20 +12,27 @@
 @class GTOID;
 @class GTSignature;
 
+NS_ASSUME_NONNULL_BEGIN
+
 /// A `GTBlameHunk` is an object that provides authorship info for a set of lines in a `GTBlame`.
 @interface GTBlameHunk : NSObject
 
-- (instancetype)initWithGitBlameHunk:(git_blame_hunk)hunk NS_DESIGNATED_INITIALIZER;
+/// Designated initializer.
+///
+/// hunk - A git_blame_hunk to wrap. May not be NULL.
+///
+/// Returns a blame hunk, or nil if initialization failed.
+- (nullable instancetype)initWithGitBlameHunk:(git_blame_hunk)hunk NS_DESIGNATED_INITIALIZER;
 
 /// A NSRange where `location` is the (1 based) starting line number,
 /// and `length` is the number of lines in the hunk.
 @property (nonatomic, readonly) NSRange lines;
 
 /// The OID of the commit where this hunk was last changed.
-@property (nonatomic, readonly, copy) GTOID *finalCommitOID;
+@property (nonatomic, readonly, copy, nullable) GTOID *finalCommitOID;
 
 /// The signature of the commit where this hunk was last changed.
-@property (nonatomic, readonly) GTSignature *finalSignature;
+@property (nonatomic, readonly, nullable) GTSignature *finalSignature;
 
 /// The path of the file in the original commit.
 @property (nonatomic, readonly, copy) NSString *originalPath;
@@ -38,3 +45,5 @@
 @property (nonatomic, readonly) git_blame_hunk git_blame_hunk;
 
 @end
+
+NS_ASSUME_NONNULL_END

Carthage/Checkouts/xcconfigs

@@ -30,52 +30,91 @@
 
 #import "GTObject.h"
 
+NS_ASSUME_NONNULL_BEGIN
 
 @interface GTBlob : GTObject
 
-/// 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;
+/// Creates a new blob from the given string.
+///
+/// This writes data to the repository's object database.
+///
+/// string     - The string to add. This must not be nil.
+/// repository - The repository to put the object in. This must not be nil.
+/// error      - Will be set if an error occurs. This may be nil.
+///
+/// Return a newly created blob object, or nil if an error occurs.
++ (nullable instancetype)blobWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error;
+
+/// Creates a new blob from the given data.
+///
+/// This writes data to the repository's object database.
+///
+/// data       - The data to add. This must not be nil.
+/// repository - The repository to put the object in. This must not be nil.
+/// error      - Will be set if an error occurs. This may be nil.
+///
+/// Return a newly created blob object, or nil if an error occurs.
++ (nullable instancetype)blobWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error;
 
+/// Creates a new blob given an NSURL to a file.
+///
+/// This copies the data from the file to the repository's object database.
+///
+/// file       - The NSURL of the file to add. This must not be nil.
+/// repository - The repository to put the object in. This must not be nil.
+/// error      - Will be set if an error occurs. This may be nil.
+///
+/// Return a newly created blob object, or nil if an error occurs.
++ (nullable instancetype)blobWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error;
+
+/// Creates a new blob from the given string.
+///
 /// Convenience wrapper around `-initWithData:inRepository:error` that converts the string to UTF8 data
-- (instancetype)initWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error;
+///
+/// string     - The string to add. This must not be nil.
+/// repository - The repository to put the object in. This must not be nil.
+/// error      - Will be set if an error occurs. This may be nil.
+///
+/// Return a newly created blob object, or nil if an error occurs.
+- (nullable 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.
+/// data       - The data to write. This must not be nil.
+/// repository - The repository to put the object in. This must not be nil.
+/// error      - Will be set if an error occurs. This may be nil.
 ///
 /// Returns a newly created blob object, or nil if an error occurs.
-- (instancetype)initWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error;
+- (nullable 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.
+/// file       - The file to copy contents from. This must not be nil.
+/// repository - The repository to put the object in. This must not be nil.
+/// error      - Will be set if an error occurs. This may be nil.
 ///
 /// Returns a newly created blob object, or nil if an error occurs.
-- (instancetype)initWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error;
+- (nullable 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));
 
 - (git_off_t)size;
 - (NSString *)content;
-- (NSData *)data;
+- (nullable NSData *)data;
 
 /// Attempts to apply the filter list for `path` to the blob.
 ///
 /// path  - The path to use filters from. Must not be nil.
 /// error - If not NULL, set to any error that occurs.
 ///
 /// Returns the filtered data, or nil if an error occurs.
-- (NSData *)applyFiltersForPath:(NSString *)path error:(NSError **)error;
+- (nullable NSData *)applyFiltersForPath:(NSString *)path error:(NSError **)error;
 
 @end
+
+NS_ASSUME_NONNULL_END

ObjectiveGit/GTBlame.h

@@ -46,19 +46,19 @@ - (NSString *)description {
 
 #pragma mark API
 
-+ (id)blobWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error {
++ (instancetype)blobWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error {
 	return [[self alloc] initWithString:string inRepository:repository error:error];
 }
 
-+ (id)blobWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error {
++ (instancetype)blobWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error {
 	return [[self alloc] initWithData:data inRepository:repository error:error];
 }
 
-+ (id)blobWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error {
++ (instancetype)blobWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error {
 	return [[self alloc] initWithFile:file inRepository:repository error:error];
 }
 
-- (id)initWithOid:(const git_oid *)oid inRepository:(GTRepository *)repository error:(NSError **)error {
+- (instancetype)initWithOid:(const git_oid *)oid inRepository:(GTRepository *)repository error:(NSError **)error {
 	NSParameterAssert(oid != NULL);
 	NSParameterAssert(repository != nil);
 
@@ -74,12 +74,12 @@ - (id)initWithOid:(const git_oid *)oid inRepository:(GTRepository *)repository e
     return [self initWithObj:obj inRepository:repository];
 }
 
-- (id)initWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error {
+- (instancetype)initWithString:(NSString *)string inRepository:(GTRepository *)repository error:(NSError **)error {
 	NSData *data = [string dataUsingEncoding:NSUTF8StringEncoding];
     return [self initWithData:data inRepository:repository error:error];
 }
 
-- (id)initWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error {
+- (instancetype)initWithData:(NSData *)data inRepository:(GTRepository *)repository error:(NSError **)error {
 	NSParameterAssert(data != nil);
 	NSParameterAssert(repository != nil);
 
@@ -95,7 +95,7 @@ - (id)initWithData:(NSData *)data inRepository:(GTRepository *)repository error:
     return [self initWithOid:&oid inRepository:repository error:error];
 }
 
-- (id)initWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error {
+- (instancetype)initWithFile:(NSURL *)file inRepository:(GTRepository *)repository error:(NSError **)error {
 	NSParameterAssert(file != nil);
 	NSParameterAssert(repository != nil);
 

ObjectiveGit/GTBlameHunk.h

@@ -35,32 +35,47 @@ typedef NS_ENUM(NSInteger, GTBranchType) {
     GTBranchTypeRemote = GIT_BRANCH_REMOTE,
 };
 
+NS_ASSUME_NONNULL_BEGIN
+
 /// A git branch object.
 ///
-/// Branches are considered to be equivalent iff both their `name` and `SHA` are
+/// Branches are considered to be equivalent if both their `name` and `SHA` are
 /// equal.
 @interface GTBranch : NSObject
 
-@property (nonatomic, readonly) NSString *name;
-@property (nonatomic, readonly) NSString *shortName;
-@property (nonatomic, copy, readonly) GTOID *OID;
-@property (nonatomic, readonly) NSString *remoteName;
+@property (nonatomic, readonly, nullable) NSString *name;
+@property (nonatomic, readonly, nullable) NSString *shortName;
+@property (nonatomic, copy, readonly, nullable) GTOID *OID;
+@property (nonatomic, readonly, nullable) NSString *remoteName;
 @property (nonatomic, readonly) GTBranchType branchType;
 @property (nonatomic, readonly, strong) GTRepository *repository;
 @property (nonatomic, readonly, strong) GTReference *reference;
 
 + (NSString *)localNamePrefix;
 + (NSString *)remoteNamePrefix;
 
-- (id)initWithReference:(GTReference *)ref repository:(GTRepository *)repo NS_DESIGNATED_INITIALIZER;
-+ (id)branchWithReference:(GTReference *)ref repository:(GTRepository *)repo;
+/// Designated initializer.
+///
+/// ref  - The branch reference to wrap. Must not be nil.
+/// repo - The repository containing the branch. Must not be nil.
+///
+/// Returns the initialized receiver.
+- (nullable instancetype)initWithReference:(GTReference *)ref repository:(GTRepository *)repo NS_DESIGNATED_INITIALIZER;
+
+/// Convenience class initializer.
+///
+/// ref  - The branch reference to wrap. Must not be nil.
+/// repo - The repository containing the branch. Must not be nil.
+///
+/// Returns an initialized instance.
++ (nullable instancetype)branchWithReference:(GTReference *)ref repository:(GTRepository *)repo;
 
 /// Get the target commit for this branch
 ///
 /// error(out) - will be filled if an error occurs
 ///
 /// returns a GTCommit object or nil if an error occurred
-- (GTCommit *)targetCommitAndReturnError:(NSError **)error;
+- (nullable GTCommit *)targetCommitAndReturnError:(NSError **)error;
 
 /// Count all commits in this branch
 ///
@@ -69,15 +84,21 @@ typedef NS_ENUM(NSInteger, GTBranchType) {
 /// returns number of commits in the branch or NSNotFound if an error occurred
 - (NSUInteger)numberOfCommitsWithError:(NSError **)error;
 
-- (NSArray *)uniqueCommitsRelativeToBranch:(GTBranch *)otherBranch error:(NSError **)error;
+/// Get unique commits
+///
+/// otherBranch -
+/// error       - If not NULL, set to any error that occurs.
+///
+/// Returns a (possibly empty) array of GTCommits, or nil if an error occurs.
+- (nullable 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;
+- (nullable GTBranch *)trackingBranchWithError:(NSError **)error success:(nullable BOOL *)success;
 
 /// Update the tracking branch.
 ///
@@ -86,7 +107,7 @@ typedef NS_ENUM(NSInteger, GTBranchType) {
 /// error          - The error if one occurred.
 ///
 /// Returns whether it was successful.
-- (BOOL)updateTrackingBranch:(GTBranch *)trackingBranch error:(NSError **)error;
+- (BOOL)updateTrackingBranch:(nullable GTBranch *)trackingBranch error:(NSError **)error;
 
 /// Reloads the branch's reference and creates a new branch based off that newly
 /// loaded reference.
@@ -96,7 +117,7 @@ typedef NS_ENUM(NSInteger, GTBranchType) {
 /// error - The error if one occurred.
 ///
 /// Returns the reloaded branch, or nil if an error occurred.
-- (GTBranch *)reloadedBranchWithError:(NSError **)error;
+- (nullable GTBranch *)reloadedBranchWithError:(NSError **)error;
 
 /// Calculate the ahead/behind count from this branch to the given branch.
 ///
@@ -110,3 +131,5 @@ typedef NS_ENUM(NSInteger, GTBranchType) {
 - (BOOL)calculateAhead:(size_t *)ahead behind:(size_t *)behind relativeTo:(GTBranch *)branch error:(NSError **)error;
 
 @end
+
+NS_ASSUME_NONNULL_END