[Payment Request] Refactors edit view controller

ios/chrome/browser/ui/payments/payment_request_edit_view_controller.mm

 // Copyright 2017 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/payments/payment_request_edit_view_controller.h"
 
 #include "base/logging.h"
 #import "base/mac/foundation_util.h"
 #include "base/strings/sys_string_conversions.h"
 #include "components/strings/grit/components_strings.h"
 #import "ios/chrome/browser/ui/autofill/autofill_edit_accessory_view.h"
 #import "ios/chrome/browser/ui/autofill/cells/autofill_edit_item.h"
 #import "ios/chrome/browser/ui/collection_view/cells/MDCCollectionViewCell+Chrome.h"
 #import "ios/chrome/browser/ui/collection_view/cells/collection_view_footer_item.h"
 #import "ios/chrome/browser/ui/collection_view/cells/collection_view_item+collection_view_controller.h"
+#import "ios/chrome/browser/ui/collection_view/cells/collection_view_switch_item.h"
 #import "ios/chrome/browser/ui/colors/MDCPalette+CrAdditions.h"
 #import "ios/chrome/browser/ui/payments/cells/payments_selector_edit_item.h"
 #import "ios/chrome/browser/ui/payments/cells/payments_text_item.h"
-#import "ios/chrome/browser/ui/payments/payment_request_edit_view_controller+internal.h"
+#import "ios/chrome/browser/ui/payments/payment_request_edit_view_controller_actions.h"
 #import "ios/chrome/browser/ui/payments/payment_request_editor_field.h"
 #import "ios/chrome/browser/ui/uikit_ui_util.h"
 #include "ios/chrome/grit/ios_theme_resources.h"
 #import "ios/third_party/material_components_ios/src/components/Typography/src/MaterialTypography.h"
 #include "ui/base/l10n/l10n_util.h"
 
 #if !defined(__has_feature) || !__has_feature(objc_arc)
 #error "This file requires ARC support."
 #endif
 
@@ skipping 15 matching lines @@
     AutofillEditCell* cell = base::mac::ObjCCast<AutofillEditCell>(view);
     if (cell)
       return cell;
   }
 
   // There has to be a cell associated with this text field.
   NOTREACHED();
   return nil;
 }
 
+CollectionViewSwitchCell* CollectionViewSwitchCellForSwitchField(
+    UISwitch* switchField) {
+  for (UIView* view = switchField; view; view = [view superview]) {
+    CollectionViewSwitchCell* cell =
+        base::mac::ObjCCast<CollectionViewSwitchCell>(view);
+    if (cell)
+      return cell;
+  }
+
+  // There should be a cell associated with this switch field.
+  NOTREACHED();
+  return nil;
+}
+
 typedef NS_ENUM(NSInteger, SectionIdentifier) {
   SectionIdentifierHeader = kSectionIdentifierEnumZero,
   SectionIdentifierFooter,
   SectionIdentifierFirstField,  // Must be the last section identifier.
 };
 
 typedef NS_ENUM(NSInteger, ItemType) {
   ItemTypeHeader = kItemTypeEnumZero,
   ItemTypeFooter,
   ItemTypeTextField,      // This is a repeated item type.
   ItemTypeSelectorField,  // This is a repeated item type.
+  ItemTypeSwitchField,    // This is a repeated item type.
   ItemTypeErrorMessage,   // This is a repeated item type.
 };
 
 }  // namespace
 
-@interface PaymentRequestEditViewController ()<AutofillEditAccessoryDelegate,
-                                               UITextFieldDelegate,
-                                               UIPickerViewDataSource,
-                                               UIPickerViewDelegate> {
+@interface PaymentRequestEditViewController ()<
+    PaymentRequestEditViewControllerActions,

[lpromero, 2017/05/30 12:35:45]

Sort alphabetically.

[Moe, 2017/05/31 03:21:11]

Done.

+    AutofillEditAccessoryDelegate,
+    UITextFieldDelegate,
+    UIPickerViewDataSource,
+    UIPickerViewDelegate> {
   // The currently focused cell. May be nil.
   __weak AutofillEditCell* _currentEditingCell;
 
   AutofillEditAccessoryView* _accessoryView;
 }
 
-// The map of autofill types to the fields definitions for the editor.
+// The map of section identifiers to the fields definitions for the editor.
 @property(nonatomic, strong)
     NSMutableDictionary<NSNumber*, EditorField*>* fieldsMap;
 
 // The list of field definitions for the editor.
 @property(nonatomic, strong) NSArray<EditorField*>* fields;
 
 // The map of autofill types to lists of UIPickerView options.
 @property(nonatomic, strong)
     NSMutableDictionary<NSNumber*, NSArray<NSString*>*>* options;
 
@@ skipping 13 matching lines @@
 // Enables or disables the accessory view's previous and next buttons depending
 // on whether there is a text field before and after the currently focused text
 // field.
 - (void)updateAccessoryViewButtonsStates;
 
 // Adds an error message item in the section |sectionIdentifier| if
 // |errorMessage| is non-empty. Otherwise removes such an item if one exists.
 - (void)addOrRemoveErrorMessage:(NSString*)errorMessage
         inSectionWithIdentifier:(NSInteger)sectionIdentifier;
 
+// Validates each field. If there is a validation error, displays an error
+// message item in the same section as the field and returns NO. Otherwise
+// removes the error message item in that section if one exists and sets the
+// value on the field. Returns YES if all the fields are validated successfully.
+- (BOOL)validateForm;
+
+// Returns the index path for the cell associated with the currently focused
+// text field.
+- (NSIndexPath*)indexPathForCurrentTextField;
+
 @end
 
 @implementation PaymentRequestEditViewController
 
 @synthesize dataSource = _dataSource;
 @synthesize delegate = _delegate;
 @synthesize validatorDelegate = _validatorDelegate;
 @synthesize fieldsMap = _fieldsMap;
 @synthesize fields = _fields;
 @synthesize options = _options;
@@ skipping 68 matching lines @@
 
   [self.pickerViews removeAllObjects];
 
   CollectionViewItem* headerItem = [_dataSource headerItem];
   if (headerItem) {
     [headerItem setType:ItemTypeHeader];
     [model addSectionWithIdentifier:SectionIdentifierHeader];
     [model addItem:headerItem toSectionWithIdentifier:SectionIdentifierHeader];
   }
 
+  self.fieldsMap =
+      [[NSMutableDictionary alloc] initWithCapacity:self.fields.count];
+
   // Iterate over the fields and add the respective sections and items.
   [self.fields enumerateObjectsUsingBlock:^(EditorField* field,
                                             NSUInteger index, BOOL* stop) {
     NSInteger sectionIdentifier = SectionIdentifierFirstField + index;
     [model addSectionWithIdentifier:sectionIdentifier];
     switch (field.fieldType) {
       case EditorFieldTypeTextField: {
         AutofillEditItem* item =
             [[AutofillEditItem alloc] initWithType:ItemTypeTextField];
         item.textFieldName = field.label;
         item.textFieldEnabled = field.enabled;
         item.textFieldValue = field.value;
         item.required = field.isRequired;
         item.autofillUIType = field.autofillUIType;
+        item.identifyingIcon = [_dataSource iconIdentifyingEditorFied:field];
         [model addItem:item toSectionWithIdentifier:sectionIdentifier];
         field.item = item;
 
         break;
       }
       case EditorFieldTypeSelector: {
         PaymentsSelectorEditItem* item = [[PaymentsSelectorEditItem alloc]
             initWithType:ItemTypeSelectorField];
         item.name = field.label;
         item.value = field.displayValue;
         item.required = field.isRequired;
         item.autofillUIType = field.autofillUIType;
         item.accessoryType = MDCCollectionViewCellAccessoryDisclosureIndicator;
         [model addItem:item toSectionWithIdentifier:sectionIdentifier];
         field.item = item;
         break;
       }
+      case EditorFieldTypeSwitch: {
+        CollectionViewSwitchItem* item =
+            [[CollectionViewSwitchItem alloc] initWithType:ItemTypeSwitchField];
+        item.text = field.label;
+        item.on = [field.value boolValue];
+        [model addItem:item toSectionWithIdentifier:sectionIdentifier];
+        field.item = item;
+        break;
+      }
       default:
         NOTREACHED();
     }
 
     field.sectionIdentifier = sectionIdentifier;
+    NSNumber* key = [NSNumber numberWithInt:sectionIdentifier];
+    [self.fieldsMap setObject:field forKey:key];
   }];
 
-  [self loadFooterItems];
+  [model addSectionWithIdentifier:SectionIdentifierFooter];
+  CollectionViewFooterItem* footerItem =
+      [[CollectionViewFooterItem alloc] initWithType:ItemTypeFooter];
+  footerItem.text = l10n_util::GetNSString(IDS_PAYMENTS_REQUIRED_FIELD_MESSAGE);
+  [model addItem:footerItem toSectionWithIdentifier:SectionIdentifierFooter];
 }
 
 - (void)viewDidLoad {
   [super viewDidLoad];
 
   self.collectionView.accessibilityIdentifier =
       kPaymentRequestEditCollectionViewAccessibilityID;
 
   // Customize collection view settings.
   self.styler.cellStyle = MDCCollectionViewCellStyleCard;
   self.styler.separatorInset =
       UIEdgeInsetsMake(0, kSeparatorEdgeInset, 0, kSeparatorEdgeInset);
 }
 
 #pragma mark - PaymentRequestEditConsumer
 
 - (void)setEditorFields:(NSArray<EditorField*>*)fields {
   self.fields = fields;
-  self.fieldsMap = [[NSMutableDictionary alloc] initWithCapacity:fields.count];
-  // Iterate over the fields and populate the map.
-  [self.fields enumerateObjectsUsingBlock:^(EditorField* field,
-                                            NSUInteger index, BOOL* stop) {
-    NSNumber* key = [NSNumber numberWithInt:field.autofillUIType];
-    [self.fieldsMap setObject:field forKey:key];
-  }];
 }
 
 - (void)setOptions:(NSArray<NSString*>*)options
     forEditorField:(EditorField*)field {
   DCHECK(field.fieldType == EditorFieldTypeTextField);
   AutofillEditItem* item =
       base::mac::ObjCCastStrict<AutofillEditItem>(field.item);
   item.textFieldEnabled = field.enabled;
   item.textFieldValue = field.value;
 
@@ skipping 20 matching lines @@
 
 - (void)textFieldDidBeginEditing:(UITextField*)textField {
   _currentEditingCell = AutofillEditCellForTextField(textField);
   [textField setInputAccessoryView:_accessoryView];
   [self updateAccessoryViewButtonsStates];
 }
 
 - (void)textFieldDidEndEditing:(UITextField*)textField {
   DCHECK(_currentEditingCell == AutofillEditCellForTextField(textField));
 
-  CollectionViewModel* model = self.collectionViewModel;
+  NSIndexPath* indexPath = [self indexPathForCurrentTextField];
+  NSInteger sectionIdentifier = [self.collectionViewModel
+      sectionIdentifierForSection:[indexPath section]];
 
-  NSIndexPath* indexPath = [self indexPathForCurrentTextField];
-  AutofillEditItem* item = base::mac::ObjCCastStrict<AutofillEditItem>(
-      [model itemAtIndexPath:indexPath]);
-
-  // Find and validate the respective editor field.
-  NSNumber* key = [NSNumber numberWithInt:item.autofillUIType];
+  // Find the respective editor field, update its value, and validate it.
+  NSNumber* key = [NSNumber numberWithInt:sectionIdentifier];
   EditorField* field = self.fieldsMap[key];
   DCHECK(field);
   field.value = textField.text;
   NSString* errorMessage =
       [_validatorDelegate paymentRequestEditViewController:self
                                              validateField:field];
-  NSInteger sectionIdentifier =
-      [model sectionIdentifierForSection:[indexPath section]];
   [self addOrRemoveErrorMessage:errorMessage
         inSectionWithIdentifier:sectionIdentifier];
 
   [textField setInputAccessoryView:nil];
   _currentEditingCell = nil;
 }
 
 - (BOOL)textFieldShouldReturn:(UITextField*)textField {
   DCHECK([_currentEditingCell textField] == textField);
   AutofillEditCell* nextCell = [self nextTextFieldWithOffset:1];
   if (nextCell)
     [self nextPressed];
   else
     [self closePressed];
 
   return NO;
 }
 
+// This method is called as the text is being typed in, pasted, or deleted. Asks
+// the delegate if the text should be changed. Should always return YES. During
+// typing/pasting text, |newText| contains one or more new characters. When user
+// deletes text, |newText| is empty. |range| is the range of characters to be
+// replaced.
+- (BOOL)textField:(UITextField*)textField
+    shouldChangeCharactersInRange:(NSRange)range
+                replacementString:(NSString*)newText {
+  CollectionViewModel* model = self.collectionViewModel;
+
+  DCHECK(_currentEditingCell == AutofillEditCellForTextField(textField));
+
+  NSIndexPath* indexPath = [self indexPathForCurrentTextField];
+  NSInteger sectionIdentifier =
+      [model sectionIdentifierForSection:[indexPath section]];
+  AutofillEditItem* item = base::mac::ObjCCastStrict<AutofillEditItem>(
+      [model itemAtIndexPath:indexPath]);
+
+  // Find the respective editor field and update its value.
+  NSNumber* key = [NSNumber numberWithInt:sectionIdentifier];
+  EditorField* field = self.fieldsMap[key];
+  DCHECK(field);
+  // Obtain the text being typed.
+  NSString* updatedText =
+      [textField.text stringByReplacingCharactersInRange:range
+                                              withString:newText];
+  field.value = updatedText;
+
+  // Get the icon that identifies the field value and reload the cell if the
+  // icon changes.
+  UIImage* oldIcon = item.identifyingIcon;
+  item.identifyingIcon = [_dataSource iconIdentifyingEditorFied:field];
+  if (item.identifyingIcon != oldIcon)
+    [self reconfigureCellsForItems:@[ item ]];
+
+  return YES;
+}
+
 #pragma mark - AutofillEditAccessoryDelegate
 
 - (void)nextPressed {
   AutofillEditCell* nextCell = [self nextTextFieldWithOffset:1];
   if (nextCell)
     [nextCell.textField becomeFirstResponder];
 }
 
 - (void)previousPressed {
   AutofillEditCell* previousCell = [self nextTextFieldWithOffset:-1];
@@ skipping 56 matching lines @@
           base::mac::ObjCCast<AutofillEditCell>(cell);
       autofillEditCell.textField.delegate = self;
       autofillEditCell.textField.clearButtonMode = UITextFieldViewModeNever;
       autofillEditCell.textLabel.font = [MDCTypography body2Font];
       autofillEditCell.textLabel.textColor = [[MDCPalette greyPalette] tint900];
       autofillEditCell.textField.font = [MDCTypography body1Font];
       autofillEditCell.textField.textColor =
           [[MDCPalette cr_bluePalette] tint600];
       break;
     }
+    case ItemTypeSwitchField: {
+      CollectionViewSwitchCell* switchCell =
+          base::mac::ObjCCastStrict<CollectionViewSwitchCell>(cell);
+      [switchCell.switchView addTarget:self
+                                action:@selector(switchToggled:)
+                      forControlEvents:UIControlEventValueChanged];
+      break;
+    }
     case ItemTypeErrorMessage: {
       PaymentsTextCell* errorMessageCell =
           base::mac::ObjCCastStrict<PaymentsTextCell>(cell);
       errorMessageCell.textLabel.font = [MDCTypography body1Font];
       errorMessageCell.textLabel.textColor =
           [[MDCPalette cr_redPalette] tint600];
       break;
     }
     case ItemTypeFooter: {
       CollectionViewFooterCell* footerCell =
@@ skipping 37 matching lines @@
 #pragma mark MDCCollectionViewStylingDelegate
 
 - (CGFloat)collectionView:(UICollectionView*)collectionView
     cellHeightAtIndexPath:(NSIndexPath*)indexPath {
   CollectionViewItem* item =
       [self.collectionViewModel itemAtIndexPath:indexPath];
   switch (item.type) {
     case ItemTypeHeader:
     case ItemTypeFooter:
     case ItemTypeTextField:
+    case ItemTypeSwitchField:
     case ItemTypeErrorMessage:
       return [MDCCollectionViewCell
           cr_preferredHeightForWidth:CGRectGetWidth(collectionView.bounds)
                              forItem:item];
     case ItemTypeSelectorField:
       return MDCCellDefaultOneLineHeight;
     default:
       NOTREACHED();
       return MDCCellDefaultOneLineHeight;
   }
 }
 
 - (BOOL)collectionView:(UICollectionView*)collectionView
     hidesInkViewAtIndexPath:(NSIndexPath*)indexPath {
   NSInteger type = [self.collectionViewModel itemTypeForIndexPath:indexPath];
   switch (type) {
     case ItemTypeHeader:
     case ItemTypeFooter:
     case ItemTypeErrorMessage:
+    case ItemTypeTextField:
+    case ItemTypeSwitchField:
       return YES;
     default:
       return NO;
   }
 }
 
 - (BOOL)collectionView:(UICollectionView*)collectionView
     shouldHideItemBackgroundAtIndexPath:(NSIndexPath*)indexPath {
   NSInteger type = [self.collectionViewModel itemTypeForIndexPath:indexPath];
   switch (type) {
@@ skipping 72 matching lines @@
     errorMessageItem.text = errorMessage;
     errorMessageItem.image = NativeImage(IDR_IOS_PAYMENTS_WARNING);
     errorMessageItem.accessibilityIdentifier = kWarningMessageAccessibilityID;
     [model addItem:errorMessageItem toSectionWithIdentifier:sectionIdentifier];
     NSIndexPath* indexPath = [model indexPathForItemType:ItemTypeErrorMessage
                                        sectionIdentifier:sectionIdentifier];
     [self.collectionView insertItemsAtIndexPaths:@[ indexPath ]];
   }
 }
 
-#pragma mark - Keyboard handling
-
-- (void)keyboardDidShow {
-  [self.collectionView
-      scrollToItemAtIndexPath:[self.collectionView
-                                  indexPathForCell:_currentEditingCell]
-             atScrollPosition:UICollectionViewScrollPositionCenteredVertically
-                     animated:YES];
-}
-
-@end
-
-@implementation PaymentRequestEditViewController (Internal)
-
 - (BOOL)validateForm {
   for (EditorField* field in self.fields) {
     NSString* errorMessage =
         [_validatorDelegate paymentRequestEditViewController:self
                                                validateField:field];
     [self addOrRemoveErrorMessage:errorMessage
           inSectionWithIdentifier:field.sectionIdentifier];
     if (errorMessage.length)
       return NO;
   }
   return YES;
 }
 
-- (void)loadFooterItems {
-  CollectionViewModel* model = self.collectionViewModel;
-
-  [model addSectionWithIdentifier:SectionIdentifierFooter];
-  CollectionViewFooterItem* footerItem =
-      [[CollectionViewFooterItem alloc] initWithType:ItemTypeFooter];
-  footerItem.text = l10n_util::GetNSString(IDS_PAYMENTS_REQUIRED_FIELD_MESSAGE);
-  [model addItem:footerItem toSectionWithIdentifier:SectionIdentifierFooter];
-}
-
 - (NSIndexPath*)indexPathForCurrentTextField {
   DCHECK(_currentEditingCell);
   NSIndexPath* indexPath =
       [[self collectionView] indexPathForCell:_currentEditingCell];
   DCHECK(indexPath);
   return indexPath;
 }
 
+#pragma mark - Keyboard handling
+
+- (void)keyboardDidShow {
+  [self.collectionView
+      scrollToItemAtIndexPath:[self.collectionView
+                                  indexPathForCell:_currentEditingCell]
+             atScrollPosition:UICollectionViewScrollPositionCenteredVertically
+                     animated:YES];
+}
+
+#pragma mark Switch Actions
+
+- (void)switchToggled:(UISwitch*)sender {
+  CollectionViewSwitchCell* switchCell =
+      CollectionViewSwitchCellForSwitchField(sender);
+  NSIndexPath* indexPath = [[self collectionView] indexPathForCell:switchCell];
+  DCHECK(indexPath);
+
+  NSInteger sectionIdentifier = [self.collectionViewModel
+      sectionIdentifierForSection:[indexPath section]];
+
+  // Update editor field's value.
+  NSNumber* key = [NSNumber numberWithInt:sectionIdentifier];
+  EditorField* field = self.fieldsMap[key];
+  DCHECK(field);
+  field.value = [sender isOn] ? @"YES" : @"NO";
+}
+
 #pragma mark - PaymentRequestEditViewControllerActions methods
 
 - (void)onCancel {
+  [self.delegate paymentRequestEditViewControllerDidCancel:self];
 }
 
 - (void)onDone {
   [_currentEditingCell.textField resignFirstResponder];
+
+  if (![self validateForm])
+    return;
+
+  [self.delegate paymentRequestEditViewController:self
+                           didFinishEditingFields:self.fields];
 }
 
 @end