From 63c793fe25331b9a865e98fa537f7405d2aa2dfc Mon Sep 17 00:00:00 2001
From: "Pfeil, Scott Robert" <scott.pfeil3@verizonwireless.com>
Date: Mon, 6 Jul 2020 15:33:25 -0400
Subject: [PATCH] accessibility fix

---
 .../TextFields/DigitEntryField.swift          |  5 +--
 .../Atomic/Atoms/Selectors/RadioBox.swift     | 39 +++++++++++++++++--
 .../RadioBoxCollectionViewCell.swift          |  8 ++++
 .../Atomic/Atoms/Selectors/RadioBoxes.swift   | 10 +++++
 .../Atomic/Atoms/Selectors/RadioSwatch.swift  | 27 ++++++++++++-
 .../RadioSwatchCollectionViewCell.swift       | 20 ++++++++++
 .../Atoms/Selectors/RadioSwatches.swift       | 10 +++++
 .../CarouselIndicator/BarsIndicatorView.swift |  5 +--
 .../CarouselIndicator/CarouselIndicator.swift |  5 +--
 .../Strings/en.lproj/Localizable.strings      |  2 +-
 .../Strings/es-MX.lproj/Localizable.strings   |  1 +
 MVMCoreUI/Utility/MVMCoreUIUtility.h          |  3 ++
 MVMCoreUI/Utility/MVMCoreUIUtility.m          |  6 +++
 13 files changed, 124 insertions(+), 17 deletions(-)

diff --git a/MVMCoreUI/Atomic/Atoms/FormFields/TextFields/DigitEntryField.swift b/MVMCoreUI/Atomic/Atoms/FormFields/TextFields/DigitEntryField.swift
index 18f61b2d..b1f202a8 100644
--- a/MVMCoreUI/Atomic/Atoms/FormFields/TextFields/DigitEntryField.swift
+++ b/MVMCoreUI/Atomic/Atoms/FormFields/TextFields/DigitEntryField.swift
@@ -25,12 +25,9 @@ import UIKit
             if numberOfDigits > 0 {
                 var digitBoxes = [DigitBox]()
                 
-                let ordinalFormatter = NumberFormatter()
-                ordinalFormatter.numberStyle = .ordinal
-                
                 for i in 0..<numberOfDigits {
                     let newDigitBox = createDigitField()
-                    let accessibileLabel = ordinalFormatter.string(from: NSNumber(value: i + 1)) ?? ""
+                    let accessibileLabel = MVMCoreUIUtility.getOrdinalString(forIndex: NSNumber(value: i + 1)) ?? ""
                     newDigitBox.digitField.accessibilityLabel = "\(accessibileLabel) field of \(numberOfDigits) digit fields"
                     digitBoxes.append(newDigitBox)
                 }
diff --git a/MVMCoreUI/Atomic/Atoms/Selectors/RadioBox.swift b/MVMCoreUI/Atomic/Atoms/Selectors/RadioBox.swift
index 1118ca33..70c1a6ef 100644
--- a/MVMCoreUI/Atomic/Atoms/Selectors/RadioBox.swift
+++ b/MVMCoreUI/Atomic/Atoms/Selectors/RadioBox.swift
@@ -26,6 +26,18 @@ open class RadioBox: Control {
         return model as? RadioBoxModel
     }
     
+    public override var isSelected: Bool {
+        didSet {
+            updateAccessibility()
+        }
+    }
+    
+    public override var isEnabled: Bool {
+        didSet {
+            updateAccessibility()
+        }
+    }
+    
     // MARK: - MVMCoreViewProtocol
     
     open override func updateView(_ size: CGFloat) {
@@ -56,6 +68,8 @@ open class RadioBox: Control {
         subTextLabelHeightConstraint?.isActive = true
         
         addTarget(self, action: #selector(selectBox), for: .touchUpInside)
+        
+        isAccessibilityElement = true
     }
     
     // MARK: - MoleculeViewProtocol
@@ -63,8 +77,6 @@ open class RadioBox: Control {
     open override func set(with model: MoleculeModelProtocol, _ delegateObject: MVMCoreUIDelegateObject?, _ additionalData: [AnyHashable: Any]?) {
         super.set(with: model, delegateObject, additionalData)
         guard let model = model as? RadioBoxModel else { return }
-        isSelected = model.selected
-        isEnabled = model.enabled
         label.text = model.text
         subTextLabel.text = model.subText
         isOutOfStock = model.strikethrough
@@ -72,6 +84,8 @@ open class RadioBox: Control {
         if let color = model.selectedAccentColor?.uiColor {
             accentColor = color
         }
+        isSelected = model.selected
+        isEnabled = model.enabled
     }
     
     open override func reset() {
@@ -91,7 +105,6 @@ open class RadioBox: Control {
             strikeLayer = line
         }
         
-        
         // Draw the border
         borderLayer?.removeFromSuperlayer()
         if isSelected {
@@ -191,5 +204,25 @@ open class RadioBox: Control {
         mask.frame = bounds
         return mask
     }
+    
+    // MARK: - Accessibility
+    public func updateAccessibility() {
+        var message = ""
+        if let labelText = label.text, label.hasText {
+            message += labelText + ", "
+        }
+        if let subLabelText = subTextLabel.text, subTextLabel.hasText {
+            message += subLabelText + ", "
+        }
+        accessibilityLabel = message
+        
+        accessibilityTraits = .button
+        if isSelected {
+            accessibilityTraits.insert(.selected)
+        }
+        if !isEnabled {
+            accessibilityTraits.insert(.notEnabled)
+        }
+    }
 }
 
diff --git a/MVMCoreUI/Atomic/Atoms/Selectors/RadioBoxCollectionViewCell.swift b/MVMCoreUI/Atomic/Atoms/Selectors/RadioBoxCollectionViewCell.swift
index c6f5474e..314a2453 100644
--- a/MVMCoreUI/Atomic/Atoms/Selectors/RadioBoxCollectionViewCell.swift
+++ b/MVMCoreUI/Atomic/Atoms/Selectors/RadioBoxCollectionViewCell.swift
@@ -17,6 +17,7 @@ open class RadioBoxCollectionViewCell: CollectionViewCell {
     
     open override func setupView() {
         super.setupView()
+        isAccessibilityElement = true
         addMolecule(radioBox)
         MVMCoreUIUtility.setMarginsFor(contentView, leading: 0, top: 0, trailing: 0, bottom: 0)
     }
@@ -24,5 +25,12 @@ open class RadioBoxCollectionViewCell: CollectionViewCell {
     open override func set(with model: MoleculeModelProtocol, _ delegateObject: MVMCoreUIDelegateObject?, _ additionalData: [AnyHashable: Any]?) {
         guard let model = model as? RadioBoxModel else { return }
         radioBox.set(with: model, delegateObject, additionalData)
+        updateAccessibility()
+    }
+    
+    open func updateAccessibility() {
+        accessibilityLabel = radioBox.accessibilityLabel
+        accessibilityHint = radioBox.accessibilityHint
+        accessibilityTraits = radioBox.accessibilityTraits
     }
 }
diff --git a/MVMCoreUI/Atomic/Atoms/Selectors/RadioBoxes.swift b/MVMCoreUI/Atomic/Atoms/Selectors/RadioBoxes.swift
index 2a6ba953..0b17061e 100644
--- a/MVMCoreUI/Atomic/Atoms/Selectors/RadioBoxes.swift
+++ b/MVMCoreUI/Atomic/Atoms/Selectors/RadioBoxes.swift
@@ -35,6 +35,13 @@ open class RadioBoxes: View {
         }
     }
     
+    open func updateAccessibilityValue(collectionView: UICollectionView, cell: RadioBoxCollectionViewCell, indexPath: IndexPath) {
+        guard let format = MVMCoreUIUtility.hardcodedString(withKey: "index_string_of_total"),
+            let indexString = MVMCoreUIUtility.getOrdinalString(forIndex: NSNumber(value: indexPath.row + 1)) else { return }
+        let total = self.collectionView(collectionView, numberOfItemsInSection: indexPath.section)
+        cell.accessibilityValue = String(format: format, indexString, total)
+    }
+    
     // MARK: - MVMCoreViewProtocol
     open override func setupView() {
         super.setupView()
@@ -136,6 +143,7 @@ extension RadioBoxes: UICollectionViewDataSource {
         if molecule.selected {
             collectionView.selectItem(at: indexPath, animated: false, scrollPosition: .centeredVertically)
         }
+        updateAccessibilityValue(collectionView: collectionView, cell: cell, indexPath: indexPath)
         cell.layoutIfNeeded()
         return cell
     }
@@ -151,11 +159,13 @@ extension RadioBoxes: UICollectionViewDelegate {
         guard let cell = collectionView.cellForItem(at: indexPath) as? RadioBoxCollectionViewCell else { return }
         cell.radioBox.selectBox()
         _ = FormValidator.validate(delegate: delegateObject?.formHolderDelegate)
+        cell.updateAccessibility()
     }
     
     open func collectionView(_ collectionView: UICollectionView, didDeselectItemAt indexPath: IndexPath) {
         guard let cell = collectionView.cellForItem(at: indexPath) as? RadioBoxCollectionViewCell else { return }
         cell.radioBox.deselectBox()
+        cell.updateAccessibility()
     }
 }
 
diff --git a/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatch.swift b/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatch.swift
index d3ac7d0b..2a3763e7 100644
--- a/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatch.swift
+++ b/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatch.swift
@@ -24,6 +24,18 @@ open class RadioSwatch: Control {
         return model as? RadioSwatchModel
     }
     
+    public override var isSelected: Bool {
+        didSet {
+            updateAccessibility()
+        }
+    }
+    
+    public override var isEnabled: Bool {
+        didSet {
+            updateAccessibility()
+        }
+    }
+    
     //--------------------------------------------------
     // MARK: - Lifecycle
     //--------------------------------------------------
@@ -45,9 +57,9 @@ open class RadioSwatch: Control {
     open override func set(with model: MoleculeModelProtocol, _ delegateObject: MVMCoreUIDelegateObject?, _ additionalData: [AnyHashable: Any]?) {
         super.set(with: model, delegateObject, additionalData)
         guard let model = model as? RadioSwatchModel else { return }
+        bottomText.text = model.text
         isSelected = model.selected
         isEnabled = model.enabled
-        bottomText.text = model.text
     }
     
     public override func reset() {
@@ -163,4 +175,17 @@ open class RadioSwatch: Control {
         mask.frame = bounds
         return mask
     }
+    
+    // MARK: - Accessibility
+    public func updateAccessibility() {
+        accessibilityLabel = bottomText.accessibilityLabel ?? bottomText.text
+        
+        accessibilityTraits = .button
+        if isSelected {
+            accessibilityTraits.insert(.selected)
+        }
+        if !isEnabled {
+            accessibilityTraits.insert(.notEnabled)
+        }
+    }
 }
diff --git a/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatchCollectionViewCell.swift b/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatchCollectionViewCell.swift
index 8412dab2..4a9efb4b 100644
--- a/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatchCollectionViewCell.swift
+++ b/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatchCollectionViewCell.swift
@@ -12,6 +12,7 @@ open class RadioSwatchCollectionViewCell: CollectionViewCell {
     
     open override func setupView() {
         super.setupView()
+        isAccessibilityElement = true
         addMolecule(radioSwatch)
         MVMCoreUIUtility.setMarginsFor(contentView, leading: 0, top: 0, trailing: 0, bottom: 0)
     }
@@ -19,5 +20,24 @@ open class RadioSwatchCollectionViewCell: CollectionViewCell {
     open override func set(with model: MoleculeModelProtocol, _ delegateObject: MVMCoreUIDelegateObject?, _ additionalData: [AnyHashable: Any]?) {
         guard let model = model as? RadioSwatchModel else { return }
         radioSwatch.set(with: model, delegateObject, additionalData)
+        updateAccessibility()
+    }
+    
+    open func updateAccessibility() {
+        accessibilityLabel = radioSwatch.accessibilityLabel
+        accessibilityHint = radioSwatch.accessibilityHint
+        accessibilityTraits = radioSwatch.accessibilityTraits
+    }
+    
+    open override func accessibilityElementDidBecomeFocused() {
+        super.accessibilityElementDidBecomeFocused()
+        radioSwatch.bottomText.isHidden = false
+    }
+    
+    open override func accessibilityElementDidLoseFocus() {
+        super.accessibilityElementDidLoseFocus()
+        if !radioSwatch.isSelected {
+            radioSwatch.bottomText.isHidden = true
+        }
     }
 }
diff --git a/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatches.swift b/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatches.swift
index 8a6b8faf..6d4f93d3 100644
--- a/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatches.swift
+++ b/MVMCoreUI/Atomic/Atoms/Selectors/RadioSwatches.swift
@@ -101,6 +101,13 @@ open class RadioSwatches: View {
         }
         collectionViewHeight?.constant = CGFloat(height)
     }
+    
+    open func updateAccessibilityValue(collectionView: UICollectionView, cell: RadioSwatchCollectionViewCell, indexPath: IndexPath) {
+        guard let format = MVMCoreUIUtility.hardcodedString(withKey: "index_string_of_total"),
+            let indexString = MVMCoreUIUtility.getOrdinalString(forIndex: NSNumber(value: indexPath.row + 1)) else { return }
+        let total = self.collectionView(collectionView, numberOfItemsInSection: indexPath.section)
+        cell.accessibilityValue = String(format: format, indexString, total)
+    }
 }
 
 //------------------------------------------------------
@@ -128,6 +135,7 @@ extension RadioSwatches: UICollectionViewDataSource {
         if molecule.selected {
             collectionView.selectItem(at: indexPath, animated: false, scrollPosition: .centeredVertically)
         }
+        updateAccessibilityValue(collectionView: collectionView, cell: cell, indexPath: indexPath)
         cell.layoutIfNeeded()
         return cell
     }
@@ -143,10 +151,12 @@ extension RadioSwatches: UICollectionViewDelegate {
         guard let cell = collectionView.cellForItem(at: indexPath) as? RadioSwatchCollectionViewCell else { return }
         cell.radioSwatch.selectSwatch()
         _ = FormValidator.validate(delegate: delegateObject?.formHolderDelegate)
+        cell.updateAccessibility()
     }
     
     open func collectionView(_ collectionView: UICollectionView, didDeselectItemAt indexPath: IndexPath) {
         guard let cell = collectionView.cellForItem(at: indexPath) as? RadioSwatchCollectionViewCell else { return }
         cell.radioSwatch.deselectSwatch()
+        cell.updateAccessibility()
     }
 }
diff --git a/MVMCoreUI/Atomic/Atoms/Views/CarouselIndicator/BarsIndicatorView.swift b/MVMCoreUI/Atomic/Atoms/Views/CarouselIndicator/BarsIndicatorView.swift
index 69048e74..f2b87c0a 100644
--- a/MVMCoreUI/Atomic/Atoms/Views/CarouselIndicator/BarsIndicatorView.swift
+++ b/MVMCoreUI/Atomic/Atoms/Views/CarouselIndicator/BarsIndicatorView.swift
@@ -110,13 +110,10 @@ open class BarsIndicatorView: CarouselIndicator {
         
         var bars = [(View, NSLayoutConstraint)]()
         
-        let ordinalFormatter = NumberFormatter()
-        ordinalFormatter.numberStyle = .ordinal
-        
         for i in 0..<numberOfPages {
             let bar = View()
             bar.isAccessibilityElement = true
-            if let accessibleValueFormat = accessibilityValueFormat, let accessibleIndex = ordinalFormatter.string(from: NSNumber(value: i + 1)) {
+            if let accessibleValueFormat = accessibilityValueFormat, let accessibleIndex = MVMCoreUIUtility.getOrdinalString(forIndex: NSNumber(value: i + 1)) {
                 bar.accessibilityLabel = String(format: accessibleValueFormat, accessibleIndex, numberOfPages)
             }
             bar.accessibilityHint = MVMCoreUIUtility.hardcodedString(withKey: "AccTabHint")
diff --git a/MVMCoreUI/Atomic/Atoms/Views/CarouselIndicator/CarouselIndicator.swift b/MVMCoreUI/Atomic/Atoms/Views/CarouselIndicator/CarouselIndicator.swift
index 48b6cddf..040657c5 100644
--- a/MVMCoreUI/Atomic/Atoms/Views/CarouselIndicator/CarouselIndicator.swift
+++ b/MVMCoreUI/Atomic/Atoms/Views/CarouselIndicator/CarouselIndicator.swift
@@ -225,11 +225,8 @@ open class CarouselIndicator: Control, CarouselPageControlProtocol {
     
     func formatAccessibilityValue(index: Int, total: Int) {
         
-        let ordinalFormatter = NumberFormatter()
-        ordinalFormatter.numberStyle = .ordinal
-        
         guard let accessibleFormat = accessibilityValueFormat,
-            let accessibleIndex = ordinalFormatter.string(from: NSNumber(value: index))
+            let accessibleIndex = MVMCoreUIUtility.getOrdinalString(forIndex: NSNumber(value: index))
             else { return }
         
         accessibilityValue = String(format: accessibleFormat, accessibleIndex, total)
diff --git a/MVMCoreUI/SupportingFiles/Strings/en.lproj/Localizable.strings b/MVMCoreUI/SupportingFiles/Strings/en.lproj/Localizable.strings
index 74b907e3..c280b737 100644
--- a/MVMCoreUI/SupportingFiles/Strings/en.lproj/Localizable.strings
+++ b/MVMCoreUI/SupportingFiles/Strings/en.lproj/Localizable.strings
@@ -10,6 +10,7 @@
 "AccCloseButton" = "Close";
 "swipe_to_select_with_action_hint" = "swipe up or down to select action, then double tap to select.";
 "AccDisabled" = "Disabled";
+"index_string_of_total" = "%@ of %d";
 
 // MARK: Tab
 "AccTab" = ", tab";
@@ -59,7 +60,6 @@
 "radio_not_selected_state" = "Not Selected";
 "radio_desc_state" = "Option";
 
-
 // MARK: Switch / Toggle
 "mfswitch_buttonlabel" = "Switch Button";
 "Toggle_buttonlabel" = "Toggle Button";
diff --git a/MVMCoreUI/SupportingFiles/Strings/es-MX.lproj/Localizable.strings b/MVMCoreUI/SupportingFiles/Strings/es-MX.lproj/Localizable.strings
index b3b6298c..f21df078 100644
--- a/MVMCoreUI/SupportingFiles/Strings/es-MX.lproj/Localizable.strings
+++ b/MVMCoreUI/SupportingFiles/Strings/es-MX.lproj/Localizable.strings
@@ -9,6 +9,7 @@
 // Accessibility
 "swipe_to_select_with_action_hint" = "deslízate hacia arriba o hacia abajo para seleccionar la acción, luego toca dos veces para seleccionar.";
 "AccDisabled" = "desactivado";
+"index_string_of_total" = "%@ de %d";
 
 "AccCloseButton" = "Cerrar";
 // Tab
diff --git a/MVMCoreUI/Utility/MVMCoreUIUtility.h b/MVMCoreUI/Utility/MVMCoreUIUtility.h
index 21c92c38..78c2608b 100644
--- a/MVMCoreUI/Utility/MVMCoreUIUtility.h
+++ b/MVMCoreUI/Utility/MVMCoreUIUtility.h
@@ -46,6 +46,9 @@ NS_ASSUME_NONNULL_BEGIN
 // Removes any format.
 + (nullable NSString *)removeMdnFormat:(nullable NSString *)mdn;
 
+/// Returns an ordinal formatted string for a number.
++ (nullable NSString *)getOrdinalStringForIndex:(nonnull NSNumber *)number;
+
 #pragma mark - Validations
 
 // Will validate passed string on corresponding regular expression
diff --git a/MVMCoreUI/Utility/MVMCoreUIUtility.m b/MVMCoreUI/Utility/MVMCoreUIUtility.m
index 0841e248..cd9e041e 100644
--- a/MVMCoreUI/Utility/MVMCoreUIUtility.m
+++ b/MVMCoreUI/Utility/MVMCoreUIUtility.m
@@ -113,6 +113,12 @@
     return mdn;
 }
 
++ (nullable NSString *)getOrdinalStringForIndex:(nonnull NSNumber *)number {
+    NSNumberFormatter *formatter = [[NSNumberFormatter alloc] init];
+    formatter.numberStyle = NSNumberFormatterOrdinalStyle;
+    return [formatter stringFromNumber:number];
+}
+
 #pragma mark - Validations
 
 + (BOOL)validateString:(nonnull NSString *)string withRegularExpression:(nonnull NSString *)regExpression {