refactor FirebaseUI Auth class names

Author: yramanchuk

FirebaseAuthUI/FIRAuthUI.h renamed to FirebaseAuthUI/FUIAuth.h

@@ -16,130 +16,130 @@
 
 #import <UIKit/UIKit.h>
 
-#import "FIRAuthProviderUI.h"
+#import "FUIAuthProvider.h"
 
 @class FIRAuth;
-@class FIRAuthPickerViewController;
-@class FIRAuthUI;
+@class FUIAuthPickerViewController;
+@class FUIAuth;
 @class FIRUser;
-@class FIREmailEntryViewController;
-@class FIRPasswordSignInViewController;
-@class FIRPasswordSignUpViewController;
-@class FIRPasswordRecoveryViewController;
-@class FIRPasswordVerificationViewController;
+@class FUIEmailEntryViewController;
+@class FUIPasswordSignInViewController;
+@class FUIPasswordSignUpViewController;
+@class FUIPasswordRecoveryViewController;
+@class FUIPasswordVerificationViewController;
 
 NS_ASSUME_NONNULL_BEGIN
 
-/** @typedef FIRAuthUIResultCallback
+/** @typedef FUIAuthResultCallback
     @brief The type of block invoked when sign-in related events complete.
     @param user The user signed in, if any.
     @param error The error which occurred, if any.
  */
-typedef void (^FIRAuthUIResultCallback)(FIRUser *_Nullable user, NSError *_Nullable error);
+typedef void (^FUIAuthResultCallback)(FIRUser *_Nullable user, NSError *_Nullable error);
 
-/** @protocol FIRAuthUIDelegate
-    @brief A delegate that receives callbacks or provides custom UI for @c FIRAuthUI.
+/** @protocol FUIAuthDelegate
+    @brief A delegate that receives callbacks or provides custom UI for @c FUIAuth.
  */
-@protocol FIRAuthUIDelegate <NSObject>
+@protocol FUIAuthDelegate <NSObject>
 
 /** @fn authUI:didSignInWithUser:error:
     @brief Message sent after the sign in process has completed to report the signed in user or
         error encountered.
-    @param authUI The @c FIRAuthUI instance sending the messsage.
+    @param authUI The @c FUIAuth instance sending the messsage.
     @param user The signed in user if the sign in attempt was successful.
     @param error The error that occured during sign in, if any.
  */
-- (void)authUI:(FIRAuthUI *)authUI didSignInWithUser:(nullable FIRUser *)user error:(nullable NSError *)error;
+- (void)authUI:(FUIAuth *)authUI didSignInWithUser:(nullable FIRUser *)user error:(nullable NSError *)error;
 
 @optional
 
 /** @fn authPickerViewControllerForAuthUI:
-    @brief Sent to the receiver to ask for an instance of @c FIRAuthPickerViewController subclass
+    @brief Sent to the receiver to ask for an instance of @c FUIAuthPickerViewController subclass
         to allow UI customizations.
-    @param authUI The @c FIRAuthUI instance sending the message.
-    @return an instance of @c FIRAuthPickerViewController subclass.
+    @param authUI The @c FUIAuth instance sending the message.
+    @return an instance of @c FUIAuthPickerViewController subclass.
  */
-- (FIRAuthPickerViewController *)authPickerViewControllerForAuthUI:(FIRAuthUI *)authUI;
+- (FUIAuthPickerViewController *)authPickerViewControllerForAuthUI:(FUIAuth *)authUI;
 
 /** @fn emailEntryViewControllerForAuthUI:
-    @brief Sent to the receiver to ask for an instance of @c FIREmailEntryViewController subclass
+    @brief Sent to the receiver to ask for an instance of @c FUIEmailEntryViewController subclass
     to allow UI customizations.
-    @param authUI The @c FIRAuthUI instance sending the message.
-    @return an instance of @c FIREmailEntryViewController subclass.
+    @param authUI The @c FUIAuth instance sending the message.
+    @return an instance of @c FUIEmailEntryViewController subclass.
  */
-- (FIREmailEntryViewController *)emailEntryViewControllerForAuthUI:(FIRAuthUI *)authUI;
+- (FUIEmailEntryViewController *)emailEntryViewControllerForAuthUI:(FUIAuth *)authUI;
 
 /** @fn passwordSignInViewControllerForAuthUI:email:
-    @brief Sent to the receiver to ask for an instance of @c FIRPasswordSignInViewController subclass
+    @brief Sent to the receiver to ask for an instance of @c FUIPasswordSignInViewController subclass
     to allow sign-in UI customizations.
-    @param authUI The @c FIRAuthUI instance sending the message.
+    @param authUI The @c FUIAuth instance sending the message.
     @param email The email user is using for sin-in.
-    @return an instance of @c FIRPasswordSignInViewController subclass.
+    @return an instance of @c FUIPasswordSignInViewController subclass.
  */
-- (FIRPasswordSignInViewController *)passwordSignInViewControllerForAuthUI:(FIRAuthUI *)authUI
+- (FUIPasswordSignInViewController *)passwordSignInViewControllerForAuthUI:(FUIAuth *)authUI
                                                                      email:(NSString *)email;
 
 /** @fn passwordSignInViewControllerForAuthUI:email:
-    @brief Sent to the receiver to ask for an instance of @c FIRPasswordSignUpViewController subclass
+    @brief Sent to the receiver to ask for an instance of @c FUIPasswordSignUpViewController subclass
     to allow sign-up UI customizations.
-    @param authUI The @c FIRAuthUI instance sending the message.
+    @param authUI The @c FUIAuth instance sending the message.
     @param email The email user is using for sin-in.
-    @return an instance of @c FIRPasswordSignUpViewController subclass.
+    @return an instance of @c FUIPasswordSignUpViewController subclass.
  */
-- (FIRPasswordSignUpViewController *)passwordSignUpViewControllerForAuthUI:(FIRAuthUI *)authUI
+- (FUIPasswordSignUpViewController *)passwordSignUpViewControllerForAuthUI:(FUIAuth *)authUI
                                                                      email:(NSString *)email;
 
 /** @fn passwordRecoveryViewControllerForAuthUI:email:
-    @brief Sent to the receiver to ask for an instance of @c FIRPasswordRecoveryViewController subclass
+    @brief Sent to the receiver to ask for an instance of @c FUIPasswordRecoveryViewController subclass
     to allow sign-up UI customizations.
-    @param authUI The @c FIRAuthUI instance sending the message.
+    @param authUI The @c FUIAuth instance sending the message.
     @param email The email user is using for password recovery.
-    @return an instance of @c FIRPasswordRecoveryViewController subclass.
+    @return an instance of @c FUIPasswordRecoveryViewController subclass.
  */
-- (FIRPasswordRecoveryViewController *)passwordRecoveryViewControllerForAuthUI:(FIRAuthUI *)authUI
+- (FUIPasswordRecoveryViewController *)passwordRecoveryViewControllerForAuthUI:(FUIAuth *)authUI
                                                                          email:(NSString *)email;
 
 /** @fn passwordVerificationViewControllerForAuthUI:email:newCredential:
-    @brief Sent to the receiver to ask for an instance of @c FIRPasswordVerificationViewController subclass
+    @brief Sent to the receiver to ask for an instance of @c FUIPasswordVerificationViewController subclass
     to allow password verification UI customizations.
-    @param authUI The @c FIRAuthUI instance sending the message.
+    @param authUI The @c FUIAuth instance sending the message.
     @param email The email user is using for sin-in.
     @param newCredential This @c FIRAuthCredential obtained from linked account.
-    @return an instance of @c FIRPasswordVerificationViewController subclass.
+    @return an instance of @c FUIPasswordVerificationViewController subclass.
  */
-- (FIRPasswordVerificationViewController *)passwordVerificationViewControllerForAuthUI:(FIRAuthUI *)authUI
+- (FUIPasswordVerificationViewController *)passwordVerificationViewControllerForAuthUI:(FUIAuth *)authUI
                                                                                  email:(NSString *)email
                                                                          newCredential:(FIRAuthCredential *)newCredential;
 @end
 
-/** @class FIRAuthUI
+/** @class FUIAuth
     @brief Provides various iOS UIs for Firebase Auth.
  */
-@interface FIRAuthUI : NSObject <NSSecureCoding>
+@interface FUIAuth : NSObject <NSSecureCoding>
 
 /** @fn defaultAuthUI
-    @brief Gets the @c FIRAuthUI object for the default FirebaseApp.
+    @brief Gets the @c FUIAuth object for the default FirebaseApp.
     @remarks Thread safe.
  */
-+ (nullable FIRAuthUI *)defaultAuthUI;
++ (nullable FUIAuth *)defaultAuthUI;
 
 /** @fn authUIWithAuth:
-    @brief Gets the @c FIRAuthUI instance for a @c FIRAuth.
-    @param auth The @c FIRAuth for which to retrieve the associated @c FIRAuthUI instance.
-    @return The @c FIRAuthUI instance associated with the given @c FIRAuth.
+    @brief Gets the @c FUIAuth instance for a @c FIRAuth.
+    @param auth The @c FIRAuth for which to retrieve the associated @c FUIAuth instance.
+    @return The @c FUIAuth instance associated with the given @c FIRAuth.
     @remarks Thread safe.
  */
-+ (nullable FIRAuthUI *)authUIWithAuth:(FIRAuth *)auth;
++ (nullable FUIAuth *)authUIWithAuth:(FIRAuth *)auth;
 
 /** @property app
     @brief Gets the @c FIRAuth this auth UI object is connected to.
  */
 @property(nonatomic, weak, readonly, nullable) FIRAuth *auth;
 
 /** @property providers
-    @brief The @c FIRAuthProviderUI implementations to use for sign-in.
+    @brief The @c FUIAuthProvider implementations to use for sign-in.
  */
-@property(nonatomic, copy) NSArray<id<FIRAuthProviderUI>> *providers;
+@property(nonatomic, copy) NSArray<id<FUIAuthProvider>> *providers;
 
 /** @property signInWithEmailHidden
     @brief Whether to hide the "Sign in with email" option, defaults to NO.
@@ -161,12 +161,12 @@ typedef void (^FIRAuthUIResultCallback)(FIRUser *_Nullable user, NSError *_Nulla
 @property(nonatomic, copy, nullable) NSURL *TOSURL;
 
 /** @property delegate
-    @brief A delegate that receives callbacks or provides custom UI for @c FIRAuthUI.
+    @brief A delegate that receives callbacks or provides custom UI for @c FUIAuth.
  */
-@property(nonatomic, weak) id<FIRAuthUIDelegate> delegate;
+@property(nonatomic, weak) id<FUIAuthDelegate> delegate;
 
 /** @fn init
-    @brief Please use @c FIRAuthUI.authUIWithAuth to get a @c FIRAuthUI instance.
+    @brief Please use @c FUIAuth.authUIWithAuth to get a @c FUIAuth instance.
  */
 - (nullable instancetype)init NS_UNAVAILABLE;
 

FirebaseAuthUI/FIRAuthUI.m renamed to FirebaseAuthUI/FUIAuth.m

@@ -14,53 +14,53 @@
 //  limitations under the License.
 //
 
-#import "FIRAuthUI.h"
+#import "FUIAuth.h"
 
 #import <objc/runtime.h>
 
 #import <FirebaseAnalytics/FIRApp.h>
 #import <FirebaseAuth/FIRAuth.h>
-#import "FIRAuthPickerViewController.h"
-#import "FIRAuthUI_Internal.h"
-#import "FIREmailEntryViewController.h"
+#import "FUIAuthPickerViewController.h"
+#import "FUIAuth_Internal.h"
+#import "FUIEmailEntryViewController.h"
 
 /** @var kAppNameCodingKey
     @brief The key used to encode the app Name for NSCoding.
  */
 static NSString *const kAppNameCodingKey = @"appName";
 
 /** @var kAuthAssociationKey
-    @brief The address of this variable is used as the key for associating FIRAuthUI instances with
+    @brief The address of this variable is used as the key for associating FUIAuth instances with
         root FIRAuth objects.
  */
 static const char kAuthAssociationKey;
 
-@interface FIRAuthUI ()
+@interface FUIAuth ()
 
 /** @fn initWithAuth:
-    @brief auth The @c FIRAuth to associate the @c FIRAuthUI instance with.
+    @brief auth The @c FIRAuth to associate the @c FUIAuth instance with.
  */
 - (nullable instancetype)initWithAuth:(FIRAuth *)auth NS_DESIGNATED_INITIALIZER;
 
 @end
 
-@implementation FIRAuthUI
+@implementation FUIAuth
 
-+ (nullable FIRAuthUI *)defaultAuthUI {
++ (nullable FUIAuth *)defaultAuthUI {
   FIRAuth *defaultAuth = [FIRAuth auth];
   if (!defaultAuth) {
     return nil;
   }
   return [self authUIWithAuth:defaultAuth];
 }
 
-+ (nullable FIRAuthUI *)authUIWithAuth:(FIRAuth *)auth {
++ (nullable FUIAuth *)authUIWithAuth:(FIRAuth *)auth {
   NSParameterAssert(auth != nil);
   @synchronized (self) {
-    // Let the FIRAuth instance retain the FIRAuthUI instance.
-    FIRAuthUI *authUI = objc_getAssociatedObject(auth, &kAuthAssociationKey);
+    // Let the FIRAuth instance retain the FUIAuth instance.
+    FUIAuth *authUI = objc_getAssociatedObject(auth, &kAuthAssociationKey);
     if (!authUI) {
-      authUI = [[FIRAuthUI alloc] initWithAuth:auth];
+      authUI = [[FUIAuth alloc] initWithAuth:auth];
       objc_setAssociatedObject(auth, &kAuthAssociationKey, authUI,
           OBJC_ASSOCIATION_RETAIN_NONATOMIC);
     }
@@ -79,7 +79,7 @@ - (instancetype)initWithAuth:(FIRAuth *)auth {
 - (BOOL)handleOpenURL:(NSURL *)URL
     sourceApplication:(NSString *)sourceApplication {
   // Complete IDP-based sign-in flow.
-  for (id<FIRAuthProviderUI> provider in _providers) {
+  for (id<FUIAuthProvider> provider in _providers) {
     if ([provider handleOpenURL:URL sourceApplication:sourceApplication]) {
       return YES;
     }
@@ -95,12 +95,12 @@ - (UINavigationController *)authViewController {
     if ([self.delegate respondsToSelector:@selector(emailEntryViewControllerForAuthUI:)]) {
       controller = [self.delegate emailEntryViewControllerForAuthUI:self];
     } else {
-      controller = [[FIREmailEntryViewController alloc] initWithAuthUI:self];
+      controller = [[FUIEmailEntryViewController alloc] initWithAuthUI:self];
     }
   } else if ([self.delegate respondsToSelector:@selector(authPickerViewControllerForAuthUI:)]) {
     controller = [self.delegate authPickerViewControllerForAuthUI:self];
   } else {
-    controller = [[FIRAuthPickerViewController alloc] initWithAuthUI:self];
+    controller = [[FUIAuthPickerViewController alloc] initWithAuthUI:self];
   }
   return [[UINavigationController alloc] initWithRootViewController:controller];
 }
@@ -110,7 +110,7 @@ - (BOOL)signOutWithError:(NSError *_Nullable *_Nullable)error {
   BOOL success = [self.auth signOut:error];
   if (success) {
     // sign out from all providers (wipes provider tokens too)
-    for (id<FIRAuthProviderUI> provider in _providers) {
+    for (id<FUIAuthProvider> provider in _providers) {
       [provider signOut];
     }
   }

FirebaseAuthUI/FIRAuthUIBaseViewController.h renamed to FirebaseAuthUI/FUIAuthBaseViewController.h

@@ -17,30 +17,30 @@
 #import <UIKit/UIKit.h>
 
 @class FIRAuth;
-@class FIRAuthUI;
-@protocol FIRAuthProviderUI;
+@class FUIAuth;
+@protocol FUIAuthProvider;
 
 NS_ASSUME_NONNULL_BEGIN
 
-/** @typedef FIRAuthUIAlertActionHandler
+/** @typedef FUIAuthAlertActionHandler
     @brief The type of block called when an alert view is dismissed by a user action.
  */
-typedef void (^FIRAuthUIAlertActionHandler)(void);
+typedef void (^FUIAuthAlertActionHandler)(void);
 
-/** @class FIRAuthUIBaseViewController
+/** @class FUIAuthBaseViewController
     @brief The base view controller that provides common methods for all subclasses.
  */
-@interface FIRAuthUIBaseViewController : UIViewController
+@interface FUIAuthBaseViewController : UIViewController
 
 /** @property auth
     @brief The @c FIRAuth instance of the application.
  */
 @property(nonatomic, strong, readonly) FIRAuth *auth;
 
 /** @property authUI
-    @brief The @c FIRAuth instance of the application.
+    @brief The @c FUIAuth instance of the application.
  */
-@property(nonatomic, strong, readonly) FIRAuthUI *authUI;
+@property(nonatomic, strong, readonly) FUIAuth *authUI;
 
 /** @fn init
     @brief Please use @c initWithNibName:bundle:authUI:.
@@ -62,17 +62,17 @@ typedef void (^FIRAuthUIAlertActionHandler)(void);
     @brief Designated initializer.
     @param nibNameOrNil The name of the nib file to associate with the view controller.
     @param nibBundleOrNil The bundle in which to search for the nib file.
-    @param authUI The @c FIRAuthUI instance that manages this view controller.
+    @param authUI The @c FUIAuth instance that manages this view controller.
  */
 - (instancetype)initWithNibName:(nullable NSString *)nibNameOrNil
                          bundle:(nullable NSBundle *)nibBundleOrNil
-                         authUI:(FIRAuthUI *)authUI NS_DESIGNATED_INITIALIZER;
+                         authUI:(FUIAuth *)authUI NS_DESIGNATED_INITIALIZER;
 
 /** @fn initWithAuthUI:
     @brief Convenience initializer.
-    @param authUI The @c FIRAuthUI instance that manages this view controller.
+    @param authUI The @c FUIAuth instance that manages this view controller.
  */
-- (instancetype)initWithAuthUI:(FIRAuthUI *)authUI;
+- (instancetype)initWithAuthUI:(FUIAuth *)authUI;
 
 /** @fn isValidEmail:
     @brief Statically validates email address.
@@ -94,8 +94,8 @@ typedef void (^FIRAuthUIAlertActionHandler)(void);
     @param handler Handler for the sign in action of the alert.
  */
 - (void)showSignInAlertWithEmail:(NSString *)email
-                        provider:(id<FIRAuthProviderUI>)provider
-                         handler:(FIRAuthUIAlertActionHandler)handler;
+                        provider:(id<FUIAuthProvider>)provider
+                         handler:(FUIAuthAlertActionHandler)handler;
 
 /** @fn pushViewController:
     @brief Push the view controller to the navigation controller of the current view controller