Plumb 'New' command status through simple menu model.

This was already added to menu item in a previous CL (behind a flag).

This CL allows SimpleMenuModel to specify that a menu item should be
flagged as "New" to help educate users about new features in Chrome.

Bug: 1098731
Change-Id: Ib2fd08acebb8731bcbfad83678017cf55f540b76
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2264196
Commit-Queue: Dana Fried <dfried@chromium.org>
Reviewed-by: Scott Violet <sky@chromium.org>
Reviewed-by: Michael Wasserman <msw@chromium.org>
Cr-Commit-Position: refs/heads/master@{#782170}

ui/base/models/menu_model.cc

@@ -19,6 +19,10 @@ bool MenuModel::IsVisibleAt(int index) const {
   return true;
 }
 
+bool MenuModel::IsNewFeatureAt(int index) const {
+  return false;
+}
+
 // static
 bool MenuModel::GetModelAndIndexForCommandId(int command_id,
                                              MenuModel** model,

ui/base/models/menu_model.h

@@ -113,6 +113,11 @@ class COMPONENT_EXPORT(UI_BASE) MenuModel
   // Returns true if the menu item is visible.
   virtual bool IsVisibleAt(int index) const;
 
+  // Returns true if the menu item grants access to a new feature that we want
+  // to show off to users (items marked as new will receive a "New" badge when
+  // the appropriate flag is enabled).
+  virtual bool IsNewFeatureAt(int index) const;
+
   // Returns the model for the submenu at the specified index.
   virtual MenuModel* GetSubmenuModelAt(int index) const = 0;
 

ui/base/models/simple_menu_model.cc

@@ -317,6 +317,10 @@ void SimpleMenuModel::SetVisibleAt(int index, bool visible) {
   MenuItemsChanged();
 }
 
+void SimpleMenuModel::SetIsNewFeatureAt(int index, bool is_new_feature) {
+  items_[ValidateItemIndex(index)].is_new_feature = is_new_feature;
+}
+
 void SimpleMenuModel::Clear() {
   items_.clear();
   MenuItemsChanged();
@@ -432,6 +436,10 @@ bool SimpleMenuModel::IsVisibleAt(int index) const {
          items_[ValidateItemIndex(index)].visible;
 }
 
+bool SimpleMenuModel::IsNewFeatureAt(int index) const {
+  return items_[ValidateItemIndex(index)].is_new_feature;
+}
+
 void SimpleMenuModel::ActivatedAt(int index) {
   ActivatedAt(index, 0);
 }

ui/base/models/simple_menu_model.h

@@ -159,6 +159,9 @@ class COMPONENT_EXPORT(UI_BASE) SimpleMenuModel : public MenuModel {
   // Sets whether the item at |index| is visible.
   void SetVisibleAt(int index, bool visible);
 
+  // Sets whether the item at |index| is new.
+  void SetIsNewFeatureAt(int index, bool is_new_feature);
+
   // Clears all items. Note that it does not free MenuModel of submenu.
   void Clear();
 
@@ -183,6 +186,7 @@ class COMPONENT_EXPORT(UI_BASE) SimpleMenuModel : public MenuModel {
   ui::ButtonMenuItemModel* GetButtonMenuItemAt(int index) const override;
   bool IsEnabledAt(int index) const override;
   bool IsVisibleAt(int index) const override;
+  bool IsNewFeatureAt(int index) const override;
   void ActivatedAt(int index) override;
   void ActivatedAt(int index, int event_flags) override;
   MenuModel* GetSubmenuModelAt(int index) const override;
@@ -216,6 +220,7 @@ class COMPONENT_EXPORT(UI_BASE) SimpleMenuModel : public MenuModel {
     MenuSeparatorType separator_type = NORMAL_SEPARATOR;
     bool enabled = true;
     bool visible = true;
+    bool is_new_feature = false;
   };
 
   typedef std::vector<Item> ItemVector;

ui/base/models/simple_menu_model_unittest.cc

@@ -147,6 +147,20 @@ TEST(SimpleMenuModelTest, IsVisibleAtWithDelegateAndCommandNotVisible) {
   ASSERT_FALSE(simple_menu_model.IsEnabledAt(0));
 }
 
+TEST(SimpleMenuModelTest, SetIsNewFeatureAt) {
+  SimpleMenuModel simple_menu_model(nullptr);
+  simple_menu_model.AddItem(/*command_id*/ 5,
+                            base::ASCIIToUTF16("menu item 0"));
+  simple_menu_model.AddItem(/*command_id*/ 6,
+                            base::ASCIIToUTF16("menu item 1"));
+
+  simple_menu_model.SetIsNewFeatureAt(/*index*/ 0, false);
+  simple_menu_model.SetIsNewFeatureAt(/*index*/ 1, true);
+
+  ASSERT_FALSE(simple_menu_model.IsNewFeatureAt(0));
+  ASSERT_TRUE(simple_menu_model.IsNewFeatureAt(1));
+}
+
 TEST(SimpleMenuModelTest, HasIconsViaDelegate) {
   DelegateBase delegate;
   SimpleMenuModel simple_menu_model(&delegate);

ui/views/controls/menu/menu_model_adapter.cc

@@ -107,7 +107,7 @@ MenuItemView* MenuModelAdapter::AddMenuItemFromModelAt(ui::MenuModel* model,
 
   ui::ImageModel icon = model->GetIconAt(model_index);
   ui::ImageModel minor_icon = model->GetMinorIconAt(model_index);
-  return menu->AddMenuItemAt(
+  auto* menu_item_view = menu->AddMenuItemAt(
       menu_index, item_id, model->GetLabelAt(model_index),
       model->GetSecondaryLabelAt(model_index),
       model->GetMinorTextAt(model_index),
@@ -118,6 +118,8 @@ MenuItemView* MenuModelAdapter::AddMenuItemFromModelAt(ui::MenuModel* model,
       icon.IsVectorIcon() ? ui::ThemedVectorIcon(icon.GetVectorIcon())
                           : ui::ThemedVectorIcon(),
       *type, ui::NORMAL_SEPARATOR);
+  menu_item_view->set_is_new(model->IsNewFeatureAt(model_index));
+  return menu_item_view;
 }
 
 // Static.

ui/views/controls/menu/menu_model_adapter_unittest.cc

@@ -78,6 +78,10 @@ class MenuModelBase : public ui::MenuModel {
 
   bool IsVisibleAt(int index) const override { return items_[index].visible; }
 
+  bool IsNewFeatureAt(int index) const override {
+    return items_[index].new_feature;
+  }
+
   MenuModel* GetSubmenuModelAt(int index) const override {
     return items_[index].submenu;
   }
@@ -117,6 +121,7 @@ class MenuModelBase : public ui::MenuModel {
     ui::MenuModel* submenu;
     bool enabled;
     bool visible;
+    bool new_feature = false;
   };
 
   const Item& GetItemDefinition(size_t index) { return items_[index]; }
@@ -155,6 +160,7 @@ class ActionableSubmenuModel : public MenuModelBase {
   ActionableSubmenuModel() : MenuModelBase(kActionableSubmenuIdBase) {
     items_.emplace_back(TYPE_COMMAND, "actionable submenu item 0", nullptr);
     items_.emplace_back(TYPE_COMMAND, "actionable submenu item 1", nullptr);
+    items_[1].new_feature = true;
   }
   ~ActionableSubmenuModel() override = default;
 
@@ -246,6 +252,9 @@ void CheckSubmenu(const RootModel& model,
     // Check visibility.
     EXPECT_EQ(model_item.visible, item->GetVisible());
 
+    // Check new feature flag.
+    EXPECT_EQ(model_item.new_feature, item->is_new());
+
     // Check activation.
     static_cast<views::MenuDelegate*>(delegate)->ExecuteCommand(id);
     EXPECT_EQ(i, size_t{submodel->last_activation()});
@@ -324,6 +333,9 @@ TEST_F(MenuModelAdapterTest, BasicTest) {
     // Check visibility.
     EXPECT_EQ(model_item.visible, item->GetVisible());
 
+    // Check visibility.
+    EXPECT_EQ(model_item.new_feature, item->is_new());
+
     // Check activation.
     static_cast<views::MenuDelegate*>(&delegate)->ExecuteCommand(id);
     EXPECT_EQ(i, size_t{model.last_activation()});