Merge pull request #959 from firebase/firebase-8

Fix bundle resource loading for dynamic frameworks

FirebaseAnonymousAuthUI.podspec

@@ -9,7 +9,6 @@ Pod::Spec.new do |s|
   s.platform = :ios
   s.ios.deployment_target = '10.0'
   s.ios.framework = 'UIKit'
-  s.static_framework = true
   s.requires_arc = true
   s.cocoapods_version = '>= 1.8.0'
   s.pod_target_xcconfig = {
@@ -21,7 +20,7 @@ Pod::Spec.new do |s|
   s.dependency 'FirebaseAuthUI'
   s.dependency 'FirebaseAuth', '~> 8.0'
   s.dependency 'FirebaseCore'
-  s.resource_bundle = {
+  s.resource_bundles = {
     'FirebaseAnonymousAuthUI' => [
       'FirebaseAnonymousAuthUI/Sources/{Resources,Strings}/*.{png,lproj}'
     ]

FirebaseAnonymousAuthUI/FirebaseAnonymousAuthUITests/FirebaseAnonymousAuthUITests.m

@@ -30,10 +30,6 @@ @implementation FirebaseAnonymousAuthUITests
 
 - (void)setUp {
   [super setUp];
-
-  id mockUtilsClass = OCMClassMock([FUIAuthUtils class]);
-  OCMStub(ClassMethod([mockUtilsClass bundleNamed:OCMOCK_ANY])).
-      andReturn([NSBundle bundleForClass:[FUIAnonymousAuth class]]);
 
   id authUIClass = OCMClassMock([FUIAuth class]);
   OCMStub(ClassMethod([authUIClass authUIWithAuth:OCMOCK_ANY])).

FirebaseAnonymousAuthUI/Sources/FUIAnonymousAuth.m

@@ -49,6 +49,11 @@ @implementation FUIAnonymousAuth {
   UIViewController *_presentingViewController;
 }
 
++ (NSBundle *)bundle {
+  return [FUIAuthUtils bundleNamed:kBundleName
+                 inFrameworkBundle:[NSBundle bundleForClass:[self class]]];
+}
+
 - (instancetype)init {
   return [self initWithAuthUI:[FUIAuth defaultAuthUI]];
 }
@@ -85,11 +90,13 @@ - (NSString *)shortName {
 }
 
 - (NSString *)signInLabel {
-  return FUILocalizedStringFromTableInBundle(kSignInAsGuest, kTableName, kBundleName);
+  return FUILocalizedStringFromTableInBundle(kSignInAsGuest,
+                                             kTableName,
+                                             [FUIAnonymousAuth bundle]);
 }
 
 - (UIImage *)icon {
-  return [FUIAuthUtils imageNamed:@"ic_anonymous" fromBundleNameOrNil:kBundleName];
+  return [FUIAuthUtils imageNamed:@"ic_anonymous" fromBundle:[FUIAnonymousAuth bundle]];
 }
 
 - (UIColor *)buttonBackgroundColor {

FirebaseAnonymousAuthUI/Sources/Public/FirebaseAnonymousAuthUI/FUIAnonymousAuth.h

@@ -28,6 +28,11 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property(nonatomic, readwrite) FUIButtonAlignment buttonAlignment;
 
+/** @fn bundle
+    @brief Returns the FirebaseAnonymousAuthUI resource bundle.
+ */
++ (NSBundle *)bundle;
+
 /** @fn init
     @brief Initialize the instance with the default AuthUI. 
  */

FirebaseAuthUI.podspec

@@ -21,7 +21,7 @@ Pod::Spec.new do |s|
   s.dependency 'FirebaseAuth'
   s.dependency 'FirebaseCore'
   s.dependency 'GoogleUtilities/UserDefaults'
-  s.resource_bundle = {
+  s.resource_bundles = {
     'FirebaseAuthUI' => ['FirebaseAuthUI/Sources/{Resources,Strings}/*.{xib,png,lproj}']
   }
 

FirebaseAuthUI/Sources/FUIAuthBaseViewController.m

@@ -87,7 +87,7 @@ - (instancetype)initWithNibName:(NSString *)nibNameOrNil
 
 - (instancetype)initWithAuthUI:(FUIAuth *)authUI {
   return [self initWithNibName:NSStringFromClass([self class])
-                        bundle:[FUIAuthUtils bundleNamed:FUIAuthBundleName]
+                        bundle:[FUIAuthUtils authUIBundle]
                         authUI:authUI];
 }
 

FirebaseAuthUI/Sources/FUIAuthPickerViewController.m

@@ -73,7 +73,7 @@ @implementation FUIAuthPickerViewController {
 
 - (instancetype)initWithAuthUI:(FUIAuth *)authUI {
   return [self initWithNibName:@"FUIAuthPickerViewController"
-                        bundle:[FUIAuthUtils bundleNamed:FUIAuthBundleName]
+                        bundle:[FUIAuthUtils authUIBundle]
                         authUI:authUI];
 }
 

FirebaseAuthUI/Sources/FUIAuthStrings.m

@@ -130,12 +130,12 @@
 }
 
 NSString *FUILocalizedStringFromTable(NSString *key, NSString *table) {
-  return FUILocalizedStringFromTableInBundle(key, table, FUIAuthBundleName);
+  return FUILocalizedStringFromTableInBundle(key, table, [FUIAuthUtils authUIBundle]);
 }
 
 NSString *FUILocalizedStringFromTableInBundle(NSString *key,
                                               NSString *table,
-                                              NSString *_Nullable bundleName) {
+                                              NSBundle *_Nullable bundle) {
   // Don't load defaultAuthUI if the default app isn't configured. We don't recommend
   // people do this in our docs, but if for whatever reason they want to use a custom
   // app, this code shouldn't crash.
@@ -150,11 +150,10 @@
       }
     }
   }
-  NSBundle *frameworkBundle = [FUIAuthUtils bundleNamed:bundleName];
-  if (frameworkBundle == nil) {
-    frameworkBundle = [NSBundle mainBundle];
+  if (bundle == nil) {
+    bundle = [NSBundle mainBundle];
   }
-  return [frameworkBundle localizedStringForKey:key value:nil table:table];
+  return [bundle localizedStringForKey:key value:nil table:table];
 }
 
 NS_ASSUME_NONNULL_END

FirebaseAuthUI/Sources/FUIAuthUtils.m

@@ -24,40 +24,53 @@
 
 @implementation FUIAuthUtils
 
-+ (nullable NSBundle *)bundleNamed:(nullable NSString *)bundleName {
-  NSBundle *frameworkBundle = nil;
++ (NSBundle *)authUIBundle {
+  return [self bundleNamed:FUIAuthBundleName
+         inFrameworkBundle:[NSBundle bundleForClass:[self class]]];
+}
+
++ (nullable NSBundle *)bundleNamed:(nullable NSString *)bundleName
+                 inFrameworkBundle:(nullable NSBundle *)framework {
+  NSBundle *returnBundle = nil;
   if (!bundleName) {
     bundleName = FUIAuthBundleName;
   }
+  // Use the main bundle as a default if the framework wasn't provided.
+  NSBundle *frameworkBundle = framework;
+  if (frameworkBundle == nil) {
+    // If frameworkBundle is unspecified, assume main bundle/static linking.
+    frameworkBundle = [NSBundle mainBundle];
+  }
+  // If using static frameworks, the bundle will be included directly in the main
+  // bundle.
   NSString *path = [[NSBundle mainBundle] pathForResource:bundleName ofType:@"bundle"];
+
+  // Otherwise, check the appropriate framework bundle.
   if (!path) {
-    // Check framework resources if bundle isn't present in main bundle.
-    path = [[NSBundle mainBundle] pathForResource:bundleName ofType:@"framework"];
+    path = [frameworkBundle pathForResource:bundleName ofType:@"bundle"];
   }
-  frameworkBundle = [NSBundle bundleWithPath:path];
-  if (!frameworkBundle) {
-    frameworkBundle = [NSBundle bundleForClass:[self class]];
+  if (!path) {
+    NSLog(@"Warning: Unable to find bundle %@ in framework %@.", bundleName, framework);
+    // Fall back on the root module.
+    return frameworkBundle;
   }
-  return frameworkBundle;
+  returnBundle = [NSBundle bundleWithPath:path];
+  return returnBundle;
 }
 
 + (nullable UIImage *)imageNamed:(NSString *)name fromBundle:(nullable NSBundle *)bundle {
   if (!bundle) {
-    bundle = [self bundleNamed:nil];
+    bundle = [self authUIBundle];
   }
   NSString *path = [bundle pathForResource:name ofType:@"png"];
   if (!path) {
     NSLog(@"Warning: Unable to find asset %@ in bundle %@.", name, bundle);
   }
-  return [UIImage imageWithContentsOfFile:path];
-}
-
-+ (nullable UIImage *)imageNamed:(NSString *)name fromBundleNameOrNil:(nullable NSString *)bundleNameOrNil {
-  NSString *path = [[FUIAuthUtils bundleNamed:bundleNameOrNil] pathForResource:name ofType:@"png"];
-  if (!path) {
-    NSLog(@"Warning: Unable to find asset %@ in bundle named %@.", name, bundleNameOrNil);
+  if (@available(iOS 13.0, *)) {
+    return [UIImage imageNamed:name inBundle:bundle withConfiguration:nil];
+  } else {
+    return [UIImage imageWithContentsOfFile:path];
   }
-  return [UIImage imageWithContentsOfFile:path];
 }
 
 @end

FirebaseAuthUI/Sources/FUIStaticContentTableViewController.m

@@ -68,7 +68,7 @@ - (instancetype)initWithContents:(nullable FUIStaticContentTableViewContent *)co
                       footerText:(nullable NSString *)footerText
                     footerAction:(nullable FUIStaticContentTableViewCellAction)footerAction {
   if (self = [super initWithNibName:NSStringFromClass([self class])
-                             bundle:[FUIAuthUtils bundleNamed:FUIAuthBundleName]
+                             bundle:[FUIAuthUtils authUIBundle]
                              authUI:[FUIAuth defaultAuthUI]]) {
     _tableViewManager.contents = contents;
     _nextAction = [nextAction copy];

FirebaseAuthUI/Sources/FUIStaticContentTableViewManager.m

@@ -64,11 +64,11 @@ - (void)setTableView:(nullable UITableView *)tableView {
   [tableView registerClass:[UITableViewCell class] forCellReuseIdentifier:kCellReuseIdentitfier];
 
   UINib *passwordCellNib = [UINib nibWithNibName:NSStringFromClass([FUIPasswordTableViewCell class])
-                                          bundle:[FUIAuthUtils bundleNamed:FUIAuthBundleName]];
+                                          bundle:[FUIAuthUtils authUIBundle]];
   [tableView registerNib:passwordCellNib forCellReuseIdentifier:kPasswordCellReuseIdentitfier];
 
   UINib *inputCellNib = [UINib nibWithNibName:NSStringFromClass([FUIInputTableViewCell class])
-                                       bundle:[FUIAuthUtils bundleNamed:FUIAuthBundleName]];
+                                       bundle:[FUIAuthUtils authUIBundle]];
   [tableView registerNib:inputCellNib forCellReuseIdentifier:kInputCellReuseIdentitfier];
 }
 

FirebaseAuthUI/Sources/Public/FirebaseAuthUI/FUIAuthStrings.h

@@ -133,12 +133,12 @@ NSString *FUILocalizedStringFromTable(NSString *key, NSString *table);
     @brief Gets a localized string from a name.
     @param key The key value of the string.
     @param table The localization table name.
-    @param bundleName The value of bundlu to look for. If nil is passed looking in apps bundle.
+    @param bundle The bundle containing the strings. If nil is provided, this function searches the main app bundle.
     @return The string by the key localized in the current locale.
 */
 NSString *FUILocalizedStringFromTableInBundle(NSString *key,
                                               NSString *table,
-                                              NSString *_Nullable bundleName);
+                                              NSBundle *_Nullable bundle);
 
 #ifdef __cplusplus
 }

FirebaseAuthUI/Sources/Public/FirebaseAuthUI/FUIAuthUtils.h

@@ -28,26 +28,22 @@ extern NSString *const FUIAuthBundleName;
 
 - (instancetype)init NS_UNAVAILABLE;
 
++ (NSBundle *)authUIBundle;
+
 /** @fn bundleNamed:
     @brief Gets the framework bundle for specified name
     @param bundleName Name of the bundle to retreive. If nil, this returns the default bundle for
         FirebaseUI.
+    @param framework The name of the framework module the resource bundle should be present in.
  */
-+ (nullable NSBundle *)bundleNamed:(nullable NSString *)bundleName;
-
-/** @fn imageNamed:fromBundle:
-    @brief Gets a UIImage with the given name, assuming it's a png.
-    @param name Name of the image to retreive.
-    @param bundleNameOrNil Name of the bundle to retreive. If nil, this method will look into the
-        default FirebaseUI framework bundle.
- */
-+ (nullable UIImage *)imageNamed:(NSString *)name fromBundleNameOrNil:(nullable NSString *)bundleNameOrNil;
++ (nullable NSBundle *)bundleNamed:(nullable NSString *)bundleName
+                 inFrameworkBundle:(nullable NSBundle *)framework;
 
 /** @fn imageNamed:fromBundle:
  @brief Gets a UIImage with the given name, assuming it's a png.
  @param name Name of the image to retreive.
  @param bundle The bundle to retrieve the image from. If nil, this method will look into the
-     default FirebaseUI framework bundle.
+     default FirebaseAuthUI framework bundle.
  */
 + (nullable UIImage *)imageNamed:(NSString *)name fromBundle:(nullable NSBundle *)bundle;
 

FirebaseEmailAuthUI.podspec

@@ -21,7 +21,7 @@ Pod::Spec.new do |s|
   s.dependency 'FirebaseAuth', '~> 8.0'
   s.dependency 'FirebaseCore'
   s.dependency 'GoogleUtilities/UserDefaults'
-  s.resource_bundle = {
+  s.resource_bundles = {
     'FirebaseEmailAuthUI' => ['FirebaseEmailAuthUI/Sources/Resources/*.{xib,png}']
   }
 

FirebaseEmailAuthUI/FirebaseEmailAuthUITests/FirebaseEmailAuthUITests.m

@@ -31,10 +31,6 @@ @implementation FirebaseEmailAuthUITests
 
 - (void)setUp {
   [super setUp];
-
-  id mockUtilsClass = OCMClassMock([FUIAuthUtils class]);
-  OCMStub(ClassMethod([mockUtilsClass bundleNamed:OCMOCK_ANY])).
-      andReturn([NSBundle bundleForClass:[FUIEmailAuth class]]);
 
   id authUIClass = OCMClassMock([FUIAuth class]);
   OCMStub([authUIClass setEmailAuthProvider:[OCMArg any]]).andDo(^(NSInvocation *invocation){

FirebaseEmailAuthUI/Sources/FUIConfirmEmailViewController.m

@@ -74,7 +74,7 @@ @implementation FUIConfirmEmailViewController
 
 - (instancetype)initWithAuthUI:(FUIAuth *)authUI {
   return [self initWithNibName:NSStringFromClass([self class])
-                        bundle:[FUIAuthUtils bundleNamed:FUIEmailAuthBundleName]
+                        bundle:[FUIEmailAuth bundle]
                         authUI:authUI];
 }
 
@@ -207,7 +207,7 @@ - (UITableViewCell *)tableView:(UITableView *)tableView
   FUIAuthTableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:kCellReuseIdentifier];
   if (!cell) {
     UINib *cellNib = [UINib nibWithNibName:NSStringFromClass([FUIAuthTableViewCell class])
-                                    bundle:[FUIAuthUtils bundleNamed:FUIAuthBundleName]];
+                                    bundle:[FUIAuthUtils authUIBundle]];
     [tableView registerNib:cellNib forCellReuseIdentifier:kCellReuseIdentifier];
     cell = [tableView dequeueReusableCellWithIdentifier:kCellReuseIdentifier];
   }

FirebaseEmailAuthUI/Sources/FUIEmailAuth.m

@@ -71,6 +71,11 @@ @interface FUIEmailAuth () <FUIEmailAuthProvider>
 
 @implementation FUIEmailAuth
 
++ (NSBundle *)bundle {
+  return [FUIAuthUtils bundleNamed:FUIEmailAuthBundleName
+                 inFrameworkBundle:[NSBundle bundleForClass:[self class]]];
+}
+
 - (instancetype)init {
   return [self initAuthAuthUI:[FUIAuth defaultAuthUI]
                  signInMethod:FIREmailPasswordAuthSignInMethod
@@ -143,7 +148,7 @@ - (NSString *)signInLabel {
 }
 
 - (UIImage *)icon {
-  return [FUIAuthUtils imageNamed:@"ic_email" fromBundleNameOrNil:FUIEmailAuthBundleName];
+  return [FUIAuthUtils imageNamed:@"ic_email" fromBundle:[FUIEmailAuth bundle]];
 }
 
 - (UIColor *)buttonBackgroundColor {

FirebaseEmailAuthUI/Sources/FUIEmailAuthStrings.m

@@ -14,6 +14,7 @@
 //  limitations under the License.
 //
 
+#import "FirebaseEmailAuthUI/Sources/Public/FirebaseEmailAuthUI/FUIEmailAuth.h"
 #import "FirebaseEmailAuthUI/Sources/FUIEmailAuthStrings.h"
 
 #if SWIFT_PACKAGE
@@ -30,5 +31,5 @@
 NSString *FUIEmailAuthLocalizedString(NSString *key) {
   return FUILocalizedStringFromTableInBundle(key,
                                              kEmailAuthProviderTableName,
-                                             FUIEmailAuthBundleName);
+                                             [FUIEmailAuth bundle]);
 }

FirebaseEmailAuthUI/Sources/FUIEmailEntryViewController.m

@@ -74,7 +74,7 @@ @implementation FUIEmailEntryViewController {
 
 - (instancetype)initWithAuthUI:(FUIAuth *)authUI {
   return [self initWithNibName:NSStringFromClass([self class])
-                        bundle:[FUIAuthUtils bundleNamed:FUIEmailAuthBundleName]
+                        bundle:[FUIEmailAuth bundle]
                         authUI:authUI];
 }
 
@@ -280,7 +280,7 @@ - (UITableViewCell *)tableView:(UITableView *)tableView
   FUIAuthTableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:kCellReuseIdentifier];
   if (!cell) {
     UINib *cellNib = [UINib nibWithNibName:NSStringFromClass([FUIAuthTableViewCell class])
-                                    bundle:[FUIAuthUtils bundleNamed:FUIAuthBundleName]];
+                                    bundle:[FUIAuthUtils authUIBundle]];
     [tableView registerNib:cellNib forCellReuseIdentifier:kCellReuseIdentifier];
     cell = [tableView dequeueReusableCellWithIdentifier:kCellReuseIdentifier];
   }

FirebaseEmailAuthUI/Sources/FUIPasswordRecoveryViewController.m

@@ -19,6 +19,7 @@
 #import <FirebaseAuth/FirebaseAuth.h>
 #import <FirebaseAuthUI/FirebaseAuthUI.h>
 
+#import "FirebaseEmailAuthUI/Sources/Public/FirebaseEmailAuthUI/FUIEmailAuth.h"
 #import "FirebaseEmailAuthUI/Sources/FUIEmailAuthStrings.h"
 
 /** @var kCellReuseIdentifier
@@ -60,7 +61,7 @@ @implementation FUIPasswordRecoveryViewController {
 - (instancetype)initWithAuthUI:(FUIAuth *)authUI
                          email:(NSString *_Nullable)email {
   return [self initWithNibName:NSStringFromClass([self class])
-                        bundle:[FUIAuthUtils bundleNamed:FUIEmailAuthBundleName]
+                        bundle:[FUIEmailAuth bundle]
                         authUI:authUI
                          email:email];
 }
@@ -168,7 +169,7 @@ - (UITableViewCell *)tableView:(UITableView *)tableView
   FUIAuthTableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:kCellReuseIdentifier];
   if (!cell) {
     UINib *cellNib = [UINib nibWithNibName:NSStringFromClass([FUIAuthTableViewCell class])
-                                    bundle:[FUIAuthUtils bundleNamed:FUIAuthBundleName]];
+                                    bundle:[FUIAuthUtils authUIBundle]];
     [tableView registerNib:cellNib forCellReuseIdentifier:kCellReuseIdentifier];
     cell = [tableView dequeueReusableCellWithIdentifier:kCellReuseIdentifier];
   }