Add a message to empty ContentSuggestions sections

ios/chrome/browser/ui/content_suggestions/content_suggestions_collection_updater.mm

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_collection_updater.h"
 
 #include "base/logging.h"
 #include "base/mac/foundation_util.h"
 #include "base/time/time.h"
+#include "components/strings/grit/components_strings.h"
 #import "ios/chrome/browser/ui/collection_view/cells/collection_view_text_item.h"
 #import "ios/chrome/browser/ui/collection_view/collection_view_controller.h"
 #import "ios/chrome/browser/ui/collection_view/collection_view_model.h"
 #import "ios/chrome/browser/ui/content_suggestions/cells/content_suggestions_article_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/cells/content_suggestions_button_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/cells/content_suggestions_expandable_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/cells/content_suggestions_favicon_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/cells/content_suggestions_footer_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/cells/content_suggestions_stack_item.h"
+#import "ios/chrome/browser/ui/content_suggestions/cells/content_suggestions_text_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestion.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_data_sink.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_data_source.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_image_fetcher.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_view_controller.h"
 #import "ios/chrome/browser/ui/content_suggestions/identifier/content_suggestion_identifier.h"
 #import "ios/chrome/browser/ui/content_suggestions/identifier/content_suggestions_section_information.h"
+#include "ui/base/l10n/l10n_util.h"
 #include "ui/gfx/image/image.h"
 #include "url/gurl.h"
 
 #if !defined(__has_feature) || !__has_feature(objc_arc)
 #error "This file requires ARC support."
 #endif
 
 namespace {
 
+using CSCollectionViewItem =
+    CollectionViewItem<ContentSuggestionIdentification>;
+using CSCollectionViewModel = CollectionViewModel<CSCollectionViewItem*>;
+
 // Enum defining the ItemType of this ContentSuggestionsCollectionUpdater.
 typedef NS_ENUM(NSInteger, ItemType) {
   ItemTypeText = kItemTypeEnumZero,
   ItemTypeArticle,
   ItemTypeExpand,
   ItemTypeStack,
   ItemTypeFavicon,
   ItemTypeFooter,
   ItemTypeHeader,
+  ItemTypeEmpty,
 };
 
 typedef NS_ENUM(NSInteger, SectionIdentifier) {
   SectionIdentifierBookmarks = kSectionIdentifierEnumZero,
   SectionIdentifierArticles,
   SectionIdentifierDefault,
 };
 
 ItemType ItemTypeForContentSuggestionType(ContentSuggestionType type) {
   switch (type) {
     case ContentSuggestionTypeArticle:
       return ItemTypeArticle;
+    case ContentSuggestionTypeEmpty:
+      return ItemTypeEmpty;
   }
 }
 
 ContentSuggestionType ContentSuggestionTypeForItemType(NSInteger type) {
   if (type == ItemTypeArticle)
     return ContentSuggestionTypeArticle;
+  if (type == ItemTypeEmpty)
+    return ContentSuggestionTypeEmpty;
   // Add new type here
 
   // Default type.
-  return ContentSuggestionTypeArticle;
+  return ContentSuggestionTypeEmpty;
 }
 
 // Returns the section identifier corresponding to the section |info|.
 SectionIdentifier SectionIdentifierForInfo(
     ContentSuggestionsSectionInformation* info) {
   switch (info.sectionID) {
     case ContentSuggestionsSectionBookmarks:
       return SectionIdentifierBookmarks;
 
     case ContentSuggestionsSectionArticles:
@@ skipping 41 matching lines @@
 
   [self reloadAllData];
 }
 
 #pragma mark - ContentSuggestionsDataSink
 
 - (void)dataAvailableForSection:
     (ContentSuggestionsSectionInformation*)sectionInfo {
   SectionIdentifier sectionIdentifier = SectionIdentifierForInfo(sectionInfo);
 
-  CollectionViewModel* model =
+  CSCollectionViewModel* model =
       self.collectionViewController.collectionViewModel;
   if ([model hasSectionForSectionIdentifier:sectionIdentifier] &&
       [model itemsInSectionWithIdentifier:sectionIdentifier].count > 0) {
     // Do not dismiss the presented items.
     return;
   }
 
   [self.collectionViewController
       addSuggestions:[self.dataSource suggestionsForSection:sectionInfo]];
 }
 
 - (void)clearSuggestion:(ContentSuggestionIdentifier*)suggestionIdentifier {
   SectionIdentifier sectionIdentifier =
       SectionIdentifierForInfo(suggestionIdentifier.sectionInfo);
   if (![self.collectionViewController.collectionViewModel
           hasSectionForSectionIdentifier:sectionIdentifier]) {
     return;
   }
 
-  NSArray<CollectionViewItem<ContentSuggestionIdentification>*>*
-      itemsInSection = [self.collectionViewController.collectionViewModel
+  NSArray<CSCollectionViewItem*>* itemsInSection =
+      [self.collectionViewController.collectionViewModel
           itemsInSectionWithIdentifier:sectionIdentifier];
 
-  CollectionViewItem<ContentSuggestionIdentification>* correspondingItem = nil;
-  for (CollectionViewItem<ContentSuggestionIdentification>* item in
-           itemsInSection) {
+  CSCollectionViewItem* correspondingItem = nil;
+  for (CSCollectionViewItem* item in itemsInSection) {
     if (item.suggestionIdentifier == suggestionIdentifier) {
       correspondingItem = item;
       break;
     }
   }
 
   if (!correspondingItem)
     return;
 
   NSIndexPath* indexPath = [self.collectionViewController.collectionViewModel
@@ skipping 35 matching lines @@
     (CollectionViewItem*)item {
   return ContentSuggestionTypeForItemType(item.type);
 }
 
 - (NSArray<NSIndexPath*>*)addSuggestionsToModel:
     (NSArray<ContentSuggestion*>*)suggestions {
   if (suggestions.count == 0) {
     return [NSArray array];
   }
 
-  CollectionViewModel* model =
-      self.collectionViewController.collectionViewModel;
-
   NSMutableArray<NSIndexPath*>* indexPaths = [NSMutableArray array];
   for (ContentSuggestion* suggestion in suggestions) {
-    NSInteger sectionIdentifier =
-        SectionIdentifierForInfo(suggestion.suggestionIdentifier.sectionInfo);
+    ContentSuggestionsSectionInformation* sectionInfo =
+        suggestion.suggestionIdentifier.sectionInfo;
+    NSInteger sectionIdentifier = SectionIdentifierForInfo(sectionInfo);
+    CSCollectionViewModel* model =
+        self.collectionViewController.collectionViewModel;
 
-    ContentSuggestionsArticleItem* articleItem =
-        [[ContentSuggestionsArticleItem alloc]
-            initWithType:ItemTypeForContentSuggestionType(suggestion.type)
-                   title:suggestion.title
-                subtitle:suggestion.text
-                delegate:self
-                     url:suggestion.url];
+    switch (suggestion.type) {
+      case ContentSuggestionTypeEmpty: {
+        if ([model hasSectionForSectionIdentifier:sectionIdentifier] &&
+            [model numberOfItemsInSection:[model sectionForSectionIdentifier:
+                                                     sectionIdentifier]] == 0) {
+          CSCollectionViewItem* item =
+              [self emptyItemForSectionInfo:sectionInfo];
+          NSIndexPath* addedIndexPath =
+              [self addItem:item toSectionWithIdentifier:sectionIdentifier];

[lpromero, 2017/03/23 10:54:37]

Is there a code path that would have two empty items added to the same section?

[gambard, 2017/03/23 15:25:49]

Yes. This is why I am testing to know if the section contains 0 item (see lines
231-232).

+          [indexPaths addObject:addedIndexPath];

[lpromero, 2017/03/23 10:54:37]

You could reuse -addEmptyItemForSection: once it returns the added index path.

[gambard, 2017/03/23 15:25:49]

I am not sure it makes sense here addEmptyItemForSection is a wrapper for the
two lines above, but it takes a section instead of a section identifier.

+        }
+        break;
+      }
+      case ContentSuggestionTypeArticle: {
+        ContentSuggestionsArticleItem* articleItem =
+            [[ContentSuggestionsArticleItem alloc]
+                initWithType:ItemTypeForContentSuggestionType(suggestion.type)
+                       title:suggestion.title
+                    subtitle:suggestion.text
+                    delegate:self
+                         url:suggestion.url];
 
-    articleItem.publisher = suggestion.publisher;
-    articleItem.publishDate = suggestion.publishDate;
+        articleItem.publisher = suggestion.publisher;
+        articleItem.publishDate = suggestion.publishDate;
 
-    articleItem.suggestionIdentifier = suggestion.suggestionIdentifier;
+        articleItem.suggestionIdentifier = suggestion.suggestionIdentifier;
 
-    NSInteger section = [model sectionForSectionIdentifier:sectionIdentifier];
-    NSInteger itemNumber = [model numberOfItemsInSection:section];
-    [model addItem:articleItem toSectionWithIdentifier:sectionIdentifier];
-
-    [indexPaths
-        addObject:[NSIndexPath indexPathForItem:itemNumber inSection:section]];
+        NSIndexPath* addedIndexPath = [self addItem:articleItem
+                            toSectionWithIdentifier:sectionIdentifier];
+        [indexPaths addObject:addedIndexPath];
+        break;
+      }
+    }
   }
 
   return indexPaths;
 }
 
 - (NSIndexSet*)addSectionsForSuggestionsToModel:
     (NSArray<ContentSuggestion*>*)suggestions {
   NSMutableIndexSet* indexSet = [NSMutableIndexSet indexSet];
 
-  CollectionViewModel* model =
+  CSCollectionViewModel* model =
       self.collectionViewController.collectionViewModel;
   for (ContentSuggestion* suggestion in suggestions) {
     ContentSuggestionsSectionInformation* sectionInfo =
         suggestion.suggestionIdentifier.sectionInfo;
     NSInteger sectionIdentifier = SectionIdentifierForInfo(sectionInfo);
 
-    if (![model hasSectionForSectionIdentifier:sectionIdentifier]) {
-      [model addSectionWithIdentifier:sectionIdentifier];
-      self.sectionInfoBySectionIdentifier[@(sectionIdentifier)] = sectionInfo;
-      [indexSet addIndex:[model sectionForSectionIdentifier:sectionIdentifier]];
+    if ([model hasSectionForSectionIdentifier:sectionIdentifier] ||
+        (suggestion.type == ContentSuggestionTypeEmpty &&
+         !sectionInfo.showIfEmpty)) {
+      continue;
+    }
 
-      [self addHeader:suggestion.suggestionIdentifier.sectionInfo];
-      [self addFooterIfNeeded:suggestion.suggestionIdentifier.sectionInfo];
-    }
+    [model addSectionWithIdentifier:sectionIdentifier];
+    self.sectionInfoBySectionIdentifier[@(sectionIdentifier)] = sectionInfo;
+    [indexSet addIndex:[model sectionForSectionIdentifier:sectionIdentifier]];
+
+    [self addHeader:sectionInfo];
+    [self addFooterIfNeeded:sectionInfo];
   }
   return indexSet;
 }
 
+- (void)addEmptyItemForSection:(NSInteger)section {

[lpromero, 2017/03/23 10:54:37]

Return the index path of the newly added item.

[gambard, 2017/03/23 15:25:49]

Done.

+  CSCollectionViewModel* model =
+      self.collectionViewController.collectionViewModel;
+  NSInteger sectionIdentifier = [model sectionIdentifierForSection:section];
+  ContentSuggestionsSectionInformation* sectionInfo =
+      self.sectionInfoBySectionIdentifier[@(sectionIdentifier)];
+  CSCollectionViewItem* item = [self emptyItemForSectionInfo:sectionInfo];
+  [model addItem:item toSectionWithIdentifier:sectionIdentifier];
+}
+
 #pragma mark - ContentSuggestionsArticleItemDelegate
 
 - (void)loadImageForArticleItem:(ContentSuggestionsArticleItem*)articleItem {
   NSInteger sectionIdentifier =
       SectionIdentifierForInfo(articleItem.suggestionIdentifier.sectionInfo);
 
   __weak ContentSuggestionsCollectionUpdater* weakSelf = self;
   __weak ContentSuggestionsArticleItem* weakArticle = articleItem;
   void (^imageFetchedCallback)(const gfx::Image&) = ^(const gfx::Image& image) {
     if (image.IsEmpty()) {
@@ skipping 64 matching lines @@
 }
 
 // Runs the additional action for the section identified by |sectionInfo|.
 - (void)runAdditionalActionForSection:
     (ContentSuggestionsSectionInformation*)sectionInfo {
   SectionIdentifier sectionIdentifier = SectionIdentifierForInfo(sectionInfo);
 
   NSMutableArray<ContentSuggestionIdentifier*>* knownSuggestionIdentifiers =
       [NSMutableArray array];
 
-  NSArray<CollectionViewItem<ContentSuggestionIdentification>*>*
-      knownSuggestions = [self.collectionViewController.collectionViewModel
+  NSArray<CSCollectionViewItem*>* knownSuggestions =
+      [self.collectionViewController.collectionViewModel
           itemsInSectionWithIdentifier:sectionIdentifier];
-  for (CollectionViewItem<ContentSuggestionIdentification>* suggestion in
-           knownSuggestions) {
-    [knownSuggestionIdentifiers addObject:suggestion.suggestionIdentifier];
+  for (CSCollectionViewItem* suggestion in knownSuggestions) {
+    if (suggestion.type != ItemTypeEmpty) {
+      [knownSuggestionIdentifiers addObject:suggestion.suggestionIdentifier];
+    }
   }
 
   __weak ContentSuggestionsCollectionUpdater* weakSelf = self;
   [self.dataSource
       fetchMoreSuggestionsKnowing:knownSuggestionIdentifiers
                   fromSectionInfo:sectionInfo
                          callback:^(NSArray<ContentSuggestion*>* suggestions) {
                            [weakSelf moreSuggestionsFetched:suggestions];
                          }];
 }
 
 // Adds the |suggestions| to the collection view. All the suggestions must have
 // the same sectionInfo.
 - (void)moreSuggestionsFetched:(NSArray<ContentSuggestion*>*)suggestions {
   [self.collectionViewController addSuggestions:suggestions];
 }
 
+// Returns a item to be displayed when the section identified by |sectionInfo|
+// is empty.
+- (CSCollectionViewItem*)emptyItemForSectionInfo:
+    (ContentSuggestionsSectionInformation*)sectionInfo {
+  ContentSuggestionsTextItem* item =
+      [[ContentSuggestionsTextItem alloc] initWithType:ItemTypeEmpty];
+  item.text = l10n_util::GetNSString(IDS_NTP_TITLE_NO_SUGGESTIONS);
+  item.detailText = sectionInfo.emptyText;
+
+  return item;
+}
+
+// Adds |item| to |sectionIdentifier| section of the model of the
+// CollectionView. Returns the IndexPath of the newly added item.
+- (NSIndexPath*)addItem:(CSCollectionViewItem*)item
+    toSectionWithIdentifier:(NSInteger)sectionIdentifier {
+  CSCollectionViewModel* model =
+      self.collectionViewController.collectionViewModel;
+  NSInteger section = [model sectionForSectionIdentifier:sectionIdentifier];
+  NSInteger itemNumber = [model numberOfItemsInSection:section];
+  [model addItem:item toSectionWithIdentifier:sectionIdentifier];
+
+  return [NSIndexPath indexPathForItem:itemNumber inSection:section];
+}
+
 @end