Merge pull request #7 from square/federman/nullable_xcode64_support

Add support for nullable and nonnull for better Swift interoperability
square · Jul 23, 2015 · 267c76e · 267c76e
2 parents 08e2c59 + de1c145
commit 267c76e
Show file tree

Hide file tree

Showing 42 changed files with 247 additions and 125 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,7 @@
 language: objective-c
+osx_image: xcode6.4
 before_script:
-    - brew update && brew upgrade xctool
+    - bundle install
 script:
-    - xctool test -project Aardvark.xcodeproj -scheme Aardvark -sdk iphonesimulator
+    - xcodebuild -project Aardvark.xcodeproj -scheme Aardvark -sdk iphonesimulator -configuration Debug -PBXBuildsContinueAfterErrors=0 ACTIVE_ARCH_ONLY=0 build test
+    - pod lib lint --verbose --fail-fast
diff --git a/Aardvark.podspec b/Aardvark.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name     = 'Aardvark'
-  s.version  = '1.0.2'
+  s.version  = '1.1'
   s.license  = 'Apache License, Version 2.0'
   s.summary  = 'Aardvark is a library that makes it dead simple to create actionable bug reports.'
   s.homepage = 'https://github.com/square/Aardvark'

diff --git a/Aardvark/Aardvark.h b/Aardvark/Aardvark.h
@@ -22,6 +22,9 @@
 #import <Aardvark/ARKEmailBugReporter.h>
 
 
+NS_ASSUME_NONNULL_BEGIN
+
+
 typedef NS_ENUM(NSUInteger, ARKLogType) {
     /// Default log type.
     ARKLogTypeDefault,
@@ -38,7 +41,7 @@ typedef NS_ENUM(NSUInteger, ARKLogType) {
 OBJC_EXTERN void ARKLog(NSString *format, ...) NS_FORMAT_FUNCTION(1,2);
 
 /// Logs a log with customized type and userInfo to the default log distributor.
-OBJC_EXTERN void ARKLogWithType(ARKLogType type, NSDictionary *userInfo, NSString *format, ...) NS_FORMAT_FUNCTION(3,4);
+OBJC_EXTERN void ARKLogWithType(ARKLogType type, NSDictionary * __nullable userInfo, NSString *format, ...) NS_FORMAT_FUNCTION(3,4);
 
 /// Logs a screenshot to the default log distributor.
 OBJC_EXTERN void ARKLogScreenshot();
@@ -47,9 +50,12 @@ OBJC_EXTERN void ARKLogScreenshot();
 @interface Aardvark : NSObject
 
 /// Sets up a two finger press-and-hold gesture recognizer to trigger email bug reports that will be sent to emailAddress. Returns the created bug reporter for convenience.
-+ (ARKEmailBugReporter *)addDefaultBugReportingGestureWithEmailBugReporterWithRecipient:(NSString *)emailAddress;
++ (nullable ARKEmailBugReporter *)addDefaultBugReportingGestureWithEmailBugReporterWithRecipient:(NSString *)emailAddress;
 
 /// Creates and returns a gesture recognizer that when triggered will call [bugReporter composeBugReport].
-+ (id)addBugReporter:(id <ARKBugReporter>)bugReporter triggeringGestureRecognizerClass:(Class)gestureRecognizerClass;
++ (nullable id)addBugReporter:(id <ARKBugReporter>)bugReporter triggeringGestureRecognizerClass:(Class)gestureRecognizerClass;
 
 @end
+
+
+NS_ASSUME_NONNULL_END
diff --git a/AardvarkSample/AardvarkSample/SampleAppDelegate.h b/AardvarkSample/AardvarkSample/SampleAppDelegate.h
@@ -20,9 +20,9 @@
 
 @interface SampleAppDelegate : UIResponder <UIApplicationDelegate>
 
-@property (strong, nonatomic, readwrite) UIWindow *window;
+@property (nonatomic) UIWindow *window;
 
-@property (strong, nonatomic, readwrite) ARKEmailBugReporter *bugReporter;
+@property (nonatomic) ARKEmailBugReporter *bugReporter;
 
 @end
 
diff --git a/AardvarkSample/AardvarkSample/SampleViewController.m b/AardvarkSample/AardvarkSample/SampleViewController.m
@@ -33,8 +33,8 @@
 
 @interface SampleViewController ()
 
-@property (nonatomic, readwrite, strong) ARKLogStore *tapGestureLogStore;
-@property (nonatomic, strong, readwrite) UITapGestureRecognizer *tapRecognizer;
+@property (nonatomic) ARKLogStore *tapGestureLogStore;
+@property (nonatomic) UITapGestureRecognizer *tapRecognizer;
 
 @end
 

diff --git a/AardvarkTests/ARKDataArchiveTests.m b/AardvarkTests/ARKDataArchiveTests.m
@@ -95,7 +95,7 @@ - (void)test_setUp_providesEmptyArchive;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_dealloc_closesFile;
@@ -169,7 +169,7 @@ - (void)test_initWithURL_preservesExistingData;
         [expectation3 fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_appendArchiveOfObject_trimsArchive;
@@ -245,7 +245,7 @@ - (void)test_appendArchiveOfObject_trimsArchive;
         [expectation5 fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_appendArchiveOfObject_trimsCorruptedArchive;
@@ -283,7 +283,7 @@ - (void)test_appendArchiveOfObject_trimsCorruptedArchive;
     }];
 
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_initWithURL_detectsCorruptedArchive;
@@ -310,7 +310,7 @@ - (void)test_initWithURL_detectsCorruptedArchive;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_initWithURL_detectsPartiallyCorruptedArchive;
@@ -339,7 +339,7 @@ - (void)test_initWithURL_detectsPartiallyCorruptedArchive;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_readObjectsFromArchive_excludesFaultyUnarchives;
@@ -381,7 +381,7 @@ - (void)test_readObjectsFromArchive_excludesFaultyUnarchives;
         [expectation2 fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_clearArchiveWithCompletionHandler_removesAllDataFromDisk;
@@ -406,7 +406,7 @@ - (void)test_clearArchiveWithCompletionHandler_removesAllDataFromDisk;
         }];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_clearArchiveWithCompletionHandler_completionHandlerCalledOnMainQueue;
@@ -417,7 +417,7 @@ - (void)test_clearArchiveWithCompletionHandler_completionHandlerCalledOnMainQueu
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 #pragma mark - Performance Tests

diff --git a/AardvarkTests/ARKDefaultLogFormatterTests.m b/AardvarkTests/ARKDefaultLogFormatterTests.m
@@ -32,9 +32,9 @@
 
 @interface ARKDefaultLogFormatterTests : XCTestCase
 
-@property (nonatomic, strong, readwrite) ARKLogDistributor *defaultLogDistributor;
-@property (nonatomic, strong, readwrite) ARKDefaultLogFormatter *logFormatter;
-@property (nonatomic, weak, readwrite) ARKLogStore *logStore;
+@property (nonatomic) ARKLogDistributor *defaultLogDistributor;
+@property (nonatomic) ARKDefaultLogFormatter *logFormatter;
+@property (nonatomic, weak) ARKLogStore *logStore;
 
 @end
 
@@ -84,7 +84,7 @@ - (void)test_formattedLogMessage_errorLogLineCount;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_formattedLogMessage_separatorLogLineCount;
@@ -103,7 +103,7 @@ - (void)test_formattedLogMessage_separatorLogLineCount;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_formattedLogMessage_defaultLogLineCount;
@@ -121,7 +121,7 @@ - (void)test_formattedLogMessage_defaultLogLineCount;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_formattedLogMessage_errorLogContent;
@@ -142,7 +142,7 @@ - (void)test_formattedLogMessage_errorLogContent;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_formattedLogMessage_separatorLogContent;
@@ -163,7 +163,7 @@ - (void)test_formattedLogMessage_separatorLogContent;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_formattedLogMessage_defaultLogContent;
@@ -183,7 +183,7 @@ - (void)test_formattedLogMessage_defaultLogContent;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_formattedLogMessage_errorPrefixChangeRespected;
@@ -203,7 +203,7 @@ - (void)test_formattedLogMessage_errorPrefixChangeRespected;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_formattedLogMessage_separatorPrefixChangeRespected;
@@ -223,7 +223,7 @@ - (void)test_formattedLogMessage_separatorPrefixChangeRespected;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_formattedLogMessage_errorPrefixOnSameLineIfLogTextIsEmpty;
@@ -241,7 +241,7 @@ - (void)test_formattedLogMessage_errorPrefixOnSameLineIfLogTextIsEmpty;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_formattedLogMessage_separatorPrefixOnSameLineIfLogTextIsEmpty;
@@ -259,7 +259,7 @@ - (void)test_formattedLogMessage_separatorPrefixOnSameLineIfLogTextIsEmpty;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 #pragma mark - Performance Tests
@@ -286,7 +286,7 @@ - (void)test_formattedLogMessage_performance;
             [expectation fulfill];
         }];
 
-        [self waitForExpectationsWithTimeout:1.0 handler:nil];
+        [self waitForExpectationsWithTimeout:5.0 handler:nil];
     }];
 }
 

diff --git a/AardvarkTests/ARKEmailBugReporterTests.m b/AardvarkTests/ARKEmailBugReporterTests.m
@@ -33,9 +33,9 @@
 
 @interface ARKEmailBugReporterTests : XCTestCase
 
-@property (nonatomic, strong, readwrite) ARKLogDistributor *defaultLogDistributor;
-@property (nonatomic, strong, readwrite) ARKEmailBugReporter *bugReporter;
-@property (nonatomic, weak, readwrite) ARKLogStore *logStore;
+@property (nonatomic) ARKLogDistributor *defaultLogDistributor;
+@property (nonatomic) ARKEmailBugReporter *bugReporter;
+@property (nonatomic, weak) ARKLogStore *logStore;
 
 @end
 
@@ -91,7 +91,7 @@ - (void)test_recentErrorLogMessagesAsPlainText_countRespected;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_recentErrorLogMessagesAsPlainText_returnsNilIfNoErrorLogsPresent;
@@ -114,7 +114,7 @@ - (void)test_recentErrorLogMessagesAsPlainText_returnsNilIfNoErrorLogsPresent;
         }];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_recentErrorLogMessagesAsPlainText_returnsNilIfRecentErrorLogsIsZero;
@@ -137,7 +137,7 @@ - (void)test_recentErrorLogMessagesAsPlainText_returnsNilIfRecentErrorLogsIsZero
         }];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_addLogStores_enforcesARKLogStoreClass;

diff --git a/AardvarkTests/ARKFileHandleAdditionsTests.m b/AardvarkTests/ARKFileHandleAdditionsTests.m
@@ -125,10 +125,7 @@ - (void)test_writeDataBlock;
     [self.fileHandle ARK_writeDataBlock:self.data_4];
     [self _assertFileContentsMatchDataList:@[ self.block_9, self.block_4, self.block_7 ] failureMessage:@"Failed to over-write data in file."];
 
-    // Write empty-length data.
-    [self.fileHandle ARK_writeDataBlock:nil];
-    [self _assertFileContentsMatchDataList:@[ self.block_9, self.block_4, self.block_7 ] failureMessage:@"Writing nil data shouldn't change the file."];
-
+    // Write empty-length data.    
     [self.fileHandle ARK_writeDataBlock:[NSData data]];
     [self _assertFileContentsMatchDataList:@[ self.block_9, self.block_4, self.block_7 ] failureMessage:@"Writing empty data shouldn't change the file."];
 }
@@ -158,9 +155,6 @@ - (void)test_appendDataBlock;
     [self _assertFileContentsMatchDataList:@[ self.block_6, self.block_7, self.block_9, self.block_4 ] failureMessage:@"Failed to append to block after seeking to end of file."];
 
     // Append empty data.
-    [self.fileHandle ARK_appendDataBlock:nil];
-    [self _assertFileContentsMatchDataList:@[ self.block_6, self.block_7, self.block_9, self.block_4 ] failureMessage:@"Appending nil data shouldn't change the file."];
-
     [self.fileHandle ARK_appendDataBlock:[NSData data]];
     [self _assertFileContentsMatchDataList:@[ self.block_6, self.block_7, self.block_9, self.block_4 ] failureMessage:@"Appending empty data shouldn't change the file."];
 }

diff --git a/AardvarkTests/ARKLogDistributorTests.m b/AardvarkTests/ARKLogDistributorTests.m
@@ -121,7 +121,7 @@ - (void)test_logMessageClass_defaultsToARKLogMessage;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_setLogMessageClass_appendedLogsAreCorrectClass;
@@ -137,7 +137,7 @@ - (void)test_setLogMessageClass_appendedLogsAreCorrectClass;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_defaultLogStore_lazilyInitializesOnFirstAccess;
@@ -176,7 +176,7 @@ - (void)test_addLogObserver_notifiesLogObserverOnARKLog;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 
     [[ARKLogDistributor defaultDistributor] removeLogObserver:testLogObserver];
 }
@@ -197,7 +197,7 @@ - (void)test_addLogObserver_notifiesLogObserverOnLogWithFormat;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_removeLogObserver_removesLogObserver;
@@ -224,7 +224,7 @@ - (void)test_removeLogObserver_removesLogObserver;
         [expectation fulfill];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)test_distributeAllPendingLogsWithCompletionHandler_informsLogObserversOfAllPendingLogs;
@@ -257,7 +257,7 @@ - (void)test_distributeAllPendingLogsWithCompletionHandler_informsLogObserversOf
         }];
     }];
 
-    [self waitForExpectationsWithTimeout:1.0 handler:nil];
+    [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 #pragma mark - Performance Tests