Make dimmer a close button in VO mode (#8)

* Make dimmer a close button in VO mode * Apply Mark suggestion * Fix unit test * Tweak VO implementation --------- Co-authored-by: Mark Pospesel <[email protected]>
codeandtheory · May 5, 2023 · d3e6d7f · d3e6d7f
1 parent ae8495d
commit d3e6d7f
Show file tree

Hide file tree

Showing 9 changed files with 103 additions and 6 deletions.
diff --git a/Package.swift b/Package.swift
@@ -4,6 +4,7 @@ import PackageDescription
 
 let package = Package(
     name: "YSideMenu",
+    defaultLocalization: "en",
     platforms: [
         .iOS(.v14)
     ],

diff --git a/Sources/YSideMenu/Animation/SideMenuDismissAnimator.swift b/Sources/YSideMenu/Animation/SideMenuDismissAnimator.swift
@@ -34,13 +34,16 @@ class SideMenuDismissAnimator: SideMenuAnimator {
             menu.dimmerView.alpha = 0
         }
 
-        UIView.animate(with: menu.appearance.dismissAnimation) {
+        UIView.animate(
+            with: menu.appearance.dismissAnimation
+        ) {
             if self.isReduceMotionEnabled {
                 menu.contentView.alpha = 0
             } else {
                 menu.contentView.frame = menuFrame
             }
-        } completion: { _ in
+        }
+        completion: { _ in
             if !transitionContext.transitionWasCancelled {
                 fromViewController.view.removeFromSuperview()
             }

diff --git a/Sources/YSideMenu/Animation/SideMenuPresentAnimator.swift b/Sources/YSideMenu/Animation/SideMenuPresentAnimator.swift
@@ -47,13 +47,16 @@ class SideMenuPresentAnimator: SideMenuAnimator {
             menu.dimmerView.alpha = 1
         }
 
-        UIView.animate(with: menu.appearance.presentAnimation) {
+        UIView.animate(
+            with: menu.appearance.presentAnimation
+        ) {
             if self.isReduceMotionEnabled {
                 menu.view.alpha = 1
             } else {
                 menu.view.layoutIfNeeded()
             }
-        } completion: { _ in
+        }
+        completion: { _ in
             transitionContext.completeTransition(!transitionContext.transitionWasCancelled)
         }
     }

diff --git a/Sources/YSideMenu/Assets/Strings/en.lproj/Localizable.strings b/Sources/YSideMenu/Assets/Strings/en.lproj/Localizable.strings
@@ -0,0 +1,9 @@
+/*
+  Localizable.strings
+ YSideMenu
+
+  Created by Caio Coan on 05/03/23.
+  Copyright © 2023 Y Media Labs. All rights reserved.
+*/
+
+"Menu_Dimmer_Close" = "Dismiss";
diff --git a/Sources/YSideMenu/Enums/SideMenuController+AccessibilityIdentifiers.swift b/Sources/YSideMenu/Enums/SideMenuController+AccessibilityIdentifiers.swift
@@ -0,0 +1,13 @@
+//
+//  SideMenuController+AccessibilityIdentifiers.swift
+//  YSideMenu
+//
+//  Created by Caio Coan on 05/03/23.
+//  Copyright © 2023 Y Media Labs. All rights reserved.
+//
+
+extension SideMenuController {
+    enum AccessibilityIdentifiers {
+        static let dimmerId = "Menu_Dimmer_Close"
+    }
+}
diff --git a/Sources/YSideMenu/Enums/SideMenuController+Strings.swift b/Sources/YSideMenu/Enums/SideMenuController+Strings.swift
@@ -0,0 +1,18 @@
+//
+//  YSideMenuController+Strings.swift
+//  YSideMenu
+//
+//  Created by Caio Coan on 05/03/23.
+//  Copyright © 2023 Y Media Labs. All rights reserved.
+//
+
+import Foundation
+import YCoreUI
+
+extension SideMenuController {
+    enum Strings: String, Localizable, CaseIterable {
+        case dimmerAccessibilityLabel = "Menu_Dimmer_Close"
+
+        static var bundle: Bundle { .module }
+    }
+}
diff --git a/Sources/YSideMenu/SideMenuController.swift b/Sources/YSideMenu/SideMenuController.swift
@@ -23,6 +23,14 @@ public class SideMenuController: UIViewController {
     }
     private var idealWidthAnchor: NSLayoutConstraint?
     private var maximumWidthAnchor: NSLayoutConstraint?
+    /// Dimmer tap view
+    internal let dimmerTapView: UIView = {
+        let view = UIView()
+        view.accessibilityTraits = .button
+        view.accessibilityLabel = Strings.dimmerAccessibilityLabel.localized
+        view.accessibilityIdentifier = AccessibilityIdentifiers.dimmerId
+        return view
+    }()
 
     /// :nodoc:
     @available(*, unavailable)
@@ -62,6 +70,7 @@ public class SideMenuController: UIViewController {
 
     internal func didDismiss() {
         guard appearance.isDismissAllowed else { return }
+        dimmerTapView.isAccessibilityElement = false
         dismiss(animated: true)
     }
 }
@@ -79,6 +88,7 @@ private extension SideMenuController {
     }
 
     func updateAppearance() {
+        dimmerTapView.isAccessibilityElement = appearance.isDismissAllowed
         dimmerView.backgroundColor = appearance.dimmerColor
         idealWidthAnchor?.isActive = false
         idealWidthAnchor = contentView.constrain(
@@ -97,6 +107,7 @@ private extension SideMenuController {
 
     func buildViews() {
         view.addSubview(dimmerView)
+        view.addSubview(dimmerTapView)
         view.addSubview(contentView)
 
         addChild(rootViewController)
@@ -106,12 +117,14 @@ private extension SideMenuController {
 
     func buildConstraints() {
         dimmerView.constrainEdges()
+        dimmerTapView.constrainEdges(.notLeading)
+        dimmerTapView.constrain(.leadingAnchor, to: contentView.trailingAnchor)
         rootViewController.view.constrainEdges()
         contentView.constrainEdges(.notTrailing)
     }
 
     func configureViews() {
-        dimmerView.addGestureRecognizer(UITapGestureRecognizer(target: self, action: #selector(didTapDimmerView)))
+        dimmerTapView.addGestureRecognizer(UITapGestureRecognizer(target: self, action: #selector(didTapDimmerView)))
         updateAppearance()
 
         contentView.backgroundColor = .systemBackground

diff --git a/Tests/YSideMenuTests/Enums/SideMenuController+StringsTests.swift b/Tests/YSideMenuTests/Enums/SideMenuController+StringsTests.swift
@@ -0,0 +1,24 @@
+//
+//  SideMenuController+StringsTests.swift
+//  YSideMenu
+//
+//  Created by Caio Coan on 03/05/23.
+//  Copyright © 2023 Y Media Labs. All rights reserved.
+//
+
+import XCTest
+import YCoreUI
+@testable import YSideMenu
+
+final class SideMenuControllerStringsTests: XCTestCase {
+    func testLoad() {
+        SideMenuController.Strings.allCases.forEach {
+            // Given a localized string constant
+            let string = $0.localized
+            // it should not be empty
+            XCTAssertFalse(string.isEmpty)
+            // and it should not equal its key
+            XCTAssertNotEqual($0.rawValue, string)
+        }
+    }
+}
diff --git a/Tests/YSideMenuTests/SideMenuControllerTests.swift b/Tests/YSideMenuTests/SideMenuControllerTests.swift
@@ -92,14 +92,17 @@ final class SideMenuControllerTests: XCTestCase {
 
     func test_onDimmer() {
         let sut = makeSpy(rootViewController: UIViewController())
-
+        sut.loadViewIfNeeded()
+
         XCTAssertFalse(sut.onDimmerTapped)
         XCTAssertFalse(sut.isDismissed)
+        XCTAssertTrue(sut.dimmerTapView.isAccessibilityElement)
 
         sut.simulateOnDimmerTap()
 
         XCTAssertTrue(sut.onDimmerTapped)
         XCTAssertTrue(sut.isDismissed)
+        XCTAssertFalse(sut.dimmerTapView.isAccessibilityElement)
     }
 
     func test_onSwipeLeft() {
@@ -120,6 +123,7 @@ final class SideMenuControllerTests: XCTestCase {
         sut.appearance.isDismissAllowed = false
         sut.loadViewIfNeeded()
 
+        XCTAssertFalse(sut.dimmerTapView.isAccessibilityElement)
         XCTAssertFalse(sut.onMenuSwiped)
         XCTAssertFalse(sut.onDimmerTapped)
         XCTAssertFalse(sut.isDismissed)
@@ -131,6 +135,15 @@ final class SideMenuControllerTests: XCTestCase {
         XCTAssertFalse(sut.onMenuSwiped)
         XCTAssertFalse(sut.onDimmerTapped)
     }
+
+    func test_accessibility() {
+        let sut = makeSUT(rootViewController: UIViewController())
+        sut.loadViewIfNeeded()
+
+        XCTAssertTrue(sut.dimmerTapView.isAccessibilityElement)
+        XCTAssertEqual(sut.dimmerTapView.accessibilityIdentifier, SideMenuController.AccessibilityIdentifiers.dimmerId)
+        XCTAssertEqual(sut.dimmerTapView.accessibilityTraits, .button)
+    }
 }
 
 private extension SideMenuControllerTests {