Add header for the Content Suggestions

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"
 #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/content_suggestion.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestion_identifier.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_article_item.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_expandable_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_favicon_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_footer_item.h"
+#import "ios/chrome/browser/ui/content_suggestions/content_suggestions_header_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_image_fetcher.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_section_information.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_stack_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_text_item.h"
 #import "ios/chrome/browser/ui/content_suggestions/content_suggestions_view_controller.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 {
 
 // Enum defining the ItemType of this ContentSuggestionsCollectionUpdater.
 typedef NS_ENUM(NSInteger, ItemType) {
   ItemTypeText = kItemTypeEnumZero,
   ItemTypeArticle,
   ItemTypeExpand,
   ItemTypeStack,
   ItemTypeFavicon,
   ItemTypeFooter,
+  ItemTypeHeader,
 };
 
 typedef NS_ENUM(NSInteger, SectionIdentifier) {
   SectionIdentifierBookmarks = kSectionIdentifierEnumZero,
   SectionIdentifierArticles,
   SectionIdentifierDefault,
 };
 
 ItemType ItemTypeForContentSuggestionType(ContentSuggestionType type) {
   switch (type) {
@@ skipping 107 matching lines @@
     return;
 
   NSIndexPath* indexPath = [self.collectionViewController.collectionViewModel
              indexPathForItem:correspondingItem
       inSectionWithIdentifier:sectionIdentifier];
   [self.collectionViewController dismissEntryAtIndexPath:indexPath];
 }
 
 - (void)reloadAllData {
   [self resetModels];
-  [self.collectionViewController
-      addSuggestions:[self.dataSource allSuggestions]];
+  NSArray<ContentSuggestion*>* suggestions = [self.dataSource allSuggestions];
+  [self addSectionsForSuggestionsToModel:suggestions];
+  [self addSuggestionsToModel:suggestions];
+  [self.collectionViewController.collectionView reloadData];

[gambard, 2017/03/16 15:49:41]

This is a bug fix, appearing only when you add header.

[lpromero, 2017/03/16 16:43:21]

Can you explain more on the issue in a comment in the code?

[gambard, 2017/03/17 09:33:39]

Done.

 }
 
 - (void)clearSection:(ContentSuggestionsSectionInformation*)sectionInfo {
   SectionIdentifier sectionIdentifier = SectionIdentifierForInfo(sectionInfo);
   NSInteger section = [self.collectionViewController.collectionViewModel
       sectionIdentifierForSection:sectionIdentifier];
 
   [self.collectionViewController dismissSection:section];
 }
 
@@ skipping 60 matching lines @@
     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]];
 
       [self addFooterIfNeeded:suggestion.suggestionIdentifier.sectionInfo];
+      [self addHeader:suggestion.suggestionIdentifier.sectionInfo];

[lpromero, 2017/03/16 16:43:21]

Optional nit: move one line up?

[gambard, 2017/03/17 09:33:39]

Done.

     }
   }
   return indexSet;
 }
 
 #pragma mark - ContentSuggestionsArticleItemDelegate
 
 - (void)loadImageForArticleItem:(ContentSuggestionsArticleItem*)articleItem {
   NSInteger sectionIdentifier =
       SectionIdentifierForInfo(articleItem.suggestionIdentifier.sectionInfo);
@@ skipping 39 matching lines @@
                block:^{
                  [weakSelf runAdditionalActionForSection:sectionInfo];
                }];
 
     [self.collectionViewController.collectionViewModel
                        setFooter:footer
         forSectionWithIdentifier:sectionIdentifier];
   }
 }
 
+// Adds the header corresponding to |sectionInfo| to the section.
+- (void)addHeader:(ContentSuggestionsSectionInformation*)sectionInfo {
+  NSInteger sectionIdentifier = SectionIdentifierForInfo(sectionInfo);
+
+  if (![self.collectionViewController.collectionViewModel
+          headerForSectionWithIdentifier:sectionIdentifier]) {
+    ContentSuggestionsHeaderItem* header =
+        [[ContentSuggestionsHeaderItem alloc] initWithType:ItemTypeHeader];
+    header.text = sectionInfo.title;
+    [self.collectionViewController.collectionViewModel
+                       setHeader:header
+        forSectionWithIdentifier:sectionIdentifier];
+  }
+}
+
 // Resets the models, removing the current CollectionViewItem and the
 // SectionInfo.
 - (void)resetModels {
   [self.collectionViewController loadModel];
   self.sectionInfoBySectionIdentifier = [[NSMutableDictionary alloc] init];
 }
 
 // Runs the additional action for the section identified by |sectionInfo|.
 - (void)runAdditionalActionForSection:
     (ContentSuggestionsSectionInformation*)sectionInfo {
@@ skipping 19 matching lines @@
                          }];
 }
 
 // Adds the |suggestions| to the collection view. All the suggestions must have
 // the same sectionInfo.
 - (void)moreSuggestionsFetched:(NSArray<ContentSuggestion*>*)suggestions {
   [self.collectionViewController addSuggestions:suggestions];
 }
 
 @end