Merge pull request #108 from morganchen12/build-issues

DatabaseUI Tests: Road to green CI

Author: morganchen12

FirebaseUI.xcodeproj/project.pbxproj

@@ -28,32 +28,32 @@ NS_ASSUME_NONNULL_BEGIN
 /** @property appId
     @brief The Facebook App ID.
  */
-@property(nonatomic, copy, readonly) NSString *appID;
+@property(nonatomic, readonly, copy) NSString *appID;
 
 /** @property scopes
     @brief The scopes to use with Facebook Login.
     @remarks Defaults to using "email" scopes.
  */
-@property(nonatomic, copy) NSArray<NSString *> *scopes;
+@property(nonatomic, readonly, copy) NSArray<NSString *> *scopes;
 
 /** @fn init
     @brief Please use initWithAppId:
  */
-- (nullable instancetype)init NS_UNAVAILABLE;
+- (instancetype)init NS_UNAVAILABLE;
 
 /** @fn initWithAppID:
     @brief Conevenience initializer. Uses a default permission of `@[ "email" ]`.
     @param appID The Facebook App ID.
  */
-- (nullable instancetype)initWithAppID:(NSString *)appID;
+- (instancetype)initWithAppID:(NSString *)appID;
 
 /** @fn initWithAppID:permissions:
     @brief Designated initializer.
     @param appID The Facebook App ID.
     @param permissions The permissions of the app. This array must be an array of specific string values
       as defined in https://developers.facebook.com/docs/facebook-login/permissions/
  */
-- (nullable instancetype)initWithAppID:(NSString *)appID permissions:(NSArray *)permissions NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithAppID:(NSString *)appID permissions:(NSArray *)permissions NS_DESIGNATED_INITIALIZER;
 
 @end
 

FirebaseUI/Auth/AuthProviderUI/Facebook/Source/FIRFacebookAuthUI.h

@@ -49,13 +49,13 @@ @implementation FIRFacebookAuthUI {
   FIRAuthProviderSignInCompletionBlock _pendingSignInCallback;
 }
 
-- (nullable instancetype)init {
+- (instancetype)init {
   @throw [NSException exceptionWithName:@"Attempt to call unavailable initializer."
                                  reason:@"Please call the designated initializer."
                                userInfo:nil];
 }
 
-- (nullable instancetype)initWithAppID:(NSString *)appID permissions:(NSArray *)permissions {
+- (instancetype)initWithAppID:(NSString *)appID permissions:(NSArray *)permissions {
   self = [super init];
   if (self != nil) {
     _scopes = permissions;
@@ -65,7 +65,7 @@ - (nullable instancetype)initWithAppID:(NSString *)appID permissions:(NSArray *)
   return self;
 }
 
-- (nullable instancetype)initWithAppID:(NSString *)appID {
+- (instancetype)initWithAppID:(NSString *)appID {
   return [self initWithAppID:appID permissions:@[ @"email" ]];
 }
 

FirebaseUI/Auth/AuthProviderUI/Facebook/Source/FIRFacebookAuthUI.m

@@ -32,20 +32,30 @@ NS_ASSUME_NONNULL_BEGIN
 
 /** @property scopes
     @brief The scopes to use with Google Sign In.
-    @remarks Defaults to using "email" and "profile" scopes.
+    @remarks Defaults to using email and profile scopes. For a list of all scopes
+      see https://developers.google.com/identity/protocols/googlescopes
  */
-@property(nonatomic, copy) NSArray<NSString *> *scopes;
+@property(nonatomic, copy, readonly) NSArray<NSString *> *scopes;
 
 /** @fn init
     @brief Please use initWithClientId:
  */
-- (nullable instancetype)init NS_UNAVAILABLE;
+- (instancetype)init NS_UNAVAILABLE;
 
 /** @fn initWithClientID:
-    @brief Designated initializer.
+    @brief Convenience initializer. Calls designated init with default 
+      scopes of "email" and "profile".
     @param clientId The Google Sign In client ID.
  */
-- (nullable instancetype)initWithClientID:(NSString *)clientID NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithClientID:(NSString *)clientID;
+
+/** @fn initWithClientID:scopes:
+ @brief Designated initializer.
+ @param clientId The Google Sign In client ID.
+ @param scopes   The user account scopes required by the app. A list of possible scopes can be
+   found at https://developers.google.com/identity/protocols/googlescopes
+ */
+- (instancetype)initWithClientID:(NSString *)clientID scopes:(NSArray <NSString *> *)scopes NS_DESIGNATED_INITIALIZER;
 
 @end
 

FirebaseUI/Auth/AuthProviderUI/Google/Source/FIRGoogleAuthUI.h

@@ -31,10 +31,15 @@
  */
 static NSString *const kGooglePlusMeScope = @"https://www.googleapis.com/auth/plus.me";
 
-/** @var kGooglePlusScopesPrefix
-    @brief The OAuth scope string prefix for all scopes starting with "plus.".
+/** @var kGooglePlusMeScope
+ @brief The OAuth scope string for the user's email scope.
+ */
+static NSString *const kGoogleUserInfoEmailScope = @"https://www.googleapis.com/auth/userinfo.email";
+
+/** @var kGooglePlusMeScope
+ @brief The OAuth scope string for the basic G+ profile information scope.
  */
-static NSString *const kGooglePlusScopesPrefix = @"https://www.googleapis.com/auth/plus.";
+static NSString *const kGoogleUserInfoProfileScope = @"https://www.googleapis.com/auth/userinfo.profile";
 
 /** @var kTableName
     @brief The name of the strings table to search for localized strings.
@@ -60,17 +65,22 @@ @implementation FIRGoogleAuthUI {
   FIRAuthProviderSignInCompletionBlock _pendingSignInCallback;
 }
 
-- (nullable instancetype)init {
+- (instancetype)init {
   @throw [NSException exceptionWithName:@"Attempt to call unavailable initializer."
                                  reason:@"Please call the designated initializer."
                                userInfo:nil];
 }
 
-- (nullable instancetype)initWithClientID:(NSString *)clientID {
+- (instancetype)initWithClientID:(NSString *)clientID {
+  return [self initWithClientID:clientID
+                         scopes:@[kGoogleUserInfoEmailScope, kGoogleUserInfoProfileScope]];
+}
+
+- (instancetype)initWithClientID:(NSString *)clientID scopes:(NSArray *)scopes {
   self = [super init];
   if (self) {
     _clientID = [clientID copy];
-    _scopes = @[ @"email", @"profile" ];
+    _scopes = [scopes copy];
   }
   return self;
 }

FirebaseUI/Auth/AuthProviderUI/Google/Source/FIRGoogleAuthUI.m

@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.XIB" version="3.0" toolsVersion="10116" systemVersion="15D21" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.XIB" version="3.0" toolsVersion="10117" systemVersion="15G31" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES">
     <dependencies>
-        <deployment identifier="iOS"/>
         <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="10085"/>
     </dependencies>
     <objects>

FirebaseUI/Auth/AuthUI/Source/FIRAuthPickerViewController.xib

@@ -67,7 +67,7 @@ typedef void (^FIRAuthUIResultCallback)(FIRUser *_Nullable user, NSError *_Nulla
     @brief Gets the @c FIRAuthUI object for the default FirebaseApp.
     @remarks Thread safe.
  */
-+ (nullable FIRAuthUI *)authUI NS_SWIFT_NAME(authUI());
++ (nullable FIRAuthUI *)defaultAuthUI;
 
 /** @fn authUIWithAuth:
     @brief Gets the @c FIRAuthUI instance for a @c FIRAuth.

FirebaseUI/Auth/AuthUI/Source/FIRAuthUI.h

@@ -45,7 +45,7 @@ - (nullable instancetype)initWithAuth:(FIRAuth *)auth NS_DESIGNATED_INITIALIZER;
 
 @implementation FIRAuthUI
 
-+ (nullable FIRAuthUI *)authUI {
++ (nullable FIRAuthUI *)defaultAuthUI {
   FIRAuth *defaultAuth = [FIRAuth auth];
   if (!defaultAuth) {
     return nil;
@@ -54,6 +54,7 @@ + (nullable FIRAuthUI *)authUI {
 }
 
 + (nullable FIRAuthUI *)authUIWithAuth:(FIRAuth *)auth {
+  NSParameterAssert(auth != nil);
   @synchronized (self) {
     // Let the FIRAuth instance retain the FIRAuthUI instance.
     FIRAuthUI *authUI = objc_getAssociatedObject(auth, &kAuthAssociationKey);
@@ -66,7 +67,7 @@ + (nullable FIRAuthUI *)authUIWithAuth:(FIRAuth *)auth {
   }
 }
 
-- (nullable instancetype)initWithAuth:(FIRAuth *)auth {
+- (instancetype)initWithAuth:(FIRAuth *)auth {
   self = [super init];
   if (self) {
     _auth = auth;

FirebaseUI/Auth/AuthUI/Source/FIRAuthUI.m

@@ -75,7 +75,7 @@ @implementation FIRAuthUIStrings
     @return Localized value of the string identified by the key.
  */
 + (NSString *)localizedStringForKey:(nonnull NSString *)key {
-  NSBundle *customStringsBundle = [FIRAuthUI authUI].customStringsBundle;
+  NSBundle *customStringsBundle = [FIRAuthUI defaultAuthUI].customStringsBundle;
   if (customStringsBundle) {
     NSString *localizedString = [customStringsBundle localizedStringForKey:key
                                                                      value:kKeyNotFound

FirebaseUI/Auth/AuthUI/Source/FIRAuthUIStrings.m

@@ -18,15 +18,25 @@
 
 // clang-format on
 
-#import <Foundation/Foundation.h>
+@import Firebase;
 
 #import "FirebaseArrayDelegate.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
-@class FIRDatabaseQuery;
-@class FIRDatabaseReference;
-@class FIRDataSnapshot;
+@protocol FIRDataObservable
+@required
+
+- (FIRDatabaseHandle)observeEventType:(FIRDataEventType)eventType
+       andPreviousSiblingKeyWithBlock:(void (^)(FIRDataSnapshot *snapshot, NSString *__nullable prevKey))block
+                      withCancelBlock:(nullable void (^)(NSError* error))cancelBlock;
+
+- (void)removeObserverWithHandle:(FIRDatabaseHandle)handle;
+
+@end
+
+@interface FIRDatabaseQuery (FIRDataObservable) <FIRDataObservable>
+@end
 
 /**
  * FirebaseArray provides an array structure that is synchronized with a Firebase reference or
@@ -39,43 +49,36 @@ NS_ASSUME_NONNULL_BEGIN
  * The delegate object that array changes are surfaced to, which conforms to the
  * [FirebaseArrayDelegate Protocol](FirebaseArrayDelegate).
  */
-@property(weak, nonatomic) id<FirebaseArrayDelegate> delegate;
+@property(weak, nonatomic, nullable) id<FirebaseArrayDelegate> delegate;
 
 /**
  * The query on a Firebase reference that provides data to populate the instance of FirebaseArray.
  */
-@property(strong, nonatomic) FIRDatabaseQuery *query;
+@property(strong, nonatomic) id<FIRDataObservable> query;
 
 /**
- * The delegate object that array changes are surfaced to.
+ * The number of objects in the FirebaseArray.
  */
-@property(strong, nonatomic) NSMutableArray<FIRDataSnapshot *> * snapshots;
-
-#pragma mark -
-#pragma mark Initializer methods
+@property(nonatomic, readonly) NSUInteger count;
 
 /**
- * Intitalizes FirebaseArray with a standard Firebase reference.
- * @param ref The Firebase reference which provides data to FirebaseArray
- * @return The instance of FirebaseArray
+ * The items currently in the FirebaseArray.
  */
-- (instancetype)initWithRef:(FIRDatabaseReference *)ref;
+@property(nonatomic, readonly, copy) NSArray *items;
+
+#pragma mark - Initializer methods
 
 /**
- * Intitalizes FirebaseArray with a Firebase query (FIRDatabaseQuery).
- * @param query A query on a Firebase reference which provides filtered data to FirebaseArray
- * @return The instance of FirebaseArray
+ * Initalizes FirebaseArray with a Firebase query (FIRDatabaseQuery) or database reference
+ * (FIRDatabaseReference).
+ * @param query A query or Firebase database reference
+ * @return A FirebaseArray instance
  */
-- (instancetype)initWithQuery:(FIRDatabaseQuery *)query;
+- (instancetype)initWithQuery:(id<FIRDataObservable>)query NS_DESIGNATED_INITIALIZER;
 
-#pragma mark -
-#pragma mark Public API methods
+- (instancetype)init NS_UNAVAILABLE;
 
-/**
- * Returns the count of objects in the FirebaseArray.
- * @return The count of objects in the FirebaseArray
- */
-- (NSUInteger)count;
+#pragma mark - Public API methods
 
 /**
  * Returns an object at a specific index in the FirebaseArray.
@@ -100,21 +103,16 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * Support for subscripting. This method is unused and trying to write directly to the
- * array using subscripting will cause an assertion.
+ * array using subscripting will cause an assertion failure.
  */
-- (void)setObject:(id)obj atIndexedSubscript:(NSUInteger)idx;
-
-#pragma mark -
-#pragma mark Private API methods
+- (void)setObject:(id)obj atIndexedSubscript:(NSUInteger)idx NS_UNAVAILABLE;
 
 /**
  * Returns an index for a given object's key (that matches the object's key in the corresponding
  * Firebase reference).
  * @param key The key of the desired object
- * @return The index of the object for which the key matches or -1 if the key is null
- * @exception FirebaseArrayKeyNotFoundException Thrown when the desired key is not in the
- * FirebaseArray, likely indicating that the FirebaseArray is no longer being properly synchronized
- * with the Firebase database.
+ * @return The index of the object for which the key matches or NSNotFound if the key is not found
+ * @exception NSInvalidArgumentException Thrown when the `key` parameter is `nil`.
  */
 - (NSUInteger)indexForKey:(NSString *)key;