[ios] Add BadgeState to BadgeItem

This replaces accepted state properties in badges with a new BadgeState
enum. This will allow for more states to be added that help the UI to
handle more complex arrangements such as temporarily showing a badge whose banner
is presenting when there are multiple badges. When BadgeItems are initialized,
they will take a BadgeStateNone state for now. It will likely change as
more states are added.

Bug: 976901
Change-Id: I0eb0755cbf4fd41cd883aecc10a767d781af70d7
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1810766
Commit-Queue: Chris Lu <thegreenfrog@chromium.org>
Reviewed-by: Sergio Collazos <sczs@chromium.org>
Reviewed-by: Peter Lee <pkl@chromium.org>
Cr-Commit-Position: refs/heads/master@{#699812}

ios/chrome/browser/infobars/infobar_badge_model.h

@@ -13,8 +13,7 @@
 // A model object that represents a badge for an Infobar.
 @interface InfobarBadgeModel : NSObject <BadgeItem>
 
-- (instancetype)initWithInfobarType:(InfobarType)type
-                           accepted:(BOOL)accepted NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithInfobarType:(InfobarType)type NS_DESIGNATED_INITIALIZER;
 - (instancetype)init NS_UNAVAILABLE;
 
 @end

ios/chrome/browser/infobars/infobar_badge_model.mm

@@ -18,17 +18,17 @@
 @end
 
 @implementation InfobarBadgeModel
-// Synthesized from protocol.
+// Synthesized from BadgeItem.
 @synthesize tappable = _tappable;
-// Synthesized from protocol.
-@synthesize accepted = _accepted;
+// Synthesized from BadgeItem.
+@synthesize badgeState = _badgeState;
 
-- (instancetype)initWithInfobarType:(InfobarType)type accepted:(BOOL)accepted {
+- (instancetype)initWithInfobarType:(InfobarType)type {
   self = [super init];
   if (self) {
     _tappable = YES;
     _infobarType = type;
-    _accepted = accepted;
+    _badgeState = BadgeStateNone;
   }
   return self;
 }

ios/chrome/browser/infobars/infobar_badge_tab_helper.mm

@@ -33,11 +33,8 @@ void InfobarBadgeTabHelper::SetDelegate(
 
 void InfobarBadgeTabHelper::UpdateBadgeForInfobarAccepted(
     InfobarType infobar_type) {
-    InfobarBadgeModel* badgeModel =
-        [[InfobarBadgeModel alloc] initWithInfobarType:infobar_type
-                                              accepted:YES];
-    [delegate_ updateInfobarBadge:badgeModel];
-    infobar_badge_models_[infobar_type] = badgeModel;
+  infobar_badge_models_[infobar_type].badgeState = BadgeStateAccepted;
+  [delegate_ updateInfobarBadge:infobar_badge_models_[infobar_type]];
 }
 
 void InfobarBadgeTabHelper::UpdateBadgeForInfobarBannerDismissed(
@@ -91,8 +88,7 @@ void InfobarBadgeTabHelper::UpdateBadgeForInfobar(infobars::InfoBar* infobar,
     InfobarType infobar_type = controller_.infobarType;
     if (display) {
       InfobarBadgeModel* new_badge =
-          [[InfobarBadgeModel alloc] initWithInfobarType:infobar_type
-                                                accepted:NO];
+          [[InfobarBadgeModel alloc] initWithInfobarType:infobar_type];
       infobar_badge_models_[infobar_type] = new_badge;
       [delegate_ addInfobarBadge:new_badge];
     } else {

ios/chrome/browser/infobars/infobar_badge_tab_helper_unittest.mm

@@ -34,20 +34,20 @@
     : NSObject <InfobarBadgeTabHelperDelegate>
 @property(nonatomic, assign) BOOL displayingBadge;
 @property(nonatomic, assign) BOOL badgeIsTappable;
-@property(nonatomic, assign) BOOL badgeIsAccepted;
+@property(nonatomic, assign) BadgeState badgeState;
 @property(nonatomic, assign) BadgeType badgeType;
 @end
 
 @implementation InfobarBadgeTabHelperTestDelegate
 - (void)updateInfobarBadge:(id<BadgeItem>)badgeItem {
   self.badgeIsTappable = badgeItem.isTappable;
-  self.badgeIsAccepted = badgeItem.isAccepted;
+  self.badgeState = badgeItem.badgeState;
   self.badgeType = badgeItem.badgeType;
 }
 - (void)addInfobarBadge:(id<BadgeItem>)badgeItem {
   self.displayingBadge = YES;
   self.badgeIsTappable = badgeItem.isTappable;
-  self.badgeIsAccepted = badgeItem.isAccepted;
+  self.badgeState = badgeItem.badgeState;
   self.badgeType = badgeItem.badgeType;
 }
 - (void)removeInfobarBadge:(id<BadgeItem>)badgeItem {
@@ -219,16 +219,16 @@ class InfobarBadgeTabHelperTest : public PlatformTest {
 TEST_F(InfobarBadgeTabHelperTest, TestInfobarBadgeState) {
   EXPECT_FALSE(infobar_badge_tab_delegate_.displayingBadge);
   EXPECT_FALSE(infobar_badge_tab_delegate_.badgeIsTappable);
-  EXPECT_FALSE(infobar_badge_tab_delegate_.badgeIsAccepted);
+  EXPECT_NE(infobar_badge_tab_delegate_.badgeState, BadgeStateAccepted);
   AddInfoBar(/*has_badge=*/true);
   EXPECT_TRUE(infobar_badge_tab_delegate_.displayingBadge);
   EXPECT_TRUE(infobar_badge_tab_delegate_.badgeIsTappable);
-  EXPECT_FALSE(infobar_badge_tab_delegate_.badgeIsAccepted);
+  EXPECT_NE(infobar_badge_tab_delegate_.badgeState, BadgeStateAccepted);
   // Test that accepting the Infobar sets the badge to accepted state.
   tab_helper()->UpdateBadgeForInfobarAccepted(
       InfobarType::kInfobarTypePasswordSave);
   EXPECT_TRUE(infobar_badge_tab_delegate_.badgeIsTappable);
-  EXPECT_TRUE(infobar_badge_tab_delegate_.badgeIsAccepted);
+  EXPECT_EQ(infobar_badge_tab_delegate_.badgeState, BadgeStateAccepted);
 }
 
 // Test the badge state after doesn't change after adding an Infobar with no
@@ -236,11 +236,11 @@ TEST_F(InfobarBadgeTabHelperTest, TestInfobarBadgeState) {
 TEST_F(InfobarBadgeTabHelperTest, TestInfobarBadgeStateNoBadge) {
   EXPECT_FALSE(infobar_badge_tab_delegate_.displayingBadge);
   EXPECT_FALSE(infobar_badge_tab_delegate_.badgeIsTappable);
-  EXPECT_FALSE(infobar_badge_tab_delegate_.badgeIsAccepted);
+  EXPECT_NE(infobar_badge_tab_delegate_.badgeState, BadgeStateAccepted);
   AddInfoBar(/*has_badge=*/false);
   EXPECT_FALSE(infobar_badge_tab_delegate_.displayingBadge);
   EXPECT_FALSE(infobar_badge_tab_delegate_.badgeIsTappable);
-  EXPECT_FALSE(infobar_badge_tab_delegate_.badgeIsAccepted);
+  EXPECT_NE(infobar_badge_tab_delegate_.badgeState, BadgeStateAccepted);
 }
 
 // Tests that the InfobarBadge has not been removed after dismissing the
@@ -259,7 +259,7 @@ TEST_F(InfobarBadgeTabHelperTest, TestInfobarBadgeOnBannerDismissal) {
 // InfobarBanner.
 TEST_F(InfobarBadgeTabHelperTest, TestInfobarBadgeOnBannerAccepted) {
   AddInfoBar(/*has_badge=*/true);
-  EXPECT_FALSE(infobar_badge_tab_delegate_.badgeIsAccepted);
+  EXPECT_NE(infobar_badge_tab_delegate_.badgeState, BadgeStateAccepted);
   tab_helper()->UpdateBadgeForInfobarAccepted(
       InfobarType::kInfobarTypePasswordSave);
   [infobar_container_coordinator_ dismissBanner];
@@ -267,7 +267,7 @@ TEST_F(InfobarBadgeTabHelperTest, TestInfobarBadgeOnBannerAccepted) {
       base::test::ios::kWaitForUIElementTimeout, ^bool {
         return !infobar_container_coordinator_.bannerIsPresenting;
       }));
-  EXPECT_TRUE(infobar_badge_tab_delegate_.badgeIsAccepted);
+  EXPECT_EQ(infobar_badge_tab_delegate_.badgeState, BadgeStateAccepted);
 }
 
 // Test that removing the InfobarView doesn't stop displaying the badge.

ios/chrome/browser/ui/badges/badge_item.h

@@ -9,6 +9,15 @@
 
 #import "ios/chrome/browser/ui/badges/badge_type.h"
 
+// States for the InfobarBadge.
+typedef NS_ENUM(NSInteger, BadgeState) {
+  // The badge is not accepted.
+  BadgeStateNone = 0,
+  // The Infobar Badge is accepted. e.g. The Infobar was accepted/confirmed, and
+  // the Infobar action has taken place.
+  BadgeStateAccepted,
+};
+
 // Holds properties and values the UI needs to configure a badge button.
 @protocol BadgeItem
 
@@ -19,8 +28,8 @@
 - (BOOL)isFullScreen;
 // Some badges may not be tappable if there is no action associated with it.
 @property(nonatomic, assign, readonly, getter=isTappable) BOOL tappable;
-// Whether this badge is in an accepted state.
-@property(nonatomic, assign, getter=isAccepted) BOOL accepted;
+// The BadgeState of the badge.
+@property(nonatomic, assign) BadgeState badgeState;
 
 @end
 

ios/chrome/browser/ui/badges/badge_mediator.mm

@@ -89,7 +89,7 @@
 - (void)updateInfobarBadge:(id<BadgeItem>)badgeItem {
   for (id<BadgeItem> item in self.badges) {
     if (item.badgeType == badgeItem.badgeType) {
-      item.accepted = badgeItem.accepted;
+      item.badgeState = badgeItem.badgeState;
       [self updateBadgesShown];
       return;
     }

ios/chrome/browser/ui/badges/badge_mediator_unittest.mm

@@ -39,8 +39,7 @@ class FakeInfobarBadgeTabHelper : public InfobarBadgeTabHelper {
 
   void AddInfobar(InfobarType infobar_type) {
     InfobarBadgeModel* new_badge =
-        [[InfobarBadgeModel alloc] initWithInfobarType:infobar_type
-                                              accepted:NO];
+        [[InfobarBadgeModel alloc] initWithInfobarType:infobar_type];
     infobar_badge_models_[infobar_type] = new_badge;
     [delegate_ addInfobarBadge:new_badge];
   }
@@ -183,11 +182,11 @@ TEST_F(BadgeMediatorTest, BadgeMediatorTestAcceptedBadge) {
   AddAndActivateWebState(0, false);
   AddInfobar();
   ASSERT_TRUE(badge_consumer_.displayedBadge);
-  EXPECT_FALSE(badge_consumer_.displayedBadge.accepted);
+  EXPECT_NE(badge_consumer_.displayedBadge.badgeState, BadgeStateAccepted);
 
   GetFakeInfobarBadgeTabHelper()->UpdateBadgeForInfobarAccepted(
       InfobarType::kInfobarTypePasswordSave);
-  EXPECT_TRUE(badge_consumer_.displayedBadge.accepted);
+  EXPECT_EQ(badge_consumer_.displayedBadge.badgeState, BadgeStateAccepted);
 }
 
 // Test that the BadgeMediator adds an incognito badge when the webstatelist

ios/chrome/browser/ui/badges/badge_static_item.mm

@@ -21,14 +21,14 @@
 // Synthesized from protocol.
 @synthesize tappable = _tappable;
 // Sythesized from protocol.
-@synthesize accepted = _accepted;
+@synthesize badgeState = _badgeState;
 
 - (instancetype)initWithBadgeType:(BadgeType)badgeType {
   self = [super init];
   if (self) {
     _badgeType = badgeType;
     _tappable = NO;
-    _accepted = NO;
+    _badgeState = BadgeStateNone;
   }
   return self;
 }

ios/chrome/browser/ui/badges/badge_tappable_item.mm

@@ -21,14 +21,14 @@
 // Synthesized from protocol.
 @synthesize tappable = _tappable;
 // Synthesized from protocol.
-@synthesize accepted = _accepted;
+@synthesize badgeState = _badgeState;
 
 - (instancetype)initWithBadgeType:(BadgeType)badgeType {
   self = [super init];
   if (self) {
     _badgeType = badgeType;
     _tappable = YES;
-    _accepted = NO;
+    _badgeState = BadgeStateNone;
   }
   return self;
 }

ios/chrome/browser/ui/badges/badge_view_controller.mm

@@ -76,7 +76,8 @@ const double kFullScreenProgressThreshold = 0.85;
   if (displayedBadgeItem) {
     BadgeButton* newButton = [self.buttonFactory
         getBadgeButtonForBadgeType:displayedBadgeItem.badgeType];
-    [newButton setAccepted:displayedBadgeItem.accepted animated:NO];
+    [newButton setAccepted:displayedBadgeItem.badgeState == BadgeStateAccepted
+                  animated:NO];
     self.displayedBadge = newButton;
   }
   if (fullscreenBadgeItem) {
@@ -101,12 +102,14 @@ const double kFullScreenProgressThreshold = 0.85;
   if (displayedBadgeItem) {
     if (self.displayedBadge &&
         self.displayedBadge.badgeType == displayedBadgeItem.badgeType) {
-      [self.displayedBadge setAccepted:displayedBadgeItem.accepted
-                              animated:YES];
+      [self.displayedBadge
+          setAccepted:displayedBadgeItem.badgeState == BadgeStateAccepted
+             animated:YES];
     } else {
       BadgeButton* newButton = [self.buttonFactory
           getBadgeButtonForBadgeType:displayedBadgeItem.badgeType];
-      [newButton setAccepted:displayedBadgeItem.accepted animated:NO];
+      [newButton setAccepted:displayedBadgeItem.badgeState == BadgeStateAccepted
+                    animated:NO];
       self.displayedBadge = newButton;
     }
   } else {

ios/showcase/badges/sc_badge_coordinator.mm

@@ -65,8 +65,7 @@
   BadgeStaticItem* incognitoItem = [[BadgeStaticItem alloc]
       initWithBadgeType:BadgeType::kBadgeTypeIncognito];
   InfobarBadgeModel* passwordBadgeItem = [[InfobarBadgeModel alloc]
-      initWithInfobarType:InfobarType::kInfobarTypePasswordSave
-                 accepted:NO];
+      initWithInfobarType:InfobarType::kInfobarTypePasswordSave];
   [self.consumer setupWithDisplayedBadge:passwordBadgeItem
                          fullScreenBadge:incognitoItem];
 }