Merge pull request #254 from surfstudio/feature/resolve_7.4_conflicts

Merge 7.4  and resolve conflicts

Author: NullIsOne

.github/workflows/Build.yml

@@ -10,7 +10,7 @@ on:
 jobs:
 
   build_iOS:
-    runs-on: macOS-12
+    runs-on: macOS-13
     steps:
     - uses: actions/checkout@v1
     - name: Generate projects
@@ -19,6 +19,8 @@ jobs:
       run: make build_lib_iOS
     - name: Run tests
       run: make test_lib_iOS
+    - name: Check Log
+      run: make check_test_log
     - name: Prepare Report
       run: make prepare_report
     - name: Upload Coverage
@@ -34,7 +36,7 @@ jobs:
 
 
   build_Example:
-    runs-on: macOS-12
+    runs-on: macOS-13
     steps:
     - uses: actions/checkout@v1
     - name: Generate projects
@@ -43,6 +45,8 @@ jobs:
       run: make build_example_iOS
     - name: Run tests
       run: make test_example_iOS
+    - name: Check Log
+      run: make check_test_log
     - name: Prepare Report
       run: make prepare_example_report
     - name: Upload Coverage
@@ -57,7 +61,7 @@ jobs:
         verbose: true
 
   build_tvOS:
-    runs-on: macOS-12
+    runs-on: macOS-13
     steps:
     - uses: actions/checkout@v1
     - name: Generate projects

.swiftlint.yml

@@ -86,12 +86,6 @@ custom_rules:
         message: "Every MARK should be surrounded with 1 newline before and 1 after it"
         severity: warning
 
-    redundant_default_type:
-        included: ".*.swift"
-        name: "Redundant explicit type"
-        regex: "(var|let) [0-9a-zA-Z_]*: (Int|String|Double|Bool)[ ]*= "
-        message: "Redundant explicit declaration of default types should be avoided"
-
     class_modificators_order:
         include: ".*.swift"
         name: "Class modificators order"

Components/Sources/Collection/CollectionWrappedCell.swift

@@ -28,7 +28,15 @@ public final class CollectionWrappedCell<View: ConfigurableItem>: UICollectionVi
 extension CollectionWrappedCell: CalculatableHeightItem where View: CalculatableHeightItem {
 
     public static func getHeight(forWidth width: CGFloat, with model: Model) -> CGFloat {
-        return View.getHeight(forWidth: width, with: model)
+        let nestedViewHeight = View.getHeight(forWidth: width, with: model)
+        if let alignment = (model as? AlignmentProvider)?.alignment {
+            switch alignment {
+            case .leading(let insets), .trailing(let insets), .all(let insets):
+                return nestedViewHeight + insets.top + insets.bottom
+            }
+        } else {
+            return nestedViewHeight
+        }
     }
 
 }
@@ -38,7 +46,15 @@ extension CollectionWrappedCell: CalculatableHeightItem where View: Calculatable
 extension CollectionWrappedCell: CalculatableWidthItem where View: CalculatableWidthItem {
 
     public static func getWidth(forHeight height: CGFloat, with model: View.Model) -> CGFloat {
-        return View.getWidth(forHeight: height, with: model)
+        let nestedViewWidth = View.getWidth(forHeight: height, with: model)
+        if let alignment = (model as? AlignmentProvider)?.alignment {
+            switch alignment {
+            case .leading(let insets), .trailing(let insets), .all(let insets):
+                return nestedViewWidth + insets.left + insets.right
+            }
+        } else {
+            return nestedViewWidth
+        }
     }
 
 }

Components/Sources/Common/Models/Styles/TextStyle.swift

@@ -12,7 +12,7 @@ public struct TextStyle: Equatable {
     public let color: UIColor
     public let font: UIFont
 
-    public init(color: UIColor = .black, font: UIFont = .systemFont(ofSize: 16)) {
+    public init(color: UIColor = .black, font: UIFont = .preferredFont(forTextStyle: .body)) {
         self.color = color
         self.font = font
     }

Components/Sources/Table/TableWrappedCell.swift

@@ -28,7 +28,15 @@ public final class TableWrappedCell<View: ConfigurableItem>: UITableViewCell, Vi
 extension TableWrappedCell: CalculatableHeightItem where View: CalculatableHeightItem {
 
     public static func getHeight(forWidth width: CGFloat, with model: Model) -> CGFloat {
-        return View.getHeight(forWidth: width, with: model)
+        let nestedViewHeight = View.getHeight(forWidth: width, with: model)
+        if let alignment = (model as? AlignmentProvider)?.alignment {
+            switch alignment {
+            case .leading(let insets), .trailing(let insets), .all(let insets):
+                return nestedViewHeight + insets.top + insets.bottom
+            }
+        } else {
+            return nestedViewHeight
+        }
     }
 
 }

Documentation/Accessibility/Overview.md

@@ -0,0 +1,7 @@
+# Overview
+
+- [UIAccessibility Basics](Pages/UIAccessibility%20Basics.md)
+- [Usage](Pages/Usage.md)
+- [Invalidation](Pages/Invalidation.md)
+- [Debugging](Pages/Debugging.md)
+- [Advanced Usage](Pages/Advanced%20Usage.md)

Documentation/Accessibility/Pages/Advanced Usage.md

@@ -0,0 +1,89 @@
+[⏎ Overview](../Overview.md)
+
+# Advanced Usage
+
+## How it works
+
+The main logic is located in `TableAccessibilityPlugin` and `CollectionAccessibilityPlugin`. It automatically added to all builders to be ready work with `AccessibilityItems`. It's a common plugin that works with delgate events.
+
+**Only each `AccessibilityItem` will be processed by these plugins.**
+
+On `willDisplay` event every time 2 steps are happens:
+
+1. Element will be passed to its defined modifier through corresponding methods `modify(item: accessibilityItem)` or `modify(item: accessibilityItem, generator: generator)` if generator implements `AccessibilityStrategyProvider`.
+2. A new invalidator instance is setted with provided `indexPath` if supports invalidation mechanism. Its invalidate method calls delegate to pass the new event `invalidatedAccessibility` which will execute step 1.
+
+On `didEndDisplay` event the plugin will remove invalidator if it exists.
+
+<img src="https://i.ibb.co/SfbfzZJ/2023-06-16-18-43-17.png" alt="Plugin Example">
+
+<br>
+
+This is the essence how accessibility works in **RDDM**, so you don't have access to its functionality. Instead, you may have full control under modify and invalidate processes.
+
+***
+
+<br>
+
+## Modify custom accessibility parameters
+
+If you need to set a parameter which is not presented or change the way how they setting, you need to define your own strategy provider (or custom accessibility item) and modifier. You can combine your custom logic with base functionality.
+
+*Example:*
+```swift
+enum CustomAccessibilityModifier: AccessibilityModifier {
+    static func modify(item: AccessibilityItem) {
+        // set base parameters
+        BaseAccessibilityModifier.modify(item)
+
+        // additional logic for custom item
+        guard let item = item as? CustomAccessibilityItem else { return }
+        item.accessibilityIdentifier = item.identifier.value
+        item.accessibilityHint = item.hintStrategy.value
+    }
+
+    // corresponding method implementation with generator
+}
+
+protocol CustomAccessibilityItem: AccessibilityItem { 
+    var modifierType: AccessibilityModifierType { CustomAccessibilityModifier.self }
+
+    // expand base accessibility item with new parameters using string strategy
+    var identifier: AccessibilityStringStrategy { get }
+    var hintStrategy: AccessibilityStringStrategy { get }
+}
+```
+
+By this way you can add any other functionality to accessibility items.
+
+***
+
+<br>
+
+## Customize invalidation
+
+
+### in table or collection
+If you want to perform additional logic on invalidate, you can implement your own `AccessibilityItemInvalidator` and set `AccessibilityInvalidatorCreationBlock` 
+
+**For example**
+```swift
+
+    private lazy var adapter = collectionView.rddm.baseBuilder
+        .add(plugin: .accessibility({ item, kind, delegate in
+            return CustomInvalidator(item, kind, delegate)
+        }))
+        .build()
+```
+
+*Note that we have `DelegatedAccessibilityItemInvalidator` which could be used as base for your custom invalidator. This class is needed to combine strategies from item and generator.*
+
+### in other view
+
+Any view can implement `AccessibilityItem`, but you need adittionaly call `AccessibilityItem.modifySelf()` to setup accessibility-properties for real.
+
+`AcessibilityInvalidatable.setBasicInvalidator` is also available for invalidation.
+
+*Note that is recomended to call*
+- `setBasicInvalidator` when view become **visible**
+- `removeInvalidator` when view become **invisible**

Documentation/Accessibility/Pages/Debugging.md

@@ -0,0 +1,77 @@
+[⏎ Overview](../Overview.md)
+
+# Debugging
+
+## Accessibility Inspector
+
+Accessibility Inspector is an instrument provided with Xcode, so this is most common insturment to see accessibility parameters. It can be opened in Menu Bar: `Xcode -> Open Developer Tool -> Accessibility Inspector`.
+
+<img src="https://i.ibb.co/wMkh1rG/2023-06-16-16-25-02.png" alt="Accessibility Inspector">
+
+Here you can see common acceessibility parameters and perform accessibility actions. To select an element you need fisrt select a running simulator. Then you click target button on the right and select an element or click arrorws "<" and ">" to navigate through all elements. Optionally, you can enable reading for selected elements.
+
+Be aware that not all accessibility parameters are displayed as they VoiceOver is reading. For example, if the element is `UISwitch`, in inspector you can see values 0 or 1, but VoiceOver will localize these values into "enabled" and "disabled". So it's better to also check elements with VoiceOver.
+
+*Note: Accessibility parameters also can be seen in a view debugger, but it's non interactive.*
+<img src="https://i.ibb.co/RQxVPGg/2023-06-16-16-32-20.png" alt="View Debugger">
+
+***
+
+<br>
+
+## Accessibility Audit
+
+Accessibility Inspector allows you to run audit of current screen to find and different accessibility issues if they exists. The second tab in right corner navigates you to audit window.
+
+<img src="https://i.ibb.co/LPfx62N/2023-06-16-16-57-17.png" alt="Accessibility Audit">
+
+***
+
+<br>
+
+## VoiceOver
+
+If you will test your app on a device with VoiceOver you can enable some useful options.
+
+<img src="https://i.ibb.co/TWJGG77/2023-06-16-17-07-42.jpg" alt="Caption Panel" width=49%>
+<img src="https://i.ibb.co/8Prs6r6/2023-06-16-17-07-17.jpg" alt="Accessibility Shortcut" width=49%>
+
+Caption panel allows you to read instead of listen to VoiceOver. And Accessibility Shortcut allows you to fast enable or disable VoiceOver by triple-click the lock button.
+
+It also useful to read an article how to use VoiceOver gestures https://support.apple.com/guide/iphone/iph3e2e2281/ios
+
+***
+
+<br>
+
+## UI Tests
+
+Accessibility elements are also used for UI tests. So changing traits affects on `XCUIElement` type (any element with trait `.button` becomes a button `XCUIElement`).
+
+If you manually change collection or table classes to become an accessibility elements your UI tests may fail, if they will not contains required accessibility.
+
+<img src="https://i.ibb.co/gz049gW/2023-06-16-17-31-51.png" alt="UI test failure">
+
+To fix this issue **RDDM** provides a built-in modifier for UI tests. You only need to provide the command line argument `"-rddm.XCUITestsCompatible"`
+
+<img src="https://i.ibb.co/XbzffYF/2023-06-16-17-36-30.png" alt="UI tests modifier">
+
+This modifier will add traits `.button` to all cells and `.staticText` to all headers and footers to prevent UI tests failures.
+
+***
+
+<br>
+
+## UI Tests Accessibility Audit
+
+In Xcode 15 you can run automatic accessibility audit with just a line of code:
+
+```swift
+try app.performAccessibilityAudit()
+```
+
+It's the same audit from Accessibility Inspector. If there will be any issues test will fail and you can see these issues in logs. See more at https://developer.apple.com/videos/play/wwdc2023/10035/.
+
+<br>
+
+Next [Advanced Usage →](./Advanced%20Usage.md)

Documentation/Accessibility/Pages/Invalidation.md

@@ -0,0 +1,44 @@
+[⏎ Overview](../Overview.md)
+
+# Invalidation
+
+**RDDM**'s accessibility plugin allows you to use your dynamic properties in accessibility strategies and so on. But if some properties will changed while the cell is on screen, you need to invalidate current accessibility parameters. For these needs you need implement `AccessibilityInvalidatable` protocol.
+
+```swift
+protocol AccessibilityInvalidatable: AccessibilityItem { 
+    var accessibilityInvalidator: AccessibilityItemInvalidator? { get set }
+}
+```
+
+This protocol required you to define an invalidatior property. Through this invalidator you can call `invalidateParameters()` method which triggers re-set of all accessibility parameters.
+
+*Important: this property is fully managed by accessibility plugin, so you don't need to set it. But if you want to add your own funtionality, see [Advanced Usage](./Advanced%20Usage.md). Invalidator may be `nil` if cell isn't on screen, so the latest parameters will be applied on `willDisplay` after the `configure()` method.*
+
+*Example:*
+
+```swift
+func updateState(state: String, isSelected: Bool) {
+    valueStrategy = .just(state)
+    isSelected ? traitsStrategy.insert(.selected) : traitsStrategy.remove(.selected)
+    accessibilityInvalidator?.invalidateParameters()
+}
+```
+
+<br>
+
+If you manage cell states like `isSelected`, `isEnabled`, you may use corresponding accessibility traits. But in a default `AccessibilityItem` these states wouldn't be changes because of `shouldOverrideStateTraits` property which by default is `false`. So you need to define this property as `true`.
+
+*Example:*
+
+```swift
+var labelStrategy: AccessibilityStringStrategy { .from(object: titleLabel) }
+var valueStrategy: AccessibilityStringStrategy = .just(nil)
+lazy var traitsStrategy: AccessibilityTraitsStrategy = .from(object: titleLabel)
+var shouldOverrideStateTraits: Bool { true }
+
+var accessibilityInvalidator: AccessibilityItemInvalidator?
+```
+
+<br>
+
+Next [Debugging →](./Debugging.md)